Class: ActiveStorage::Variation

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

Overview

Active Storage Variation

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], colourspace: "b-w", rotate: "-90", saver: { trim: true })

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.



46
47
48
 
# File 'activestorage/app/models/active_storage/variation.rb', line 46

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

Instance Attribute Details

#transformations ⇒ Object (readonly)

Returns the value of attribute transformations



17
18
19
 
# File 'activestorage/app/models/active_storage/variation.rb', line 17

def transformations
  @transformations
end

Class Method Details

.decode(key) ⇒ Object

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



35
36
37
 
# File 'activestorage/app/models/active_storage/variation.rb', line 35

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).



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

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.



23
24
25
26
27
28
29
30
31
32
 
# File 'activestorage/app/models/active_storage/variation.rb', line 23

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

Instance Method Details

#content_type ⇒ Object 



70
71
72
 
# File 'activestorage/app/models/active_storage/variation.rb', line 70

def content_type
  Marcel::MimeType.for(extension: format.to_s)
end

#default_to(defaults) ⇒ Object 



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

def default_to(defaults)
  self.class.new transformations.reverse_merge(defaults)
end

#digest ⇒ Object 



79
80
81
 
# File 'activestorage/app/models/active_storage/variation.rb', line 79

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

#format ⇒ Object 



62
63
64
65
66
67
68
 
# File 'activestorage/app/models/active_storage/variation.rb', line 62

def format
  transformations.fetch(:format, :png).tap do |format|
    if Marcel::Magic.by_extension(format.to_s).nil?
      raise ArgumentError, "Invalid variant format (#{format.inspect})"
    end
  end
end

#key ⇒ Object

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



75
76
77
 
# File 'activestorage/app/models/active_storage/variation.rb', line 75

def key
  self.class.encode(transformations)
end

#transform(file, &block) ⇒ Object

Accepts a File object, performs the transformations against it, and saves the transformed image into a temporary file.



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

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