Class: Paperclip::Attachment

Inherits:
Object
  • Object
show all
Defined in:
lib/paperclip/attachment.rb

Overview

The Attachment class manages the files for a given attachment. It saves when the model saves, deletes when the model is destroyed, and processes the file upon assignment.

Constant Summary collapse

DEFAULT_URL = 
"/system/:attachment/:id/:style/:filename".freeze
DIGEST_PATH = 
"files/:digest/:style.:extension".freeze
DIGEST_URL = 
"/system/#{DIGEST_PATH}".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, instance, options = {}) ⇒ Attachment

Creates an Attachment object. name is the name of the attachment, instance is the ActiveRecord object instance it’s attached to, and options is the same as the hash passed to has_attached_file.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/paperclip/attachment.rb', line 34

def initialize name, instance, options = {}
  @name              = name
  @instance          = instance

  options = self.class.default_options.merge(options)

  @url               = options[:url]
  @url               = @url.call(self) if @url.is_a?(Proc)
  @path              = options[:path]
  @path              = @path.call(self) if @path.is_a?(Proc)
  @styles            = options[:styles]
  @normalized_styles = nil
  @default_url       = options[:default_url]
  @default_style     = options[:default_style]
  @storage           = options[:storage]
  @delete_files      = options[:delete_files]
  @whiny             = options[:whiny_thumbnails] || options[:whiny]
  @convert_options   = options[:convert_options]
  @processors        = options[:processors]
  @options           = options
  @queued_for_delete = []
  @queued_for_write  = {}
  @errors            = {}
  @dimensions        = {}
  @dirty             = false

  initialize_storage
end

Instance Attribute Details

#convert_options ⇒ Object (readonly)

Returns the value of attribute convert_options.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def convert_options
  @convert_options
end

#default_style ⇒ Object (readonly)

Returns the value of attribute default_style.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def default_style
  @default_style
end

#instance ⇒ Object (readonly)

Returns the value of attribute instance.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def instance
  @instance
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def options
  @options
end

#queued_for_write ⇒ Object (readonly)

Returns the value of attribute queued_for_write.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def queued_for_write
  @queued_for_write
end

#whiny ⇒ Object (readonly)

Returns the value of attribute whiny.



29
30
31
 
# File 'lib/paperclip/attachment.rb', line 29

def whiny
  @whiny
end

Class Method Details

.default_options ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/paperclip/attachment.rb', line 14

def self.default_options
  @default_options ||= {
    :url               => DEFAULT_URL,
    :path              => ":rails_root/public:url",
    :styles            => {},
    :processors        => [:thumbnail],
    :convert_options   => {},
    :default_url       => "/:attachment/:style/missing.png",
    :default_style     => :original,
    :storage           => :filesystem,
    :delete_files      => true,
    :whiny             => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails]
  }
end

.interpolations ⇒ Object

Paths and URLs can have a number of variables interpolated into them to vary the storage location based on name, id, style, class, etc. This method is a deprecated access into supplying and retrieving these interpolations. Future access should use either Paperclip.interpolates or extend the Paperclip::Interpolations module directly.



244
245
246
247
248
249
 
# File 'lib/paperclip/attachment.rb', line 244

def self.interpolations
  warn('[DEPRECATION] Paperclip::Attachment.interpolations is deprecated ' +
       'and will be removed from future versions. ' +
       'Use Paperclip.interpolates instead')
  Paperclip::Interpolations
end

Instance Method Details

#assign(uploaded_file) ⇒ Object

What gets called when you call instance.attachment = File. It clears errors, assigns attributes, and processes the file. It also queues up the previous file for deletion, to be flushed away on #save of its host. In addition to form uploads, you can also assign another Paperclip attachment:

new_user.avatar = old_user.avatar



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/paperclip/attachment.rb', line 83

def assign uploaded_file
  ensure_required_accessors!

  if uploaded_file.is_a?(Paperclip::Attachment)
    uploaded_file = uploaded_file.to_file(:original)
    close_uploaded_file = uploaded_file.respond_to?(:close)
  end

  return nil unless valid_assignment?(uploaded_file)

  uploaded_file.binmode if uploaded_file.respond_to? :binmode
  self.clear

  return nil if uploaded_file.nil?

  @queued_for_write[:original]   = uploaded_file.to_tempfile
  instance_write(:file_name,       uploaded_file.original_filename.strip)
  if @queued_for_write[:original].path
    instance_write(:digest,        Digest::SHA1.file(@queued_for_write[:original].path).hexdigest)
  else
    instance_write(:digest,        Digest::SHA1.hexdigest(@queued_for_write[:original].read))
  end
  content_type = Paperclip.content_type_for_file(@queued_for_write[:original]) || uploaded_file.content_type
  instance_write(:content_type,    content_type.to_s.strip)
  instance_write(:file_size,       uploaded_file.size.to_i)
  instance_write(:updated_at,      Time.now)

  @dirty = true

  post_process

  # Reset the file size if the original file was reprocessed.
  instance_write(:file_size, @queued_for_write[:original].size.to_i)

  if image? &&
     @instance.respond_to?("#{name}_width") &&
     @instance.respond_to?("#{name}_height")

     begin
       geometry = Paperclip::Geometry.from_file(@queued_for_write[:original])
       instance_write(:width, geometry.width.to_i)
       instance_write(:height, geometry.height.to_i)
     rescue NotIdentifiedByImageMagickError => e
       log("Couldn't get dimensions for #{name}: #{e}")
     end
  else
    instance_write(:width, nil)
    instance_write(:height, nil)
  end
ensure
  uploaded_file.close if close_uploaded_file
end

#clear ⇒ Object

Clears out the attachment. Has the same effect as previously assigning nil to the attachment. Does NOT save. If you wish to clear AND save, use #destroy.



183
184
185
186
 
# File 'lib/paperclip/attachment.rb', line 183

def clear
  queue_existing_for_delete
  @errors            = {}
end

#content_type ⇒ Object

Returns the content_type of the file as originally assigned, and lives in the <attachment>_content_type attribute of the model.



214
215
216
 
# File 'lib/paperclip/attachment.rb', line 214

def content_type
  instance_read(:content_type)
end

#destroy ⇒ Object

Destroys the attachment. Has the same effect as previously assigning nil to the attachment *and saving*. This is permanent. If you wish to wipe out the existing attachment but not save, use #clear.



191
192
193
194
 
# File 'lib/paperclip/attachment.rb', line 191

def destroy
  clear
  save
end

#digest ⇒ Object 



202
203
204
 
# File 'lib/paperclip/attachment.rb', line 202

def digest
  instance_read(:digest)
end

#dirty? ⇒ Boolean

Returns true if there are changes that need to be saved.

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/paperclip/attachment.rb', line 167

def dirty?
  @dirty
end

#errors ⇒ Object

Returns an array containing the errors on this attachment.



162
163
164
 
# File 'lib/paperclip/attachment.rb', line 162

def errors
  @errors
end

#file? ⇒ Boolean

Returns true if a file has been assigned.

Returns:

  • (Boolean) 


274
275
276
 
# File 'lib/paperclip/attachment.rb', line 274

def file?
  !original_filename.blank?
end

#height(style = default_style) ⇒ Object

If <attachment> is an image and <attachment>_height attribute is present, returns the original width of the image when no argument is specified or the calculated new height of the image when passed a valid style. Returns nil otherwise



235
236
237
 
# File 'lib/paperclip/attachment.rb', line 235

def height style = default_style
  dimensions(style)[1]
end

#image? ⇒ Boolean

Determines whether or not the attachment is an image based on the content_type

Returns:

  • (Boolean) 


279
280
281
 
# File 'lib/paperclip/attachment.rb', line 279

def image?
  !content_type.nil? and !!content_type.match(%r{\Aimage/})
end

#instance_read(attr) ⇒ Object

Reads the attachment-specific attribute on the instance. See instance_write for more details.



295
296
297
298
299
300
301
 
# File 'lib/paperclip/attachment.rb', line 295

def instance_read(attr)
  getter = :"#{name}_#{attr}"
  responds = instance.respond_to?(getter)
  cached = self.instance_variable_get("@_#{getter}")
  return cached if cached
  instance.send(getter) if responds || attr.to_s == "file_name"
end

#instance_write(attr, value) ⇒ Object

Writes the attachment-specific attribute on the instance. For example, instance_write(:file_name, “me.jpg”) will write “me.jpg” to the instance’s “avatar_file_name” field (assuming the attachment is called avatar).



286
287
288
289
290
291
 
# File 'lib/paperclip/attachment.rb', line 286

def instance_write(attr, value)
  setter = :"#{name}_#{attr}="
  responds = instance.respond_to?(setter)
  self.instance_variable_set("@_#{setter.to_s.chop}", value)
  instance.send(setter, value) if responds || attr.to_s == "file_name"
end

#original_filename ⇒ Object

Returns the name of the file as originally assigned, and lives in the <attachment>_file_name attribute of the model.



198
199
200
 
# File 'lib/paperclip/attachment.rb', line 198

def original_filename
  instance_read(:file_name)
end

#path(style_name = default_style) ⇒ Object

Returns the path of the attachment as defined by the :path option. If the file is stored in the filesystem the path refers to the path of the file on disk. If the file is stored in S3, the path is the “key” part of the URL, and the :bucket option refers to the S3 bucket.



152
153
154
 
# File 'lib/paperclip/attachment.rb', line 152

def path style_name = default_style
  original_filename.nil? ? nil : interpolate(@path, style_name)
end

#processors ⇒ Object 



73
74
75
 
# File 'lib/paperclip/attachment.rb', line 73

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

#reprocess!(style_names = styles.keys) ⇒ Object

This method really shouldn’t be called that often. It’s expected use is in the paperclip:refresh rake task and that’s it. It will regenerate thumbnails for all given style_names forcefully by reobtaining the original file and going through the post-process again.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/paperclip/attachment.rb', line 255

def reprocess!(style_names=styles.keys)
  new_original = Tempfile.new("paperclip-reprocess")
  new_original.binmode
  if old_original = to_file(:original)
    new_original.write( old_original.respond_to?(:get) ? old_original.get : old_original.read )
    new_original.rewind

    @queued_for_write = { :original => new_original }
    post_process(style_names)

    old_original.close if old_original.respond_to?(:close)

    save
  else
    true
  end
end

#save ⇒ Object

Saves the file, if there are no errors. If there are, it flushes them to the instance’s errors and returns false, cancelling the save.



173
174
175
176
177
178
 
# File 'lib/paperclip/attachment.rb', line 173

def save
  flush_deletes
  flush_writes
  @dirty = false
  true
end

#size ⇒ Object

Returns the size of the file as originally assigned, and lives in the <attachment>_file_size attribute of the model.



208
209
210
 
# File 'lib/paperclip/attachment.rb', line 208

def size
  instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size)
end

#styles ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'lib/paperclip/attachment.rb', line 63

def styles
  unless @normalized_styles
    @normalized_styles = {}
    (@styles.respond_to?(:call) ? @styles.call(self) : @styles).each do |name, args|
      @normalized_styles[name] = Paperclip::Style.new(name, args, self)
    end
  end
  @normalized_styles
end

#to_s(style_name = nil) ⇒ Object

Alias to url



157
158
159
 
# File 'lib/paperclip/attachment.rb', line 157

def to_s style_name = nil
  url(style_name)
end

#updated_at ⇒ Object

Returns the last modified time of the file as originally assigned, and lives in the <attachment>_updated_at attribute of the model.



220
221
222
223
 
# File 'lib/paperclip/attachment.rb', line 220

def updated_at
  time = instance_read(:updated_at)
  time && time.to_f.to_i
end

#url(style = default_style, include_updated_timestamp = false) ⇒ Object

Returns the public URL of the attachment, with a given style. Note that this does not necessarily need to point to a file that your web server can access and can point to an action in your app, if you need fine grained security. This is not recommended if you don’t need the security, however, for performance reasons. set include_updated_timestamp to false if you want to stop the attachment update time appended to the url



143
144
145
146
 
# File 'lib/paperclip/attachment.rb', line 143

def url style = default_style, include_updated_timestamp = false
  url = original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style)
  include_updated_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
end

#width(style = default_style) ⇒ Object

If <attachment> is an image and <attachment>_width attribute is present, returns the original width of the image when no argument is specified or the calculated new width of the image when passed a valid style. Returns nil otherwise



228
229
230
 
# File 'lib/paperclip/attachment.rb', line 228

def width style = default_style
  dimensions(style)[0]
end