dragonfly 0.5.7 → 0.6.0

data/extra_docs/GettingStarted.md

@@ -45,7 +45,7 @@ Example: Using to serve resized images
     require 'rack/cache'
 
     app = Dragonfly::App[:images]
-    app.configure_with(Dragonfly::RMagickConfiguration)
+    app.configure_with(Dragonfly::Config::RMagickImages)
 
     use Rack::Cache,
       :verbose     => true,

data/extra_docs/Processing.md

@@ -24,7 +24,7 @@ give us the processing methods `resize`, `crop`, `resize_and_crop`, `rotate`, et
     temp_object.process(:resize, :geometry => '30x30!')        # => returns a new temp_object with width x height = 30x30
     temp_object.process!(:resize, :geometry => '30x30!')       # => resizes its own data
 
-The saved configuration {Dragonfly::RMagickConfiguration RMagickConfiguration} registers the above processor automatically.
+The saved configuration {Dragonfly::Config::RMagickImages RMagickImages} registers the above processor automatically.
 
 Custom Processing
 -----------------

data/extra_docs/Shortcuts.md

@@ -13,10 +13,10 @@ The parameters are the following:
   - `:format` - the format to encode the data with, e.g. 'png'
   - `:encoding` - an options hash passed to the encoder for other options, e.g. bitrate, etc.
 
-Say we have an app configured with the {Dragonfly::RMagickConfiguration RMagickConfiguration}
+Say we have an app configured with the {Dragonfly::Config::RMagickImages RMagickImages}
 
     app = Dragonfly::App[:my_app]
-    app.configure_with(Dragonfly::RMagickConfiguration)
+    app.configure_with(Dragonfly::Config::RMagickImages)
 
 we can call things like
 

data/extra_docs/UsingWithRails.md

@@ -5,7 +5,7 @@ Dragonfly works with both Rails 2.3 and Rails 3.
 
 The main way to use Dragonfly with Rails is as a {Dragonfly::Middleware middleware}.
 
-1. The initializer
+1. Setting up
 ------------------
 
 The quick way
@@ -20,48 +20,26 @@ registers the app so that you can use ActiveRecord accessors, and inserts it int
 
 The more explicit way
 ---------------------
-If you want to set up and configure the Dragonfly app yourself, then you can put something like the code below in an initializer and
-modify accordingly:
+You can do the above explicitly.
+
+config/initializers/dragonfly.rb:
 
     require 'dragonfly'
 
-    # Set up and configure the dragonfly app
     app = Dragonfly::App[:images]
-    app.configure_with(Dragonfly::RMagickConfiguration)
-    app.configure do |c|
-      c.log = Rails.logger
-      c.datastore.configure do |d|
-        d.root_path = "#{Rails.root}/public/system/dragonfly/#{Rails.env}"
-      end
-      c.url_handler.configure do |u|
-        u.secret = 'insert some secret here to protect from DOS attacks!'
-        u.path_prefix = '/media'
-      end
-    end
-
-    # Extend ActiveRecord
-    # This allows you to use e.g.
-    #   image_accessor :my_attribute
-    # in your models.
-    ActiveRecord::Base.extend Dragonfly::ActiveRecordExtensions
-    ActiveRecord::Base.register_dragonfly_app(:image, Dragonfly::App[:images])
-
-    ### Insert the middleware ###
-    # Where the middleware is depends on the version of Rails
-    middleware = Rails.respond_to?(:application) ? Rails.application.middleware : ActionController::Dispatcher.middleware
-    middleware.insert_after Rack::Lock, Dragonfly::Middleware, :images
+    app.configure_with(Dragonfly::Config::RailsImages)
+    
+    # Define the method 'image_accessor' in ActiveRecord models
+    Dragonfly.active_record_macro(:image, app)
 
-    # # UNCOMMENT THIS IF YOU WANT TO CACHE REQUESTS WITH Rack::Cache
-    # require 'rack/cache'
-    # middleware.insert_before Dragonfly::Middleware, Rack::Cache, {
-    #   :verbose     => true,
-    #   :metastore   => "file:#{Rails.root}/tmp/dragonfly/cache/meta",
-    #   :entitystore => "file:#{Rails.root}/tmp/dragonfly/cache/body"
-    # }
+environment.rb (application.rb in Rails 3):
 
-If you can't be bothered to copy and paste, then there's actually a generator for Rails 2.3 (not Rails 3 yet) that will do something like the above for you:
-
-    ./script/generate dragonfly_app images
+    config.middleware.insert_after 'Rack::Lock', 'Dragonfly::Middleware', :images
+    config.middleware.insert_before 'Dragonfly::Middleware', 'Rack::Cache', {
+      :verbose     => true,
+      :metastore   => "file:#{Rails.root}/tmp/dragonfly/cache/meta",
+      :entitystore => "file:#{Rails.root}/tmp/dragonfly/cache/body"
+    }
 
 2. Gem dependencies
 -------------------
@@ -91,3 +69,13 @@ Now that you have a parasitic Dragonfly app living inside your Rails app, you ca
 To see what you can do with the active record accessors, see {file:ActiveRecord}.
 
 For more info about general Dragonfly setup, including avoiding denial-of-service attacks, see {file:GettingStarted}.
+
+Extra Config
+------------
+There are one or two config options you may commonly want to tweak.
+In this case, add something like the following to your initializer:
+
+    Dragonfly::App[:images].configure do |c|
+      c.url_handler.path_prefix = '/attachments'   # configures where the Dragonfly app is served from - default '/media'
+      c.url_handler.secret = 'PUT A SECRET HERE!!' # for protecting from Denial-Of-Service attacks
+    end

data/features/rails_2.3.5.feature

@@ -2,13 +2,6 @@ Feature: champion uses dragonfly in his Rails 2.3.5 application
   In order to be a champion
   A user uses dragonfly in his Rails 2.3.5 application
 
-  Background:
-    Given a Rails 2.3.5 application set up for using dragonfly
-
-  Scenario: Set up dragonfly using the generator
-    When I use the Rails 2.3.5 generator to set up dragonfly
-    Then the cucumber features in my Rails 2.3.5 app should pass
-
   Scenario: Set up dragonfly using the provided initializer
-    When I use the provided 2.3.5 initializer
+    Given a Rails 2.3.5 application set up for using dragonfly
     Then the cucumber features in my Rails 2.3.5 app should pass

data/features/rails_3.0.0.beta3.feature

@@ -0,0 +1,7 @@
+Feature: champion uses dragonfly in his Rails 3.0.0.beta3 application
+  In order to be a champion
+  A user uses dragonfly in his Rails 3.0.0.beta3 application
+
+  Scenario: Set up dragonfly using initializer
+    Given a Rails 3.0.0.beta3 application set up for using dragonfly
+    Then the cucumber features in my Rails 3.0.0.beta3 app should pass

data/features/steps/rails_steps.rb

@@ -15,17 +15,7 @@ Given /^a Rails (.+) application set up for using dragonfly$/ do |version|
   raise "Problem setting up Rails app" unless `
     cd #{fixture_path(version)} &&
     rm -rf #{RAILS_APP_NAME} &&
-    ../rails _#{version}_ #{RAILS_APP_NAME} -m template.rb`
-end
-
-When /^I use the Rails (.+) generator to set up dragonfly$/ do |version|
-  raise "Problem using the generator" unless `
-    cd #{fixture_path(version)}/#{RAILS_APP_NAME} &&
-    ./script/generate dragonfly_app images`
-end
-
-When /^I use the provided (.+) initializer$/ do |version|
-  FileUtils.cp("#{FIXTURES_PATH}/dragonfly_setup.rb", "#{app_path(version)}/config/initializers")
+    rails _#{version}_ #{RAILS_APP_NAME} -m template.rb`
 end
 
 Then /^the cucumber features in my Rails (.+) app should pass$/ do |version|

data/features/support/env.rb

@@ -12,7 +12,7 @@ ENV['PATH'] += ':' + extra_paths.join(':')
 # A hash of <name for reference> => <dragonfly uid> pairs
 TEMP_FILES = {}
 
-Dragonfly::App[:images].configure_with(Dragonfly::RMagickConfiguration)
+Dragonfly::App[:images].configure_with(Dragonfly::Config::RMagickImages)
 Dragonfly::App[:files].configure do |c|
   c.register_analyser(Dragonfly::Analysis::FileCommandAnalyser)
   c.register_encoder(Dragonfly::Encoding::TransparentEncoder)

data/fixtures/files/app/views/albums/show.html.erb

@@ -1,3 +1,4 @@
+<%= flash[:notice] %>
 Look at this cover image!
 <%= image_tag @album.cover_image.url('200x100!') %>
 <%= link_to 'Index', albums_path %>

data/fixtures/files/config/initializers/{aaa_dragonfly_load_path.rb → dragonfly.rb}

@@ -1,3 +1,4 @@
 # This is a hack to get the generated rails apps to use the version of dragonfly being worked on.
 $:.unshift(File.expand_path(File.dirname(__FILE__)+'/../../../../../lib'))
+require 'dragonfly/rails/images'
 

data/fixtures/rails_2.3.5/template.rb

@@ -1,12 +1,10 @@
-generate 'scaffold albums cover_image_uid:string'
-rake 'db:migrate'
-
-# Set up webrat and cucumber
+gem 'rack-cache', :lib => 'rack/cache'
+gem 'rmagick', :lib => 'RMagick'
 gem 'cucumber'
 generate 'cucumber'
 
-gem 'rack-cache', :lib => 'rack/cache'
-gem 'rmagick', :lib => 'RMagick'
+generate 'scaffold albums cover_image_uid:string'
+rake 'db:migrate'
 
 # Copy over all files from the template dir
 files_dir = File.expand_path(File.dirname(__FILE__) + '/../../files')

data/fixtures/rails_3.0.0.beta3/template.rb

@@ -0,0 +1,16 @@
+gem 'rack-cache', :require => 'rack/cache'
+gem 'rmagick', :require => 'RMagick'
+
+gem 'capybara'
+gem 'cucumber-rails'
+gem 'cucumber', '0.7.2'
+gem 'rspec-rails', '2.0.0.beta.8'
+
+generate 'cucumber:skeleton'
+
+generate 'scaffold albums cover_image_uid:string'
+rake 'db:migrate'
+
+# Copy over all files from the template dir
+files_dir = File.expand_path(File.dirname(__FILE__) + '/../../files')
+run "cp -r #{files_dir}/** ."

data/lib/dragonfly.rb

@@ -29,7 +29,29 @@ end
 
 autoload_files_in_dir("#{File.dirname(__FILE__)}/dragonfly", 'Dragonfly')
 
-require 'rubygems'
 require File.dirname(__FILE__) + '/dragonfly/core_ext/object'
 require File.dirname(__FILE__) + '/dragonfly/core_ext/string'
 require File.dirname(__FILE__) + '/dragonfly/core_ext/symbol'
+
+module Dragonfly
+  class << self
+
+    def const_missing(const)
+      case const
+      when :RMagickConfiguration
+        puts "WARNING: RMagickConfiguration is deprecated and will be removed in future "+
+             "versions of Dragonfly. Please change to Dragonfly::Config::RMagickImages"
+        const_set(:RMagickConfiguration, Config::RMagickImages)
+      else
+        super
+      end
+    end
+
+    def active_record_macro(prefix, app)
+      already_extended = (class << ActiveRecord::Base; self; end).included_modules.include?(ActiveRecordExtensions)
+      ActiveRecord::Base.extend(ActiveRecordExtensions) unless already_extended
+      ActiveRecord::Base.register_dragonfly_app(prefix, app)
+    end
+
+  end
+end

data/lib/dragonfly/active_record_extensions/attachment.rb

@@ -124,7 +124,7 @@ module Dragonfly
       end
       
       def methods_to_delegate_to_temp_object
-        analyser.callable_methods
+        analyser.delegatable_methods
       end
       
       def can_delegate_to_temp_object?(meth)

data/lib/dragonfly/analyser_list.rb

@@ -1,5 +1,9 @@
 module Dragonfly
   class AnalyserList
     include Delegator
+    
+    def initialize(app)
+      @app = app
+    end
   end
 end

data/lib/dragonfly/analysis/base.rb

@@ -2,6 +2,7 @@ module Dragonfly
   module Analysis
     class Base
 
+      include BelongsToApp
       include Delegatable
 
     end

data/lib/dragonfly/analysis/r_magick_analyser.rb

@@ -26,11 +26,18 @@ module Dragonfly
         rmagick_image(image).number_colors
       end
       alias number_of_colors number_of_colours
+
+      def format(image)
+        rmagick_image(image).format.downcase.to_sym
+      end
       
       private
       
       def rmagick_image(image)
         Magick::Image.from_blob(image.data).first
+      rescue Magick::ImageMagickError => e
+        log.warn("Unable to handle content in #{self.class} - got:\n#{e}")
+        throw :unable_to_handle
       end
       
     end

data/lib/dragonfly/app.rb

@@ -70,10 +70,9 @@ module Dragonfly
     end
     
     def initialize
-      @analysers, @processors, @encoders = AnalyserList.new, ProcessorList.new, EncoderList.new
+      @analysers, @processors, @encoders = AnalyserList.new(self), ProcessorList.new(self), EncoderList.new(self)
       @parameters_class = Class.new(Parameters)
       @url_handler = UrlHandler.new(@parameters_class)
-      initialize_temp_object_class
     end
     
     # @see Analysis::AnalyserList
@@ -86,8 +85,6 @@ module Dragonfly
     attr_reader :url_handler
     # @see Parameters
     attr_reader :parameters_class
-    # @see TempObject, and ExtendedTempObject
-    attr_reader :temp_object_class
 
     alias parameters parameters_class
     
@@ -134,7 +131,7 @@ module Dragonfly
     # @param [String, File, Tempfile, TempObject] initialization_object the object holding the data
     # @return [ExtendedTempObject] a temp_object holding the data
     def create_object(initialization_object)
-      temp_object_class.new(initialization_object)
+      ExtendedTempObject.new(initialization_object, self)
     end
 
     # Fetch an object from the database and optionally transform
@@ -150,7 +147,7 @@ module Dragonfly
     # app.fetch('abcd1234', '20x20!')   # returns a transformed temp_object, in this case with image data resized to 20x20
     # @see Parameters
     def fetch(uid, *args)
-      temp_object = temp_object_class.new(datastore.retrieve(uid))
+      temp_object = ExtendedTempObject.new(datastore.retrieve(uid), self)
       temp_object.transform(*args)
     end
 
@@ -202,11 +199,6 @@ module Dragonfly
     end
 
     private
-    
-    def initialize_temp_object_class
-      @temp_object_class = Class.new(ExtendedTempObject)
-      @temp_object_class.app = self
-    end
 
     def warn_with_info(message, env)
       log.warn "Got error: #{message}\nPath was #{env['PATH_INFO'].inspect} and query was #{env['QUERY_STRING'].inspect}"

data/lib/dragonfly/belongs_to_app.rb

@@ -0,0 +1,24 @@
+require 'logger'
+
+module Dragonfly
+  module BelongsToApp
+    
+    # Exceptions
+    class NotConfigured < RuntimeError; end
+    
+    attr_writer :app
+    
+    def app
+      @app || raise(NotConfigured, "#{self.inspect} has no app set")
+    end
+    
+    def app_set?
+      !!@app
+    end
+    
+    def log
+      app_set? ? app.log : (@log ||= Logger.new(STDOUT))
+    end
+    
+  end
+end

data/lib/dragonfly/config/heroku_rails_images.rb

@@ -0,0 +1,23 @@
+module Dragonfly
+  module Config
+    
+    module HerokuRailsImages
+    
+      def self.apply_configuration(app, bucket_name)
+        app.configure_with(RMagickImages)
+        app.configure_with(RailsDefaults) do |c|
+          # Use S3 for production
+          if ::Rails.env == 'production'
+            c.datastore = Dragonfly::DataStorage::S3DataStore.new
+            c.datastore.configure do |d|
+              d.bucket_name = bucket_name
+              d.access_key_id = ENV['S3_KEY'] || raise("ENV variable 'S3_KEY' needs to be set - use\n\theroku config:add S3_KEY=XXXXXXXXX")
+              d.secret_access_key = ENV['S3_SECRET'] || raise("ENV variable 'S3_SECRET' needs to be set - use\n\theroku config:add S3_SECRET=XXXXXXXXX")
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/dragonfly/config/r_magick_images.rb

@@ -0,0 +1,69 @@
+module Dragonfly
+  module Config
+    
+    # RMagickImages is a saved configuration for Dragonfly apps, which does the following:
+    # - registers an rmagick analyser
+    # - registers an rmagick processor
+    # - registers an rmagick encoder
+    # - adds parameter shortcuts like '280x140!', etc.
+    # Look at the source code for apply_configuration to see exactly how it configures the app.
+    module RMagickImages
+    
+      def self.apply_configuration(app)
+        app.configure do |c|
+          c.register_analyser(Analysis::FileCommandAnalyser)
+          c.register_analyser(Analysis::RMagickAnalyser)
+          c.register_processor(Processing::RMagickProcessor)
+          c.register_encoder(Encoding::RMagickEncoder)
+          c.parameters.configure do |p|
+            p.default_format = :jpg
+            # Standard resizing like '30x40!', etc.
+            p.add_shortcut(Symbol) do |format|
+              {:format => format}
+            end
+            p.add_shortcut(/^\d*x\d*[><%^!]?$|^\d+@$/) do |geometry, match_data|
+              {
+                :processing_method => :resize,
+                :processing_options => {:geometry => geometry}
+              }
+            end
+            # Cropped resizing like '20x50#ne'
+            p.add_shortcut(/^(\d+)x(\d+)#(\w{1,2})?/) do |geometry, match_data|
+              {
+                :processing_method => :resize_and_crop,
+                :processing_options => {:width => match_data[1], :height => match_data[2], :gravity => match_data[3]}
+              }
+            end
+            # Cropping like '30x30+10+10ne'
+            p.add_shortcut(/^(\d+)x(\d+)([+-]\d+)([+-]\d+)(\w{1,2})?/) do |geometry, match_data|
+              {
+                :processing_method => :crop,
+                :processing_options => {
+                  :width => match_data[1],
+                  :height => match_data[2],
+                  :x => match_data[3],
+                  :y => match_data[4],
+                  :gravity => match_data[5]
+                }
+              }
+            end
+            p.add_shortcut(/^\d*x/, Symbol) do |geometry, format|
+              p.hash_from_shortcut(geometry).merge(:format => format)
+            end
+            p.add_shortcut(:rotate, Numeric) do |_, amount|
+              {
+                :processing_method => :rotate,
+                :processing_options => {:amount => amount, :background_colour => '#0000'}
+              }
+            end
+            p.add_shortcut(:rotate, Numeric, Symbol) do |a, b, format|
+              p.hash_from_shortcut(a,b).merge(:format => format)
+            end
+          end
+        end
+    
+      end
+    
+    end  
+  end
+end