dragonfly 0.1.6 → 0.2.1

data/spec/dragonfly/processing/rmagick_processor_spec.rb

@@ -5,8 +5,7 @@ describe Dragonfly::Processing::RMagickProcessor do
   before(:each) do
     sample_file = File.dirname(__FILE__) + '/../../../samples/beach.png' # 280x355
     @image = Dragonfly::TempObject.new(File.new(sample_file))
-    @processor = Object.new
-    @processor.extend Dragonfly::Processing::RMagickProcessor
+    @processor = Dragonfly::Processing::RMagickProcessor.new
   end
   
   describe "#resize" do

data/spec/dragonfly/temp_object_spec.rb

@@ -195,6 +195,10 @@ describe Dragonfly::TempObject do
       @temp_object.modify_self!(tempfile)
       @temp_object.data.should == data
     end
+    it "should still work when the object is itself" do
+      @temp_object.modify_self!(@temp_object)
+      @temp_object.data.should == 'DATA_ONE'
+    end
     
   end
   
@@ -228,6 +232,11 @@ describe Dragonfly::TempObject do
     it "should not set the name if the initial object doesn't respond to 'original filename'" do
       Dragonfly::TempObject.new(@obj).name.should be_nil
     end
+    it "should set the name if the initial object is a file object" do
+      file = File.new(SAMPLES_DIR + '/round.gif')
+      temp_object = Dragonfly::TempObject.new(file)
+      temp_object.name.should == 'round.gif'
+    end
   end
   
   describe "ext" do
@@ -248,4 +257,46 @@ describe Dragonfly::TempObject do
     end
   end
   
+  describe "to_file" do
+    
+    describe "common behaviour for to_file", :shared => true do
+      before(:each) do
+        @filename = 'eggnog.txt'
+        FileUtils.rm(@filename) if File.exists?(@filename)
+      end
+      after(:each) do
+        FileUtils.rm(@filename) if File.exists?(@filename)
+      end
+      it "should write to a file" do
+        @temp_object.to_file(@filename)
+        File.exists?(@filename).should be_true
+      end
+      it "should write the correct data to the file" do
+        @temp_object.to_file(@filename)
+        File.read(@filename).should == 'HELLO'
+      end
+      it "should return a readable file" do
+        file = @temp_object.to_file(@filename)
+        file.should be_a(File)
+        file.read.should == 'HELLO'
+      end
+    end
+    
+    describe "when initialized with a string" do
+      before(:each){ @temp_object = Dragonfly::TempObject.new('HELLO') }
+      it_should_behave_like "common behaviour for to_file"
+    end
+    
+    describe "when initialized with a file" do
+      before(:each){ @temp_object = Dragonfly::TempObject.new(new_tempfile('HELLO')) }
+      it_should_behave_like "common behaviour for to_file"
+    end
+    
+    describe "when initialized with a tempfile" do
+      before(:each){ @temp_object = Dragonfly::TempObject.new(new_file('HELLO')) }
+      it_should_behave_like "common behaviour for to_file"
+    end
+
+  end
+  
 end

data/spec/dragonfly/url_handler_spec.rb

@@ -19,11 +19,6 @@ describe Dragonfly::UrlHandler do
       @parameters.uid.should == 'images/some_image'
     end
     
-    it "should behave the same if there is no beginning slash" do
-      parameters = @url_handler.url_to_parameters('images/some_image.jpg', @query_string)
-      parameters.uid.should == 'images/some_image'
-    end
-    
     it "should take into account the path prefix if there is one" do
       @url_handler.path_prefix = '/images'
       parameters = @url_handler.url_to_parameters('/images/2009/some_image.jpg', @query_string)
@@ -67,10 +62,10 @@ describe Dragonfly::UrlHandler do
       url_handler.url_to_parameters(@path, @query_string)
     end
     
-    it "should raise an UnknownUrl error if the path doesn't have an extension" do
-      lambda{
-        @url_handler.url_to_parameters('hello', @query_string)
-      }.should raise_error(Dragonfly::UrlHandler::UnknownUrl)
+    it "should not set the format if the path doesn't have an extension" do
+      parameters = @url_handler.url_to_parameters('/hello', @query_string)
+      parameters.uid.should == 'hello'
+      parameters.format.should be_nil
     end
 
     it "should raise an UnknownUrl error if the path doesn't have a uid bit" do
@@ -86,13 +81,13 @@ describe Dragonfly::UrlHandler do
     end
     
     it "should set most of the path as the uid if there is more than one dot" do
-      parameters = @url_handler.url_to_parameters('hello.old.bean', @query_string)
+      parameters = @url_handler.url_to_parameters('/hello.old.bean', @query_string)
       parameters.uid.should == 'hello.old'
       parameters.format.should == 'bean'
     end
     
     it "should unescape any url-escaped characters" do
-      parameters = @url_handler.url_to_parameters('hello%20bean.jpg', 'm=whats%20up')
+      parameters = @url_handler.url_to_parameters('/hello%20bean.jpg', 'm=whats%20up')
       parameters.uid.should == 'hello bean'
       parameters.processing_method.should == 'whats up'
     end
@@ -121,6 +116,10 @@ describe Dragonfly::UrlHandler do
       @parameters.processing_method = nil
       @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique.gif?o[d]=e&o[j]=k&e[x]=y')
     end
+    it "should leave out the format if there is none" do
+      @parameters.format = nil
+      @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique?m=b&o[d]=e&o[j]=k&e[x]=y')
+    end
     it "should leave out any empty parameters" do
       @parameters.processing_options = {}
       @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique.gif?m=b&e[x]=y')
@@ -129,10 +128,6 @@ describe Dragonfly::UrlHandler do
       @url_handler.path_prefix = '/images'
       @url_handler.parameters_to_url(@parameters).should match_url('/images/thisisunique.gif?m=b&o[d]=e&o[j]=k&e[x]=y')
     end
-    it "should validate the parameters" do
-      @parameters.should_receive(:validate!)
-      @url_handler.parameters_to_url(@parameters)
-    end
     it "should escape any non-url friendly characters except for '/'" do
       parameters = Dragonfly::Parameters.new :uid => 'hello/u"u', :processing_method => 'm"m', :format => 'jpg'
       @url_handler.parameters_to_url(parameters).should == '/hello/u%22u.jpg?m=m%22m'

data/yard/handlers/configurable_attr_handler.rb

@@ -0,0 +1,38 @@
+class ConfigurableAttrHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/^\s*configurable_attr/)
+
+  def process
+    owner[:configurable_attributes] ||= []
+    
+    attribute = token_to_object(statement.tokens[2])
+    comments = statement.comments.join(' ') if statement.comments
+    
+    if statement.block
+    # e.g. configurable_attr :datastore do FileDataStore.new end
+      lazy_default_value = statement.block.to_s
+    else
+    # e.g. configurable_attr :fallback_mime_type, 'application/octet-stream'    
+      default_value = token_to_object(statement.tokens[5..-1])
+    end
+    owner[:configurable_attributes] << {
+      :attribute => attribute,
+      :default_value => default_value,
+      :lazy_default_value => lazy_default_value,
+      :comments => comments
+    }
+  end
+
+  private
+
+  def token_to_object(token)
+    if token
+      if token.is_a?(YARD::Parser::Ruby::Legacy::TokenList)
+        eval(token.to_s)
+      else # is a single token
+        eval(token.text)
+      end
+    end
+  end
+
+end
+

data/yard/setup.rb

@@ -0,0 +1,9 @@
+# Allow debugging
+require 'rubygems'
+require 'ruby-debug'
+
+YARD::Templates::Engine.register_template_path(File.dirname(__FILE__) + '/templates')
+Dir[File.dirname(__FILE__) + '/handlers/*.rb'].each do |file|
+  require File.expand_path(file)
+end
+YARD::Parser::SourceParser.parser_type = :ruby18

data/yard/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,27 @@
+/* Overrides for yard documentation */
+
+pre, code, .code,
+#filecontents pre.code,
+.docstring pre.code,
+.source_code pre {
+  font-family: monaco, 'Trebuchet MS', monospace;
+}
+
+pre.code, code {
+  background:#F5F5FF;
+  border:1px solid #EEEEFF;
+}
+pre.code {
+  margin-top:4px;
+  padding:5px 12px;
+}
+
+code .val {
+  color:#036A07;
+}
+code .kw {
+  color:#0000FF;
+}
+code .symbol {
+  color:#C5060B;
+}

data/yard/templates/default/module/html/configuration_summary.erb

@@ -0,0 +1,31 @@
+<% configurable_attributes = object[:configurable_attributes] || [] %>
+<% if configurable_attributes.any? %>
+<h2>Configuration Summary</h2>
+<h3>Configurable attributes</h3>
+Configurable attributes for an object in general <code>object</code> can be configured either by using something like
+<pre class="code">
+  object.configure <%= hl :do %> |c|
+    c.some_configurable_attribute = <%= hl 'some value' %>
+    c.some_other_configurable_attribute = <%= hl 42 %>
+    ...
+  <%= hl :end %>
+</pre>
+or
+<pre class="code">
+  object.some_configurable_attribute = <%= hl 'some value' %>
+</pre>
+<h4>Configurable attributes for instances of <%= object %></h4>
+<ul>
+  <% configurable_attributes.each do |attribute| %>
+  <li>
+    <code><%= attribute[:attribute] %></code>
+    <% if attribute[:lazy_default_value] %>
+     - default <code><%= hl attribute[:lazy_default_value] %></code> (evaluated lazily) 
+    <% else %>
+     - default <code><%= hl attribute[:default_value] %></code>
+    <% end %>
+    <%= '- ' + attribute[:comments] if attribute[:comments] %>
+  </li>
+  <% end %>
+</ul>
+<% end %>

data/yard/templates/default/module/setup.rb

@@ -0,0 +1,17 @@
+def init
+  super
+  sections.place(:configuration_summary).before(:method_summary)
+end
+
+# Highlight stuff
+def hl(code)
+  case code
+  when :do, :end then %(<span class="kw">#{code}</span>)
+  when Symbol then %(<span class="symbol">#{code.inspect}</span>)
+  when Integer then %(<span class="integer val">#{code}</span>)
+  when String then %(<span class="string val">#{code.inspect}</span>)
+  when true, false then %(<span class="kw">#{code.inspect}</span>)
+  when nil then %(<span class="nil kw">#{code.inspect}</span>)
+  else code
+  end    
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dragonfly
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors: 
 - Mark Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-18 00:00:00 +00:00
+date: 2009-12-11 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,11 +30,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
+- README.md
 files: 
 - .gitignore
+- .yardopts
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - VERSION
 - config.rb
@@ -42,14 +43,21 @@ files:
 - docs.watchr
 - dragonfly-rails.gemspec
 - dragonfly.gemspec
-- features/dragonfly.feature
+- extra_docs/ActiveRecord.md
+- extra_docs/Analysers.md
+- extra_docs/DataStorage.md
+- extra_docs/Encoding.md
+- extra_docs/GettingStarted.md
+- extra_docs/Processing.md
+- extra_docs/Shortcuts.md
+- extra_docs/UsingWithRails.md
+- features/images.feature
+- features/no_processing.feature
 - features/steps/common_steps.rb
 - features/steps/dragonfly_steps.rb
 - features/support/env.rb
-- features/support/image_helpers.rb
 - generators/dragonfly_app/USAGE
 - generators/dragonfly_app/dragonfly_app_generator.rb
-- generators/dragonfly_app/templates/custom_processing.erb
 - generators/dragonfly_app/templates/initializer.erb
 - generators/dragonfly_app/templates/metal_file.erb
 - irbrc.rb
@@ -59,7 +67,6 @@ files:
 - lib/dragonfly/active_record_extensions/class_methods.rb
 - lib/dragonfly/active_record_extensions/instance_methods.rb
 - 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
@@ -71,6 +78,8 @@ files:
 - 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/delegatable.rb
+- lib/dragonfly/delegator.rb
 - lib/dragonfly/encoding/base.rb
 - lib/dragonfly/encoding/r_magick_encoder.rb
 - lib/dragonfly/encoding/transparent_encoder.rb
@@ -78,7 +87,7 @@ files:
 - lib/dragonfly/middleware.rb
 - lib/dragonfly/middleware_with_cache.rb
 - lib/dragonfly/parameters.rb
-- lib/dragonfly/processing/processor.rb
+- lib/dragonfly/processing/base.rb
 - lib/dragonfly/processing/r_magick_processor.rb
 - lib/dragonfly/r_magick_configuration.rb
 - lib/dragonfly/rails/images.rb
@@ -87,6 +96,7 @@ files:
 - samples/beach.png
 - samples/egg.png
 - samples/round.gif
+- samples/sample.docx
 - samples/taj.jpg
 - spec/argument_matchers.rb
 - spec/dragonfly/active_record_extensions/attachment_spec.rb
@@ -95,12 +105,14 @@ files:
 - spec/dragonfly/active_record_extensions/model_spec.rb
 - spec/dragonfly/active_record_extensions/models.rb
 - spec/dragonfly/active_record_extensions/spec_helper.rb
-- spec/dragonfly/analysis/analyser_spec.rb
 - spec/dragonfly/analysis/r_magick_analyser_spec.rb
 - spec/dragonfly/app_spec.rb
 - spec/dragonfly/configurable_spec.rb
 - spec/dragonfly/data_storage/data_store_spec.rb
 - spec/dragonfly/data_storage/file_data_store_spec.rb
+- spec/dragonfly/delegatable_spec.rb
+- spec/dragonfly/delegator_spec.rb
+- spec/dragonfly/encoding/r_magick_encoder_spec.rb
 - spec/dragonfly/extended_temp_object_spec.rb
 - spec/dragonfly/middleware_spec.rb
 - spec/dragonfly/middleware_with_cache_spec.rb
@@ -113,7 +125,12 @@ files:
 - spec/image_matchers.rb
 - spec/simple_matchers.rb
 - spec/spec_helper.rb
-has_rdoc: true
+- yard/handlers/configurable_attr_handler.rb
+- yard/setup.rb
+- yard/templates/default/fulldoc/html/css/common.css
+- yard/templates/default/module/html/configuration_summary.erb
+- yard/templates/default/module/setup.rb
+has_rdoc: yard
 homepage: http://github.com/markevans/dragonfly
 licenses: []
 
@@ -149,12 +166,14 @@ test_files:
 - spec/dragonfly/active_record_extensions/model_spec.rb
 - spec/dragonfly/active_record_extensions/models.rb
 - spec/dragonfly/active_record_extensions/spec_helper.rb
-- spec/dragonfly/analysis/analyser_spec.rb
 - spec/dragonfly/analysis/r_magick_analyser_spec.rb
 - spec/dragonfly/app_spec.rb
 - spec/dragonfly/configurable_spec.rb
 - spec/dragonfly/data_storage/data_store_spec.rb
 - spec/dragonfly/data_storage/file_data_store_spec.rb
+- spec/dragonfly/delegatable_spec.rb
+- spec/dragonfly/delegator_spec.rb
+- spec/dragonfly/encoding/r_magick_encoder_spec.rb
 - spec/dragonfly/extended_temp_object_spec.rb
 - spec/dragonfly/middleware_spec.rb
 - spec/dragonfly/middleware_with_cache_spec.rb

data/features/support/image_helpers.rb

@@ -1,9 +0,0 @@
-module ImageHelpers
-  
-  def make_image_request(name, parameters = {})
-    request = Rack::MockRequest.new(APP)
-    url = APP.url_handler.url_for(TEMP_IMAGES[name], parameters)
-    @response = request.get(url)
-  end
-  
-end

data/generators/dragonfly_app/templates/custom_processing.erb

@@ -1,13 +0,0 @@
-module <%= module_name %>
-
-  # Define any of your own custom processing methods here
-  # e.g.
-  # def my_processing_method(<%= temp_object_name %>, opts={})
-  #   # ...do processing here - you can use methods like
-  #   # <%= temp_object_name %>.data, <%= temp_object_name %>.path, etc.
-  #   # (see Dragonfly::ExtendedTempObject for more details)
-  #   #
-  #   # the method must return a String, Tempfile, File, or Dragonfly::TempObject
-  # end
-
-end

data/lib/dragonfly/analysis/analyser.rb

@@ -1,45 +0,0 @@
-module Dragonfly
-  module Analysis
-    class Analyser
-      
-      def initialize
-        @analysers = []
-      end
-      
-      include Configurable
-
-      def register(analyser)
-        analysers.unshift(analyser)
-      end
-      configuration_method :register
-
-      def mime_type(temp_object)
-        analysers.each do |analyser|
-          mime_type = analyser.mime_type(temp_object)
-          return mime_type if mime_type
-        end
-        nil
-      end
-      
-      def analysis_methods
-        analysers.map{|a| a.public_methods(false) }.flatten.uniq
-      end
-      
-      def has_analysis_method?(method)
-        analysis_methods.include?(method.to_s)
-      end
-      
-      private
-      
-      attr_reader :analysers
-
-      def method_missing(meth, *args)
-        analysers.each do |analyser|
-          return analyser.send(meth, *args) if analyser.respond_to?(meth)
-        end
-        super
-      end
-      
-    end
-  end
-end