Asset pipeline basics in Ruby on Rails - Mini Project: Build & Apply

Asset pipeline basics

📖 Scenario: You are building a simple Rails web page that needs to include CSS and JavaScript files efficiently.The asset pipeline helps combine, minify, and serve these files in a way that speeds up page loading.

🎯 Goal: Create a basic Rails asset pipeline setup by adding CSS and JavaScript files, configuring the manifest files, and including them in the application layout.

📋 What You'll Learn

Create a CSS file with some styles in app/assets/stylesheets

Create a JavaScript file in app/assets/javascripts

Add the CSS and JavaScript files to the manifest files application.css and application.js

Include the stylesheet and JavaScript tags in the application layout app/views/layouts/application.html.erb

💡 Why This Matters

🌍 Real World

Web developers use the Rails asset pipeline to organize and optimize CSS, JavaScript, and images for faster page loads and easier maintenance.

💼 Career

Understanding the asset pipeline is essential for Rails developers to build performant and maintainable web applications.

1

Create a CSS file with styles

Create a file named custom.css inside app/assets/stylesheets with the following CSS rule: body { background-color: #f0f0f0; }

Ruby on Rails

# Create app/assets/stylesheets/custom.css
/* Add CSS rule for body background color */

Hint

Use standard CSS syntax to set the background color of the body element.

2

Create a JavaScript file with a simple script

Create a file named custom.js inside app/assets/javascripts with this JavaScript code: console.log('Custom JS loaded');

Ruby on Rails

/* app/assets/stylesheets/custom.css */
body { background-color: #f0f0f0; }

// Create app/assets/javascripts/custom.js
// Add console.log statement

Hint

Use console.log to print a message when the script loads.

3

Add custom files to the manifest files

Edit app/assets/stylesheets/application.css to include custom.css using *= require custom. Also edit app/assets/javascripts/application.js to include custom.js using //= require custom.

Ruby on Rails

/* app/assets/stylesheets/custom.css */
body { background-color: #f0f0f0; }

// app/assets/javascripts/custom.js
console.log('Custom JS loaded');

/* Edit application.css and application.js to require custom files */

Hint

Use the require directive in the manifest files to include your custom files.

4

Include asset tags in the application layout

Edit app/views/layouts/application.html.erb to include the stylesheet and JavaScript tags by adding <%= stylesheet_link_tag 'application', media: 'all' %> inside the <head> and <%= javascript_include_tag 'application' %> before the closing </body> tag.

Ruby on Rails

  MyApp
  


  
  

Hint

Use Rails helper tags to include the compiled CSS and JS files in the layout.

Practice

1. What is the main purpose of the Rails asset pipeline?

easy

A. To generate HTML templates dynamically

B. To handle database migrations automatically

C. To combine, compress, and manage CSS, JavaScript, and images for faster loading

D. To manage user authentication and sessions

Solution

1. Step 1: Understand asset pipeline role

   The asset pipeline organizes and prepares CSS, JavaScript, and images for the app.

2. Step 2: Identify its main benefits

   It combines and compresses assets to improve website speed and maintenance.

3. Final Answer:

   To combine, compress, and manage CSS, JavaScript, and images for faster loading -> Option C

4. Quick Check:

   Asset pipeline = combine and compress assets [OK]

Hint: Asset pipeline = faster loading by combining assets [OK]

Common Mistakes:

• Confusing asset pipeline with database tasks
• Thinking it generates HTML templates
• Mixing it up with user authentication

2. Which file is typically used to specify which JavaScript files to include in the Rails asset pipeline?

easy

A. application.js

B. routes.rb

C. database.yml

D. Gemfile

Solution

1. Step 1: Identify manifest files for assets

   Rails uses manifest files like application.js to list JavaScript files to include.

2. Step 2: Recognize unrelated files

   routes.rb manages URL routes, database.yml configures database, Gemfile manages gems.

3. Final Answer:

   application.js -> Option A

4. Quick Check:

   JavaScript manifest = application.js [OK]

Hint: JavaScript manifest file is application.js [OK]

Common Mistakes:

• Choosing routes.rb which is for routing
• Confusing Gemfile with asset files
• Picking database.yml which is unrelated

3. Given the following snippet in app/assets/javascripts/application.js:

//= require jquery
//= require_tree .

What will happen when the asset pipeline processes this file?

medium

A. It will cause a syntax error and fail to compile

B. It will only include jQuery and ignore other files

C. It will include files in reverse alphabetical order

D. It will include jQuery first, then all other JavaScript files in the directory

Solution

1. Step 1: Understand require directives

   "//= require jquery" includes jQuery first; "//= require_tree ." includes all files in the directory.

2. Step 2: Determine inclusion order

   jQuery is included first, then all other JavaScript files are included in alphabetical order.

3. Final Answer:

   It will include jQuery first, then all other JavaScript files in the directory -> Option D

4. Quick Check:

   require + require_tree = jQuery then all files [OK]

Hint: require_tree includes all files after listed requires [OK]

Common Mistakes:

• Thinking require_tree ignores previous requires
• Assuming syntax error from comments
• Believing files load in reverse order

4. You added a new CSS file custom.css to app/assets/stylesheets but it does not appear on your site. What is the most likely cause?

medium

A. You forgot to add *= require custom in application.css

B. The file name must be custom.scss to work

C. CSS files are not supported by the asset pipeline

D. You need to restart the Rails server to load new assets

Solution

1. Step 1: Check manifest file inclusion

   New CSS files must be included in application.css manifest using "*= require filename".

2. Step 2: Verify other options

   CSS files are supported; file extension .css is valid; server restart is not required for asset changes.

3. Final Answer:

   You forgot to add *= require custom in application.css -> Option A

4. Quick Check:

   Missing require in manifest = no CSS load [OK]

Hint: Add *= require line in application.css to include new CSS [OK]

Common Mistakes:

• Thinking .css files are unsupported
• Assuming server restart is needed
• Believing file extension must be .scss

5. You want to add a new image logo.png to your Rails app and use it in CSS. Which is the correct way to reference it in application.css using the asset pipeline?

hard

A. background-image: url('/assets/logo.png');

B. background-image: image-url('logo.png');

C. background-image: url('logo.png');

D. background-image: asset_path('logo.png');

Solution

1. Step 1: Understand asset pipeline helpers in CSS

   Rails asset pipeline uses helper functions like image-url() in CSS to reference images correctly with fingerprinting.

2. Step 2: Evaluate options

   background-image: url('/assets/logo.png'); uses a hardcoded path which may break with asset fingerprinting; background-image: url('logo.png'); lacks helper; background-image: asset_path('logo.png'); is invalid CSS syntax.

3. Final Answer:

   background-image: image-url('logo.png'); -> Option B

4. Quick Check:

   Use image-url() helper for images in CSS [OK]

Hint: Use image-url() helper to reference images in CSS [OK]

Common Mistakes:

• Hardcoding asset paths breaking fingerprinting
• Using url() without helper in asset pipeline
• Trying to use Ruby helpers directly in CSS