Class: Sprockets::Asset

Inherits:

Object

• Object
• Sprockets::Asset

show all

Defined in:

lib/sprockets/asset.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) content_type readonly

  Returns the value of attribute content_type.

• - (Object) digest readonly

  Returns the value of attribute digest.

• - (Object) length (also: #bytesize) readonly

  Returns the value of attribute length.

• - (Object) logical_path readonly

  Returns the value of attribute logical_path.

• - (Object) mtime readonly

  Returns the value of attribute mtime.

• - (Object) pathname readonly

  Returns the value of attribute pathname.

Class Method Summary (collapse)

• + (Object) from_hash(environment, hash)

  Internal initializer to load `Asset` from serialized `Hash`.

Instance Method Summary (collapse)

• - (Object) body

  `body` is aliased to source by default if it can't have any dependencies.

• - (Object) dependencies

  Return an `Array` of `Asset` files that are declared dependencies.

• - (Object) digest_path

  Return logical path with digest spliced in.

• - (Object) each {|to_s| ... }

  Add enumerator to allow `Asset` instances to be used as Rack compatible body objects.

• - (Object) encode_with(coder)

  Copy serialized attributes to the coder object.

• - (Boolean) eql?(other) (also: #==)

  Assets are equal if they share the same path, mtime and digest.

• - (Boolean) fresh?(environment)

  Checks if Asset is fresh by comparing the actual mtime and digest to the inmemory model.

• - (Object) hash
• - (Object) init_with(environment, coder)

  Initialize `Asset` from serialized `Hash`.

• - (Asset) initialize(environment, logical_path, pathname) constructor

  A new instance of Asset.

• - (Object) inspect

  Pretty inspect.

• - (Boolean) stale?(environment)

  Checks if Asset is stale by comparing the actual mtime and digest to the inmemory model.

• - (Object) to_a

  Expand asset into an `Array` of parts.

• - (Object) to_s

  Return `String` of concatenated source.

• - (Object) write_to(filename, options = {})

  Save asset to disk.

35
36
37
38
39
40
41
42
43
44
45

# File 'lib/sprockets/asset.rb', line 35

def initialize(environment, logical_path, pathname)
  raise ArgumentError, "Asset logical path has no extension: #{logical_path}" if File.extname(logical_path) == ""

  @root         = environment.root
  @logical_path = logical_path.to_s
  @pathname     = Pathname.new(pathname)
  @content_type = environment.content_type_of(pathname)
  @mtime        = environment.stat(pathname).mtime
  @length       = environment.stat(pathname).size
  @digest       = environment.file_digest(pathname).hexdigest
end

32
33
34

# File 'lib/sprockets/asset.rb', line 32

def content_type
  @content_type
end

32
33
34

# File 'lib/sprockets/asset.rb', line 32

def digest
  @digest
end

32
33
34

# File 'lib/sprockets/asset.rb', line 32

def length
  @length
end

31
32
33

# File 'lib/sprockets/asset.rb', line 31

def logical_path
  @logical_path
end

32
33
34

# File 'lib/sprockets/asset.rb', line 32

def mtime
  @mtime
end

31
32
33

# File 'lib/sprockets/asset.rb', line 31

def pathname
  @pathname
end

8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# File 'lib/sprockets/asset.rb', line 8

def self.from_hash(environment, hash)
  return unless hash.is_a?(Hash)

  klass = case hash['class']
    when 'BundledAsset'
      BundledAsset
    when 'ProcessedAsset'
      ProcessedAsset
    when 'StaticAsset'
      StaticAsset
    else
      nil
    end

  if klass
    asset = klass.allocate
    asset.init_with(environment, hash)
    asset
  end
rescue UnserializeError
  nil
end

107
108
109

# File 'lib/sprockets/asset.rb', line 107

def body
  source
end

91
92
93

# File 'lib/sprockets/asset.rb', line 91

def dependencies
  []
end

"foo/bar-37b51d194a7513e45b56f6524f2d51f2.js"

86
87
88

# File 'lib/sprockets/asset.rb', line 86

def digest_path
  logical_path.sub(/\.(\w+)$/) { |ext| "-#{digest}#{ext}" }
end

118
119
120

# File 'lib/sprockets/asset.rb', line 118

def each
  yield to_s
end

72
73
74
75
76
77
78
79
80

# File 'lib/sprockets/asset.rb', line 72

def encode_with(coder)
  coder['class']        = self.class.name.sub(/Sprockets::/, '')
  coder['logical_path'] = logical_path
  coder['pathname']     = relativize_root_path(pathname).to_s
  coder['content_type'] = content_type
  coder['mtime']        = mtime.iso8601
  coder['length']       = length
  coder['digest']       = digest
end

185
186
187
188
189
190

# File 'lib/sprockets/asset.rb', line 185

def eql?(other)
  other.class == self.class &&
    other.logical_path == self.logical_path &&
    other.mtime.to_i == self.mtime.to_i &&
    other.digest == self.digest
end

126
127
128
129

# File 'lib/sprockets/asset.rb', line 126

def fresh?(environment)
  # Check current mtime and digest
  dependency_fresh?(environment, self)
end

180
181
182

# File 'lib/sprockets/asset.rb', line 180

def hash
  digest.hash
end

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# File 'lib/sprockets/asset.rb', line 48

def init_with(environment, coder)
  @root = environment.root

  @logical_path = coder['logical_path']
  @content_type = coder['content_type']
  @digest       = coder['digest']

  if pathname = coder['pathname']
    # Expand `$root` placeholder and wrapper string in a `Pathname`
    @pathname = Pathname.new(expand_root_path(pathname))
  end

  if mtime = coder['mtime']
    # Parse time string
    @mtime = Time.parse(mtime)
  end

  if length = coder['length']
    # Convert length to an `Integer`
    @length = Integer(length)
  end
end

172
173
174
175
176
177
178

# File 'lib/sprockets/asset.rb', line 172

def inspect
  "#<#{self.class}:0x#{object_id.to_s(16)} " +
    "pathname=#{pathname.to_s.inspect}, " +
    "mtime=#{mtime.inspect}, " +
    "digest=#{digest.inspect}" +
    ">"
end

135
136
137

# File 'lib/sprockets/asset.rb', line 135

def stale?(environment)
  !fresh?(environment)
end

102
103
104

# File 'lib/sprockets/asset.rb', line 102

def to_a
  [self]
end

112
113
114

# File 'lib/sprockets/asset.rb', line 112

def to_s
  source
end

140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

# File 'lib/sprockets/asset.rb', line 140

def write_to(filename, options = {})
  # Gzip contents if filename has '.gz'
  options[:compress] ||= File.extname(filename) == '.gz'

  FileUtils.mkdir_p File.dirname(filename)

  File.open("#{filename}+", 'wb') do |f|
    if options[:compress]
      # Run contents through `Zlib`
      gz = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
      gz.mtime = mtime.to_i
      gz.write to_s
      gz.close
    else
      # Write out as is
      f.write to_s
    end
  end

  # Atomic write
  FileUtils.mv("#{filename}+", filename)

  # Set mtime correctly
  File.utime(mtime, mtime, filename)

  nil
ensure
  # Ensure tmp file gets cleaned up
  FileUtils.rm("#{filename}+") if File.exist?("#{filename}+")
end