Class: Lipsiadmin::Attachment::Attach

Inherits:
Object
  • Object
show all
Defined in:
lib/data_base/attachment/attach.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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

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.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/data_base/attachment/attach.rb', line 125

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

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

  @url               = options[:url]
  @path              = options[:path]
  @styles            = options[:styles]
  @default_url       = options[:default_url]
  @validations       = options[:validations]
  @default_style     = options[:default_style]
  @storage           = options[:storage]
  @whiny             = options[:whiny_thumbnails]
  @convert_options   = options[:convert_options] || {}
  @background        = options[:background].nil? ? instance.respond_to?(:spawn) : options[:background]
  @processors        = options[:processors] || [:thumbnail]
  @options           = options
  @queued_for_delete = []
  @queued_for_write  = {}
  @errors            = {}
  @validation_errors = nil
  @dirty             = false

  normalize_style_definition
  initialize_storage
          
  log("Attachment on #{instance.class} initialized.")
end

Instance Attribute Details

#convert_options ⇒ Object (readonly)

Returns the value of attribute convert_options.



120
121
122
 
# File 'lib/data_base/attachment/attach.rb', line 120

def convert_options
  @convert_options
end

#default_style ⇒ Object (readonly)

Returns the value of attribute default_style.



120
121
122
 
# File 'lib/data_base/attachment/attach.rb', line 120

def default_style
  @default_style
end

#instance ⇒ Object (readonly)

Returns the value of attribute instance.



120
121
122
 
# File 'lib/data_base/attachment/attach.rb', line 120

def instance
  @instance
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



120
121
122
 
# File 'lib/data_base/attachment/attach.rb', line 120

def name
  @name
end

#queued_for_write ⇒ Object (readonly)

Returns the value of attribute queued_for_write.



120
121
122
 
# File 'lib/data_base/attachment/attach.rb', line 120

def queued_for_write
  @queued_for_write
end

#styles ⇒ Object (readonly)

Returns the value of attribute styles.



120
121
122
 
# File 'lib/data_base/attachment/attach.rb', line 120

def styles
  @styles
end

Class Method Details

.default_options ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/data_base/attachment/attach.rb', line 108

def self.default_options
  @default_options ||= {
    :url           => "/uploads/:id_:style_:basename.:extension",
    :path          => ":rails_root/public/uploads/:id_:style_:basename.:extension",
    :styles        => {},
    :default_url   => "/images/backend/no-image.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.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/data_base/attachment/attach.rb', line 297

def self.interpolations
  @interpolations ||= {
    :rails_root   => lambda{|attachment,style| RAILS_ROOT },
    :rails_env    => lambda{|attachment,style| RAILS_ENV },
    :class        => lambda do |attachment,style|
                       attachment.instance.class.name.underscore.pluralize
                     end,
    :basename     => lambda do |attachment,style|
                       attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
                     end,
    :extension    => lambda do |attachment,style| 
                       ((style = attachment.styles[style]) && style[:format]) ||
                       File.extname(attachment.original_filename).gsub(/^\.+/, "")
                     end,
    :id           => lambda{|attachment,style| attachment.instance.id },
    :id_partition => lambda do |attachment, style|
                       ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
                     end,
    :attachment   => lambda{|attachment,style| attachment.name.to_s.downcase.pluralize },
    :style        => lambda{|attachment,style| style || attachment.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 Attachment 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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/data_base/attachment/attach.rb', line 163

def assign(uploaded_file)
  %w(file_name).each do |field|
    unless @instance.class.column_names.include?("#{name}_#{field}")
      raise AttachmentError.new("#{@instance.class} model does not have required column '#{name}_#{field}'")
    end
  end

  if uploaded_file.is_a?(Lipsiadmin::Attachment::Attach)
    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

  solidify_style_definitions
  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

#background(&blk) ⇒ Object

When processing, if the spawn plugin is installed, processing can be done in a background fork or thread if desired.



469
470
471
472
473
474
475
 
# File 'lib/data_base/attachment/attach.rb', line 469

def background(&blk)
  # if instance.respond_to?(:spawn) && @background
  #   instance.spawn(&blk)
  # else
    blk.call
  # end
end

#callback(which) ⇒ Object

:nodoc:



477
478
479
 
# File 'lib/data_base/attachment/attach.rb', line 477

def callback(which)#:nodoc:
  instance.run_callbacks(which, @queued_for_write){|result, obj| result == false }
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.



281
282
283
 
# File 'lib/data_base/attachment/attach.rb', line 281

def content_type
  instance_read(:content_type)
end

#dirty? ⇒ Boolean

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

Returns:

  • (Boolean) 


247
248
249
 
# File 'lib/data_base/attachment/attach.rb', line 247

def dirty?
  @dirty
end

#errors ⇒ Object

Returns an array containing the errors on this attachment.



242
243
244
 
# File 'lib/data_base/attachment/attach.rb', line 242

def errors
  @errors
end

#exist? ⇒ Boolean

Returns true if a file has been assigned.

Returns:

  • (Boolean) 


343
344
345
 
# File 'lib/data_base/attachment/attach.rb', line 343

def exist?
  !original_filename.blank?
end

#extra_options_for(style) ⇒ Object

:nodoc:



428
429
430
431
432
433
434
435
 
# File 'lib/data_base/attachment/attach.rb', line 428

def extra_options_for(style) #:nodoc:
  all_options   = convert_options[:all]
  all_options   = all_options.call(instance)   if all_options.respond_to?(:call)
  style_options = convert_options[style]
  style_options = style_options.call(instance) if style_options.respond_to?(:call)

  [ style_options, all_options ].compact.join(" ")
end

#fire_events(which) ⇒ Object

:nodoc:



446
447
448
449
 
# File 'lib/data_base/attachment/attach.rb', line 446

def fire_events(which) #:nodoc:
  return true if callback(:"#{which}_post_process") == false
  return true if callback(:"#{which}_#{name}_post_process") == false
end

#flush_errors ⇒ Object

:nodoc:



503
504
505
506
507
 
# File 'lib/data_base/attachment/attach.rb', line 503

def flush_errors #:nodoc:
  @errors.each do |error, message|
    instance.errors.add(name, message) if message
  end
end

#initialize_storage ⇒ Object

:nodoc:



423
424
425
426
 
# File 'lib/data_base/attachment/attach.rb', line 423

def initialize_storage #:nodoc:
  @storage_module = Attachment::Storage.const_get(@storage.to_s.capitalize)
  self.extend(@storage_module)
end

#instance_read(attr) ⇒ Object

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



358
359
360
361
362
 
# File 'lib/data_base/attachment/attach.rb', line 358

def instance_read(attr)
  getter = :"#{name}_#{attr}"
  responds = instance.respond_to?(getter)
  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).



350
351
352
353
354
 
# File 'lib/data_base/attachment/attach.rb', line 350

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

#interpolate(pattern, style = default_style) ⇒ Object

:nodoc:



481
482
483
484
485
486
487
488
489
 
# File 'lib/data_base/attachment/attach.rb', line 481

def interpolate(pattern, style = default_style) #:nodoc:
  interpolations = self.class.interpolations.sort{|a,b| a.first.to_s <=> b.first.to_s }
  interpolations.reverse.inject( pattern.dup ) do |result, interpolation|
    tag, blk = interpolation
    match    = blk.call(self, style)
    # If we use tag original we dont want to add :original to filename or url
    tag == :style && match == :original ? result.gsub(/:style_/, "") : result.gsub(/:#{tag}/, match.to_s)
  end
end

#log(message) ⇒ Object

:nodoc:



368
369
370
 
# File 'lib/data_base/attachment/attach.rb', line 368

def log message #:nodoc:
  logger.info("[Attachment] #{message}") if logging?
end

#logger ⇒ Object

:nodoc:



364
365
366
 
# File 'lib/data_base/attachment/attach.rb', line 364

def logger #:nodoc:
  instance.logger
end

#logging? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


372
373
374
 
# File 'lib/data_base/attachment/attach.rb', line 372

def logging? #:nodoc:
  Lipsiadmin::Attachment.options[:log]
end

#normalize_style_definition ⇒ Object

:nodoc:



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/data_base/attachment/attach.rb', line 393

def normalize_style_definition #:nodoc:
  @styles.each do |name, args|
    unless args.is_a? Hash
      dimensions, format = [args, nil].flatten[0..1]
      format             = nil if format.blank?
      @styles[name]      = {
        :processors      => @processors,
        :geometry        => dimensions,
        :format          => format,
        :whiny           => @whiny,
        :convert_options => extra_options_for(name)
      }
    else
      @styles[name] = {
        :processors => @processors,
        :whiny => @whiny,
        :convert_options => extra_options_for(name)
      }.merge(@styles[name])
    end
  end
end

#original_filename ⇒ Object

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



269
270
271
 
# File 'lib/data_base/attachment/attach.rb', line 269

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.



226
227
228
 
# File 'lib/data_base/attachment/attach.rb', line 226

def path(style = nil) #:nodoc:
  original_filename.nil? ? nil : interpolate(@path, style)
end

#post_process ⇒ Object

:nodoc:



437
438
439
440
441
442
443
444
 
# File 'lib/data_base/attachment/attach.rb', line 437

def post_process #:nodoc:
  return if @queued_for_write[:original].nil?
  background do
    return if fire_events(:before)
    post_process_styles
    return if fire_events(:after)
  end
end

#post_process_styles ⇒ Object

:nodoc:



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/data_base/attachment/attach.rb', line 451

def post_process_styles #:nodoc:
  log("Post-processing #{name}")
  @styles.each do |name, args|
    begin
      raise RuntimeError.new("Style #{name} has no processors defined.") if args[:processors].blank?
      @queued_for_write[name] = args[:processors].inject(@queued_for_write[:original]) do |file, processor|
        log("Processing #{name} #{file} in the #{processor} processor.")
        Lipsiadmin::Attachment.processor(processor).make(file, args)
      end
    rescue AttachmentError => e
      log("An error was received while processing: #{e.inspect}")
      (@errors[:processing] ||= []) << e.message if @whiny
    end
  end
end

#queue_existing_for_delete ⇒ Object

:nodoc:



491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/data_base/attachment/attach.rb', line 491

def queue_existing_for_delete #:nodoc:
  return unless exist?
  log("Queueing the existing files for #{name} for deletion.")
  @queued_for_delete += [:original, *@styles.keys].uniq.map do |style|
    path(style) if exists?(style)
  end.compact
  instance_write(:file_name, nil)
  instance_write(:content_type, nil)
  instance_write(:file_size, nil)
  instance_write(:updated_at, nil)
end

#reprocess! ⇒ Object

This method really shouldn’t be called that often. It’s expected use is in the attachment: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.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/data_base/attachment/attach.rb', line 324

def reprocess!
  new_original = Tempfile.new("attachment-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.



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/data_base/attachment/attach.rb', line 253

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.



275
276
277
 
# File 'lib/data_base/attachment/attach.rb', line 275

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

#solidify_style_definitions ⇒ Object

:nodoc:



415
416
417
418
419
420
421
 
# File 'lib/data_base/attachment/attach.rb', line 415

def solidify_style_definitions #:nodoc:
  @styles.each do |name, args|
    if @styles[name][:geometry].respond_to?(:call)
      @styles[name][:geometry] = @styles[name][:geometry].call(instance) 
    end
  end
end

#to_s(style = nil) ⇒ Object

Alias to url



231
232
233
 
# File 'lib/data_base/attachment/attach.rb', line 231

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.



287
288
289
290
 
# File 'lib/data_base/attachment/attach.rb', line 287

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



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/data_base/attachment/attach.rb', line 211

def url(style = default_style, include_updated_timestamp = true)
  if original_filename.nil?
    url = interpolate(@default_url, style)
  elsif File.exist?(path(style))
    url = interpolate(@url, style)
  else
    url = interpolate(@url, :original)
  end
  include_updated_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
end

#valid? ⇒ Boolean

Returns true if there are no errors on this attachment.

Returns:

  • (Boolean) 


236
237
238
239
 
# File 'lib/data_base/attachment/attach.rb', line 236

def valid?
  validate
  errors.empty?
end

#valid_assignment?(file) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


376
377
378
 
# File 'lib/data_base/attachment/attach.rb', line 376

def valid_assignment? file #:nodoc:
  file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
end

#validate ⇒ Object

:nodoc:



380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/data_base/attachment/attach.rb', line 380

def validate #:nodoc:
  unless @validation_errors
    @validation_errors = @validations.inject({}) do |errors, validation|
      name, block = validation
      errors[name] = block.call(self, instance) if block
      errors
    end
    @validation_errors.reject!{|k,v| v == nil }
    @errors.merge!(@validation_errors)
  end
  @validation_errors
end