Class: Paperclip::Attachment
- Inherits:
-
Object
- Object
- Paperclip::Attachment
- 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.
Instance Attribute Summary collapse
-
#convert_options ⇒ Object
readonly
Returns the value of attribute convert_options.
-
#default_style ⇒ Object
readonly
Returns the value of attribute default_style.
-
#instance ⇒ Object
readonly
Returns the value of attribute instance.
-
#interpolator ⇒ Object
readonly
Returns the value of attribute interpolator.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#post_processing ⇒ Object
Returns the value of attribute post_processing.
-
#queued_for_write ⇒ Object
readonly
Returns the value of attribute queued_for_write.
-
#source_file_options ⇒ Object
readonly
Returns the value of attribute source_file_options.
-
#whiny ⇒ Object
readonly
Returns the value of attribute whiny.
Class Method Summary collapse
Instance Method Summary collapse
-
#assign(uploaded_file) ⇒ Object
What gets called when you call instance.attachment = File.
-
#clear(*styles_to_clear) ⇒ Object
Clears out the attachment.
-
#content_type ⇒ Object
Returns the content_type of the file as originally assigned, and lives in the <attachment>_content_type attribute of the model.
-
#destroy ⇒ Object
Destroys the attachment.
-
#dirty? ⇒ Boolean
Returns true if there are changes that need to be saved.
-
#errors ⇒ Object
Returns an array containing the errors on this attachment.
-
#file? ⇒ Boolean
(also: #present?)
Returns true if a file has been assigned.
-
#fingerprint ⇒ Object
Returns the fingerprint of the file, if one’s defined.
-
#hash_key(style_name = default_style) ⇒ Object
Returns a unique hash suitable for obfuscating the URL of an otherwise publicly viewable attachment.
-
#initialize(name, instance, options = {}) ⇒ Attachment
constructor
Creates an Attachment object.
-
#instance_read(attr) ⇒ Object
Reads the attachment-specific attribute on the instance.
-
#instance_respond_to?(attr) ⇒ Boolean
Determines whether the instance responds to this attribute.
-
#instance_write(attr, value) ⇒ Object
Writes the attachment-specific attribute on the instance.
-
#original_filename ⇒ Object
Returns the name of the file as originally assigned, and lives in the <attachment>_file_name attribute of the model.
-
#path(style_name = default_style) ⇒ Object
Returns the path of the attachment as defined by the :path option.
- #processors ⇒ Object
-
#reprocess!(*style_args) ⇒ Object
This method really shouldn’t be called that often.
-
#save ⇒ Object
Saves the file, if there are no errors.
-
#size ⇒ Object
Returns the size of the file as originally assigned, and lives in the <attachment>_file_size attribute of the model.
- #styles ⇒ Object
-
#time_zone ⇒ Object
The time zone to use for timestamp interpolation.
-
#to_s(style_name = default_style) ⇒ Object
Alias to
url
. -
#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.
-
#uploaded_file ⇒ Object
Returns the uploaded file if present.
-
#url(style_name = default_style, options = {}) ⇒ Object
Returns the public URL of the attachment with a given style.
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
.
Options include:
url
- a relative URL of the attachment. This is interpolated using interpolator
path
- where on the filesystem to store the attachment. This is interpolated using interpolator
styles
- a hash of options for processing the attachment. See has_attached_file
for the details only_process
- style args to be run through the post-processor. This defaults to the empty list default_url
- a URL for the missing image default_style
- the style to use when don’t specify an argument to e.g. #url, #path storage
- the storage mechanism. Defaults to :filesystem use_timestamp
- whether to append an anti-caching timestamp to image URLs. Defaults to true whiny
, whiny_thumbnails
- whether to raise when thumbnailing fails use_default_time_zone
- related to use_timestamp
. Defaults to true hash_digest
- a string representing a class that will be used to hash URLs for obfuscation hash_data
- the relative URL for the hash data. This is interpolated using interpolator
hash_secret
- a secret passed to the hash_digest
convert_options
- flags passed to the convert
command for processing source_file_options
- flags passed to the convert
command that controls how the file is read processors
- classes that transform the attachment. Defaults to [:thumbnail] preserve_files
- whether to keep files on the filesystem when deleting to clearing the attachment. Defaults to false interpolator
- the object used to interpolate filenames and URLs. Defaults to Paperclip::Interpolations url_generator
- the object used to generate URLs, using the interpolator. Defaults to Paperclip::UrlGenerator
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/paperclip/attachment.rb', line 63 def initialize(name, instance, = {}) @name = name @instance = instance = self.class..merge() @options = @post_processing = true @queued_for_delete = [] @queued_for_write = {} @errors = {} @dirty = false @interpolator = [:interpolator] @url_generator = [:url_generator].new(self, @options) @source_file_options = [:source_file_options] @whiny = [:whiny] initialize_storage end |
Instance Attribute Details
#convert_options ⇒ Object (readonly)
Returns the value of attribute convert_options.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def @convert_options end |
#default_style ⇒ Object (readonly)
Returns the value of attribute default_style.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def default_style @default_style end |
#instance ⇒ Object (readonly)
Returns the value of attribute instance.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def instance @instance end |
#interpolator ⇒ Object (readonly)
Returns the value of attribute interpolator.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def interpolator @interpolator end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def name @name end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def @options end |
#post_processing ⇒ Object
Returns the value of attribute post_processing.
36 37 38 |
# File 'lib/paperclip/attachment.rb', line 36 def post_processing @post_processing end |
#queued_for_write ⇒ Object (readonly)
Returns the value of attribute queued_for_write.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def queued_for_write @queued_for_write end |
#source_file_options ⇒ Object (readonly)
Returns the value of attribute source_file_options.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def @source_file_options end |
#whiny ⇒ Object (readonly)
Returns the value of attribute whiny.
34 35 36 |
# File 'lib/paperclip/attachment.rb', line 34 def whiny @whiny end |
Class Method Details
.default_options ⇒ Object
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/paperclip/attachment.rb', line 10 def self. @default_options ||= { :convert_options => {}, :default_style => :original, :default_url => "/:attachment/:style/missing.png", :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/, :hash_data => ":class/:attachment/:id/:style/:updated_at", :hash_digest => "SHA1", :interpolator => Paperclip::Interpolations, :only_process => [], :path => ":rails_root/public:url", :preserve_files => false, :processors => [:thumbnail], :source_file_options => {}, :storage => :filesystem, :styles => {}, :url => "/system/:class/:attachment/:id_partition/:style/:filename", :url_generator => Paperclip::UrlGenerator, :use_default_time_zone => true, :use_timestamp => true, :whiny => Paperclip.[:whiny] || Paperclip.[:whiny_thumbnails] } 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
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/paperclip/attachment.rb', line 89 def assign uploaded_file ensure_required_accessors! file = Paperclip.io_adapters.for(uploaded_file) @options[:only_process].map!(&:to_sym) self.clear(*@options[:only_process]) return nil if file.nil? @queued_for_write[:original] = file instance_write(:file_name, cleanup_filename(file.original_filename)) instance_write(:content_type, file.content_type.to_s.strip) instance_write(:file_size, file.size) instance_write(:fingerprint, file.fingerprint) if instance_respond_to?(:fingerprint) instance_write(:updated_at, Time.now) @dirty = true post_process(*@options[:only_process]) if post_processing # Reset the file size if the original file was reprocessed. instance_write(:file_size, @queued_for_write[:original].size) instance_write(:fingerprint, @queued_for_write[:original].fingerprint) if instance_respond_to?(:fingerprint) end |
#clear(*styles_to_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.
208 209 210 211 212 213 214 215 216 |
# File 'lib/paperclip/attachment.rb', line 208 def clear(*styles_to_clear) if styles_to_clear.any? queue_some_for_delete(*styles_to_clear) else queue_all_for_delete @queued_for_write = {} @errors = {} end 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.
253 254 255 |
# File 'lib/paperclip/attachment.rb', line 253 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.
221 222 223 224 225 226 |
# File 'lib/paperclip/attachment.rb', line 221 def destroy unless @options[:preserve_files] clear save end end |
#dirty? ⇒ Boolean
Returns true if there are changes that need to be saved.
192 193 194 |
# File 'lib/paperclip/attachment.rb', line 192 def dirty? @dirty end |
#errors ⇒ Object
Returns an array containing the errors on this attachment.
187 188 189 |
# File 'lib/paperclip/attachment.rb', line 187 def errors @errors end |
#file? ⇒ Boolean Also known as: present?
Returns true if a file has been assigned.
297 298 299 |
# File 'lib/paperclip/attachment.rb', line 297 def file? !original_filename.blank? end |
#fingerprint ⇒ Object
Returns the fingerprint of the file, if one’s defined. The fingerprint is stored in the <attachment>_fingerpring attribute of the model.
247 248 249 |
# File 'lib/paperclip/attachment.rb', line 247 def fingerprint instance_read(:fingerprint) end |
#hash_key(style_name = default_style) ⇒ Object
Returns a unique hash suitable for obfuscating the URL of an otherwise publicly viewable attachment.
272 273 274 275 276 277 |
# File 'lib/paperclip/attachment.rb', line 272 def hash_key(style_name = default_style) raise ArgumentError, "Unable to generate hash without :hash_secret" unless @options[:hash_secret] require 'openssl' unless defined?(OpenSSL) data = interpolate(@options[:hash_data], style_name) OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@options[:hash_digest]).new, @options[:hash_secret], data) end |
#instance_read(attr) ⇒ Object
Reads the attachment-specific attribute on the instance. See instance_write for more details.
321 322 323 324 325 326 327 |
# File 'lib/paperclip/attachment.rb', line 321 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_respond_to?(attr) ⇒ Boolean
Determines whether the instance responds to this attribute. Used to prevent calculations on fields we won’t even store.
305 306 307 |
# File 'lib/paperclip/attachment.rb', line 305 def instance_respond_to?(attr) instance.respond_to?(:"#{name}_#{attr}") 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).
312 313 314 315 316 317 |
# File 'lib/paperclip/attachment.rb', line 312 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.
235 236 237 |
# File 'lib/paperclip/attachment.rb', line 235 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.
149 150 151 152 |
# File 'lib/paperclip/attachment.rb', line 149 def path(style_name = default_style) path = original_filename.nil? ? nil : interpolate(path_option, style_name) path.respond_to?(:unescape) ? path.unescape : path end |
#processors ⇒ Object
176 177 178 179 180 181 182 183 184 |
# File 'lib/paperclip/attachment.rb', line 176 def processors processing_option = @options[:processors] if processing_option.respond_to?(:call) processing_option.call(instance) else processing_option end end |
#reprocess!(*style_args) ⇒ 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 all thumbnails forcefully, by reobtaining the original file and going through the post-process again.
283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/paperclip/attachment.rb', line 283 def reprocess!(*style_args) saved_only_process, @options[:only_process] = @options[:only_process], style_args begin assign(self) save rescue Errno::EACCES => e warn "#{e} - skipping file." false ensure @options[:only_process] = saved_only_process 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.
198 199 200 201 202 203 |
# File 'lib/paperclip/attachment.rb', line 198 def save flush_deletes unless @options[:keep_old_files] 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.
241 242 243 |
# File 'lib/paperclip/attachment.rb', line 241 def size instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size) end |
#styles ⇒ Object
163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/paperclip/attachment.rb', line 163 def styles if @options[:styles].respond_to?(:call) || @normalized_styles.nil? styles = @options[:styles] styles = styles.call(self) if styles.respond_to?(:call) @normalized_styles = styles.dup @normalized_styles.each_pair do |name, | @normalized_styles[name.to_sym] = Paperclip::Style.new(name.to_sym, .dup, self) end end @normalized_styles end |
#time_zone ⇒ Object
The time zone to use for timestamp interpolation. Using the default time zone ensures that results are consistent across all threads.
266 267 268 |
# File 'lib/paperclip/attachment.rb', line 266 def time_zone @options[:use_default_time_zone] ? Time.zone_default : Time.zone end |
#to_s(style_name = default_style) ⇒ Object
Alias to url
155 156 157 |
# File 'lib/paperclip/attachment.rb', line 155 def to_s style_name = default_style 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.
259 260 261 262 |
# File 'lib/paperclip/attachment.rb', line 259 def updated_at time = instance_read(:updated_at) time && time.to_f.to_i end |
#uploaded_file ⇒ Object
Returns the uploaded file if present.
229 230 231 |
# File 'lib/paperclip/attachment.rb', line 229 def uploaded_file instance_read(:uploaded_file) end |
#url(style_name = default_style, options = {}) ⇒ Object
Returns the public URL of the attachment with a given style. This does not necessarily need to point to a file that your Web server can access and can instead point to an action in your app, for example for fine grained security; this has a serious performance tradeoff.
Options:
timestamp
- Add a timestamp to the end of the URL. Default: true. escape
- Perform URI escaping to the URL. Default: true.
Global controls (set on has_attached_file):
interpolator
- The object that fills in a URL pattern’s variables. default_url
- The image to show when the attachment has no image. url
- The URL for a saved image. url_generator
- The object that generates a URL. Default: Paperclip::UrlGenerator.
As mentioned just above, the object that generates this URL can be passed in, for finer control. This object must respond to two methods:
#new(Paperclip::Attachment, options_hash) #for(style_name, options_hash)
135 136 137 138 139 140 141 142 143 |
# File 'lib/paperclip/attachment.rb', line 135 def url(style_name = default_style, = {}) = {:timestamp => @options[:use_timestamp], :escape => true} if == true || == false # Backwards compatibility. @url_generator.for(style_name, .merge(:timestamp => )) else @url_generator.for(style_name, .merge()) end end |