module Paperclip::Interpolations

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.

Constants

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.

Public Class Methods

[](name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 17
def self.[] name
  method(name)
end
[]=(name, block) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 11
def self.[]= name, block
  define_method(name, &block)
end
all() click to toggle source

Returns a sorted list of all interpolations.

# File lib/dm-paperclip/interpolations.rb, line 22
def self.all
  self.instance_methods(false).sort
end
interpolate(pattern, *args) click to toggle source

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

# File lib/dm-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

Public Instance Methods

attachment(attachment, style_name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 134
def attachment attachment, style_name
  DataMapper::Inflector.pluralize(attachment.name.to_s.downcase)
end
basename(attachment, style_name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 98
def basename attachment, style_name
  attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
end
class(attachment = nil, style_name = nil) click to toggle source

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.

Calls superclass method
# File lib/dm-paperclip/interpolations.rb, line 91
def class attachment = nil, style_name = nil
  return super() if attachment.nil? && style_name.nil?
  name = DataMapper::Inflector.underscore(attachment.instance.class.to_s)
  DataMapper::Inflector.pluralize(name)
end
extension(attachment, style_name) click to toggle source

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.

# File lib/dm-paperclip/interpolations.rb, line 105
def extension attachment, style_name
  ((style = attachment.styles[style_name]) && style[:format]) ||
    File.extname(attachment.original_filename).gsub(/^\.+/, "")
end
filename(attachment, style_name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 38
def filename attachment, style_name
  "#{basename(attachment, style_name)}.#{extension(attachment, style_name)}"
end
fingerprint(attachment, style_name) click to toggle source

Returns the fingerprint of the instance.

# File lib/dm-paperclip/interpolations.rb, line 116
def fingerprint attachment, style_name
  attachment.fingerprint
end
hash(attachment, style_name) click to toggle source

Returns a the attachment hash. See Paperclip::Attachment#hash for more details.

# File lib/dm-paperclip/interpolations.rb, line 122
def hash attachment, style_name
  attachment.hash(style_name)
end
id(attachment, style_name) click to toggle source

Returns the id of the instance.

# File lib/dm-paperclip/interpolations.rb, line 111
def id attachment, style_name
  attachment.instance.id
end
id_partition(attachment, style_name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 128
def id_partition attachment, style_name
  ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
end
merb_env(attachment, style) click to toggle source
# File lib/dm-paperclip/interpolations.rb, line 83
def merb_env attachment, style
  Object.const_defined?('Merb') ? Merb.env : nil
end
merb_root(attachment, style) click to toggle source
# File lib/dm-paperclip/interpolations.rb, line 79
def merb_root attachment, style
  Object.const_defined?('Merb') ? Merb.root : nil
end
rails_env(attachment, style_name) click to toggle source

Returns the Rails.env constant.

# File lib/dm-paperclip/interpolations.rb, line 75
def rails_env attachment, style_name
  Object.const_defined?('Rails') ? Rails.env : nil
end
rails_root(attachment, style_name) click to toggle source

Returns the Rails.root constant.

# File lib/dm-paperclip/interpolations.rb, line 70
def rails_root attachment, style_name
  Object.const_defined?('Rails') ? Rails.root : nil
end
style(attachment, style_name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 139
def style attachment, style_name
  style_name || attachment.default_style
end
timestamp(attachment, style_name) click to toggle source

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

# File lib/dm-paperclip/interpolations.rb, line 52
def timestamp attachment, style_name
  attachment.instance_read(:updated_at).to_s
end
updated_at(attachment, style_name) click to toggle source

Returns an integer timestamp that is time zone-neutral, so that paths remain valid even if a server's time zone changes.

# File lib/dm-paperclip/interpolations.rb, line 58
def updated_at attachment, style_name
  attachment.updated_at
end
url(attachment, style_name) click to toggle source
# File lib/dm-paperclip/interpolations.rb, line 46
def url attachment, style_name
  raise InfiniteInterpolationError if caller.any?{|b| b.index(RIGHT_HERE) }
  attachment.url(style_name, false)
end
uuid(attachment, style_name) click to toggle source

Returns the uuid of the instance.

# File lib/dm-paperclip/interpolations.rb, line 144
def uuid attachment, style_name
  attachment.instance.uuid
end
web_root(attachment, style) click to toggle source
# File lib/dm-paperclip/interpolations.rb, line 62
def web_root attachment, style
 Paperclip.config.root ||
 merb_root(attachment, style) ||
 rails_root(attachment, style) ||
 ""
 end