Class: Paperclip::Attachment
- Inherits:
-
Object
- Object
- Paperclip::Attachment
- Defined in:
- lib/polygallery/paperclip_integration.rb
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
- #as_json(options = nil) ⇒ Object
- #assign(uploaded_file) ⇒ Object
- #blank? ⇒ Boolean
-
#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.
-
#created_at ⇒ Object
Returns the creation time of the file as originally assigned, and lives in the <attachment>_created_at attribute of the model.
- #default_options ⇒ Object
-
#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.
-
#expiring_url(time = 3600, style_name = default_style) ⇒ Object
Alias to
url
that allows using the expiring_url method provided by the cloud storage implementations, but keep using filesystem storage for development and testing. -
#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.
- #only_process ⇒ Object
-
#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.
-
#staged? ⇒ Boolean
:nodoc:.
-
#staged_path(style_name = default_style) ⇒ Object
:nodoc:.
- #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 model 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 an argument is not specified 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 or clearing the attachment. Defaults to false filename_cleaner
- An object that responds to #call(filename) that will strip unacceptable charcters from filename 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 escape_url
- Perform URI escaping to URLs. Defaults to true
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/polygallery/paperclip_integration.rb', line 69 def initialize(name, instance, = {}) @name = name @instance = instance = self.class..deep_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.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def @convert_options end |
#default_style ⇒ Object (readonly)
Returns the value of attribute default_style.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def default_style @default_style end |
#instance ⇒ Object (readonly)
Returns the value of attribute instance.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def instance @instance end |
#interpolator ⇒ Object (readonly)
Returns the value of attribute interpolator.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def interpolator @interpolator end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def name @name end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def @options end |
#post_processing ⇒ Object
Returns the value of attribute post_processing.
40 41 42 |
# File 'lib/polygallery/paperclip_integration.rb', line 40 def post_processing @post_processing end |
#queued_for_write ⇒ Object (readonly)
Returns the value of attribute queued_for_write.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def queued_for_write @queued_for_write end |
#source_file_options ⇒ Object (readonly)
Returns the value of attribute source_file_options.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 def @source_file_options end |
#whiny ⇒ Object (readonly)
Returns the value of attribute whiny.
38 39 40 |
# File 'lib/polygallery/paperclip_integration.rb', line 38 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 33 34 35 36 |
# File 'lib/polygallery/paperclip_integration.rb', line 10 def self. @default_options ||= { :convert_options => {}, :default_style => :original, :default_url => "/:attachment/:style/missing.png", :escape_url => true, :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/, :filename_cleaner => nil, :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], :validate_media_type => true, :check_validity_before_processing => true } end |
Instance Method Details
#as_json(options = nil) ⇒ Object
182 183 184 |
# File 'lib/polygallery/paperclip_integration.rb', line 182 def as_json( = nil) to_s(( && [:style]) || default_style) end |
#assign(uploaded_file) ⇒ Object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/polygallery/paperclip_integration.rb', line 89 def assign(uploaded_file) is_polyphoto = self.instance.is_a?(Polygallery::Photo) @file = Paperclip.io_adapters.for(uploaded_file) ensure_required_accessors! ensure_required_validations! if @file.assignment? clear(*only_process) unless is_polyphoto if @file.nil? nil else clear(*only_process) if is_polyphoto assign_attributes post_process_file reset_file_if_original_reprocessed end else nil end end |
#blank? ⇒ Boolean
349 350 351 |
# File 'lib/polygallery/paperclip_integration.rb', line 349 def blank? not present? 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.
241 242 243 244 245 246 247 248 249 |
# File 'lib/polygallery/paperclip_integration.rb', line 241 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.
284 285 286 |
# File 'lib/polygallery/paperclip_integration.rb', line 284 def content_type instance_read(:content_type) end |
#created_at ⇒ Object
Returns the creation time of the file as originally assigned, and lives in the <attachment>_created_at attribute of the model.
290 291 292 293 294 295 |
# File 'lib/polygallery/paperclip_integration.rb', line 290 def created_at if able_to_store_created_at? time = instance_read(:created_at) time && time.to_f.to_i end end |
#default_options ⇒ Object
142 143 144 145 146 147 |
# File 'lib/polygallery/paperclip_integration.rb', line 142 def { :timestamp => @options[:use_timestamp], :escape => @options[:escape_url] } 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.
254 255 256 257 |
# File 'lib/polygallery/paperclip_integration.rb', line 254 def destroy clear save end |
#dirty? ⇒ Boolean
Returns true if there are changes that need to be saved.
225 226 227 |
# File 'lib/polygallery/paperclip_integration.rb', line 225 def dirty? @dirty end |
#errors ⇒ Object
Returns an array containing the errors on this attachment.
220 221 222 |
# File 'lib/polygallery/paperclip_integration.rb', line 220 def errors @errors end |
#expiring_url(time = 3600, style_name = default_style) ⇒ Object
Alias to url
that allows using the expiring_url method provided by the cloud storage implementations, but keep using filesystem storage for development and testing.
152 153 154 |
# File 'lib/polygallery/paperclip_integration.rb', line 152 def expiring_url(time = 3600, style_name = default_style) url(style_name) end |
#file? ⇒ Boolean Also known as: present?
Returns true if a file has been assigned.
343 344 345 |
# File 'lib/polygallery/paperclip_integration.rb', line 343 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>_fingerprint attribute of the model.
278 279 280 |
# File 'lib/polygallery/paperclip_integration.rb', line 278 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.
312 313 314 315 316 317 |
# File 'lib/polygallery/paperclip_integration.rb', line 312 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.
371 372 373 374 375 376 |
# File 'lib/polygallery/paperclip_integration.rb', line 371 def instance_read(attr) getter = :"#{name}_#{attr}" if instance.respond_to?(getter) instance.send(getter) end 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.
355 356 357 |
# File 'lib/polygallery/paperclip_integration.rb', line 355 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).
362 363 364 365 366 367 |
# File 'lib/polygallery/paperclip_integration.rb', line 362 def instance_write(attr, value) setter = :"#{name}_#{attr}=" if instance.respond_to?(setter) instance.send(setter, value) end end |
#only_process ⇒ Object
203 204 205 206 207 |
# File 'lib/polygallery/paperclip_integration.rb', line 203 def only_process only_process = @options[:only_process].dup only_process = only_process.call(self) if only_process.respond_to?(:call) only_process.map(&:to_sym) end |
#original_filename ⇒ Object
Returns the name of the file as originally assigned, and lives in the <attachment>_file_name attribute of the model.
266 267 268 |
# File 'lib/polygallery/paperclip_integration.rb', line 266 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.
160 161 162 163 |
# File 'lib/polygallery/paperclip_integration.rb', line 160 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
209 210 211 212 213 214 215 216 217 |
# File 'lib/polygallery/paperclip_integration.rb', line 209 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. NOTE: Calling reprocess WILL NOT delete existing files. This is due to inconsistencies in timing of S3 commands. It’s possible that calling #reprocess! will lose data if the files are not kept.
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/polygallery/paperclip_integration.rb', line 326 def reprocess!(*style_args) saved_only_process, @options[:only_process] = @options[:only_process], style_args saved_preserve_files, @options[:preserve_files] = @options[:preserve_files], true begin assign(self) save instance.save rescue Errno::EACCES => e warn "#{e} - skipping file." false ensure @options[:only_process] = saved_only_process @options[:preserve_files] = saved_preserve_files 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.
231 232 233 234 235 236 |
# File 'lib/polygallery/paperclip_integration.rb', line 231 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.
272 273 274 |
# File 'lib/polygallery/paperclip_integration.rb', line 272 def size instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size) end |
#staged? ⇒ Boolean
:nodoc:
173 174 175 |
# File 'lib/polygallery/paperclip_integration.rb', line 173 def staged? ! @queued_for_write.empty? end |
#staged_path(style_name = default_style) ⇒ Object
:nodoc:
166 167 168 169 170 |
# File 'lib/polygallery/paperclip_integration.rb', line 166 def staged_path(style_name = default_style) if staged? @queued_for_write[style_name].path end end |
#styles ⇒ Object
190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/polygallery/paperclip_integration.rb', line 190 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 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.
306 307 308 |
# File 'lib/polygallery/paperclip_integration.rb', line 306 def time_zone @options[:use_default_time_zone] ? Time.zone_default : Time.zone end |
#to_s(style_name = default_style) ⇒ Object
Alias to url
178 179 180 |
# File 'lib/polygallery/paperclip_integration.rb', line 178 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.
299 300 301 302 |
# File 'lib/polygallery/paperclip_integration.rb', line 299 def updated_at time = instance_read(:updated_at) time && time.to_f.to_i end |
#uploaded_file ⇒ Object
Returns the uploaded file if present.
260 261 262 |
# File 'lib/polygallery/paperclip_integration.rb', line 260 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)
134 135 136 137 138 139 140 |
# File 'lib/polygallery/paperclip_integration.rb', line 134 def url(style_name = default_style, = {}) if == true || == false # Backwards compatibility. @url_generator.for(style_name, .merge(:timestamp => )) else @url_generator.for(style_name, .merge()) end end |