dragonfly 0.1.0 → 0.1.1

data/README.markdown

@@ -10,9 +10,7 @@ For the lazy rails user
 In environment.rb:
 
     config.gem 'dragonfly-rails', :lib => 'dragonfly/rails/images'
-    config.middleware.use 'Dragonfly::Middleware', :images
-
-IMPORTANT: see 'Caching' below to add caching (recommended!)
+    config.middleware.use 'Dragonfly::MiddlewareWithCache', :images
 
 Migration:
 
@@ -38,6 +36,8 @@ Model:
       validates_mime_type_of :cover_image, :in => %w(image/jpeg image/png image/gif)
       
       image_accessor :cover_image            # This provides the reader/writer for cover_image
+      
+      image_accessor :some_other_image       # have as many as you like - each needs a xxxx_uid column as per migration above
     
     end
 
@@ -53,30 +53,12 @@ View (for uploading via a file field):
 View (to display):
 
     <%= image_tag @album.cover_image.url('400x200') %>
-    <%= image_tag @album.cover_image.url('100x100!') %>
+    <%= image_tag @album.cover_image.url('100x100!', :png) %>
     <%= image_tag @album.cover_image.url('100x100#') %>
-    <%= image_tag @album.cover_image.url('50x50+30+30sw') %>
+    <%= image_tag @album.cover_image.url('50x50+30+30sw', :tif) %>
+    <%= image_tag @album.cover_image.url(:rotate, 15) %>
     ...etc.
 
-
-Caching
--------
-
-All this processing and encoding on the fly is pretty expensive to perform on every page request.
-Thankfully, HTTP caching comes to the rescue.
-You could use any HTTP caching component such as Varnish, Squid, etc., but the quickest and easiest way is to use the excellent Rack::Cache, which should be adequate for most websites.
-
-In that case, rather than the above, your `environment.rb` should contain something like this:
-
-    config.gem 'dragonfly-rails', :lib => 'dragonfly/rails/images'
-    config.gem 'rack-cache', :lib => 'rack/cache'
-    config.middleware.use 'Rack::Cache',
-      :verbose     => true,
-      :metastore   => 'file:/var/cache/rack/meta',
-      :entitystore => 'file:/var/cache/rack/body'
-    config.middleware.use 'Dragonfly::Middleware', :images
-
-
 Using outside of rails, custom storage/processing/encoding/analysis, and more...
 ------------------------------------------------------------------------
 Dragonfly is primarily a Rack app, the Rails part of it being nothing more than a separate layer on top of the main code, which means you can use it as a standalone app, or with Sinatra, Merb, etc.

data/Rakefile

@@ -22,6 +22,7 @@ begin
     s.extra_rdoc_files = []
     s.add_dependency('dragonfly')
     s.add_dependency('rack')
+    s.add_dependency('rack-cache')
     s.add_dependency('mime-types')
     s.add_dependency('rmagick')
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/dragonfly-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dragonfly-rails}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2009-11-09}
+  s.date = %q{2009-11-14}
   s.email = %q{mark@new-bamboo.co.uk}
   s.homepage = %q{http://github.com/markevans/dragonfly}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -24,17 +24,20 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<dragonfly>, [">= 0"])
       s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-cache>, [">= 0"])
       s.add_runtime_dependency(%q<mime-types>, [">= 0"])
       s.add_runtime_dependency(%q<rmagick>, [">= 0"])
     else
       s.add_dependency(%q<dragonfly>, [">= 0"])
       s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<rack-cache>, [">= 0"])
       s.add_dependency(%q<mime-types>, [">= 0"])
       s.add_dependency(%q<rmagick>, [">= 0"])
     end
   else
     s.add_dependency(%q<dragonfly>, [">= 0"])
     s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<rack-cache>, [">= 0"])
     s.add_dependency(%q<mime-types>, [">= 0"])
     s.add_dependency(%q<rmagick>, [">= 0"])
   end

data/dragonfly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dragonfly}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2009-11-09}
+  s.date = %q{2009-11-14}
   s.email = %q{mark@new-bamboo.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -51,11 +51,14 @@ Gem::Specification.new do |s|
      "lib/dragonfly/core_ext/object.rb",
      "lib/dragonfly/data_storage.rb",
      "lib/dragonfly/data_storage/base.rb",
+     "lib/dragonfly/data_storage/base64_data_store.rb",
      "lib/dragonfly/data_storage/file_data_store.rb",
+     "lib/dragonfly/data_storage/transparent_data_store.rb",
      "lib/dragonfly/encoding/base.rb",
      "lib/dragonfly/encoding/r_magick_encoder.rb",
      "lib/dragonfly/extended_temp_object.rb",
      "lib/dragonfly/middleware.rb",
+     "lib/dragonfly/middleware_with_cache.rb",
      "lib/dragonfly/parameters.rb",
      "lib/dragonfly/processing/processor.rb",
      "lib/dragonfly/processing/r_magick_processor.rb",
@@ -82,8 +85,10 @@ Gem::Specification.new do |s|
      "spec/dragonfly/data_storage/file_data_store_spec.rb",
      "spec/dragonfly/extended_temp_object_spec.rb",
      "spec/dragonfly/middleware_spec.rb",
+     "spec/dragonfly/middleware_with_cache_spec.rb",
      "spec/dragonfly/parameters_spec.rb",
      "spec/dragonfly/processing/rmagick_processor_spec.rb",
+     "spec/dragonfly/shared_middleware_spec.rb",
      "spec/dragonfly/temp_object_spec.rb",
      "spec/dragonfly/url_handler_spec.rb",
      "spec/dragonfly_spec.rb",
@@ -112,8 +117,10 @@ Gem::Specification.new do |s|
      "spec/dragonfly/data_storage/file_data_store_spec.rb",
      "spec/dragonfly/extended_temp_object_spec.rb",
      "spec/dragonfly/middleware_spec.rb",
+     "spec/dragonfly/middleware_with_cache_spec.rb",
      "spec/dragonfly/parameters_spec.rb",
      "spec/dragonfly/processing/rmagick_processor_spec.rb",
+     "spec/dragonfly/shared_middleware_spec.rb",
      "spec/dragonfly/temp_object_spec.rb",
      "spec/dragonfly/url_handler_spec.rb",
      "spec/dragonfly_spec.rb",

data/lib/dragonfly/data_storage/base64_data_store.rb

@@ -0,0 +1,23 @@
+require "base64"
+
+module Dragonfly
+  module DataStorage
+
+    class Base64DataStore < Base
+
+      def store(temp_object)
+        Base64.encode64(temp_object.data)
+      end
+
+      def retrieve(uid)
+        Base64.decode64(uid)
+      end
+      
+      def destroy(uid)
+        # Nothing to destroy!
+      end
+      
+    end
+    
+  end
+end

data/lib/dragonfly/data_storage/transparent_data_store.rb

@@ -0,0 +1,21 @@
+module Dragonfly
+  module DataStorage
+
+    class TransparentDataStore < Base
+      
+      def store(temp_object)
+        temp_object.data
+      end
+
+      def retrieve(uid)
+        uid
+      end
+      
+      def destroy(uid)
+        # Nothing to destroy!
+      end
+      
+    end
+    
+  end
+end

data/lib/dragonfly/middleware.rb

@@ -8,7 +8,7 @@ module Dragonfly
     end
     
     def call(env)
-      response = dragonfly_app.call(env)
+      response = endpoint.call(env)
       if response[0] == 404
         @app.call(env)
       else
@@ -18,7 +18,7 @@ module Dragonfly
     
     private
     
-    def dragonfly_app
+    def endpoint
       App[@dragonfly_app_name]
     end
     

data/lib/dragonfly/middleware_with_cache.rb

@@ -0,0 +1,26 @@
+require 'rack/cache'
+
+module Dragonfly
+  class MiddlewareWithCache < Middleware
+    
+    def initialize(app, dragonfly_app_name, rack_cache_opts={})
+      super(app, dragonfly_app_name)
+      @rack_cache_opts = {
+        :verbose     => true,
+        :metastore   => 'file:/var/cache/rack/meta',
+        :entitystore => 'file:/var/cache/rack/body'
+      }.merge(rack_cache_opts)
+    end
+    
+    private
+    
+    def endpoint
+      rack_cache_opts = @rack_cache_opts
+      @endpoint ||= Rack::Builder.new do
+        use Rack::Cache, rack_cache_opts
+        run super
+      end
+    end
+    
+  end
+end

data/lib/dragonfly/parameters.rb

@@ -19,7 +19,7 @@ module Dragonfly
       
       def add_shortcut(*args, &block)
         if block
-          block_shortcuts_of_length(args.length) << [args, block]
+          block_shortcuts_of_length(args.length).unshift([args, block])
         else
           shortcut_name, attributes = args
           simple_shortcuts[shortcut_name] = attributes
@@ -27,15 +27,20 @@ module Dragonfly
       end
       configuration_method :add_shortcut
       
-      def from_shortcut(*args)
+      def hash_from_shortcut(*args)
         if attributes = matching_simple_shortcut(args)
-          new(attributes)
+          attributes
         elsif attributes = matching_block_shortcut(args)
-          new(attributes)
+          attributes
         else
           raise InvalidShortcut, "No shortcut was found matching (#{args.map{|a| a.inspect }.join(', ')})"
         end
       end
+      configuration_method :hash_from_shortcut
+      
+      def from_shortcut(*args)
+        new(hash_from_shortcut(*args))
+      end
       
       def from_args(*args)
         if args.empty? then new

data/lib/dragonfly/processing/r_magick_processor.rb

@@ -50,6 +50,20 @@ module Dragonfly
         image.resize_to_fill(width, height, gravity).to_blob
       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)
+          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
+        end
+      end
+
       def vignette(temp_object, opts={})
         x      = opts[:x].to_f      || temp_object.width  * 0.1
         y      = opts[:y].to_f      || temp_object.height * 0.1

data/lib/dragonfly/r_magick_configuration.rb

@@ -14,6 +14,9 @@ module Dragonfly
       c.parameters 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,
@@ -40,6 +43,18 @@ module Dragonfly
             }
           }
         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

data/spec/dragonfly/middleware_spec.rb

@@ -1,44 +1,14 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-require 'rack'
+require File.dirname(__FILE__) + '/shared_middleware_spec'
 
 describe Dragonfly::Middleware do
   
-  def make_request(app, url)
-    Rack::MockRequest.new(app).get(url)
-  end
-  
   before(:each) do
     @stack = Rack::Builder.new do
       use Dragonfly::Middleware, :images
-      run lambda{|env| [200, {"Content-Type" => "text/html"}, ["#{env['PATH_INFO']}, #{env['QUERY_STRING']}"]] }
+      run dummy_rack_app
     end
   end
   
-  it "should continue the calling chain if the app returns a 404 for that url" do
-    Dragonfly::App[:images].should_receive(:call).and_return(
-      [404, {"Content-Type" => 'text/plain'}, ['Not found']]
-    )
-    response = make_request(@stack, 'hello.png?howare=you')
-    response.status.should == 200
-    response.body.should == 'hello.png, howare=you'
-  end
-  
-  it "should return as per the dragonfly app if the app returns a 200" do
-    Dragonfly::App[:images].should_receive(:call).and_return(
-      [200, {"Content-Type" => 'text/plain'}, ['ABCD']]
-    )
-    response = make_request(@stack, 'hello.png?howare=you')
-    response.status.should == 200
-    response.body.should == 'ABCD'
-  end
-  
-  it "should return as per the dragonfly app if the app returns a 400" do
-    Dragonfly::App[:images].should_receive(:call).and_return(
-      [400, {"Content-Type" => 'text/plain'}, ['ABCD']]
-    )
-    response = make_request(@stack, 'hello.png?howare=you')
-    response.status.should == 400
-    response.body.should == 'ABCD'
-  end
+  it_should_behave_like 'dragonfly middleware'
   
-end
+end

data/spec/dragonfly/middleware_with_cache_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/shared_middleware_spec'
+
+describe Dragonfly::MiddlewareWithCache do
+  
+  before(:each) do
+    @stack = Rack::Builder.new do
+      use Dragonfly::MiddlewareWithCache, :images
+      run dummy_rack_app
+    end
+  end
+  
+  it_should_behave_like 'dragonfly middleware'
+  
+end

data/spec/dragonfly/parameters_spec.rb

@@ -168,12 +168,12 @@ describe Dragonfly::Parameters do
         :encoding => {:doogie => :howser}
       }
       @parameters_class.add_shortcut(:doobie, attributes)
-      @parameters_class.from_shortcut(:doobie).should == Dragonfly::Parameters.new(attributes)
+      @parameters_class.hash_from_shortcut(:doobie).should == attributes
     end
     
     it "should raise an error if the shortcut doesn't exist" do
       lambda{
-        @parameters_class.from_shortcut(:idontexist)
+        @parameters_class.hash_from_shortcut(:idontexist)
       }.should raise_error(Dragonfly::Parameters::InvalidShortcut)
     end
     
@@ -186,22 +186,28 @@ describe Dragonfly::Parameters do
       end
       
       it "should allow for more complex shortcuts by using a block and matching args" do
-        parameters = Dragonfly::Parameters.new(:processing_method => 'hellothere', :format => :tif)
-        @parameters_class.from_shortcut('hellothere', :tif).should == parameters
+        @parameters_class.hash_from_shortcut('hellothere', :tif).should == {:processing_method => 'hellothere', :format => :tif}
       end
 
       it "should raise an error if the shortcut doesn't match properly" do
         lambda{
-          @parameters_class.from_shortcut('hellothere', 'tif')
+          @parameters_class.hash_from_shortcut('hellothere', 'tif')
         }.should raise_error(Dragonfly::Parameters::InvalidShortcut)
       end
       
       it "should raise an error if the shortcut matches but has the wrong number of args" do
         lambda{
-          @parameters_class.from_shortcut('hellothere', :tif, 'YO')
+          @parameters_class.hash_from_shortcut('hellothere', :tif, 'YO')
         }.should raise_error(Dragonfly::Parameters::InvalidShortcut)
       end
 
+      it "should let later shortcuts have priority over earlier ones" do
+        @parameters_class.add_shortcut(/hello/, :tif) do |a, b|
+          {:processing_method => :bumble}
+        end
+        @parameters_class.hash_from_shortcut('hellothere', :tif).should == {:processing_method => :bumble}
+      end
+
     end
     
     describe "single regexp shortcuts" do
@@ -210,7 +216,7 @@ describe Dragonfly::Parameters do
         @parameters_class.add_shortcut(/^hello(.*)$/) do |arg, match_data|
           {:processing_options => {:arg => arg, :match_data => match_data}}
         end
-        processing_options = @parameters_class.from_shortcut('hellothere').processing_options
+        processing_options = @parameters_class.hash_from_shortcut('hellothere')[:processing_options]
         processing_options[:arg].should == 'hellothere'
         processing_options[:match_data].should be_a(MatchData)
         processing_options[:match_data][1].should == 'there'
@@ -218,6 +224,15 @@ describe Dragonfly::Parameters do
       
     end
     
+    describe ".from_shortcut" do
+      it "should just be the parameters equivalent of 'hash_from_shortcut'" do
+        @parameters_class.add_shortcut(/^hello.*$/, Symbol) do |processing_method, format, matches|
+          {:processing_method => processing_method, :format => format}
+        end
+        @parameters_class.from_shortcut('hellothere', :tif).should == @parameters_class.new(@parameters_class.hash_from_shortcut('hellothere', :tif))
+      end
+    end
+    
   end
   
   describe ".from_args" do

data/spec/dragonfly/processing/rmagick_processor_spec.rb

@@ -145,4 +145,32 @@ describe Dragonfly::Processing::RMagickProcessor do
     
   end
   
+  describe "rotate" do
+    
+    it "should rotate by 90 degrees" do
+      image = @processor.rotate(@image, :amount => '90')
+      image.should have_width(355)
+      image.should have_height(280)
+    end
+    
+    it "should not rotate given a larger height and the '>' qualifier" do
+      image = @processor.rotate(@image, :amount => 90, :qualifier => '>')
+      image.should have_width(280)
+      image.should have_height(355)
+    end
+    
+    it "should rotate given a larger height and the '<' qualifier" do
+      image = @processor.rotate(@image, :amount => 90, :qualifier => '<')
+      image.should have_width(355)
+      image.should have_height(280)
+    end
+    
+    it "should do nothing if no amount given" do
+      image = @processor.rotate(@image)
+      image.should have_width(280)
+      image.should have_height(355)
+    end
+    
+  end
+  
 end

data/spec/dragonfly/shared_middleware_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'rack'
+
+def dummy_rack_app
+  lambda{|env| [200, {"Content-Type" => "text/html"}, ["#{env['PATH_INFO']}, #{env['QUERY_STRING']}"]] }
+end
+
+
+describe "dragonfly middleware", :shared => true do
+
+  # REQUIRES THAT @stack and Dragonfly::App[:images] IS DEFINED
+
+  def make_request(app, url)
+    Rack::MockRequest.new(app).get(url)
+  end
+
+  it "should continue the calling chain if the app returns a 404 for that url" do
+    Dragonfly::App[:images].should_receive(:call).and_return(
+      [404, {"Content-Type" => 'text/plain'}, ['Not found']]
+    )
+    response = make_request(@stack, 'hello.png?howare=you')
+    response.status.should == 200
+    response.body.should == 'hello.png, howare=you'
+  end
+  
+  it "should return as per the dragonfly app if the app returns a 200" do
+    Dragonfly::App[:images].should_receive(:call).and_return(
+      [200, {"Content-Type" => 'text/plain'}, ['ABCD']]
+    )
+    response = make_request(@stack, 'hello.png?howare=you')
+    response.status.should == 200
+    response.body.should == 'ABCD'
+  end
+  
+  it "should return as per the dragonfly app if the app returns a 400" do
+    Dragonfly::App[:images].should_receive(:call).and_return(
+      [400, {"Content-Type" => 'text/plain'}, ['ABCD']]
+    )
+    response = make_request(@stack, 'hello.png?howare=you')
+    response.status.should == 400
+    response.body.should == 'ABCD'
+  end
+  
+end

data/spec/image_matchers.rb

@@ -1,4 +1,8 @@
-def image_properties(data)
+def image_properties(image)
+  data = case image
+  when Dragonfly::TempObject then image.data
+  when String then image
+  end
   tempfile = Tempfile.new('image')
   tempfile.write(data)
   tempfile.close

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dragonfly
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mark Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-09 00:00:00 +00:00
+date: 2009-11-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,11 +67,14 @@ files:
 - lib/dragonfly/core_ext/object.rb
 - lib/dragonfly/data_storage.rb
 - lib/dragonfly/data_storage/base.rb
+- lib/dragonfly/data_storage/base64_data_store.rb
 - lib/dragonfly/data_storage/file_data_store.rb
+- lib/dragonfly/data_storage/transparent_data_store.rb
 - lib/dragonfly/encoding/base.rb
 - lib/dragonfly/encoding/r_magick_encoder.rb
 - lib/dragonfly/extended_temp_object.rb
 - lib/dragonfly/middleware.rb
+- lib/dragonfly/middleware_with_cache.rb
 - lib/dragonfly/parameters.rb
 - lib/dragonfly/processing/processor.rb
 - lib/dragonfly/processing/r_magick_processor.rb
@@ -98,8 +101,10 @@ files:
 - spec/dragonfly/data_storage/file_data_store_spec.rb
 - spec/dragonfly/extended_temp_object_spec.rb
 - spec/dragonfly/middleware_spec.rb
+- spec/dragonfly/middleware_with_cache_spec.rb
 - spec/dragonfly/parameters_spec.rb
 - spec/dragonfly/processing/rmagick_processor_spec.rb
+- spec/dragonfly/shared_middleware_spec.rb
 - spec/dragonfly/temp_object_spec.rb
 - spec/dragonfly/url_handler_spec.rb
 - spec/dragonfly_spec.rb
@@ -150,8 +155,10 @@ test_files:
 - spec/dragonfly/data_storage/file_data_store_spec.rb
 - spec/dragonfly/extended_temp_object_spec.rb
 - spec/dragonfly/middleware_spec.rb
+- spec/dragonfly/middleware_with_cache_spec.rb
 - spec/dragonfly/parameters_spec.rb
 - spec/dragonfly/processing/rmagick_processor_spec.rb
+- spec/dragonfly/shared_middleware_spec.rb
 - spec/dragonfly/temp_object_spec.rb
 - spec/dragonfly/url_handler_spec.rb
 - spec/dragonfly_spec.rb