Class: Paperclip::Style
- Inherits:
-
Object
- Object
- Paperclip::Style
- Defined in:
- lib/paperclip/style.rb
Overview
The Style class holds the definition of a thumbnail style, applying whatever processing is required to normalize the definition and delaying the evaluation of block parameters until useful context is available.
Instance Attribute Summary collapse
-
#attachment ⇒ Object
readonly
Returns the value of attribute attachment.
-
#format ⇒ Object
readonly
Returns the value of attribute format.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
Instance Method Summary collapse
-
#[](key) ⇒ Object
Supports getting and setting style properties with hash notation to ensure backwards-compatibility eg.
- #[]=(key, value) ⇒ Object
- #convert_options ⇒ Object
-
#geometry ⇒ Object
returns the geometry string for this style if a proc has been supplied, we call it here.
-
#initialize(name, definition, attachment) ⇒ Style
constructor
Creates a Style object.
-
#processor_options ⇒ Object
Supplies the hash of options that processors expect to receive as their second argument Arguments other than the standard geometry, format etc are just passed through from initialization and any procs are called here, just before post-processing.
-
#processors ⇒ Object
retrieves from the attachment the processors defined in the has_attached_file call (which method (in the attachment) will call any supplied procs) There is an important change of interface here: a style rule can set its own processors by default we behave as before, though.
-
#whiny ⇒ Object
retrieves from the attachment the whiny setting.
-
#whiny? ⇒ Boolean
returns true if we’re inclined to grumble.
Constructor Details
#initialize(name, definition, attachment) ⇒ Style
Creates a Style object. name
is the name of the attachment, definition
is the style definition from has_attached_file, which can be string, array or hash
14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
# File 'lib/paperclip/style.rb', line 14 def initialize name, definition, @name = name @attachment = if definition.is_a? Hash @geometry = definition.delete(:geometry) @format = definition.delete(:format) @processors = definition.delete(:processors) @other_args = definition else @geometry, @format = [definition, nil].flatten[0..1] @other_args = {} end @format = nil if @format.blank? end |
Instance Attribute Details
#attachment ⇒ Object (readonly)
Returns the value of attribute attachment.
9 10 11 |
# File 'lib/paperclip/style.rb', line 9 def @attachment end |
#format ⇒ Object (readonly)
Returns the value of attribute format.
9 10 11 |
# File 'lib/paperclip/style.rb', line 9 def format @format end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
9 10 11 |
# File 'lib/paperclip/style.rb', line 9 def name @name end |
Instance Method Details
#[](key) ⇒ Object
Supports getting and setting style properties with hash notation to ensure backwards-compatibility eg. @attachment.styles[:geometry]@ will still work
73 74 75 76 77 78 79 |
# File 'lib/paperclip/style.rb', line 73 def [](key) if [:name, :convert_options, :whiny, :processors, :geometry, :format].include?(key) send(key) elsif defined? @other_args[key] @other_args[key] end end |
#[]=(key, value) ⇒ Object
81 82 83 84 85 86 87 |
# File 'lib/paperclip/style.rb', line 81 def []=(key, value) if [:name, :convert_options, :whiny, :processors, :geometry, :format].include?(key) send("#{key}=".intern, value) else @other_args[key] = value end end |
#convert_options ⇒ Object
47 48 49 |
# File 'lib/paperclip/style.rb', line 47 def .send(:extra_options_for, name) end |
#geometry ⇒ Object
returns the geometry string for this style if a proc has been supplied, we call it here
53 54 55 |
# File 'lib/paperclip/style.rb', line 53 def geometry @geometry.respond_to?(:call) ? @geometry.call(.instance) : @geometry end |
#processor_options ⇒ Object
Supplies the hash of options that processors expect to receive as their second argument Arguments other than the standard geometry, format etc are just passed through from initialization and any procs are called here, just before post-processing.
60 61 62 63 64 65 66 67 68 69 |
# File 'lib/paperclip/style.rb', line 60 def args = {} @other_args.each do |k,v| args[k] = v.respond_to?(:call) ? v.call() : v end [:processors, :geometry, :format, :whiny, :convert_options].each do |k| (arg = send(k)) && args[k] = arg end args end |
#processors ⇒ Object
retrieves from the attachment the processors defined in the has_attached_file call (which method (in the attachment) will call any supplied procs) There is an important change of interface here: a style rule can set its own processors by default we behave as before, though.
33 34 35 |
# File 'lib/paperclip/style.rb', line 33 def processors @processors || .processors end |
#whiny ⇒ Object
retrieves from the attachment the whiny setting
38 39 40 |
# File 'lib/paperclip/style.rb', line 38 def whiny .whiny end |
#whiny? ⇒ Boolean
returns true if we’re inclined to grumble
43 44 45 |
# File 'lib/paperclip/style.rb', line 43 def whiny? !!whiny end |