attached 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e45f92f25ab1b73622afb14386c57fc6cf0d8a5
-  data.tar.gz: 0e27bcc32bda3d8655571e1e5f3a272b471ee77b
+  metadata.gz: 8bc176dbc2ad38b99ab49a128971f1e32103e009
+  data.tar.gz: d56c4292c0979d826074d95546d42a7907edb677
 SHA512:
-  metadata.gz: 724488b8ed45dd27a81f7576a3c9c74448e1a582343e3634f634e4ae3cbe497a6298478425ee11afc4f7d29505130ac858d22e961e9cf031a89fa1899090152f
-  data.tar.gz: 4d252660428dfc6bde86c5def8f18bfa232e43790235a92fb5b1c0857a497f9996c2041b5c08ec31908e40c4991be940c508e647ebe1185d74f31193abff344c
+  metadata.gz: 862c1a697e68afe188aba95ef8e1b3db5b241f666d2d314630a11b558f0e1f31caf31e6a8b12a7658b9ebbacd75ebc517b1513fa941662a8b4962fe952bdf4f6
+  data.tar.gz: 0426cbf46893ad05460682f7f7153168923409919f26e3e1ca73741dfd11eaf024008b0f9ee736f6823c5bd235e8f9aff452a119c74c98b82833bbc5b062ad10

data/README.rdoc

@@ -6,8 +6,8 @@ Attached is a Ruby on Rails file attachment tool that lets users upload to the c
 
 The gem is tested with:
 
-* Ruby on Rails 4.1.1
-* Ruby on Rails 4.0.5
+* Ruby on Rails 4.1.2
+* Ruby on Rails 4.0.6
 * Ruby 2.1.2
 * Ruby 2.0.0
 * Ruby 1.9.3
@@ -166,9 +166,10 @@ View:
 
 == Status
 
-{<img src="http://img.shields.io/gemnasium/ksylvest/attached.svg" />}[https://gemnasium.com/ksylvest/attached]
-{<img src="http://img.shields.io/travis/ksylvest/attached.svg" />}[https://travis-ci.org/ksylvest/attached]
-{<img src="http://img.shields.io/codeclimate/github/ksylvest/attached.svg" />}[https://codeclimate.com/github/ksylvest/attached]
+{<img src="https://img.shields.io/gemnasium/ksylvest/attached.svg" />}[https://gemnasium.com/ksylvest/attached]
+{<img src="https://img.shields.io/travis/ksylvest/attached.svg" />}[https://travis-ci.org/ksylvest/attached]
+{<img src="https://img.shields.io/coveralls/ksylvest/attached.svg" />}[https://coveralls.io/r/ksylvest/attached]
+{<img src="https://img.shields.io/codeclimate/github/ksylvest/attached.svg" />}[https://codeclimate.com/github/ksylvest/attached]
 
 == Copyright
 

data/Rakefile

@@ -14,9 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'

data/lib/attached.rb

@@ -1,37 +1,20 @@
+require 'attached/definition'
 require 'attached/attachment'
+require 'attached/attatcher'
 require 'attached/railtie'
 
-
 module Attached
 
-
   def self.mock!
     Fog.mock!
   end
 
-
   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)
-        column("#{name}_size", :integer, options)
-      end
-    end
   end
 
-
   module ClassMethods
 
-
     # Add an attachment to a class.
     #
     # Options:
@@ -43,70 +26,13 @@ module Attached
     # Usage:
     #
     #   has_attached :video
-    #   has_attached :video, :storage => :aws
-    #   has_attached :video, styles => { :mov => { :size => "480p", :format => "mov" } }
+    #   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
-
-      define_method "#{name}?" do
-        attachment_for(name).attached?
-      end
-
-      define_method "#{name}_url=" do |url|
-        attachment_for(name).url = url
-      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
-
+      Attatcher.define(self, name, options)
     end
 
-
     # Validates an attached size in a specified range or minimum and maximum.
     #
     # Options:
@@ -118,9 +44,9 @@ module Attached
     #
     # 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"
+    #   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 = {})
 
@@ -141,12 +67,11 @@ module Attached
       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,
-        :if => options[:if], :unless => options[:unless]
+      validates_inclusion_of :"#{name}_size", in: range, message: message,
+        if: options[:if], unless: options[:unless]
 
     end
 
-
     # Validates an attached extension in a specified set.
     #
     # Options:
@@ -155,11 +80,11 @@ module 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"
+    #   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 = {})
 
@@ -170,11 +95,10 @@ module Attached
 
       range = options[:in].map { |element| ".#{element}" }
 
-      validates_inclusion_of :"#{name}_extension", :in => range, :message => message,
-        :if => options[:if], :unless => options[:unless]
+      validates_inclusion_of :"#{name}_extension", in: range, message: message,
+        if: options[:if], unless: options[:unless]
     end
 
-
     # Validates that an attachment is included.
     #
     # Options:
@@ -184,22 +108,20 @@ module Attached
     # Usage:
     #
     #   validates_attached_presence :avatar
-    #   validates_attached_presence :avatar, :message => "must be attached"
+    #   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]
+      validates_presence_of :"#{name}_identifier", message: message,
+        if: options[:if], unless: options[:unless]
 
     end
 
-
   private
 
-
     # Convert a number to a human readable size.
     #
     # Usage:
@@ -213,9 +135,9 @@ module Attached
       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"]
+      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
 
@@ -227,56 +149,6 @@ module Attached
       "#{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|
-        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

@@ -1,18 +1,13 @@
 require 'open-uri'
-
 require 'identifier'
-
 require 'attached/storage'
 require 'attached/storage/error'
-
 require 'attached/processor'
 require 'attached/processor/error'
 
 module Attached
-
   class Attachment
 
-
     attr_reader :file
     attr_reader :name
     attr_reader :instance
@@ -33,25 +28,23 @@ module Attached
     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" }
+    #   Attached::Attachment.options = { storage: :fs, path: ":name/:style/:identifier:extension" }
 
     def self.options
       @options ||= {
-        :path        => ":name/:style/:identifier:extension",
-        :missing     => ":name/:style/missing:extension",
-        :default     => :original,
-        :medium      => :local,
-        :credentials => {},
-        :metadata    => { 'Cache-Control' => 'max-age=3153600' }
+        path: ":name/:style/:identifier:extension",
+        missing: ":name/:style/missing:extension",
+        default: :original,
+        medium: :local,
+        credentials: {},
+        metadata: { 'Cache-Control' => 'max-age=3153600' }
       }
     end
 
-
     # Initialize a new attachment by providing a name and the instance the attachment is associated with.
     #
     # Parameters:
@@ -71,7 +64,7 @@ module Attached
     # * :aliases     - An array of aliases
 
     def initialize(name, instance, options = {})
-      options      = self.class.options.clone.merge(options)
+      options = self.class.options.clone.merge(options)
 
       options[:styles]     ||= {}
       options[:aliases]    ||= []
@@ -79,11 +72,9 @@ module Attached
 
       @name        = name
       @instance    = instance
-
       @queue       = {}
       @purge       = []
       @errors      = []
-
       @path        = options[:path]
       @missing     = options[:missing]
       @styles      = options[:styles]
@@ -95,16 +86,12 @@ 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:
@@ -115,7 +102,6 @@ module Attached
       instance.changed.include? "#{name}_identifier"
     end
 
-
     # Check if an attachment is present.
     #
     # Usage:
@@ -126,7 +112,6 @@ module Attached
       not identifier.blank?
     end
 
-
     # Check if an attachment is present.
     #
     # Usage:
@@ -137,7 +122,6 @@ module Attached
       not identifier.blank?
     end
 
-
     # Custom setter for specifying an attachment.
     #
     # Usage:
@@ -148,7 +132,6 @@ module Attached
       @file = file.respond_to?(:tempfile) ? file.tempfile : file
     end
 
-
     # Assign an attachment to a file.
     #
     # Usage:
@@ -162,7 +145,6 @@ module Attached
         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
@@ -176,7 +158,6 @@ module Attached
       process if file
     end
 
-
     # Assign an attachment to a file.
     #
     # Usage:
@@ -185,16 +166,12 @@ module Attached
 
     def url=(url)
       extension = File.extname(url)
-
       file = Tempfile.new(["", extension])
       file.binmode
-
       file << open(url).read
-
       self.assign(file)
     end
 
-
     # Save an attachment.
     #
     # Usage:
@@ -206,16 +183,13 @@ module Attached
         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:
@@ -229,12 +203,10 @@ module Attached
           self.storage.destroy(self.path(style))
         end
       end
-
       @purge = []
       @queue = {}
     end
 
-
     # Acesss the URL for an attachment.
     #
     # Usage:
@@ -245,14 +217,11 @@ module Attached
 
     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.
     #
     # Usage:
@@ -263,16 +232,13 @@ module Attached
 
     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)
       path.gsub!(/:identifier/, identifier(style).to_s)
-
       return path
     end
 
-
     # Access the size for an attachment.
     #
     # Usage:
@@ -283,7 +249,6 @@ module Attached
       return instance_get(:size)
     end
 
-
     # Access the status for an attachment.
     #
     # Usage:
@@ -294,7 +259,6 @@ module Attached
       instance_get(:status)
     end
 
-
     # Access the extension for an attachment. It will first check the styles
     # to see if one is specified before checking the instance.
     #
@@ -310,7 +274,6 @@ module Attached
       instance_get(:extension)
     end
 
-
     # Access the identifier for an attachment. It will first check the styles
     # to see if one is specified before checking the instance.
     #
@@ -326,7 +289,6 @@ module Attached
       instance_get(:identifier)
     end
 
-
     # Set the size for an attachment.
     #
     # Usage:
@@ -337,7 +299,6 @@ module Attached
       instance_set(:size, size)
     end
 
-
     # Set the status for an attachment.
     #
     # Usage:
@@ -348,7 +309,6 @@ module Attached
       instance_set(:size, status)
     end
 
-
     # Set the extension for an attachment. It will act independently of the
     # defined style.
     #
@@ -360,7 +320,6 @@ module Attached
       instance_set(:extension, extension)
     end
 
-
     # Set the identifier for an attachment. It will act independently of the
     # defined style.
     #
@@ -372,19 +331,15 @@ module Attached
       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:
@@ -393,22 +348,18 @@ module Attached
 
     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:
@@ -420,7 +371,6 @@ module Attached
       self.instance.send(setter, value) if instance.respond_to?(setter)
     end
 
-
     # Helper function for getting instance variables.
     #
     # Usage:
@@ -432,7 +382,5 @@ module Attached
       self.instance.send(getter) if instance.respond_to?(getter)
     end
 
-
   end
-
 end