Sprockets asset pipeline in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of the Sprockets asset pipeline in Rails?

The Sprockets asset pipeline helps manage and serve assets like JavaScript, CSS, and images efficiently by combining, compressing, and fingerprinting them for faster loading in web applications.

beginner

How does Sprockets improve web page load times?

Sprockets combines multiple asset files into one, compresses them to reduce size, and adds fingerprints to enable browser caching, which all together speed up page loading.

intermediate

What is the role of 'manifest files' like application.js or application.css in Sprockets?

Manifest files list and require other asset files. They tell Sprockets which files to include and in what order, helping organize and bundle assets neatly.

intermediate

Explain what 'fingerprinting' means in the context of the Sprockets asset pipeline.

Fingerprinting adds a unique hash to asset filenames based on their content. This helps browsers know when assets change and avoid loading old cached versions.

beginner

Where are assets typically stored in a Rails project using Sprockets?

Assets are usually stored in the app/assets, lib/assets, and vendor/assets directories, which Sprockets uses to find and process files.

What does Sprockets do to JavaScript and CSS files before serving them?

A Converts them to HTML

B Deletes unused files automatically

C Combines and compresses them

D Uploads them to a cloud server

Sprockets combines multiple files into one and compresses them to reduce size and improve loading speed.

Which file typically acts as a manifest to include other JavaScript files in Sprockets?

A application.js

B index.html

C style.css

D routes.rb

application.js is the manifest file that lists other JavaScript files to include.

What is the benefit of fingerprinting asset files?

A It helps browsers cache assets correctly

B It changes file content automatically

C It makes filenames shorter

D It encrypts the files for security

Fingerprinting adds a unique hash to filenames so browsers know when to update cached files.

Where would you place custom images for your Rails app to be processed by Sprockets?

A config/initializers

B app/assets/images

C db/migrate

D lib/tasks

Images go in app/assets/images so Sprockets can find and serve them.

Which of these is NOT a feature of the Sprockets asset pipeline?

A Adding fingerprints to filenames

B Compressing assets

C Combining files

D Running database migrations

Running database migrations is unrelated to asset management and not handled by Sprockets.

Describe how the Sprockets asset pipeline helps improve a Rails app's performance.

Think about what happens to JavaScript and CSS files before they reach the browser.

Explain the purpose of manifest files like application.js in the Sprockets asset pipeline.

Consider how you tell Sprockets which files to include.

Practice

1. What is the main purpose of the Sprockets asset pipeline in a Rails application?

easy

A. To combine and prepare CSS, JavaScript, and images for faster loading

B. To manage database migrations automatically

C. To handle user authentication and sessions

D. To generate HTML templates dynamically

Solution

1. Step 1: Understand Sprockets role

   Sprockets is designed to manage assets like CSS, JavaScript, and images.

2. Step 2: Identify its main benefit

   It combines and prepares these assets to improve loading speed and organization.

3. Final Answer:

   To combine and prepare CSS, JavaScript, and images for faster loading -> Option A

4. Quick Check:

   Sprockets purpose = combine and prepare assets [OK]

Hint: Remember: Sprockets handles assets, not databases or HTML [OK]

Common Mistakes:

• Confusing asset pipeline with database management
• Thinking it handles user sessions
• Assuming it generates HTML templates

2. Which directive is used in a JavaScript manifest file to include another JavaScript file using Sprockets?

easy

A. //= include file.js

B. //= require file.js

C. /*= require file.js */

D. #= require file.js

Solution

1. Step 1: Identify correct directive syntax for JS files

   In JavaScript manifests, Sprockets uses //= require to include files.

2. Step 2: Compare options

   //= require file.js matches the correct syntax; others use wrong comment styles or keywords.

3. Final Answer:

   //= require file.js -> Option B

4. Quick Check:

   JS include directive = //= require [OK]

Hint: JS uses //= require, CSS uses *= require [OK]

Common Mistakes:

• Using /*= require */ in JS files instead of //= require
• Using #= require which is invalid
• Writing //= include instead of require

3. Given the following application.js manifest file content:

//= require jquery
//= require_tree .
console.log('Loaded');

What will happen when the page loads?

medium

A. Syntax error stops JavaScript from running

B. Only jQuery loads, 'Loaded' logs, other files are ignored

C. jQuery and all JavaScript files in the directory load, then 'Loaded' logs to console

D. 'Loaded' logs before jQuery loads

Solution

1. Step 1: Understand directives order

   //= require jquery loads jQuery first, then //= require_tree . loads all JS files in the directory.

2. Step 2: Execution order of console.log

   After loading scripts, the console.log runs, so 'Loaded' appears after scripts load.

3. Final Answer:

   jQuery and all JavaScript files in the directory load, then 'Loaded' logs to console -> Option C

4. Quick Check:

   require order respected, console.log last [OK]

Hint: require directives load files in order before code runs [OK]

Common Mistakes:

• Assuming require_tree loads before require jquery
• Thinking console.log runs before scripts load
• Confusing syntax causing errors

4. You added a new JavaScript file custom.js in your assets folder but it is not loading in your Rails app. Which of the following is the most likely cause?

medium

A. You placed custom.js outside the assets folder

B. You used *= require custom in a JavaScript manifest file

C. You named the file custom.css by mistake

D. You forgot to add //= require custom in the manifest file

Solution

1. Step 1: Check manifest inclusion

   JavaScript files must be included with //= require custom in the manifest to load.

2. Step 2: Eliminate distractors

   Placing outside assets contradicts the question. Using *= require custom is CSS syntax ignored in JS manifest. Naming as custom.css mismatches. Most likely: forgetting the directive.

3. Final Answer:

   You forgot to add //= require custom in the manifest file -> Option D

4. Quick Check:

   JS files need //= require to load [OK]

Hint: JS files must be required with //= require, not *= require [OK]

Common Mistakes:

• Using CSS require syntax in JS manifest
• Placing files outside assets folder without updating paths
• Misnaming JS files as CSS

5. You want to include all CSS files in your stylesheets folder except admin.css using Sprockets directives. Which approach correctly achieves this?

hard

A. Manually require each CSS file except admin.css in the manifest

B. Rename admin.css to admin.scss and it will be excluded automatically

C. Use *= require_directory . which excludes admin.css automatically

D. Use *= require_tree . and then override admin styles manually

Solution

1. Step 1: Understand require_tree behavior

   *= require_tree . includes all files in the directory, no exclusions.

2. Step 2: Exclude specific files

   To exclude admin.css, you must list each file manually except admin.css in the manifest.

3. Step 3: Evaluate other options

   Require_directory includes all files too; renaming does not exclude files automatically.

4. Final Answer:

   Manually require each CSS file except admin.css in the manifest -> Option A

5. Quick Check:

   Exclude files by manual require, require_tree includes all [OK]

Hint: require_tree includes all files; exclude by manual listing [OK]

Common Mistakes:

• Assuming require_tree can exclude files
• Thinking require_directory excludes files automatically
• Believing renaming changes inclusion behavior