dragonfly 0.6.2 → 0.7.0

data/lib/dragonfly/job_builder.rb

@@ -0,0 +1,39 @@
+module Dragonfly
+  class JobBuilder
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def build(job, *args)
+      evaluate_block(job, false, *args)
+    end
+
+    def build!(job, *args)
+      evaluate_block(job, true, *args)
+    end
+
+    Job.step_names.each do |step|
+      
+      # fetch, process, etc.
+      define_method step do |*args|
+        if @perform_with_bangs
+          @job.send("#{step}!", *args)
+        else
+          @job = @job.send(step, *args)
+        end
+      end
+      
+    end
+    
+    private
+    
+    def evaluate_block(job, perform_with_bangs, *args)
+      @job = job
+      @perform_with_bangs = perform_with_bangs
+      instance_exec(*args, &@block)
+      @job
+    end
+
+  end
+end

data/lib/dragonfly/job_definitions.rb

@@ -0,0 +1,26 @@
+module Dragonfly
+  class JobDefinitions < Module
+
+    def initialize
+      @job_definitions = {}
+    end
+
+    def add(name, &definition_proc)
+      job_definitions[name] = JobBuilder.new(&definition_proc)
+      jd = job_definitions # Needed because we're about to change 'self'
+      
+      define_method name do |*args|
+        jd[name].build(self, *args)
+      end
+      
+      define_method "#{name}!" do |*args|
+        jd[name].build!(self, *args)
+      end
+    end
+
+    private
+
+    attr_reader :job_definitions
+
+  end
+end

data/lib/dragonfly/job_endpoint.rb

@@ -0,0 +1,17 @@
+module Dragonfly
+  class JobEndpoint
+
+    include Endpoint
+
+    def initialize(job)
+      @job = job
+    end
+
+    def call(env={})
+      response_for_job(job, env)
+    end
+
+    attr_reader :job
+
+  end
+end

data/lib/dragonfly/loggable.rb

@@ -0,0 +1,28 @@
+require 'logger'
+
+module Dragonfly
+  module Loggable
+
+    def log
+      case @log_object
+      when nil
+        @log_object = Logger.new($stdout)
+      when Proc
+        @log_object[]
+      when Logger
+        @log_object
+      end
+    end
+
+    def log=(object)
+      @log_object = object
+    end
+    
+    attr_reader :log_object
+
+    def use_same_log_as(object)
+      self.log = proc{ object.log }
+    end
+
+  end
+end

data/lib/dragonfly/middleware.rb

@@ -1,27 +1,34 @@
 module Dragonfly
-
   class Middleware
-    
-    def initialize(app, dragonfly_app_name)
+
+    def initialize(app, dragonfly_app_name, path_prefix)
       @app = app
-      @dragonfly_app_name = dragonfly_app_name
+      @endpoint = Rack::Builder.new {
+        map path_prefix do
+          run Dragonfly[dragonfly_app_name]
+        end
+      }.to_app
     end
-    
+
     def call(env)
-      response = endpoint.call(env)
-      if response[0] == 404
+      response = @endpoint.call(env)
+      if route_not_found?(response)
         @app.call(env)
       else
         response
       end
     end
-    
+
     private
-    
-    def endpoint
-      App[@dragonfly_app_name]
+
+    def route_not_found?(response)
+      response[1]['X-Cascade'] == 'pass' ||
+        (rack_version_doesnt_support_x_cascade? && response[0] == 404)
+    end
+
+    def rack_version_doesnt_support_x_cascade?
+      Rack.version < '1.1'
     end
-    
-  end
 
-end
+  end
+end

data/lib/dragonfly/processing/r_magick_processor.rb

@@ -2,8 +2,8 @@ require 'RMagick'
 
 module Dragonfly
   module Processing
-    class RMagickProcessor < Base
-      
+    class RMagickProcessor
+
       GRAVITIES = {
         'nw' => Magick::NorthWestGravity,
         'n'  => Magick::NorthGravity,
@@ -16,14 +16,14 @@ module Dragonfly
         'se' => Magick::SouthEastGravity
       }
 
-      def generate(width, height, format='png')
-        image = Magick::Image.read("plasma:fractal"){self.size = "#{width}x#{height}"}.first
-        image.format = format.to_s
-        image.to_blob
-      end
-      
-      # Processing methods
-      
+      # Geometry string patterns
+      RESIZE_GEOMETRY         = /^\d*x\d*[><%^!]?$|^\d+@$/ # e.g. '300x200!'
+      CROPPED_RESIZE_GEOMETRY = /^(\d+)x(\d+)#(\w{1,2})?$/ # e.g. '20x50#ne'
+      CROP_GEOMETRY           = /^(\d+)x(\d+)([+-]\d+)?([+-]\d+)?(\w{1,2})?$/ # e.g. '30x30+10+10'
+      THUMB_GEOMETRY = Regexp.union RESIZE_GEOMETRY, CROPPED_RESIZE_GEOMETRY, CROP_GEOMETRY
+
+      include RMagickUtils
+
       def crop(temp_object, opts={})
         x       = opts[:x].to_i
         y       = opts[:y].to_i
@@ -31,49 +31,79 @@ module Dragonfly
         width   = opts[:width].to_i
         height  = opts[:height].to_i
 
-        image = rmagick_image(temp_object)
+        rmagick_image(temp_object) do |image|
+          # RMagick throws an error if the cropping area is bigger than the image,
+          # when the gravity is something other than nw
+          width  = image.columns - x if x + width  > image.columns
+          height = image.rows    - y if y + height > image.rows
+          image.crop(gravity, x, y, width, height)
+        end
+      end
 
-        # RMagick throws an error if the cropping area is bigger than the image,
-        # when the gravity is something other than nw
-        width  = image.columns - x if x + width  > image.columns
-        height = image.rows    - y if y + height > image.rows
+      def flip(temp_object)
+        rmagick_image(temp_object) do |image|
+          image.flip!
+        end
+      end
 
-        image.crop(gravity, x, y, width, height).to_blob
+      def flop(temp_object)
+        rmagick_image(temp_object) do |image|
+          image.flop!
+        end
       end
-      
+
       def greyscale(temp_object, opts={})
         depth = opts[:depth] || 256
-        rmagick_image(temp_object).quantize(depth, Magick::GRAYColorspace).to_blob
+        rmagick_image(temp_object) do |image|
+          image.quantize(depth, Magick::GRAYColorspace)
+        end
       end
       alias grayscale greyscale
-      
-      def resize(temp_object, opts={})
-        rmagick_image(temp_object).change_geometry!(opts[:geometry]) do |cols, rows, img|
-         img.resize!(cols, rows)
-        end.to_blob
+
+      def resize(temp_object, geometry)
+        rmagick_image(temp_object) do |image|
+          image.change_geometry!(geometry) do |cols, rows, img|
+           img.resize!(cols, rows)
+          end
+        end
       end
 
       def resize_and_crop(temp_object, opts={})
-        image = rmagick_image(temp_object)
-        
-        width   = opts[:width] ? opts[:width].to_i : image.columns
-        height  = opts[:height] ? opts[:height].to_i : image.rows
-        gravity = GRAVITIES[opts[:gravity]] || Magick::CenterGravity
+        rmagick_image(temp_object) do |image|
 
-        image.crop_resized(width, height, gravity).to_blob
+          width   = opts[:width] ? opts[:width].to_i : image.columns
+          height  = opts[:height] ? opts[:height].to_i : image.rows
+          gravity = GRAVITIES[opts[:gravity]] || Magick::CenterGravity
+
+          image.crop_resized(width, height, gravity)
+        end
       end
 
-      def rotate(temp_object, opts={})
-        if opts[:amount]
-          args = [opts[:amount].to_f]
-          args << opts[:qualifier] if opts[:qualifier]
-          image = rmagick_image(temp_object)
+      def rotate(temp_object, amount, opts={})
+        args = [amount.to_f]
+        args << opts[:qualifier] if opts[:qualifier]
+        rmagick_image(temp_object) do |image|
           image.background_color = opts[:background_colour] if opts[:background_colour]
           image.background_color = opts[:background_color] if opts[:background_color]
-          rotated_image = image.rotate(*args)
-          rotated_image ? rotated_image.to_blob : temp_object
-        else
-          temp_object
+          image.rotate(*args) || temp_object
+        end
+      end
+
+      def thumb(temp_object, geometry)
+        case geometry
+        when RESIZE_GEOMETRY
+          resize(temp_object, geometry)
+        when CROPPED_RESIZE_GEOMETRY
+          resize_and_crop(temp_object, :width => $1, :height => $2, :gravity => $3)
+        when CROP_GEOMETRY
+          crop(temp_object,
+            :width => $1,
+            :height => $2,
+            :x => $3,
+            :y => $4,
+            :gravity => $5
+          )
+        else raise ArgumentError, "Didn't recognise the geometry string #{geometry}"
         end
       end
 
@@ -83,16 +113,9 @@ module Dragonfly
         radius = opts[:radius].to_f ||  0.0
         sigma  = opts[:sigma].to_f  || 10.0
 
-        rmagick_image(temp_object).vignette(x, y, radius, sigma).to_blob
-      end
-      
-      private
-      
-      def rmagick_image(temp_object)
-        Magick::Image.from_blob(temp_object.data).first
-      rescue Magick::ImageMagickError => e
-        log.warn("Unable to handle content in #{self.class} - got:\n#{e}")
-        throw :unable_to_handle
+        rmagick_image(temp_object) do |image|
+          image.vignette(x, y, radius, sigma)
+        end
       end
 
     end

data/lib/dragonfly/processor.rb

@@ -0,0 +1,9 @@
+module Dragonfly
+  class Processor < FunctionManager
+
+    def process(temp_object, method, *args)
+      call_last(method, temp_object, *args)
+    end
+
+  end
+end

data/lib/dragonfly/r_magick_utils.rb

@@ -0,0 +1,24 @@
+module Dragonfly
+  module RMagickUtils
+    
+    private
+    
+    def rmagick_image(temp_object, &block)
+      image = Magick::Image.from_blob(temp_object.data).first
+      result = block[image]
+      case result
+      when Magick::Image, Magick::ImageList
+        content = result.to_blob
+        result.destroy!
+      else
+        content = result
+      end
+      image.destroy! unless image.destroyed?
+      content
+    rescue Magick::ImageMagickError => e
+      log.warn("Unable to handle content in #{self.class} - got:\n#{e}")
+      throw :unable_to_handle
+    end
+    
+  end
+end

data/lib/dragonfly/rails/images.rb

@@ -1,19 +1,22 @@
 require 'dragonfly'
 require 'rack/cache'
+require 'uri'
 
 ### The dragonfly app ###
-app = Dragonfly::App[:images]
-app.configure_with(Dragonfly::Config::RailsImages)
+app = Dragonfly[:images]
+app.configure_with(:rails)
+app.configure_with(:rmagick)
 
 ### Extend active record ###
-Dragonfly.active_record_macro(:image, app)
+app.define_macro(ActiveRecord::Base, :image_accessor)
 
 ### 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
-middleware.insert_before Dragonfly::Middleware, Rack::Cache, {
+
+middleware.insert 0, Dragonfly::Middleware, :images, app.url_path_prefix
+middleware.insert 0, Rack::Cache, {
   :verbose     => true,
-  :metastore   => "file:#{Rails.root}/tmp/dragonfly/cache/meta",
-  :entitystore => "file:#{Rails.root}/tmp/dragonfly/cache/body"
+  :metastore   => URI.encode("file:#{Rails.root}/tmp/dragonfly/cache/meta"), # URI encoded because Windows
+  :entitystore => URI.encode("file:#{Rails.root}/tmp/dragonfly/cache/body")  # has problems with spaces
 }

data/lib/dragonfly/routed_endpoint.rb

@@ -0,0 +1,42 @@
+module Dragonfly
+  class RoutedEndpoint
+
+    include Endpoint
+
+    class NoRoutingParams < RuntimeError; end
+
+    def initialize(app, &block)
+      @app = app
+      @block = block
+    end
+
+    def call(env)
+      params = symbolize_keys_of Rack::Request.new(env).params
+      job = @block.call(params.merge(routing_params(env)), @app)
+      response_for_job(job, env)
+    rescue Job::NoSHAGiven => e
+      [400, {"Content-Type" => 'text/plain'}, ["You need to give a SHA parameter"]]
+    rescue Job::IncorrectSHA => e
+      [400, {"Content-Type" => 'text/plain'}, ["The SHA parameter you gave (#{e}) is incorrect"]]
+    end
+
+    private
+
+    def routing_params(env)
+      env['rack.routing_args'] ||
+        env['action_dispatch.request.path_parameters'] ||
+        env['router.params'] ||
+        env['usher.params'] ||
+        env['dragonfly.params'] ||
+        raise(NoRoutingParams, "couldn't find any routing parameters in env #{env.inspect}")
+    end
+
+    def symbolize_keys_of(hash)
+      hash.inject({}) do |h, (key, value)|
+        h[(key.to_sym rescue key) || key] = value
+        h
+      end
+    end
+
+  end
+end

data/lib/dragonfly/serializer.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'base64'
+
+module Dragonfly
+  module Serializer
+    
+    # Exceptions
+    class BadString < RuntimeError; end
+    
+    extend self # So we can do Serializer.b64_encode, etc.
+    
+    def b64_encode(string)
+      Base64.encode64(string).tr("\n=",'')
+    end
+    
+    def b64_decode(string)
+      padding_length = string.length % 4
+      Base64.decode64(string + '=' * padding_length)
+    end
+    
+    def marshal_encode(object)
+      b64_encode(Marshal.dump(object))
+    end
+    
+    def marshal_decode(string)
+      Marshal.load(b64_decode(string))
+    rescue TypeError, ArgumentError => e
+      raise BadString, "couldn't decode #{string} - got #{e}"
+    end
+    
+  end
+end