dragonfly 0.9.8 → 0.9.9

data/extra_docs/Rails3.md

@@ -35,7 +35,7 @@ application.rb:
 Gemfile
 -------
 
-    gem 'dragonfly', '~>0.9.8'
+    gem 'dragonfly', '~>0.9.9'
     gem 'rack-cache', :require => 'rack/cache'
 
 Capistrano

data/extra_docs/URLs.md

@@ -87,11 +87,16 @@ Downloaded filename
 To specify the filename the browser uses for 'Save As' dialogues:
 
     app.content_filename = proc{|job, request|
-      "#{job.basename}_#{job.process_steps.first.name}.#{job.format}"
+      if job.process_steps.any?
+        "#{job.basename}_#{job.process_steps.first.name}.#{job.format}"
+      else
+        "#{job.basename}.#{job.format}"
+      end
     }
 
 This will for example give the following filenames for the following jobs:
 
+    app.fetch('some/tree.png')                          # -> 'tree.png'
     app.fetch('some/tree.png').process(:greyscale)      # -> 'tree_greyscale.png'
     app.fetch('some/tree.png').process(:greyscale).gif  # -> 'tree_greyscale.gif'
 
@@ -141,6 +146,8 @@ Rails 3 (routes.rb):
 
 In each case the url will need to be generated by the router of choice, or manually.
 
+NOTE: Ruby treats curly braces slightly differently to `do`...`end` so be aware of this when using the above examples.
+
 Simple Endpoints
 ----------------
 {Dragonfly::Job Job} objects can also be turned straight into Rack endpoints using `to_app`, e.g. in Rails 3:

data/lib/dragonfly.rb

@@ -3,7 +3,7 @@
 # The convention is that dirs are modules
 # so declare them here and autoload any modules/classes inside them
 # All paths here are absolute
-def camelize(path)
+camelize = proc do |path|
   # e.g. 'test/this_one' => Test::ThisOne
   "#{path}".
     chomp('/').
@@ -12,27 +12,26 @@ def camelize(path)
     gsub('_','').
     sub(/^(\w)/){ $1.upcase }
 end
-def autoload_files_in_dir(path, namespace)
+
+autoload_files_in_dir = proc do |path, namespace|
   # Define the module
   eval("module #{namespace}; end")
   # Autoload modules/classes in that module
   Dir.glob("#{path}/*.rb").each do |file|
     file = File.expand_path(file)
-    sub_const_name = camelize( File.basename(file, '.rb') )
+    sub_const_name = camelize[ File.basename(file, '.rb') ]
     eval("#{namespace}.autoload('#{sub_const_name}', '#{file}')")
   end
   # Recurse on subdirectories
   Dir.glob("#{path}/*/").each do |dir|
-    sub_namespace = camelize( File.basename(dir) )
-    autoload_files_in_dir(dir, "#{namespace}::#{sub_namespace}")
+    sub_namespace = camelize[ File.basename(dir) ]
+    autoload_files_in_dir[dir, "#{namespace}::#{sub_namespace}"]
   end
 end
 
-autoload_files_in_dir("#{File.dirname(__FILE__)}/dragonfly", 'Dragonfly')
+autoload_files_in_dir["#{File.dirname(__FILE__)}/dragonfly", 'Dragonfly']
 
 require 'dragonfly/core_ext/object'
-require 'dragonfly/core_ext/string'
-require 'dragonfly/core_ext/symbol'
 require 'dragonfly/core_ext/array'
 require 'dragonfly/core_ext/hash'
 

data/lib/dragonfly/active_model_extensions/attachment.rb

@@ -14,15 +14,17 @@ module Dragonfly
         :data, :to_file, :file, :tempfile, :path,
         :process, :encode, :analyse,
         :meta, :meta=,
-        :name, :basename, :ext, :size,
+        :name, :size,
         :url
 
+      include HasFilename
+
       alias_method :length, :size
       
       def initialize(model)
         @model = model
         self.uid = model_uid
-        update_from_uid if uid
+        set_job_from_uid if uid
         @should_run_callbacks = true
         self.class.ensure_uses_cached_magic_attributes
       end
@@ -50,10 +52,11 @@ module Dragonfly
           else app.new_job(value)
           end
           set_magic_attributes
-          update_meta
+          job.url_attrs = all_extra_attributes
           self.class.run_callbacks(:after_assign, model, self) if should_run_callbacks?
           retain! if should_retain?
         end
+        model_uid_will_change!
         value
       end
 
@@ -79,9 +82,8 @@ module Dragonfly
       end
 
       def name=(name)
-        job.name = name
         set_magic_attribute(:name, name) if has_magic_attribute_for?(:name)
-        name
+        job.name = name
       end
 
       def process!(*args)
@@ -150,7 +152,7 @@ module Dragonfly
             model.send("#{attribute}_#{key}=", value)
           end
           sync_with_model
-          update_from_uid
+          set_job_from_uid
           self.retained = true
         end
       end
@@ -172,6 +174,7 @@ module Dragonfly
       end
 
       def store_job!
+        meta.merge!(all_extra_attributes)
         opts = self.class.evaluate_storage_opts(model, self)
         set_uid_and_model_uid job.store(opts)
         self.job = job.to_fetched_job(uid)
@@ -210,6 +213,11 @@ module Dragonfly
         model.send("#{attribute}_uid")
       end
 
+      def model_uid_will_change!
+        meth = "#{attribute}_uid_will_change!"
+        model.send(meth) if model.respond_to?(meth)
+      end
+      
       attr_reader :model, :uid
       attr_writer :job
       attr_accessor :previous_uid
@@ -219,17 +227,6 @@ module Dragonfly
         @uid = uid
       end
 
-      def update_meta
-        magic_attributes.each{|property| meta[property] = model.send("#{attribute}_#{property}") }
-        meta[:model_class] = model.class.name
-        meta[:model_attachment] = attribute
-      end
-
-      def update_from_uid
-        self.job = app.fetch(uid)
-        update_meta
-      end
-
       def magic_attributes
         self.class.magic_attributes
       end
@@ -254,6 +251,29 @@ module Dragonfly
         model.send("#{attribute}_#{property}")
       end
 
+      def magic_attributes_hash
+        magic_attributes.inject({}) do |attrs, property|
+          attrs[property] = model.send("#{attribute}_#{property}")
+          attrs
+        end
+      end
+
+      def extra_attributes
+        @extra_attributes ||= {
+          :model_class => model.class.name,
+          :model_attachment => attribute
+        }
+      end
+      
+      def all_extra_attributes
+        magic_attributes_hash.merge(extra_attributes)
+      end
+      
+      def set_job_from_uid
+        self.job = app.fetch(uid)
+        job.url_attrs = all_extra_attributes
+      end
+
     end
   end
 end

data/lib/dragonfly/active_model_extensions/attachment_class_methods.rb

@@ -95,7 +95,7 @@ module Dragonfly
 
         # Magic attributes
         def allowed_magic_attributes
-          app.analyser.analysis_method_names + [:size, :basename, :name, :ext, :meta]
+          app.analyser.analysis_method_names + [:size, :name]
         end
 
         def magic_attributes

data/lib/dragonfly/active_model_extensions/validations.rb

@@ -2,38 +2,65 @@ module Dragonfly
   module ActiveModelExtensions
     module Validations
 
-      private
-
-      def validates_property(property_name, opts)
-        attrs = opts[:of] or raise ArgumentError, "you need to provide the attribute which has the property, using :of => <attribute_name>"
-        attrs = [attrs].flatten #(make sure it's an array)
-
-        raise ArgumentError, "you must provide either :in => [<value1>, <value2>..] or :as => <value>" unless opts[:in] || opts[:as]
-        allowed_values = opts[:in] || [opts[:as]]
-
-        args = attrs + [opts]
-        validates_each(*args) do |model, attr, attachment|
+      class PropertyValidator < ActiveModel::EachValidator
+        
+        def validate_each(model, attribute, attachment)
           if attachment
             property = attachment.send(property_name)
-            unless allowed_values.include?(property)
-              message = opts[:message] ||
-                "#{property_name.to_s.humanize.downcase} is incorrect. "+
-                "It needs to be #{Validations.expected_values_string(allowed_values)}"+
-                (property ? ", but was '#{property}'" : "")
-              message = message.call(property, model) if message.respond_to?(:call)
-              model.errors.add(attr, message)
-            end
+            model.errors.add(attribute, message(property, model)) unless matches?(property)
           end
         end
-
+        
+        private
+        
+        def matches?(property)
+          if case_insensitive?
+            prop = property.to_s.downcase
+            allowed_values.any?{|v| v.to_s.downcase == prop }
+          else
+            allowed_values.include?(property)
+          end
+        end
+        
+        def message(property, model)
+          message = options[:message] ||
+            "#{property_name.to_s.humanize.downcase} is incorrect. " +
+            "It needs to be #{expected_values_string}" +
+            (property ? ", but was '#{property}'" : "")
+          message.respond_to?(:call) ? message.call(property, model) : message
+        end
+        
+        def check_validity!
+          raise ArgumentError, "you must provide either :in => [<value1>, <value2>..] or :as => <value>" unless options[:in] || options[:as]
+        end
+        
+        def property_name
+          options[:property_name]
+        end
+        
+        def case_insensitive?
+          options[:case_sensitive] == false
+        end
+        
+        def allowed_values
+          @allowed_values ||= options[:in] || [options[:as]]
+        end
+        
+        def expected_values_string
+          if allowed_values.is_a?(Range)
+            "between #{allowed_values.first} and #{allowed_values.last}"
+          else
+            allowed_values.length > 1 ? "one of '#{allowed_values.join('\', \'')}'" : "'#{allowed_values.first.to_s}'"
+          end
+        end
+        
       end
 
-      def self.expected_values_string(allowed_values)
-        if allowed_values.is_a?(Range)
-          "between #{allowed_values.first} and #{allowed_values.last}"
-        else
-          allowed_values.length > 1 ? "one of '#{allowed_values.join('\', \'')}'" : "'#{allowed_values.first.to_s}'"
-        end
+      private
+
+      def validates_property(property_name, options)
+        raise ArgumentError, "you need to provide the attribute which has the property, using :of => <attribute_name>" unless options[:of]
+        validates_with PropertyValidator, options.merge(:attributes => [*options[:of]], :property_name => property_name)
       end
 
     end

data/lib/dragonfly/analyser.rb

@@ -21,7 +21,7 @@ module Dragonfly
     
     def analyse(temp_object, method, *args)
       if enable_cache
-        key = [temp_object.object_id, method, *args]
+        key = [temp_object.unique_id, method, *args]
         cache[key] ||= call_last(method, temp_object, *args)
       else
         call_last(method, temp_object, *args)

data/lib/dragonfly/app.rb

@@ -86,7 +86,7 @@ module Dragonfly
     end
 
     def store(object, opts={})
-      temp_object = object.is_a?(TempObject) ? object : TempObject.new(object)
+      temp_object = object.is_a?(TempObject) ? object : TempObject.new(object, opts[:meta] || {})
       datastore.store(temp_object, opts)
     end
 

data/lib/dragonfly/config/heroku.rb

@@ -4,6 +4,13 @@ module Dragonfly
     module Heroku
 
       def self.apply_configuration(app, bucket_name)
+        app.log.warn("""HEROKU CONFIGURATION IS NOW DEPRECATED - you should configure with the S3 Datastore directly, e.g.
+  c.datastore = Dragonfly::DataStorage::S3DataStore.new(
+    :bucket_name => '#{bucket_name}',
+    :access_key_id => 'XXX',
+    :secret_access_key => 'XXX'
+  )
+""")
         app.configure do |c|
           c.datastore = DataStorage::S3DataStore.new
           c.datastore.configure do |d|

data/lib/dragonfly/configurable.rb

@@ -9,13 +9,6 @@ module Dragonfly
       klass.class_eval do
         include Configurable::InstanceMethods
         extend Configurable::ClassMethods
-
-        # We should use configured_class rather than self.class
-        # because sometimes this will be the eigenclass of an object
-        # e.g. if we configure a module, etc.
-        define_method :configured_class do
-          klass
-        end
       end
     end
 
@@ -46,21 +39,17 @@ module Dragonfly
       def has_config_method?(method_name)
         config_methods.include?(method_name.to_sym)
       end
-            
-      def config_methods
-        @config_methods ||= configured_class.config_methods.dup
-      end
       
       def configuration
         @configuration ||= {}
       end
+            
+      def config_methods
+        @config_methods ||= self.class.config_methods.dup
+      end
       
       def default_configuration
-        # Merge the default configuration of all ancestor classes/modules which are configurable
-        @default_configuration ||= [self.class, configured_class, *configured_class.ancestors].reverse.inject({}) do |default_config, klass|
-          default_config.merge!(klass.default_configuration) if klass.respond_to? :default_configuration
-          default_config
-        end
+        @default_configuration ||= self.class.default_configuration.dup
       end
 
       def set_config_value(key, value)
@@ -106,7 +95,7 @@ module Dragonfly
       end
 
       def saved_configs
-        configured_class.saved_configs
+        self.class.saved_configs
       end
 
       def saved_config_for(symbol)
@@ -123,11 +112,17 @@ module Dragonfly
     module ClassMethods
 
       def default_configuration
-        @default_configuration ||= {}
+        @default_configuration ||= configurable_ancestors.reverse.inject({}) do |default_config, klass|
+          default_config.merge!(klass.default_configuration)
+          default_config
+        end
       end
 
       def config_methods
-        @config_methods ||= []
+        @config_methods ||= configurable_ancestors.inject([]) do |conf_methods, klass|
+          conf_methods |= klass.config_methods
+          conf_methods
+        end
       end
 
       def nested_configurables
@@ -142,6 +137,10 @@ module Dragonfly
         @saved_configs ||= {}
       end
 
+      def configurable_ancestors
+        @configurable_ancestors ||= ancestors.select{|a| a.included_modules.include?(Configurable) } - [self]
+      end
+
       private
 
       def configurable_attr attribute, default=nil, &blk
@@ -198,7 +197,7 @@ module Dragonfly
       attr_reader :owner
 
       def nested_configurable?(method)
-        owner.configured_class.nested_configurables.include?(method.to_sym)
+        owner.class.nested_configurables.include?(method.to_sym)
       end
 
     end

data/lib/dragonfly/data_storage/couch_data_store.rb

@@ -22,12 +22,11 @@ module Dragonfly
       end
 
       def store(temp_object, opts={})
-        meta = opts[:meta] || {}
-        name = meta[:name] || temp_object.original_filename || 'file'
+        name = temp_object.name || 'file'
         content_type = opts[:content_type] || opts[:mime_type] || 'application/octet-stream'
         
         temp_object.file do |f|
-          doc = CouchRest::Document.new(:meta => marshal_encode(meta))
+          doc = CouchRest::Document.new(:meta => marshal_encode(temp_object.meta))
           response = db.save_doc(doc)
           doc.put_attachment(name, f.dup, :content_type => content_type)
           form_uid(response['id'], name)

data/lib/dragonfly/data_storage/file_data_store.rb

@@ -15,11 +15,10 @@ module Dragonfly
       configurable_attr :store_meta, true
 
       def store(temp_object, opts={})
-        meta = opts[:meta] || {}
         relative_path = if opts[:path]
           opts[:path]
         else
-          filename = meta[:name] || temp_object.original_filename || 'file'
+          filename = temp_object.name || 'file'
           relative_path = relative_path_for(filename)
         end
 
@@ -28,9 +27,8 @@ module Dragonfly
           until !File.exist?(path)
             path = disambiguate(path)
           end
-          prepare_path(path)
           temp_object.to_file(path).close
-          store_meta_data(path, meta) if store_meta
+          store_meta_data(path, temp_object.meta) if store_meta
         rescue Errno::EACCES => e
           raise UnableToStore, e.message
         end
@@ -124,11 +122,6 @@ module Dragonfly
         end
       end
 
-      def prepare_path(path)
-        dir = File.dirname(path)
-        FileUtils.mkdir_p(dir) unless File.exist?(dir)
-      end
-
       def purge_empty_directories(path)
         containing_directory = Pathname.new(path).dirname
         containing_directory.ascend do |relative_dir|