dragonfly 0.1.1 → 0.1.4

data/Rakefile

@@ -39,6 +39,16 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = %w(--no-private)
+end
+YARD::Rake::YardocTask.new 'yard:changed' do |t|
+  t.files   = `git stat | grep '.rb' | grep modified | cut -d' ' -f4`.split
+  t.options = %w(--no-private)
+end
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.libs << 'lib' << 'spec'

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.4

data/docs.watchr

@@ -0,0 +1 @@
+watch( 'lib/.*\.rb' )  {|md| system("rake yard:changed") }

data/dragonfly-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dragonfly-rails}
-  s.version = "0.1.1"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2009-11-14}
+  s.date = %q{2009-11-18}
   s.email = %q{mark@new-bamboo.co.uk}
   s.homepage = %q{http://github.com/markevans/dragonfly}
   s.rdoc_options = ["--charset=UTF-8"]

data/dragonfly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dragonfly}
-  s.version = "0.1.1"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2009-11-14}
+  s.date = %q{2009-11-18}
   s.email = %q{mark@new-bamboo.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "config.rb",
      "config.ru",
+     "docs.watchr",
      "dragonfly-rails.gemspec",
      "dragonfly.gemspec",
      "features/dragonfly.feature",
@@ -44,9 +45,9 @@ Gem::Specification.new do |s|
      "lib/dragonfly/active_record_extensions/validations.rb",
      "lib/dragonfly/analysis/analyser.rb",
      "lib/dragonfly/analysis/base.rb",
+     "lib/dragonfly/analysis/file_command_analyser.rb",
      "lib/dragonfly/analysis/r_magick_analyser.rb",
      "lib/dragonfly/app.rb",
-     "lib/dragonfly/app_configuration.rb",
      "lib/dragonfly/configurable.rb",
      "lib/dragonfly/core_ext/object.rb",
      "lib/dragonfly/data_storage.rb",
@@ -56,6 +57,7 @@ Gem::Specification.new do |s|
      "lib/dragonfly/data_storage/transparent_data_store.rb",
      "lib/dragonfly/encoding/base.rb",
      "lib/dragonfly/encoding/r_magick_encoder.rb",
+     "lib/dragonfly/encoding/transparent_encoder.rb",
      "lib/dragonfly/extended_temp_object.rb",
      "lib/dragonfly/middleware.rb",
      "lib/dragonfly/middleware_with_cache.rb",

data/features/steps/dragonfly_steps.rb

@@ -1,7 +1,7 @@
 Given /^a stored image "(.+?)" with dimensions (\d+)x(\d+)$/ do |name, width, height|
   tempfile = Tempfile.new(name)
   `convert -resize #{width}x#{height}! #{SAMPLE_IMAGE_PATH} #{tempfile.path}`
-  temp_object = APP.temp_object_class.new(tempfile)
+  temp_object = APP.create_object(tempfile)
   uid = APP.datastore.store(temp_object)
   TEMP_IMAGES[name] = uid
 end

data/lib/dragonfly/active_record_extensions/attachment.rb

@@ -97,7 +97,7 @@ module Dragonfly
       def magic_attributes
         parent_model.class.column_names.select { |name|
           name =~ /^#{attribute_name}_(.+)$/ &&
-            analyser.has_analysis_method?($1) || $1 == 'size'
+            (analyser.has_analysis_method?($1) || %w(size ext).include?($1))
         }
       end
       

data/lib/dragonfly/analysis/file_command_analyser.rb

@@ -0,0 +1,21 @@
+require 'rmagick'
+require 'mime/types'
+
+module Dragonfly
+  module Analysis
+    
+    class FileCommandAnalyser < Base
+      
+      include Configurable
+      
+      configurable_attr :file_command do `which file`.chomp end
+      
+      def mime_type(temp_object)
+        output = `#{file_command} -b --mime #{temp_object.path}`
+        output.split(';').first
+      end
+      
+    end
+    
+  end
+end

data/lib/dragonfly/app.rb

@@ -2,12 +2,63 @@ require 'logger'
 require 'forwardable'
 
 module Dragonfly
+
+  # A Dragonfly App is the rack app which holds everything together.
+  # You can have as many app instances as you want, and they all have
+  # completely separate configuration.
+  # Each App has a name.
+  # @example
+  # Dragonfly::App[:images]   # => creates a new app named :images
+  # Dragonfly::App[:images]   # => returns the :images app
+  # Dragonfly::App[:ocr]      # => creates a new app named :ocr
+  #
+  # # The two apps can be differently configured
+  # Dragonfly::App[:images].parameters.default_format = :jpg
+  # Dragonfly::App[:ocr].parameters.default_format = :tif
+  #
+  # @example Example configuration options:
+  #
+  # Dragonfly::App[:images].configure do |c|
+  #   c.datastore = MyEC2DataStore.new           # See DataStorage::Base for how to create a custom data store
+  #   c.encoder = Encoding::RMagickEncoder.new   # See Encoding::Base for how to create a custom encoder
+  #   c.log = Logger.new('/tmp/my.log')          
+  #   c.cache_duration = 3000                    # seconds
+  # end
+  #
+  # @example Configuration including nested items
+  #
+  # Dragonfly::App[:images].configure do |c|
+  #   # ...
+  #   c.datastore.configure do |d|    # configuration depends on which data store you use
+  #     # ...
+  #   end
+  #   c.analyser.configure do |a|     # see Analysis::Analyser
+  #     # ...
+  #   end
+  #   c.processor.configure do |p|    # see Processing::Processor
+  #     # ...
+  #   end
+  #   c.parameters.configure do |p|   # see Parameters (class methods)
+  #     # ...
+  #   end
+  #   c.url_handler.configure do |u|   # see UrlHandler
+  #     # ...
+  #   end
+  # end
+  #
   class App
     
+    
     class << self
       
       private :new # Hide 'new' - need to use 'instance'
       
+      # Get / create a Dragonfly App.
+      #
+      # Rather than using 'new', use this method to create / refer to each app.
+      #
+      # @param [Symbol] name the name of the App
+      # @return [App] either the named App or a new one with that name
       def instance(name)
         apps[name] ||= new
       end
@@ -30,16 +81,19 @@ module Dragonfly
       initialize_temp_object_class
     end
     
-    attr_reader :analyser,
-                :processor,
-                :encoder,
-                :url_handler,
-                :parameters_class,
-                :temp_object_class
+    # @see Analysis::Analyser
+    attr_reader :analyser
+    # @see Processing::Processor
+    attr_reader :processor
+    # @see Encoding::Base
+    attr_reader :encoder
+    # @see UrlHandler
+    attr_reader :url_handler
+    # @see Parameters
+    attr_reader :parameters_class
 
     alias parameters parameters_class
     
-    # Just for convenience so the user doesn't have to use url_handler
     extend Forwardable
     def_delegator :url_handler, :url_for
     
@@ -48,13 +102,26 @@ module Dragonfly
     configurable_attr :datastore do DataStorage::FileDataStore.new end
     configurable_attr :encoder do Encoding::Base.new end
     configurable_attr :log do Logger.new('/var/tmp/dragonfly.log') end
-    configurable_attr :cache_duration, 3000
+    configurable_attr :cache_duration, 3600*24*365 # Defaults to 1 year
+    configurable_attr :fallback_mime_type, 'application/octet-stream'
     
+    # The call method required by Rack to run.
+    #
+    # @param env the Rack env hash
+    # @return [Array] a Rack response:
+    #
+    #   - 200 status if all ok
+    #
+    #   - 400 if url recognised but parameters incorrect
+    #
+    #   - 404 if url not recognised / data not found.
+    #
+    # See the Rack documentation for more details
     def call(env)
       parameters = url_handler.url_to_parameters(env['PATH_INFO'], env['QUERY_STRING'])
       temp_object = fetch(parameters.uid, parameters)
       [200, {
-        "Content-Type" => temp_object.mime_type,
+        "Content-Type" => temp_object.mime_type || fallback_mime_type,
         "Content-Length" => temp_object.size.to_s,
         "ETag" => parameters.unique_signature,
         "Cache-Control" => "public, max-age=#{cache_duration}"
@@ -65,17 +132,42 @@ module Dragonfly
       [404, {"Content-Type" => 'text/plain'}, [e.message]]
     end
 
+    # Store an object, using the configured datastore
+    # @param [String, File, Tempfile, TempObject] object the object holding the data
+    # @return [String] the uid assigned to it
+    def store(object)
+      datastore.store(create_object(object))
+    end
+
+    # Fetch an object from the database and optionally transform
+    #
+    # Note that the arguments passed in to transform are as defined by the
+    # parameter shortcuts (see Parameter class methods)
+    # @param [String] uid the string uid corresponding to the stored data object
+    # @param [*args [optional]] shortcut_args the shortcut args for transforming the object 
+    # @return [ExtendedTempObject] a temp_object holding the data
+    # @example 
+    # app = Dragonfly::App[:images]
+    # app.fetch('abcd1234')             # returns a temp_object with exactly the data that was originally stored
+    # 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.transform(*args)
     end
 
+    # Create a temp_object from the object passed in
+    # @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)
     end
 
     private
     
+    # @private
+    attr_reader :temp_object_class
+    
     def initialize_temp_object_class
       @temp_object_class = Class.new(ExtendedTempObject)
       @temp_object_class.app = self

data/lib/dragonfly/data_storage/file_data_store.rb

@@ -12,7 +12,7 @@ module Dragonfly
         suffix = if temp_object.name.blank?
           'file'
         else
-          temp_object.name.sub(/\.[^.]*?$/, '')
+          temp_object.name
         end
         relative_path = relative_storage_path(suffix)
 
@@ -26,15 +26,15 @@ module Dragonfly
           raise UnableToStore, e.message
         end
       
-        relative_path
+        relative_path.sub(/\.[^.]*?$/, '')
       end
 
-      def retrieve(relative_path)
-        begin
-          File.new(absolute_storage_path(relative_path))
-        rescue Errno::ENOENT => e
-          raise DataNotFound, e.message
-        end
+      def retrieve(uid)
+        entries = Dir[absolute_storage_path(uid) + '*']
+        raise DataNotFound if entries.empty?
+        File.new(entries.first)
+      rescue Errno::ENOENT => e
+        raise DataNotFound, e.message
       end
 
       def destroy(relative_path)

data/lib/dragonfly/encoding/transparent_encoder.rb

@@ -0,0 +1,14 @@
+module Dragonfly
+  module Encoding
+    
+    class TransparentEncoder < Base
+      
+      # Does nothing
+      def encode(temp_object, format, encoding={})
+        temp_object.file
+      end
+      
+    end
+    
+  end
+end

data/lib/dragonfly/r_magick_configuration.rb

@@ -1,62 +1,63 @@
 module Dragonfly
-  
-  RMagickConfiguration = AppConfiguration.new
-  
-  def RMagickConfiguration.apply_configuration(app)
-    app.configure do |c|
-      c.analyser do |a|
-        a.register(Analysis::RMagickAnalyser.new)
-      end
-      c.processor do |p|
-        p.register(Processing::RMagickProcessor)
-      end
-      c.encoder = Encoding::RMagickEncoder.new
-      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,
-            :processing_options => {:geometry => geometry}
-          }
+  module RMagickConfiguration
+    
+    def self.apply_configuration(app)
+      app.configure do |c|
+        c.analyser do |a|
+          a.register(Analysis::RMagickAnalyser.new)
         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]}
-          }
+        c.processor do |p|
+          p.register(Processing::RMagickProcessor)
         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]
+        c.encoder = Encoding::RMagickEncoder.new
+        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,
+              :processing_options => {:geometry => geometry}
             }
-          }
-        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
+          # 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  
+end

data/lib/dragonfly/rails/images.rb

@@ -11,7 +11,7 @@ app.configure do |c|
   end
   c.url_handler do |u|
     u.protect_from_dos_attacks = false
-    u.path_prefix = '/images'
+    u.path_prefix = '/media'
   end
 end
 

data/lib/dragonfly/temp_object.rb

@@ -58,6 +58,12 @@ module Dragonfly
       end
     end
     
+    def ext
+      return unless name
+      bits = name.split('.')
+      bits.last if bits.size > 1
+    end
+    
     def each(&block)
       if initialized_data
         string_io = StringIO.new(initialized_data)

data/spec/dragonfly/active_record_extensions/migration.rb

@@ -5,7 +5,8 @@ class MigrationForTest < ActiveRecord::Migration
       t.string  :title
       t.string  :preview_image_uid
       t.string  :preview_image_some_analyser_method
-      t.integer  :preview_image_size
+      t.integer :preview_image_size
+      t.string  :preview_image_ext
       t.string  :preview_image_blah_blah
       t.string  :other_image_uid
       t.string  :yet_another_image_uid

data/spec/dragonfly/active_record_extensions/model_spec.rb

@@ -395,6 +395,13 @@ describe Item do
       @item.preview_image_size.should == 3
     end
     
+    it "should store the original file extension if it exists" do
+      data = 'jasdlkf sadjl'
+      data.stub!(:original_filename).and_return('hello.png')
+      @item.preview_image = data
+      @item.preview_image_ext.should == 'png'
+    end
+    
   end
 
 end

data/spec/dragonfly/app_spec.rb

@@ -66,4 +66,24 @@ describe Dragonfly::App do
 
   end
 
+  describe "mime types" do
+    before(:each) do
+      @app = Dragonfly::App[:images]
+      @app.url_handler.protect_from_dos_attacks = false
+      @app.fallback_mime_type = 'egg/heads'
+      @temp_object = Dragonfly::TempObject.new('GOOG')
+      @app.stub!(:fetch).and_return(@temp_object)
+    end
+    it "should use the temp object mime-type" do
+      @temp_object.should_receive(:mime_type).and_return 'my/type'
+      response = make_request(@app, 'hello.png')
+      response.headers['Content-Type'].should == 'my/type'
+    end
+    it "should use the app's fallback mime-type if the temp_object one isn't known" do
+      @temp_object.should_receive(:mime_type).and_return nil
+      response = make_request(@app, 'hello.png')
+      response.headers['Content-Type'].should == 'egg/heads'
+    end
+  end
+
 end

data/spec/dragonfly/data_storage/file_data_store_spec.rb

@@ -56,9 +56,9 @@ describe Dragonfly::DataStorage::FileDataStore do
       @data_store.store(@temp_object)
     end
     
-    it "should use the basename (all but part after last dot) of the temp_object name if it exists" do
+    it "should use the entire temp_object name including extension if it exists" do
       @temp_object.name = 'hello.you.png'
-      it_should_write_to_file("#{@file_pattern_prefix}_hello.you", @temp_object)
+      it_should_write_to_file("#{@file_pattern_prefix}_hello.you.png", @temp_object)
       @data_store.store(@temp_object)
     end
 
@@ -68,10 +68,15 @@ describe Dragonfly::DataStorage::FileDataStore do
       @data_store.store(@temp_object)
     end
 
-    it "should return the filepath without the root of the stored file" do
+    it "should return the filepath without the root of the stored file when a file name is not provided" do
       @data_store.store(@temp_object).should == "#{@file_pattern_prefix_without_root}_file"
     end
     
+    it "should return the filepath without the root of the stored file when a file name is provided" do
+      @temp_object.name = 'hello.you.png'
+      @data_store.store(@temp_object).should == "#{@file_pattern_prefix_without_root}_hello.you"
+    end
+    
     it "should raise an error if it can't create a directory" do
       FileUtils.should_receive(:mkdir_p).and_raise(Errno::EACCES)
       lambda{ @data_store.store(@temp_object) }.should raise_error(Dragonfly::DataStorage::UnableToStore)
@@ -88,6 +93,15 @@ describe Dragonfly::DataStorage::FileDataStore do
       @data_store.root_path.should be_an_empty_directory
     end
     
+    describe "retrieving" do
+      it "should retrieve the correct file even though the extension isn't given" do
+        @temp_object.name = 'hello.there'
+        uid = @data_store.store(@temp_object)
+        uid.should =~ /_hello$/
+        Dragonfly::TempObject.new(@data_store.retrieve(uid)).data.should == @temp_object.data
+      end
+    end
+    
   end
   
 end

data/spec/dragonfly/temp_object_spec.rb

@@ -230,4 +230,22 @@ describe Dragonfly::TempObject do
     end
   end
   
+  describe "ext" do
+    before(:each) do
+      @temp_object = Dragonfly::TempObject.new('asfsadf')
+    end
+    it "should use the correct extension from name" do
+      @temp_object.name = 'hello.there.mate'
+      @temp_object.ext.should == 'mate'
+    end
+    it "should be nil if name has none" do
+      @temp_object.name = 'hello'
+      @temp_object.ext.should be_nil
+    end
+    it "should be nil if name is nil" do
+      @temp_object.name = nil
+      @temp_object.ext.should be_nil
+    end
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dragonfly
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors: 
 - Mark Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 +00:00
+date: 2009-11-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,6 +39,7 @@ files:
 - VERSION
 - config.rb
 - config.ru
+- docs.watchr
 - dragonfly-rails.gemspec
 - dragonfly.gemspec
 - features/dragonfly.feature
@@ -60,9 +61,9 @@ files:
 - lib/dragonfly/active_record_extensions/validations.rb
 - lib/dragonfly/analysis/analyser.rb
 - lib/dragonfly/analysis/base.rb
+- lib/dragonfly/analysis/file_command_analyser.rb
 - lib/dragonfly/analysis/r_magick_analyser.rb
 - lib/dragonfly/app.rb
-- lib/dragonfly/app_configuration.rb
 - lib/dragonfly/configurable.rb
 - lib/dragonfly/core_ext/object.rb
 - lib/dragonfly/data_storage.rb
@@ -72,6 +73,7 @@ files:
 - lib/dragonfly/data_storage/transparent_data_store.rb
 - lib/dragonfly/encoding/base.rb
 - lib/dragonfly/encoding/r_magick_encoder.rb
+- lib/dragonfly/encoding/transparent_encoder.rb
 - lib/dragonfly/extended_temp_object.rb
 - lib/dragonfly/middleware.rb
 - lib/dragonfly/middleware_with_cache.rb

data/lib/dragonfly/app_configuration.rb

@@ -1,9 +0,0 @@
-module Dragonfly
-  class AppConfiguration
-    
-    def apply_configuration(app)
-      raise NotImplementedError
-    end
-    
-  end
-end