Class: Paperclip::Style

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

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, attachment
  @name = name
  @attachment = attachment
  if definition.is_a? Hash
    @geometry = definition.delete(:geometry)
    self.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
  @attachment
end

#formats ⇒ Object

Returns the value of attribute formats.



9
10
11
 
# File 'lib/paperclip/style.rb', line 9

def formats
  @formats
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.options.styles[:geometry]@ will still work



78
79
80
81
82
83
84
 
# File 'lib/paperclip/style.rb', line 78

def [](key)
  if [:name, :convert_options, :whiny, :processors, :geometry, :format, :formats, :animated, :source_file_options].include?(key)
    send(key)
  elsif defined? @other_args[key]
    @other_args[key]
  end
end

#[]=(key, value) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/paperclip/style.rb', line 86

def []=(key, value)
  if [:name, :convert_options, :whiny, :processors, :geometry, :format, :formats, :animated, :source_file_options].include?(key)
    send("#{key}=".intern, value)
  else
    @other_args[key] = value
  end
end

#convert_options ⇒ Object 



48
49
50
 
# File 'lib/paperclip/style.rb', line 48

def convert_options
  attachment.send(:extra_options_for, name)
end

#format ⇒ Object 



99
100
101
102
103
104
105
106
 
# File 'lib/paperclip/style.rb', line 99

def format
  if @formats.present? && (filename = attachment.original_filename)
    ext = File.extname(filename)[1..-1]
    @formats.include?(ext) ? ext : @formats.first
  else
    nil
  end
end

#geometry ⇒ Object

returns the geometry string for this style if a proc has been supplied, we call it here



58
59
60
 
# File 'lib/paperclip/style.rb', line 58

def geometry
  @geometry.respond_to?(:call) ? @geometry.call(attachment.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.



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/paperclip/style.rb', line 65

def processor_options
  args = {}
  @other_args.each do |k,v|
    args[k] = v.respond_to?(:call) ? v.call(attachment) : v
  end
  [:processors, :geometry, :format, :whiny, :convert_options, :source_file_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. if a proc has been supplied, we call it here



34
35
36
 
# File 'lib/paperclip/style.rb', line 34

def processors
  @processors.respond_to?(:call) ? @processors.call(attachment.instance) : (@processors || attachment.options.processors)
end

#source_file_options ⇒ Object 



52
53
54
 
# File 'lib/paperclip/style.rb', line 52

def source_file_options
  attachment.send(:extra_source_file_options_for, name)
end

#whiny ⇒ Object

retrieves from the attachment the whiny setting



39
40
41
 
# File 'lib/paperclip/style.rb', line 39

def whiny
  attachment.options.whiny
end

#whiny? ⇒ Boolean

returns true if we’re inclined to grumble

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/paperclip/style.rb', line 44

def whiny?
  !!whiny
end