Module: Paperclip::Interpolations
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.
Constant Summary collapse
- RIGHT_HERE =
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.
"#{__FILE__.gsub(%r{^\./}, "")}:#{__LINE__ + 3}"
Class Method Summary collapse
-
.[](name) ⇒ Object
Hash access of interpolations.
-
.[]=(name, block) ⇒ Object
Hash assignment of interpolations.
-
.all ⇒ Object
Returns a sorted list of all interpolations.
-
.interpolate(pattern, *args) ⇒ Object
Perform the actual interpolation.
Instance Method Summary collapse
-
#attachment(attachment, style_name) ⇒ Object
Returns the pluralized form of the attachment name.
-
#basename(attachment, style_name) ⇒ Object
Returns the basename of the file.
-
#class(attachment = nil, style_name = nil) ⇒ Object
Returns the underscored, pluralized version of the class name.
-
#content_type_extension(attachment, style_name) ⇒ Object
Returns an extension based on the content type.
-
#extension(attachment, style_name) ⇒ Object
Returns the extension of the file.
-
#filename(attachment, style_name) ⇒ Object
Returns the filename, the same way as “:basename.:extension” would.
-
#fingerprint(attachment, style_name) ⇒ Object
Returns the fingerprint of the instance.
-
#hash(attachment = nil, style_name = nil) ⇒ Object
Returns a the attachment hash.
-
#id(attachment, style_name) ⇒ Object
Returns the id of the instance.
-
#id_partition(attachment, style_name) ⇒ Object
Returns the id of the instance in a split path form.
-
#param(attachment, style_name) ⇒ Object
Returns the #to_param of the instance.
-
#rails_env(attachment, style_name) ⇒ Object
Returns the Rails.env constant.
-
#rails_root(attachment, style_name) ⇒ Object
Returns the Rails.root constant.
-
#style(attachment, style_name) ⇒ Object
Returns the style, or the default style if nil is supplied.
-
#timestamp(attachment, style_name) ⇒ Object
Returns the timestamp as defined by the <attachment>_updated_at field in the server default time zone unless :use_global_time_zone is set to false.
-
#updated_at(attachment, style_name) ⇒ Object
Returns an integer timestamp that is time zone-neutral, so that paths remain valid even if a server’s time zone changes.
- #url(attachment, style_name) ⇒ Object
Class Method Details
.[](name) ⇒ Object
Hash access of interpolations. Included only for compatibility, 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 compatibility, 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. You can pass a method name on your record as a symbol, which should turn an interpolation pattern for Paperclip to use.
30 31 32 33 34 35 36 37 |
# File 'lib/paperclip/interpolations.rb', line 30 def self.interpolate pattern, *args pattern = args.first.instance.send(pattern) if pattern.kind_of? Symbol 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
166 167 168 |
# File 'lib/paperclip/interpolations.rb', line 166 def , style_name .name.to_s.downcase.pluralize end |
#basename(attachment, style_name) ⇒ Object
Returns the basename of the file. e.g. “file” for “file.jpg”
88 89 90 |
# File 'lib/paperclip/interpolations.rb', line 88 def basename , style_name .original_filename.gsub(/#{File.extname(.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.
82 83 84 85 |
# File 'lib/paperclip/interpolations.rb', line 82 def class = nil, style_name = nil return super() if .nil? && style_name.nil? .instance.class.to_s.underscore.pluralize end |
#content_type_extension(attachment, style_name) ⇒ Object
Returns an extension based on the content type. e.g. “jpeg” for “image/jpeg”. Each mime type generally has multiple extensions associated with it, so if the extension from teh original filename is one of these extensions, that extension is used, otherwise, the first in the list is used.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/paperclip/interpolations.rb', line 108 def content_type_extension , style_name mime_type = MIME::Types[.content_type] extensions_for_mime_type = unless mime_type.empty? mime_type.first.extensions else [] end original_extension = extension(, style_name) if extensions_for_mime_type.include? original_extension original_extension elsif !extensions_for_mime_type.empty? extensions_for_mime_type.first else # It's possible, though unlikely, that the mime type is not in the # database, so just use the part after the '/' in the mime type as the # extension. %r{/([^/]*)$}.match(.content_type)[1] end 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.
95 96 97 98 99 100 101 102 |
# File 'lib/paperclip/interpolations.rb', line 95 def extension , style_name if !.instance.respond_to?(:created_at) || .instance.created_at <= Time.utc(2011, 10, 17, 8, 30, 0) return File.extname(.original_filename).gsub(/^\.+/, "") end ((style = .styles[style_name]) && style[:format]) || File.extname(.original_filename).gsub(/^\.+/, "") end |
#filename(attachment, style_name) ⇒ Object
Returns the filename, the same way as “:basename.:extension” would.
40 41 42 |
# File 'lib/paperclip/interpolations.rb', line 40 def filename , style_name [ basename(, style_name), extension(, style_name) ].reject(&:blank?).join(".") end |
#fingerprint(attachment, style_name) ⇒ Object
Returns the fingerprint of the instance.
140 141 142 |
# File 'lib/paperclip/interpolations.rb', line 140 def fingerprint , style_name .fingerprint end |
#hash(attachment = nil, style_name = nil) ⇒ Object
Returns a the attachment hash. See Paperclip::Attachment#hash for more details.
146 147 148 149 150 151 152 |
# File 'lib/paperclip/interpolations.rb', line 146 def hash =nil, style_name=nil if && style_name .hash(style_name) else super() end end |
#id(attachment, style_name) ⇒ Object
Returns the id of the instance.
130 131 132 |
# File 'lib/paperclip/interpolations.rb', line 130 def id , style_name .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.
156 157 158 159 160 161 162 |
# File 'lib/paperclip/interpolations.rb', line 156 def id_partition , style_name if (id = .instance.id).is_a?(Integer) ("%09d" % id).scan(/\d{3}/).join("/") else id.scan(/.{3}/).first(3).join("/") end end |
#param(attachment, style_name) ⇒ Object
Returns the #to_param of the instance.
135 136 137 |
# File 'lib/paperclip/interpolations.rb', line 135 def param , style_name .instance.to_param end |
#rails_env(attachment, style_name) ⇒ Object
Returns the Rails.env constant.
74 75 76 |
# File 'lib/paperclip/interpolations.rb', line 74 def rails_env , style_name Rails.env end |
#rails_root(attachment, style_name) ⇒ Object
Returns the Rails.root constant.
69 70 71 |
# File 'lib/paperclip/interpolations.rb', line 69 def rails_root , style_name Rails.root end |
#style(attachment, style_name) ⇒ Object
Returns the style, or the default style if nil is supplied.
171 172 173 |
# File 'lib/paperclip/interpolations.rb', line 171 def style , style_name style_name || .default_style end |
#timestamp(attachment, style_name) ⇒ Object
Returns the timestamp as defined by the <attachment>_updated_at field in the server default time zone unless :use_global_time_zone is set to false. Note that a Rails.config.time_zone change will still invalidate any path or URL that uses :timestamp. For a time_zone-agnostic timestamp, use #updated_at.
58 59 60 |
# File 'lib/paperclip/interpolations.rb', line 58 def , style_name .instance_read(:updated_at).in_time_zone(.time_zone).to_s end |
#updated_at(attachment, style_name) ⇒ Object
Returns an integer timestamp that is time zone-neutral, so that paths remain valid even if a server’s time zone changes.
64 65 66 |
# File 'lib/paperclip/interpolations.rb', line 64 def updated_at , style_name .updated_at end |
#url(attachment, style_name) ⇒ Object
48 49 50 51 |
# File 'lib/paperclip/interpolations.rb', line 48 def url , style_name raise InfiniteInterpolationError if caller.any?{|b| b.index(RIGHT_HERE) } .url(style_name, false) end |