Module: Paperclip::Interpolations

Extended by:
Interpolations
Included in:
Interpolations
Defined in:
lib/paperclip/interpolations.rb

Overview

This module contains all the methods that are available for interpolation in paths and urls. To add your own (or override an existing one), you can either open this module and define it, or call the Paperclip.interpolates method.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.[](name) ⇒ Object

Hash access of interpolations. Included only for compatability, and is not intended for normal use.



17
18
19
 
# File 'lib/paperclip/interpolations.rb', line 17

def self.[] name
  method(name)
end

.[]=(name, block) ⇒ Object

Hash assignment of interpolations. Included only for compatability, and is not intended for normal use.



11
12
13
 
# File 'lib/paperclip/interpolations.rb', line 11

def self.[]= name, block
  define_method(name, &block)
end

.all ⇒ Object

Returns a sorted list of all interpolations.



22
23
24
 
# File 'lib/paperclip/interpolations.rb', line 22

def self.all
  self.instance_methods(false).sort
end

.interpolate(pattern, *args) ⇒ Object

Perform the actual interpolation. Takes the pattern to interpolate and the arguments to pass, which are the attachment and style name.



28
29
30
31
32
33
34
 
# File 'lib/paperclip/interpolations.rb', line 28

def self.interpolate pattern, *args
  all.reverse.inject( pattern.dup ) do |result, tag|
    result.gsub(/:#{tag}/) do |match|
      send( tag, *args )
    end
  end
end

Instance Method Details

#attachment(attachment, style_name) ⇒ Object

Returns the pluralized form of the attachment name. e.g. “avatars” for an attachment of :avatar



104
105
106
 
# File 'lib/paperclip/interpolations.rb', line 104

def attachment attachment, style_name
  attachment.name.to_s.downcase.pluralize
end

#basename(attachment, style_name) ⇒ Object

Returns the basename of the file. e.g. “file” for “file.jpg”



74
75
76
 
# File 'lib/paperclip/interpolations.rb', line 74

def basename attachment, style_name
  attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
end

#class(attachment = nil, style_name = nil) ⇒ Object

Returns the underscored, pluralized version of the class name. e.g. “users” for the User class. NOTE: The arguments need to be optional, because some tools fetch all class names. Calling #class will return the expected class.



68
69
70
71
 
# File 'lib/paperclip/interpolations.rb', line 68

def class attachment = nil, style_name = nil
  return super() if attachment.nil? && style_name.nil?
  attachment.instance.class.to_s.underscore.pluralize
end

#extension(attachment, style_name) ⇒ Object

Returns the extension of the file. e.g. “jpg” for “file.jpg” If the style has a format defined, it will return the format instead of the actual extension.



81
82
83
84
 
# File 'lib/paperclip/interpolations.rb', line 81

def extension attachment, style_name
  ((style = attachment.styles[style_name]) && style[:format]) ||
    File.extname(attachment.original_filename).gsub(/^\.+/, "")
end

#filename(attachment, style_name) ⇒ Object

Returns the filename, the same way as “:basename.:extension” would.



37
38
39
 
# File 'lib/paperclip/interpolations.rb', line 37

def filename attachment, style_name
  "#{basename(attachment, style_name)}.#{extension(attachment, style_name)}"
end

#fingerprint(attachment, style_name) ⇒ Object

Returns the fingerprint of the instance.



92
93
94
 
# File 'lib/paperclip/interpolations.rb', line 92

def fingerprint attachment, style_name
  attachment.fingerprint
end

#id(attachment, style_name) ⇒ Object

Returns the id of the instance.



87
88
89
 
# File 'lib/paperclip/interpolations.rb', line 87

def id attachment, style_name
  attachment.instance.id
end

#id_partition(attachment, style_name) ⇒ Object

Returns the id of the instance in a split path form. e.g. returns 000/001/234 for an id of 1234.



98
99
100
 
# File 'lib/paperclip/interpolations.rb', line 98

def id_partition attachment, style_name
  ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
end

#rails_env(attachment, style_name) ⇒ Object

Returns the Rails.env constant.



60
61
62
 
# File 'lib/paperclip/interpolations.rb', line 60

def rails_env attachment, style_name
  Rails.env
end

#rails_root(attachment, style_name) ⇒ Object

Returns the Rails.root constant.



55
56
57
 
# File 'lib/paperclip/interpolations.rb', line 55

def rails_root attachment, style_name
  Rails.root
end

#style(attachment, style_name) ⇒ Object

Returns the style, or the default style if nil is supplied.



109
110
111
 
# File 'lib/paperclip/interpolations.rb', line 109

def style attachment, style_name
  style_name || attachment.default_style
end

#timestamp(attachment, style_name) ⇒ Object

Returns the timestamp as defined by the <attachment>_updated_at field



50
51
52
 
# File 'lib/paperclip/interpolations.rb', line 50

def timestamp attachment, style_name
  attachment.instance_read(:updated_at).to_s
end

#url(attachment, style_name) ⇒ Object

Returns the interpolated URL. Will raise an error if the url itself contains “:url” to prevent infinite recursion. This interpolation is used in the default :path to ease default specifications.

Raises:



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

def url attachment, style_name
  raise InfiniteInterpolationError if attachment.options[:url].include?(":url")
  attachment.url(style_name, false)
end