Class: Sprockets::Manifest
- Inherits:
-
Object
- Object
- Sprockets::Manifest
- Includes:
- ManifestUtils
- Defined in:
- lib/sprockets/manifest.rb,
lib/sprockets/legacy.rb
Overview
The Manifest logs the contents of assets compiled to a single directory. It records basic attributes about the asset for fast lookup without having to compile. A pointer from each logical path indicates which fingerprinted asset is the current one.
The JSON is part of the public API and should be considered stable. This should make it easy to read from other programming languages and processes that don’t have sprockets loaded. See ‘#assets` and `#files` for more infomation about the structure.
Constant Summary
Constants included from ManifestUtils
Sprockets::ManifestUtils::LEGACY_MANIFEST_RE, Sprockets::ManifestUtils::MANIFEST_RE
Instance Attribute Summary collapse
-
#directory ⇒ Object
(also: #dir)
readonly
Returns the value of attribute directory.
-
#environment ⇒ Object
readonly
Returns the value of attribute environment.
-
#filename ⇒ Object
(also: #path)
readonly
Returns String path to manifest.json file.
Class Method Summary collapse
-
.compile_match_filter(filter) ⇒ Object
Deprecated: Compile logical path matching filter into a proc that can be passed to logical_paths.select(&proc).
- .compute_alias_logical_path(path) ⇒ Object
- .simple_logical_path?(str) ⇒ Boolean
Instance Method Summary collapse
-
#assets ⇒ Object
Returns internal assets mapping.
-
#clean(count = 2, age = 3600) ⇒ Object
Cleanup old assets in the compile directory.
-
#clobber ⇒ Object
Wipe directive.
-
#compile(*args) ⇒ Object
Compile and write asset to directory.
-
#files ⇒ Object
Returns internal file directory listing.
-
#filter_logical_paths(*args) ⇒ Object
(also: #find_logical_paths)
Deprecated: Filter logical paths in environment.
-
#find(*args) ⇒ Object
Public: Find all assets matching pattern set in environment.
-
#find_sources(*args) ⇒ Object
Public: Find the source of assets by paths.
-
#initialize(*args) ⇒ Manifest
constructor
Create new Manifest associated with an ‘environment`.
-
#remove(filename) ⇒ Object
Removes file from directory and from manifest.
-
#save ⇒ Object
Persist manfiest back to FS.
Methods included from ManifestUtils
#find_directory_manifest, #generate_manifest_path
Constructor Details
#initialize(*args) ⇒ Manifest
Create new Manifest associated with an ‘environment`. `filename` is a full path to the manifest json file. The file may or may not already exist. The dirname of the `filename` will be used to write compiled assets to. Otherwise, if the path is a directory, the filename will default a random “.sprockets-manifest-*.json” file in that directory.
Manifest.new(environment, "./public/assets/manifest.json")
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/sprockets/manifest.rb', line 32 def initialize(*args) if args.first.is_a?(Base) || args.first.nil? @environment = args.shift end @directory, @filename = args[0], args[1] # Whether the manifest file is using the old manifest-*.json naming convention @legacy_manifest = false # Expand paths @directory = File.(@directory) if @directory @filename = File.(@filename) if @filename # If filename is given as the second arg if @directory && File.extname(@directory) != "" @directory, @filename = nil, @directory end # Default dir to the directory of the filename @directory ||= File.dirname(@filename) if @filename # If directory is given w/o filename, pick a random manifest location @rename_filename = nil if @directory && @filename.nil? @filename = find_directory_manifest(@directory) # If legacy manifest name autodetected, mark to rename on save if File.basename(@filename).start_with?("manifest") @rename_filename = File.join(@directory, generate_manifest_path) end end unless @directory && @filename raise ArgumentError, "manifest requires output filename" end data = {} begin if File.exist?(@filename) data = json_decode(File.read(@filename)) end rescue JSON::ParserError => e logger.error "#{@filename} is invalid: #{e.class} #{e.}" end @data = data end |
Instance Attribute Details
#directory ⇒ Object (readonly) Also known as: dir
Returns the value of attribute directory.
86 87 88 |
# File 'lib/sprockets/manifest.rb', line 86 def directory @directory end |
#environment ⇒ Object (readonly)
Returns the value of attribute environment.
22 23 24 |
# File 'lib/sprockets/manifest.rb', line 22 def environment @environment end |
#filename ⇒ Object (readonly) Also known as: path
Returns String path to manifest.json file.
83 84 85 |
# File 'lib/sprockets/manifest.rb', line 83 def filename @filename end |
Class Method Details
.compile_match_filter(filter) ⇒ Object
Deprecated: Compile logical path matching filter into a proc that can be passed to logical_paths.select(&proc).
compile_match_filter(proc { |logical_path|
File.extname(logical_path) == '.js'
})
compile_match_filter(/application.js/)
compile_match_filter("foo/*.js")
Returns a Proc or raise a TypeError.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/sprockets/legacy.rb', line 279 def self.compile_match_filter(filter) # If the filter is already a proc, great nothing to do. if filter.respond_to?(:call) filter # If the filter is a regexp, wrap it in a proc that tests it against the # logical path. elsif filter.is_a?(Regexp) proc { |logical_path| filter.match(logical_path) } elsif filter.is_a?(String) # If its an absolute path, detect the matching full filename if PathUtils.absolute_path?(filter) proc { |logical_path, filename| filename == filter.to_s } else # Otherwise do an fnmatch against the logical path. proc { |logical_path| File.fnmatch(filter.to_s, logical_path) } end else raise TypeError, "unknown filter type: #{filter.inspect}" end end |
.compute_alias_logical_path(path) ⇒ Object
306 307 308 309 310 311 312 313 314 |
# File 'lib/sprockets/legacy.rb', line 306 def self.compute_alias_logical_path(path) dirname, basename = File.split(path) extname = File.extname(basename) if File.basename(basename, extname) == 'index' "#{dirname}#{extname}" else nil end end |
.simple_logical_path?(str) ⇒ Boolean
300 301 302 303 304 |
# File 'lib/sprockets/legacy.rb', line 300 def self.simple_logical_path?(str) str.is_a?(String) && !PathUtils.absolute_path?(str) && str !~ /\*|\*\*|\?|\[|\]|\{|\}/ end |
Instance Method Details
#assets ⇒ Object
Returns internal assets mapping. Keys are logical paths which map to the latest fingerprinted filename.
Logical path (String): Fingerprint path (String)
{ "application.js" => "application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js",
"jquery.js" => "jquery-ae0908555a245f8266f77df5a8edca2e.js" }
97 98 99 |
# File 'lib/sprockets/manifest.rb', line 97 def assets @data['assets'] ||= {} end |
#clean(count = 2, age = 3600) ⇒ Object
Cleanup old assets in the compile directory. By default it will keep the latest version, 2 backups and any created within the past hour.
Examples
To force only 1 backup to be kept, set count=1 and age=0.
To only keep files created within the last 10 minutes, set count=0 and
age=600.
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/sprockets/manifest.rb', line 271 def clean(count = 2, age = 3600) asset_versions = files.group_by { |_, attrs| attrs['logical_path'] } asset_versions.each do |logical_path, versions| current = assets[logical_path] versions.reject { |path, _| path == current }.sort_by { |_, attrs| # Sort by timestamp Time.parse(attrs['mtime']) }.reverse.each_with_index.drop_while { |(_, attrs), index| _age = [0, Time.now - Time.parse(attrs['mtime'])].max # Keep if under age or within the count limit _age < age || index < count }.each { |(path, _), _| # Remove old assets remove(path) } end end |
#clobber ⇒ Object
Wipe directive
294 295 296 297 298 |
# File 'lib/sprockets/manifest.rb', line 294 def clobber FileUtils.rm_r(directory) if File.exist?(directory) logger.info "Removed #{directory}" nil end |
#compile(*args) ⇒ Object
Compile and write asset to directory. The asset is written to a fingerprinted filename like ‘application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js`. An entry is also inserted into the manifest file.
compile("application.js")
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/sprockets/manifest.rb', line 176 def compile(*args) unless environment raise Error, "manifest requires environment for compilation" end filenames = [] concurrent_compressors = [] concurrent_writers = [] find(*args) do |asset| files[asset.digest_path] = { 'logical_path' => asset.logical_path, 'mtime' => asset.mtime.iso8601, 'size' => asset.bytesize, 'digest' => asset.hexdigest, # Deprecated: Remove beta integrity attribute in next release. # Callers should DigestUtils.hexdigest_integrity_uri to compute the # digest themselves. 'integrity' => DigestUtils.hexdigest_integrity_uri(asset.hexdigest) } assets[asset.logical_path] = asset.digest_path if alias_logical_path = self.class.compute_alias_logical_path(asset.logical_path) assets[alias_logical_path] = asset.digest_path end target = File.join(dir, asset.digest_path) if File.exist?(target) logger.debug "Skipping #{target}, already exists" else logger.info "Writing #{target}" write_file = Concurrent::Future.execute { asset.write_to target } concurrent_writers << write_file end filenames << asset.filename next if environment.skip_gzip? gzip = Utils::Gzip.new(asset) next if gzip.cannot_compress?(environment.mime_types) if File.exist?("#{target}.gz") logger.debug "Skipping #{target}.gz, already exists" else logger.info "Writing #{target}.gz" concurrent_compressors << Concurrent::Future.execute do write_file.wait! if write_file gzip.compress(target) end end end concurrent_writers.each(&:wait!) concurrent_compressors.each(&:wait!) save filenames end |
#files ⇒ Object
Returns internal file directory listing. Keys are filenames which map to an attributes array.
Fingerprint path (String):
logical_path: Logical path (String)
mtime: ISO8601 mtime (String)
digest: Base64 hex digest (String)
{ "application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js" =>
{ 'logical_path' => "application.js",
'mtime' => "2011-12-13T21:47:08-06:00",
'digest' => "2e8e9a7c6b0aafa0c9bdeec90ea30213" } }
114 115 116 |
# File 'lib/sprockets/manifest.rb', line 114 def files @data['files'] ||= {} end |
#filter_logical_paths(*args) ⇒ Object Also known as: find_logical_paths
Deprecated: Filter logical paths in environment. Useful for selecting what files you want to compile.
Returns an Enumerator.
320 321 322 323 324 325 |
# File 'lib/sprockets/legacy.rb', line 320 def filter_logical_paths(*args) filters = args.flatten.map { |arg| self.class.compile_match_filter(arg) } environment.cached.logical_paths.select do |a, b| filters.any? { |f| f.call(a, b) } end end |
#find(*args) ⇒ Object
Public: Find all assets matching pattern set in environment.
Returns Enumerator of Assets.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/sprockets/manifest.rb', line 121 def find(*args) unless environment raise Error, "manifest requires environment for compilation" end return to_enum(__method__, *args) unless block_given? paths, filters = args.flatten.partition { |arg| self.class.simple_logical_path?(arg) } filters = filters.map { |arg| self.class.compile_match_filter(arg) } environment = self.environment.cached paths.each do |path| environment.find_all_linked_assets(path) do |asset| yield asset end end if filters.any? environment.logical_paths do |logical_path, filename| if filters.any? { |f| f.call(logical_path, filename) } environment.find_all_linked_assets(filename) do |asset| yield asset end end end end nil end |
#find_sources(*args) ⇒ Object
Public: Find the source of assets by paths.
Returns Enumerator of assets file content.
155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/sprockets/manifest.rb', line 155 def find_sources(*args) return to_enum(__method__, *args) unless block_given? if environment find(*args).each do |asset| yield asset.source end else args.each do |path| yield File.binread(File.join(dir, assets[path])) end end end |
#remove(filename) ⇒ Object
Removes file from directory and from manifest. ‘filename` must be the name with any directory path.
manifest.remove("application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js")
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/sprockets/manifest.rb', line 241 def remove(filename) path = File.join(dir, filename) gzip = "#{path}.gz" logical_path = files[filename]['logical_path'] if assets[logical_path] == filename assets.delete(logical_path) end files.delete(filename) FileUtils.rm(path) if File.exist?(path) FileUtils.rm(gzip) if File.exist?(gzip) save logger.info "Removed #{filename}" nil end |
#save ⇒ Object
Persist manfiest back to FS
301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/sprockets/manifest.rb', line 301 def save if @rename_filename logger.info "Renaming #{@filename} to #{@rename_filename}" FileUtils.mv(@filename, @rename_filename) @filename = @rename_filename @rename_filename = nil end data = json_encode(@data) FileUtils.mkdir_p File.dirname(@filename) PathUtils.atomic_write(@filename) do |f| f.write(data) end end |