Module Paperclip::Interpolations
In: lib/paperclip/interpolations.rb

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.

Methods

[]   []=   all   attachment   basename   class   extension   filename   id   id_partition   interpolate   rails_env   rails_root   style   timestamp   url  

Public Class methods

[](name)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 17
17:     def self.[] name
18:       method(name)
19:     end
[]=(name, block)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 11
11:     def self.[]= name, block
12:       define_method(name, &block)
13:     end
all()

Returns a sorted list of all interpolations.

[Source]

    # File lib/paperclip/interpolations.rb, line 22
22:     def self.all
23:       self.instance_methods(false).sort
24:     end
interpolate(pattern, *args)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 28
28:     def self.interpolate pattern, *args
29:       all.reverse.inject( pattern.dup ) do |result, tag|
30:         result.gsub(/:#{tag}/) do |match|
31:           send( tag, *args )
32:         end
33:       end
34:     end

Public Instance methods

attachment(attachment, style)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 96
96:     def attachment attachment, style
97:       attachment.name.to_s.downcase.pluralize
98:     end
basename(attachment, style)

Returns the basename of the file. e.g. "file" for "file.jpg"

[Source]

    # File lib/paperclip/interpolations.rb, line 71
71:     def basename attachment, style
72:       attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
73:     end
class(attachment, style)

Returns the underscored, pluralized version of the class name. e.g. "users" for the User class.

[Source]

    # File lib/paperclip/interpolations.rb, line 66
66:     def class attachment, style
67:       attachment.instance.class.to_s.underscore.pluralize
68:     end
extension(attachment, style)

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.

[Source]

    # File lib/paperclip/interpolations.rb, line 78
78:     def extension attachment, style 
79:       ((style = attachment.styles[style]) && style[:format]) ||
80:         File.extname(attachment.original_filename).gsub(/^\.+/, "")
81:     end
filename(attachment, style)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 37
37:     def filename attachment, style
38:       "#{basename(attachment, style)}.#{extension(attachment, style)}"
39:     end
id(attachment, style)

Returns the id of the instance.

[Source]

    # File lib/paperclip/interpolations.rb, line 84
84:     def id attachment, style
85:       attachment.instance.id
86:     end
id_partition(attachment, style)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 90
90:     def id_partition attachment, style
91:       ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
92:     end
rails_env(attachment, style)

Returns the RAILS_ENV constant.

[Source]

    # File lib/paperclip/interpolations.rb, line 60
60:     def rails_env attachment, style
61:       RAILS_ENV
62:     end
rails_root(attachment, style)

Returns the RAILS_ROOT constant.

[Source]

    # File lib/paperclip/interpolations.rb, line 55
55:     def rails_root attachment, style
56:       RAILS_ROOT
57:     end
style(attachment, style)

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

[Source]

     # File lib/paperclip/interpolations.rb, line 101
101:     def style attachment, style
102:       style || attachment.default_style
103:     end
timestamp(attachment, style)

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

[Source]

    # File lib/paperclip/interpolations.rb, line 50
50:     def timestamp attachment, style
51:       attachment.instance_read(:updated_at).to_s
52:     end
url(attachment, style)

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.

[Source]

    # File lib/paperclip/interpolations.rb, line 44
44:     def url attachment, style
45:       raise InfiniteInterpolationError if attachment.options[:url].include?(":url")
46:       attachment.url(style)
47:     end

[Validate]