Class: Sprockets::AssetAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/sprockets/asset_attributes.rb

Overview

‘AssetAttributes` is a wrapper similar to `Pathname` that provides some helper accessors.

These methods should be considered internalish.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(environment, path) ⇒ AssetAttributes

Returns a new instance of AssetAttributes.



11
12
13
14
 
# File 'lib/sprockets/asset_attributes.rb', line 11

def initialize(environment, path)
  @environment = environment
  @pathname = path.is_a?(Pathname) ? path : Pathname.new(path.to_s)
end

Instance Attribute Details

#environment ⇒ Object (readonly)

Returns the value of attribute environment.



9
10
11
 
# File 'lib/sprockets/asset_attributes.rb', line 9

def environment
  @environment
end

#pathname ⇒ Object (readonly)

Returns the value of attribute pathname.



9
10
11
 
# File 'lib/sprockets/asset_attributes.rb', line 9

def pathname
  @pathname
end

Instance Method Details

#content_type ⇒ Object

Returns the content type for the pathname. Falls back to ‘application/octet-stream`.



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/sprockets/asset_attributes.rb', line 105

def content_type
  @content_type ||= begin
    if format_extension.nil?
      engine_content_type || 'application/octet-stream'
    else
      @environment.mime_types(format_extension) ||
        engine_content_type ||
        'application/octet-stream'
    end
  end
end

#engine_extensions ⇒ Object

Returns an ‘Array` of engine extensions.

"foo.js.coffee.erb"
# => [".coffee", ".erb"]



82
83
84
85
86
87
88
89
90
 
# File 'lib/sprockets/asset_attributes.rb', line 82

def engine_extensions
  exts = extensions

  if offset = extensions.index(format_extension)
    exts = extensions[offset+1..-1]
  end

  exts.select { |ext| @environment.engines(ext) }
end

#engines ⇒ Object

Returns engine classes.



93
94
95
 
# File 'lib/sprockets/asset_attributes.rb', line 93

def engines
  engine_extensions.map { |ext| @environment.engines(ext) }
end

#expand_root ⇒ Object

Replaces ‘$root` placeholder with actual environment root.



17
18
19
 
# File 'lib/sprockets/asset_attributes.rb', line 17

def expand_root
  pathname.to_s.sub(/^\$root/, environment.root)
end

#extensions ⇒ Object

Returns ‘Array` of extension `String`s.

"foo.js.coffee"
# => [".js", ".coffee"]



62
63
64
 
# File 'lib/sprockets/asset_attributes.rb', line 62

def extensions
  @extensions ||= @pathname.basename.to_s.scan(/\.[^.]+/)
end

#format_extension ⇒ Object

Returns the format extension.

"foo.js.coffee"
# => ".js"



71
72
73
74
75
 
# File 'lib/sprockets/asset_attributes.rb', line 71

def format_extension
  extensions.reverse.detect { |ext|
    @environment.mime_types(ext) && !@environment.engines(ext)
  }
end

#logical_path ⇒ Object

Reverse guess logical path for fully expanded path.

This has some known issues. For an example if a file is shaddowed in the path, but is required relatively, its logical path will be incorrect.

Raises:



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sprockets/asset_attributes.rb', line 44

def logical_path
  raise ArgumentError unless pathname.absolute?

  if root_path = environment.paths.detect { |path| pathname.to_s[path] }
    path = pathname.relative_path_from(Pathname.new(root_path)).to_s
    path = engine_extensions.inject(path) { |p, ext| p.sub(ext, '') }
    path = "#{path}#{engine_format_extension}" unless format_extension
    path
  else
    raise FileOutsidePaths, "#{pathname} isn't in paths: #{environment.paths.join(', ')}"
  end
end

#path_fingerprint ⇒ Object

Gets digest fingerprint.

"foo-0aa2105d29558f3eb790d411d7d8fb66.js"
# => "0aa2105d29558f3eb790d411d7d8fb66"



122
123
124
 
# File 'lib/sprockets/asset_attributes.rb', line 122

def path_fingerprint
  pathname.basename(extensions.join).to_s =~ /-([0-9a-f]{7,40})$/ ? $1 : nil
end

#path_with_fingerprint(digest) ⇒ Object

Injects digest fingerprint into path.

"foo.js"
# => "foo-0aa2105d29558f3eb790d411d7d8fb66.js"



131
132
133
134
135
136
137
 
# File 'lib/sprockets/asset_attributes.rb', line 131

def path_with_fingerprint(digest)
  if old_digest = path_fingerprint
    pathname.sub(old_digest, digest).to_s
  else
    pathname.to_s.sub(/\.(\w+)$/) { |ext| "-#{digest}#{ext}" }
  end
end

#processors ⇒ Object

Returns all processors to run on the path.



98
99
100
101
102
 
# File 'lib/sprockets/asset_attributes.rb', line 98

def processors
  environment.preprocessors(content_type) +
    engines.reverse +
    environment.postprocessors(content_type)
end

#relativize_root ⇒ Object

Replaces environment root with ‘$root` placeholder.



22
23
24
 
# File 'lib/sprockets/asset_attributes.rb', line 22

def relativize_root
  pathname.to_s.sub(/^#{Regexp.escape(environment.root)}/, '$root')
end

#search_paths ⇒ Object

Returns paths search the load path for.



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/sprockets/asset_attributes.rb', line 27

def search_paths
  paths = [pathname.to_s]

  if pathname.basename(extensions.join).to_s != 'index'
    path_without_extensions = extensions.inject(pathname) { |p, ext| p.sub(ext, '') }
    index_path = path_without_extensions.join("index#{extensions.join}").to_s
    paths << index_path
  end

  paths
end