attached 0.5.2 → 0.5.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 - 2011 Kevin Sylvestre
+Copyright (c) 2010 - 2012 Kevin Sylvestre
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -173,4 +173,4 @@ View:
   
 == Copyright
 
-Copyright (c) 2010 - 2011 Kevin Sylvestre. See LICENSE for details.
+Copyright (c) 2010 - 2012 Kevin Sylvestre. See LICENSE for details.

data/lib/attached.rb

@@ -2,19 +2,19 @@ require 'attached/attachment'
 require 'attached/railtie'
 
 
-module Attached  
-  
-  
+module Attached
+
+
   def self.included(base)
     base.extend ClassMethods
     base.class_attribute :attached_options
   end
-  
-  
+
+
   module Definition
     def attachment(*args)
       options = args.extract_options!
-      
+
       args.each do |name|
         column("#{name}_identifier", :string, options)
         column("#{name}_extension", :string, options)
@@ -22,11 +22,11 @@ module Attached
       end
     end
   end
-  
-  
+
+
   module ClassMethods
-    
-    
+
+
     # Add an attachment to a class.
     #
     # Options:
@@ -40,21 +40,21 @@ module Attached
     #   has_attached :video
     #   has_attached :video, :storage => :aws
     #   has_attached :video, styles => { :mov => { :size => "480p", :format => "mov" } }
-    
+
     def has_attached(name, options = {})
-      
+
       include InstanceMethods
-      
+
       self.attached_options ||= {}
       self.attached_options[name] = options
-      
+
       before_save :save_attached
       before_destroy :destroy_attached
-      
+
       define_method name do
         attachment_for(name)
       end
-      
+
       define_method "#{name}=" do |file|
         attachment_for(name).assign(file)
       end
@@ -62,43 +62,43 @@ module Attached
       define_method "#{name}?" do
         attachment_for(name).attached?
       end
-      
+
       validates_each(name) do |record, attr, value|
         attachment = record.attachment_for(name)
         attachment.errors.each do |error|
           record.errors.add(name, error)
         end
       end
-      
+
       after_validation do
-        
+
         if self.errors.include?(:"#{name}_size")
           self.errors[:"#{name}_size"].each do |message|
             self.errors.add(name, message)
           end
           self.errors[:"#{name}_size"].clear
         end
-        
+
         if self.errors.include?(:"#{name}_extension")
           self.errors[:"#{name}_extension"].each do |message|
             self.errors.add(name, message)
           end
           self.errors[:"#{name}_extension"].clear
         end
-        
+
         if self.errors.include?(:"#{name}_identifier")
           self.errors[:"#{name}_identifier"].each do |message|
             self.errors.add(name, message)
           end
           self.errors[:"#{name}_identifier"].clear
         end
-        
+
       end
-      
+
     end
-    
-    
-    # Validates an attached size in a specified range or minimum and maximum. 
+
+
+    # Validates an attached size in a specified range or minimum and maximum.
     #
     # Options:
     #
@@ -108,64 +108,64 @@ module Attached
     # * :in - range of bytes for file
     #
     # Usage:
-    #   
+    #
     #   validates_attached_size :avatar, :range => 10.megabytes .. 20.megabytes
     #   validates_attached_size :avatar, :minimum => 10.megabytes, :maximum => 20.megabytes
     #   validates_attached_size :avatar, :message => "size must be between :minimum and :maximum bytes"
-    
+
     def validates_attached_size(name, options = {})
-      
+
       zero = (0.0 / 1.0)
       infi = (1.0 / 0.0)
-       
+
       minimum = options[:minimum] || options[:in] && options[:in].first || zero
       maximum = options[:maximum] || options[:in] && options[:in].last  || infi
-      
+
       message = options[:message]
       message ||= "size must be specified" if minimum == zero && maximum == infi
       message ||= "size must be a minimum of :minimum" if maximum == infi
       message ||= "size must be a maximum of :maximum" if minimum == zero
       message ||= "size must be between :minimum and :maximum"
-       
+
       range = minimum..maximum
-      
+
       message.gsub!(/:minimum/, number_to_size(minimum)) unless minimum == zero
       message.gsub!(/:maximum/, number_to_size(maximum)) unless maximum == infi
-      
-      validates_inclusion_of :"#{name}_size", :in => range, :message => message, 
+
+      validates_inclusion_of :"#{name}_size", :in => range, :message => message,
         :if => options[:if], :unless => options[:unless]
-      
+
     end
-    
-    
-    # Validates an attached extension in a specified set. 
+
+
+    # Validates an attached extension in a specified set.
     #
     # Options:
     #
     # * :in - allowed values for attached
     #
     # Usage:
-    #   
+    #
     #   validates_attached_extension :avatar, :is => 'png'
     #   validates_attached_extension :avatar, :in => %w(png jpg)
     #   validates_attached_extension :avatar, :in => [:png, :jpg]
     #   validates_attached_extension :avatar, :in => %w(png jpg), :message => "extension must be :in"
     #   validates_attached_extension :avatar, :in => %w(png jpg), :message => "extension must be :in"
-    
+
     def validates_attached_extension(name, options = {})
-      
+
       message = options[:message]
       message ||= "extension is invalid"
-      
+
       options[:in] ||= [options[:is]] if options[:is]
-       
+
       range = options[:in].map { |element| ".#{element}" }
-      
+
       validates_inclusion_of :"#{name}_extension", :in => range, :message => message,
         :if => options[:if], :unless => options[:unless]
     end
-    
-    
+
+
     # Validates that an attachment is included.
     #
     # Options:
@@ -176,21 +176,21 @@ module Attached
     #
     #   validates_attached_presence :avatar
     #   validates_attached_presence :avatar, :message => "must be attached"
-    
+
     def validates_attached_presence(name, options = {})
-      
+
       message = options[:message]
       message ||= "must be attached"
-      
+
       validates_presence_of :"#{name}_identifier", :message => message,
         :if => options[:if], :unless => options[:unless]
-      
+
     end
-    
-    
+
+
   private
-  
-  
+
+
     # Convert a number to a human readable size.
     #
     # Usage:
@@ -199,75 +199,75 @@ module Attached
     #   number_to_size(2) # 2 bytes
     #   number_to_size(1024) # 1 kilobyte
     #   number_to_size(2048) # 2 kilobytes
-    
+
     def number_to_size(number, options = {})
       return if number == 0.0 / 1.0
       return if number == 1.0 / 0.0
-      
+
       singular = options['singular'] || 1
       base     = options['base']     || 1024
       units    = options['units']    || ["byte", "kilobyte", "megabyte", "gigabyte", "terabyte", "petabyte"]
-      
+
       exponent = (Math.log(number) / Math.log(base)).floor
-      
+
       number /= base ** exponent
       unit = units[exponent]
-      
+
       number == singular ?  unit.gsub!(/s$/, '') : unit.gsub!(/$/, 's')
-      
+
       "#{number} #{unit}"
     end
-    
-    
+
+
   end
-  
-  
+
+
   module InstanceMethods
-    
-    
+
+
     # Create or access attachment.
     #
     # Usage:
-    # 
+    #
     #    attachment_for :avatar
-    
+
     def attachment_for(name)
       @_attached_attachments ||= {}
       @_attached_attachments[name] ||= Attachment.new(name, self, self.class.attached_options[name])
     end
-    
-    
+
+
     # Log and save all attached (using specified storage).
     #
     # Usage:
     #
     #   before_save :save_attached
-    
+
     def save_attached
       logger.info "[attached] save attached"
-      
-      self.class.attached_options.each do |name, options| 
+
+      self.class.attached_options.each do |name, options|
         attachment_for(name).save
       end
     end
-    
-    
+
+
     # Log and destroy all attached (using specified storage).
     #
     # Usage:
     #
     #   before_save :destroy_attached
-    
+
     def destroy_attached
       logger.info "[attached] destroy attached"
-      
+
       self.class.attached_options.each do |name, options|
         attachment_for(name).destroy
       end
     end
-    
-    
+
+
   end
-  
-  
+
+
 end

data/lib/attached/attachment.rb

@@ -7,10 +7,10 @@ require 'attached/processor'
 require 'attached/processor/error'
 
 module Attached
-  
+
   class Attachment
-    
-    
+
+
     attr_reader :file
     attr_reader :name
     attr_reader :instance
@@ -30,14 +30,14 @@ module Attached
     attr_reader :alias
     attr_reader :storage
     attr_reader :host
-    
-    
+
+
     # A default set of options that can be extended to customize the path, storage or credentials.
     #
     # Usage:
     #
     #   Attached::Attachment.options = { :storage => :fs, :path => ":name/:style/:identifier:extension" }
-    
+
     def self.options
       @options ||= {
         :path        => ":name/:style/:identifier:extension",
@@ -47,12 +47,12 @@ module Attached
         :credentials => {},
       }
     end
-    
-    
+
+
     # Initialize a new attachment by providing a name and the instance the attachment is associated with.
     #
     # Parameters:
-    # 
+    #
     # * name        - The name for the attachment such as 'avatar' or 'photo'
     # * instance    - The instance the attachment is attached to
     #
@@ -64,23 +64,23 @@ module Attached
     # * :medium      - A symbol or subclass of 'Attached::Storage::Base' to be used
     # * :processor   - A symbol or subclass of 'Attached::Processor::Base' to be used
     # * :alias       - A string representing a fully qualified host alias
-    # * :processors  - An array of processors 
+    # * :processors  - An array of processors
     # * :aliases     - An array of aliases
-    
+
     def initialize(name, instance, options = {})
       options      = self.class.options.clone.merge(options)
-      
+
       options[:styles]     ||= {}
       options[:aliases]    ||= []
       options[:processors] ||= []
-      
+
       @name        = name
       @instance    = instance
-      
+
       @queue       = {}
       @purge       = []
       @errors      = []
-      
+
       @path        = options[:path]
       @missing     = options[:missing]
       @styles      = options[:styles]
@@ -92,116 +92,116 @@ module Attached
       @processor   = options[:processor]
       @aliases     = options[:aliases]
       @alias       = options[:alias]
-      
+
       @aliases     = self.aliases << self.alias if self.alias
       @processors  = self.processors << self.processor if self.processor
-      
+
       @storage     = Attached::Storage.storage(self.medium, self.credentials)
-      
+
       @host        = self.storage.host
     end
-    
-    
+
+
     # Check if an attachment has been modified.
     #
     # Usage:
     #
     #   @object.avatar.changed?
-    
+
     def changed?
       instance.changed.include? "#{name}_identifier"
     end
-    
-    
+
+
     # Check if an attachment is present.
     #
     # Usage:
     #
     #   @object.avatar.file?
-    
+
     def file?
       not identifier.blank?
     end
-    
-    
+
+
     # Check if an attachment is present.
     #
     # Usage:
     #
     #   @object.avatar.attached?
-    
+
     def attached?
       not identifier.blank?
     end
-    
-    
+
+
     # Custom setter for specifying an attachment.
-    # 
+    #
     # Usage:
     #
     #    @object.avatar.file = File.open(...)
-    
+
     def file=(file)
       @file = file
       @file = file.tempfile if file.respond_to?(:tempfile)
     end
-    
-    
+
+
     # Assign an attachment to a file.
     #
     # Usage:
     #
     #   @object.avatar.assign(...)
-    
+
     def assign(file, identifier = Identifier.generate)
       self.file = file
-      
+
       if file
         extension ||= file.extension if file.respond_to? :extension
         extension ||= File.extname(file.original_filename) if file.respond_to? :original_filename
         extension ||= File.extname(file.path) if file.respond_to? :path
-        
+
         size ||= file.size if file.respond_to? :size
         size ||= File.size(file.path) if file.respond_to? :path
       end
-      
+
       @purge = [self.path, *self.styles.map { |style, options| self.path(style) }] if attached?
-      
+
       self.size       = file ? size       : nil
       self.extension  = file ? extension  : nil
       self.identifier = file ? identifier : nil
-      
+
       process if file
     end
-    
-    
+
+
     # Save an attachment.
     #
     # Usage:
     #
     #   @object.avatar.save
-    
-    def save      
+
+    def save
       self.queue.each do |style, file|
         path = self.path(style)
         self.storage.save(file, path) if file and path
       end
-      
+
       self.purge.each do |path|
         self.storage.destroy(path)
       end
-      
+
       @purge = []
       @queue = {}
     end
-    
-    
+
+
     # Destroy an attachment.
     #
     # Usage:
     #
     #   @object.avatar.destroy
-    
+
     def destroy
       if attached?
         self.storage.destroy(self.path)
@@ -209,12 +209,12 @@ module Attached
           self.storage.destroy(self.path(style))
         end
       end
-      
+
       @purge = []
       @queue = {}
     end
-    
-    
+
+
     # Acesss the URL for an attachment.
     #
     # Usage:
@@ -222,28 +222,28 @@ module Attached
     #   @object.avatar.url
     #   @object.avatar.url(:small)
     #   @object.avatar.url(:large)
-    
+
     def url(style = self.default)
       path = self.path(style)
-      
+
       host = self.host
       host = self.aliases[path.hash % self.aliases.count] unless self.aliases.empty?
-      
+
       return "#{host}#{path}"
     end
-    
-    
-    # Access the path for an attachment. 
+
+
+    # Access the path for an attachment.
     #
     # Usage:
     #
     #   @object.avatar.url
     #   @object.avatar.url(:small)
     #   @object.avatar.url(:large)
-    
+
     def path(style = self.default)
       path = self.attached? ? @path.clone : @missing.clone
-      
+
       path.gsub!(/:name/, name.to_s)
       path.gsub!(/:style/, style.to_s)
       path.gsub!(/:extension/, extension(style).to_s)
@@ -251,168 +251,168 @@ module Attached
 
       return path
     end
-    
-    
+
+
     # Access the size for an attachment.
     #
     # Usage:
     #
     # @object.avatar.size
-    
+
     def size
       return instance_get(:size)
     end
-    
-    
+
+
     # Access the status for an attachment.
     #
     # Usage:
     #
     # @object.avatar.status
-    
+
     def status
       instance_get(:status)
     end
-    
-    
-    # Access the extension for an attachment. It will first check the styles 
+
+
+    # Access the extension for an attachment. It will first check the styles
     # to see if one is specified before checking the instance.
     #
     # Usage:
     #
     # @object.avatar.extension
-    
+
     def extension(style = nil)
       style and
-      self.styles and 
-      self.styles[style] and 
-      self.styles[style][:extension] or 
+      self.styles and
+      self.styles[style] and
+      self.styles[style][:extension] or
       instance_get(:extension)
     end
-    
-    
-    # Access the identifier for an attachment. It will first check the styles 
+
+
+    # Access the identifier for an attachment. It will first check the styles
     # to see if one is specified before checking the instance.
     #
     # Usage:
     #
     # @object.avatar.identifier
-    
+
     def identifier(style = nil)
       style and
-      self.styles and 
-      self.styles[style] and 
-      self.styles[style][:identifier] or 
+      self.styles and
+      self.styles[style] and
+      self.styles[style][:identifier] or
       instance_get(:identifier)
     end
-    
-    
+
+
     # Set the size for an attachment.
     #
     # Usage:
     #
     # @object.avatar.size = 1024
-    
+
     def size=(size)
       instance_set(:size, size)
     end
-    
-    
+
+
     # Set the status for an attachment.
     #
     # Usage:
     #
     # @object.avatar.status = 'processing'
-    
+
     def status=(status)
       instance_set(:size, status)
     end
-    
-    
-    # Set the extension for an attachment. It will act independently of the 
+
+
+    # Set the extension for an attachment. It will act independently of the
     # defined style.
     #
     # Usage:
     #
     # @object.avatar.extension = ".png"
-    
+
     def extension=(extension)
       instance_set(:extension, extension)
     end
-    
-    
-    # Set the identifier for an attachment. It will act independently of the 
+
+
+    # Set the identifier for an attachment. It will act independently of the
     # defined style.
     #
     # Usage:
     #
     # @object.avatar.identifier = "1234"
-    
+
     def identifier=(identifier)
       instance_set(:identifier, identifier)
     end
-    
-    
+
+
     # Access the original file .
-    
+
     def reprocess!
       self.file = self.storage.retrieve(self.path)
-      
+
       process
     end
-    
-    
+
+
   private
-    
-  
+
+
     # Helper function for calling processors (will queue default).
     #
     # Usage:
     #
     #   self.process
-    
+
     def process
       self.queue[self.default] = self.file
-              
+
       begin
-      
+
         self.processors.each do |processor|
           processor = Attached::Processor.processor(processor)
           self.styles.each do |style, options|
             self.queue[style] = processor.process(self.queue[style] || self.file, options, self)
           end
         end
-        
+
       rescue Attached::Processor::Error => error
         self.errors << error.message
       end
     end
-  
-  
+
+
     # Helper function for setting instance variables.
-    # 
+    #
     # Usage:
     #
     #   self.instance_set(size, 12345)
-  
+
     def instance_set(attribute, value)
       setter = :"#{self.name}_#{attribute}="
       self.instance.send(setter, value) if instance.respond_to?(setter)
     end
-    
-    
+
+
     # Helper function for getting instance variables.
     #
     # Usage:
     #
     # self.instance_get(size)
-    
+
     def instance_get(attribute)
       getter = :"#{self.name}_#{attribute}"
       self.instance.send(getter) if instance.respond_to?(getter)
     end
 
-    
+
   end
-  
+
 end