Class: ActiveStorage::Variation

Inherits:
Object
  • Object
show all
Defined in:
activestorage/app/models/active_storage/variation.rb

Overview

A set of transformations that can be applied to a blob to create a variant. This class is exposed via the ActiveStorage::Blob#variant method and should rarely be used directly.

In case you do need to use this directly, it's instantiated using a hash of transformations where the key is the command and the value is the arguments. Example:

ActiveStorage::Variation.new(resize_to_limit: [100, 100], monochrome: true, trim: true, rotate: "-90")

The options map directly to ImageProcessing commands.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transformations) ⇒ Variation

Returns a new instance of Variation.


42
43
44
# File 'activestorage/app/models/active_storage/variation.rb', line 42

def initialize(transformations)
  @transformations = transformations.deep_symbolize_keys
end

Instance Attribute Details

#transformationsObject (readonly)

Returns the value of attribute transformations


13
14
15
# File 'activestorage/app/models/active_storage/variation.rb', line 13

def transformations
  @transformations
end

Class Method Details

.decode(key) ⇒ Object

Returns a Variation instance with the transformations that were encoded by encode.


31
32
33
# File 'activestorage/app/models/active_storage/variation.rb', line 31

def decode(key)
  new ActiveStorage.verifier.verify(key, purpose: :variation)
end

.encode(transformations) ⇒ Object

Returns a signed key for the transformations, which can be used to refer to a specific variation in a URL or combined key (like ActiveStorage::Variant#key).


37
38
39
# File 'activestorage/app/models/active_storage/variation.rb', line 37

def encode(transformations)
  ActiveStorage.verifier.generate(transformations, purpose: :variation)
end

.wrap(variator) ⇒ Object

Returns a Variation instance based on the given variator. If the variator is a Variation, it is returned unmodified. If it is a String, it is passed to ActiveStorage::Variation.decode. Otherwise, it is assumed to be a transformations Hash and is passed directly to the constructor.


19
20
21
22
23
24
25
26
27
28
# File 'activestorage/app/models/active_storage/variation.rb', line 19

def wrap(variator)
  case variator
  when self
    variator
  when String
    decode variator
  else
    new variator
  end
end

Instance Method Details

#digestObject


61
62
63
# File 'activestorage/app/models/active_storage/variation.rb', line 61

def digest
  Digest::SHA1.base64digest Marshal.dump(transformations)
end

#keyObject

Returns a signed key for all the transformations that this variation was instantiated with.


57
58
59
# File 'activestorage/app/models/active_storage/variation.rb', line 57

def key
  self.class.encode(transformations)
end

#transform(file, format: nil, &block) ⇒ Object

Accepts a File object, performs the transformations against it, and saves the transformed image into a temporary file. If format is specified it will be the format of the result image, otherwise the result image retains the source format.


50
51
52
53
54
# File 'activestorage/app/models/active_storage/variation.rb', line 50

def transform(file, format: nil, &block)
  ActiveSupport::Notifications.instrument("transform.active_storage") do
    transformer.transform(file, format: format, &block)
  end
end