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.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#queued_for_write ⇒ Object
readonly
Returns the value of attribute queued_for_write.
-
#styles ⇒ Object
readonly
Returns the value of attribute styles.
Class Method Summary collapse
- .default_options ⇒ Object
-
.interpolations ⇒ Object
A hash of procs that are run during the interpolation of a path or url.
Instance Method Summary collapse
-
#assign(uploaded_file) ⇒ Object
What gets called when you call instance.attachment = File.
-
#content_type ⇒ Object
Returns the content_type of the file as originally assigned, and lives in the <attachment>_content_type attribute of the model.
-
#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
Returns true if a file has been assigned.
-
#initialize(name, instance, options = {}) ⇒ Attachment
constructor
Creates an Attachment object.
-
#instance_read(attr) ⇒ Object
Reads the attachment-specific attribute on the instance.
-
#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 = nil) ⇒ Object
Returns the path of the attachment as defined by the :path option.
-
#reprocess! ⇒ 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.
-
#to_s(style = nil) ⇒ 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.
-
#url(style = default_style, include_updated_timestamp = true) ⇒ Object
Returns the public URL of the attachment, with a given style.
-
#valid? ⇒ Boolean
Returns true if there are no errors on this attachment.
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
.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/paperclip/attachment.rb', line 24 def initialize name, instance, = {} @name = name @instance = instance = self.class..merge() @url = [:url] @url = @url.call(self) if @url.is_a?(Proc) @path = [:path] @path = @path.call(self) if @path.is_a?(Proc) @styles = [:styles] @styles = @styles.call(self) if @styles.is_a?(Proc) @default_url = [:default_url] @validations = [:validations] @default_style = [:default_style] @storage = [:storage] @whiny = [:whiny_thumbnails] @convert_options = [:convert_options] || {} @processors = [:processors] || [:thumbnail] @options = @queued_for_delete = [] @queued_for_write = {} @errors = {} @validation_errors = nil @dirty = false normalize_style_definition initialize_storage log("Paperclip attachment #{name} on #{instance.class} initialized.") end |
Instance Attribute Details
#convert_options ⇒ Object (readonly)
Returns the value of attribute convert_options.
19 20 21 |
# File 'lib/paperclip/attachment.rb', line 19 def @convert_options end |
#default_style ⇒ Object (readonly)
Returns the value of attribute default_style.
19 20 21 |
# File 'lib/paperclip/attachment.rb', line 19 def default_style @default_style end |
#instance ⇒ Object (readonly)
Returns the value of attribute instance.
19 20 21 |
# File 'lib/paperclip/attachment.rb', line 19 def instance @instance end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
19 20 21 |
# File 'lib/paperclip/attachment.rb', line 19 def name @name end |
#queued_for_write ⇒ Object (readonly)
Returns the value of attribute queued_for_write.
19 20 21 |
# File 'lib/paperclip/attachment.rb', line 19 def queued_for_write @queued_for_write end |
#styles ⇒ Object (readonly)
Returns the value of attribute styles.
19 20 21 |
# File 'lib/paperclip/attachment.rb', line 19 def styles @styles end |
Class Method Details
.default_options ⇒ Object
7 8 9 10 11 12 13 14 15 16 17 |
# File 'lib/paperclip/attachment.rb', line 7 def self. @default_options ||= { :url => "/system/:attachment/:id/:style/:basename.:extension", :path => ":rails_root/public/system/:attachment/:id/:style/:basename.:extension", :styles => {}, :default_url => "/:attachment/:style/missing.png", :default_style => :original, :validations => {}, :storage => :filesystem } end |
.interpolations ⇒ Object
A hash of procs that are run during the interpolation of a path or url. A variable of the format :name will be replaced with the return value of the proc named “:name”. Each lambda takes the attachment and the current style as arguments. This hash can be added to with your own proc if necessary.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/paperclip/attachment.rb', line 191 def self.interpolations @interpolations ||= { :rails_root => lambda{|,style| RAILS_ROOT }, :rails_env => lambda{|,style| RAILS_ENV }, :class => lambda do |,style| .instance.class.name.underscore.pluralize end, :basename => lambda do |,style| .original_filename.gsub(/#{File.extname(.original_filename)}$/, "") end, :extension => lambda do |,style| ((style = .styles[style]) && style[:format]) || File.extname(.original_filename).gsub(/^\.+/, "") end, :id => lambda{|,style| .instance.id }, :id_partition => lambda do |, style| ("%09d" % .instance.id).scan(/\d{3}/).join("/") end, :attachment => lambda{|,style| .name.to_s.downcase.pluralize }, :style => lambda{|,style| style || .default_style }, } end |
Instance Method Details
#assign(uploaded_file) ⇒ Object
What gets called when you call instance.attachment = File. It clears errors, assigns attributes, processes the file, and runs validations. 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
If the file that is assigned is not valid, the processing (i.e. thumbnailing, etc) will NOT be run.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/paperclip/attachment.rb', line 64 def assign uploaded_file %w(file_name).each do |field| unless @instance.class.column_names.include?("#{name}_#{field}") raise PaperclipError.new("#{@instance.class} model does not have required column '#{name}_#{field}'") end end 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) log("Assigning #{uploaded_file.inspect} to #{name}") uploaded_file.binmode if uploaded_file.respond_to? :binmode queue_existing_for_delete @errors = {} @validation_errors = nil return nil if uploaded_file.nil? log("Writing attributes for #{name}") @queued_for_write[:original] = uploaded_file.to_tempfile instance_write(:file_name, uploaded_file.original_filename.strip.gsub(/[^\w\d\.\-]+/, '_')) instance_write(:content_type, uploaded_file.content_type.to_s.strip) instance_write(:file_size, uploaded_file.size.to_i) instance_write(:updated_at, Time.now) @dirty = true post_process if valid? # Reset the file size if the original file was reprocessed. instance_write(:file_size, @queued_for_write[:original].size.to_i) ensure uploaded_file.close if close_uploaded_file validate 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.
175 176 177 |
# File 'lib/paperclip/attachment.rb', line 175 def content_type instance_read(:content_type) end |
#dirty? ⇒ Boolean
Returns true if there are changes that need to be saved.
141 142 143 |
# File 'lib/paperclip/attachment.rb', line 141 def dirty? @dirty end |
#errors ⇒ Object
Returns an array containing the errors on this attachment.
136 137 138 |
# File 'lib/paperclip/attachment.rb', line 136 def errors @errors end |
#file? ⇒ Boolean
Returns true if a file has been assigned.
237 238 239 |
# File 'lib/paperclip/attachment.rb', line 237 def file? !original_filename.blank? end |
#instance_read(attr) ⇒ Object
Reads the attachment-specific attribute on the instance. See instance_write for more details.
253 254 255 256 257 258 259 |
# File 'lib/paperclip/attachment.rb', line 253 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).
244 245 246 247 248 249 |
# File 'lib/paperclip/attachment.rb', line 244 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.
163 164 165 |
# File 'lib/paperclip/attachment.rb', line 163 def original_filename instance_read(:file_name) end |
#path(style = nil) ⇒ 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.
120 121 122 |
# File 'lib/paperclip/attachment.rb', line 120 def path style = nil #:nodoc: original_filename.nil? ? nil : interpolate(@path, style) end |
#reprocess! ⇒ 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.
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/paperclip/attachment.rb', line 218 def reprocess! new_original = Tempfile.new("paperclip-reprocess") new_original.binmode if old_original = to_file(:original) new_original.write( old_original.read ) new_original.rewind @queued_for_write = { :original => new_original } post_process 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.
147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/paperclip/attachment.rb', line 147 def save if valid? log("Saving files for #{name}") flush_deletes flush_writes @dirty = false true else log("Errors on #{name}. Not saving.") flush_errors false end end |
#size ⇒ Object
Returns the size of the file as originally assigned, and lives in the <attachment>_file_size attribute of the model.
169 170 171 |
# File 'lib/paperclip/attachment.rb', line 169 def size instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size) end |
#to_s(style = nil) ⇒ Object
Alias to url
125 126 127 |
# File 'lib/paperclip/attachment.rb', line 125 def to_s style = nil url(style) 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.
181 182 183 184 |
# File 'lib/paperclip/attachment.rb', line 181 def updated_at time = instance_read(:updated_at) time && time.to_i end |
#url(style = default_style, include_updated_timestamp = true) ⇒ 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
111 112 113 114 |
# File 'lib/paperclip/attachment.rb', line 111 def url style = default_style, = true url = original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style) && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url end |
#valid? ⇒ Boolean
Returns true if there are no errors on this attachment.
130 131 132 133 |
# File 'lib/paperclip/attachment.rb', line 130 def valid? validate errors.empty? end |