dragonfly 0.7.7 → 0.8.0

data/extra_docs/Analysers.md

@@ -19,14 +19,14 @@ and an image object (actually a {Dragonfly::Job Job} object)...
 
 We can analyse it using any analysis methods that have been registered with the analyser.
 
-RMagickAnalyser
----------------
-The {Dragonfly::Analysis::RMagickAnalyser RMagickAnalyser} is registered by default by the
-{Dragonfly::Config::RMagick RMagick configuration} used by 'dragonfly/rails/images'.
+ImageMagickAnalyser
+-------------------
+The {Dragonfly::Analysis::ImageMagickAnalyser ImageMagickAnalyser} is registered by default by the
+{Dragonfly::Config::ImageMagick ImageMagick configuration} used by 'dragonfly/rails/images'.
 
 If not already registered:
 
-    app.analyser.register(Dragonfly::Analysis::RMagickAnalyser)
+    app.analyser.register(Dragonfly::Analysis::ImageMagickAnalyser)
 
 gives us these methods:
 
@@ -39,6 +39,15 @@ gives us these methods:
     image.number_of_colours   # => 34703
     image.format              # => :png
 
+RMagickAnalyser
+-------------------
+The {Dragonfly::Analysis::RMagickAnalyser RMagickAnalyser} uses the {http://rmagick.rubyforge.org RMagick} library and provides methods `width`, `height`, `aspect_ratio`,
+`portrait?`, `landscape?`, `depth`, `number_of_colours` and `format` like the ImageMagickAnalyser.
+
+You can tell it not to use the file system when registering it
+
+    app.analyser.register(Dragonfly::Analysis::RMagickAnalyser){|a| a.use_filesystem = false }
+
 FileCommandAnalyser
 -------------------
 The {Dragonfly::Analysis::FileCommandAnalyser FileCommandAnalyser} is registered by default by the
@@ -72,7 +81,7 @@ To register a single custom analyser:
 
     image.wobbliness    # => 71
 
-You can create a class like the RMagick one above, in which case all public methods will be counted as analysis methods.
+You can create a class like the ImageMagick one above, in which case all public methods will be counted as analysis methods.
 Each method takes the temp_object as its argument.
 
     class MyAnalyser

data/extra_docs/Configuration.md

@@ -65,6 +65,19 @@ Saved configurations
 Saved configurations are useful if you often configure the app the same way.
 There are a number that are provided with Dragonfly:
 
+ImageMagick
+-----------
+
+    app.configure_with(:imagemagick)
+
+The {Dragonfly::Config::ImageMagick ImageMagick configuration} registers the app with the {Dragonfly::Analysis::ImageMagickAnalyser ImageMagickAnalyser}, {Dragonfly::Processing::ImageMagickProcessor ImageMagickProcessor},
+{Dragonfly::Encoding::ImageMagickEncoder ImageMagickEncoder} and {Dragonfly::Generation::ImageMagickGenerator ImageMagickGenerator}, and adds the 'job shortcuts'
+`thumb`, `jpg`, `png`, `gif` and `convert`.
+
+The file 'dragonfly/rails/images' does this for you.
+
+The processor, analyser, encoder and generator pass data around using tempfiles.
+
 RMagick
 -------
 
@@ -74,8 +87,6 @@ The {Dragonfly::Config::RMagick RMagick configuration} registers the app with th
 {Dragonfly::Encoding::RMagickEncoder RMagickEncoder} and {Dragonfly::Generation::RMagickGenerator RMagickGenerator}, and adds the 'job shortcuts'
 `thumb`, `jpg`, `png` and `gif`.
 
-The file 'dragonfly/rails/images' does this for you.
-
 By default the processor, analyser, encoder and generator pass data around using tempfiles.
 You can make it pass data around using in-memory strings using
 

data/extra_docs/Encoding.md

@@ -20,14 +20,14 @@ and an image object (actually a {Dragonfly::Job Job} object)...
 
 We can encode it to any format registered with the encoder.
 
-RMagickEncoder
-----------------
-The {Dragonfly::Encoding::RMagickEncoder RMagickEncoder} is registered by default by
-the {Dragonfly::Config::RMagick RMagick configuration} used by 'dragonfly/rails/images'.
+ImageMagickEncoder
+------------------
+The {Dragonfly::Encoding::ImageMagickEncoder ImageMagickEncoder} is registered by default by
+the {Dragonfly::Config::ImageMagick ImageMagick configuration} used by 'dragonfly/rails/images'.
 
 If not already registered:
 
-    app.encoder.register(Dragonfly::Encoding::RMagickEncoder)
+    app.encoder.register(Dragonfly::Encoding::ImageMagickEncoder)
 
 gives us:
 
@@ -36,7 +36,20 @@ gives us:
     image.encode(:png)
     image.encode(:tiff)
 
-and various other formats (see {Dragonfly::Encoding::RMagickEncoder RMagickEncoder})
+and various other formats (see {Dragonfly::Encoding::ImageMagickEncoder ImageMagickEncoder}).
+
+You can also pass additional options to the imagemagick command line:
+
+    image.encode(:jpg, '-quality 10')
+
+RMagickEncoder
+--------------
+The {Dragonfly::Encoding::RMagickEncoder RMagickEncoder} uses the {http://rmagick.rubyforge.org RMagick} library to do similar things to the
+ImageMagickEncoder above.
+
+You can tell it not to use the file system when registering it using
+
+    app.encoder.register(Dragonfly::Encoding::RMagickEncoder){|e| e.use_filesystem = false }
 
 Lazy evaluation
 ---------------
@@ -68,7 +81,7 @@ To register a custom encoder, for e.g. pdf format:
 
 If `:unable_to_handle` is thrown, the next most recently registered encoder is used, and so on.
 
-Alternatively you can create a class like the RMagick one above, which implements the method `encode`, and register this.
+Alternatively you can create a class like the ImageMagick one above, which implements the method `encode`, and register this.
 
     class MyEncoder
 

data/extra_docs/GeneralUsage.md

@@ -110,9 +110,12 @@ To define this shortcut:
       # ...
     end
 
-The {Dragonfly::Config::RMagick RMagick} configuration comes with the pre-defined shortcuts:
+The {Dragonfly::Config::ImageMagick ImageMagick} configuration comes with the pre-defined shortcuts:
 
-    image.thumb('40x30')   # same as image.process(:thumb, '40x30')
-    image.jpg              # same as image.encode(:jpg)
-    image.png              # same as image.encode(:png)
-    image.gif              # same as image.encode(:gif)
+    image.thumb('40x30')              # same as image.process(:thumb, '40x30')
+    image.jpg                         # same as image.encode(:jpg)
+    image.png                         # same as image.encode(:png)
+    image.gif                         # same as image.encode(:gif)
+    image.convert('-scale 30x30')     # same as image.process(:convert, '-scale 30x30')
+
+`thumb` and `convert` can optionally take a format (e.g. :gif) as the second argument.

data/extra_docs/Generators.md

@@ -15,14 +15,14 @@ we can get generated content using
 
 where `:some_method` is added by the configured generators.
 
-RMagickGenerator
-----------------
-The {Dragonfly::Generation::RMagickGenerator RMagickGenerator} is registered by default by the
-{Dragonfly::Config::RMagick RMagick configuration} used by 'dragonfly/rails/images'.
+ImageMagickGenerator
+--------------------
+The {Dragonfly::Generation::ImageMagickGenerator ImageMagickGenerator} is registered by default by the
+{Dragonfly::Config::ImageMagick ImageMagick configuration} used by 'dragonfly/rails/images'.
 
 If not already registered:
 
-    app.generator.register(Dragonfly::Generation::RMagickGenerator)
+    app.generator.register(Dragonfly::Generation::ImageMagickGenerator)
 
 gives us these methods:
 
@@ -48,9 +48,19 @@ Note that the options are meant to resemble css as much as possible. You can als
 
 You can use `padding-top`, `padding-left`, etc., as well as the standard css shortcuts for `padding` (it assumes unit is px).
 
-An alternative for `:font_family` is `:font` (see {http://www.imagemagick.org/RMagick/doc/draw.html#font}), which could be a complete filename.
+An alternative for `:font_family` is `:font` (see {http://www.imagemagick.org/script/command-line-options.php#font}), which could be a complete filename.
 Available fonts are those available on your system.
 
+RMagickGenerator
+----------------
+The {Dragonfly::Generation::RMagickGenerator RMagickGenerator} gives you `plasma` and `text` like the imagemagick generator above, using the
+{http://rmagick.rubyforge.org RMagick} library.
+
+You can tell it not to use the file system when registering it
+
+    app.generator.register(Dragonfly::Generation::RMagickGenerator){|g| g.use_filesystem = false }
+
+
 Custom Generators
 -----------------
 To register a single custom generator:
@@ -62,7 +72,7 @@ To register a single custom generator:
     app.generate(:blank_image, 'red')      # => 'Job' object which we can get data, etc.
 
 
-Or create a class like the RMagick one above, in which case all public methods will be counted as generator methods.
+Or create a class like the ImageMagick one above, in which case all public methods will be counted as generator methods.
 
     class RoundedCornerGenerator
 

data/extra_docs/Heroku.md

@@ -12,7 +12,6 @@ Assuming you have an S3 account set up...
 
 Gem dependencies:
 
-    - rmagick (require as 'RMagick')
     - aws-s3 (require as aws/s3)
     - dragonfly
 
@@ -21,7 +20,7 @@ Initializer (e.g. config/initializers/dragonfly.rb):
     require 'dragonfly'
     app = Dragonfly[:images]
 
-    app.configure_with(:rmagick)
+    app.configure_with(:imagemagick)
     app.configure_with(:rails)
     app.configure_with(:heroku, 'my_bucket_name') if Rails.env.production?
 

data/extra_docs/MimeTypes.md

@@ -27,7 +27,7 @@ You can also do this inside a configuration block.
 Analysers
 ---------
 The {Dragonfly::Analysis::FileCommandAnalyser FileCommandAnalyser} has a `mime_type` method and the
-{Dragonfly::Analysis::RMagickAnalyser RMagickAnalyser} has a `format` method.
+{Dragonfly::Analysis::ImageMagickAnalyser ImageMagickAnalyser} has a `format` method.
 
 These are both registered by default when you use the preconfigured 'dragonfly/rails/images' file.
 

data/extra_docs/Models.md

@@ -190,7 +190,7 @@ As you can see, a couple of things are added by the model. You can also access t
 
     app.fetch(@album.cover_image_uid).meta     # => {:model_class=>"Album", ...}
 
-'Magic' Attributes
+"Magic" Attributes
 ------------------
 An accessor like `cover_image` only relies on the accessor `cover_image_uid` to work.
 However, in some cases you may want to record some other properties, whether it be for using in queries, or

data/extra_docs/Mongo.md

@@ -20,8 +20,8 @@ In config/initializers/dragonfly.rb:
     # Get database name from config/mongoid.yml
     db = YAML.load_file(Rails.root.join('config/mongoid.yml'))[Rails.env]['database']
 
-    # Configure to use RMagick, Rails defaults, and the Mongo data store
-    app.configure_with(:rmagick)
+    # Configure to use ImageMagick, Rails defaults, and the Mongo data store
+    app.configure_with(:imagemagick)
     app.configure_with(:rails) do |c|
       c.datastore = Dragonfly::DataStorage::MongoDataStore.new :database => db
     end

data/extra_docs/Processing.md

@@ -19,14 +19,14 @@ and an image object (actually a {Dragonfly::Job Job} object)...
 
 We can process it using any processing methods that have been registered with the processor.
 
-RMagickProcessor
-----------------
-The {Dragonfly::Processing::RMagickProcessor RMagickProcessor} is registered by default by
-the {Dragonfly::Config::RMagick RMagick configuration} used by 'dragonfly/rails/images'.
+ImageMagickProcessor
+--------------------
+The {Dragonfly::Processing::ImageMagickProcessor ImageMagickProcessor} is registered by default by
+the {Dragonfly::Config::ImageMagick ImageMagick configuration} used by 'dragonfly/rails/images'.
 
 If not already registered:
 
-    app.processor.register(Dragonfly::Processing::RMagickProcessor)
+    app.processor.register(Dragonfly::Processing::ImageMagickProcessor)
 
 gives us these methods:
 
@@ -45,8 +45,6 @@ gives us these methods:
 
     image.process(:rotate, 45, :background_colour => 'transparent')   # default bg black
 
-    image.process(:vignette)                     # options :x, :y, :radius, :sigma
-
 The method `thumb` takes a geometry string and calls `resize`, `resize_and_crop` or `crop` accordingly.
 
     image.process(:thumb, '400x300')             # calls resize
@@ -67,6 +65,16 @@ Below are some examples of geometry strings:
     '400x300se'          # crop, with south-east gravity
     '400x300+50+100'     # crop from the point 50,100 with width, height 400,300
 
+RMagickProcessor
+----------------
+The {Dragonfly::Processing::RMagickProcessor RMagickProcessor} uses the {http://rmagick.rubyforge.org RMagick} library and provides the methods
+`thumb`, `crop`, `flip`, `flop`, `greyscale`, `resize`, `resize_and_crop` and `rotate` like the ImageMagickProcessor above.
+
+You can tell it not to use the file system when registering it
+
+    app.processor.register(Dragonfly::Processing::RMagickProcessor){|p| p.use_filesystem = false }
+
+
 Lazy evaluation
 ---------------
 

data/extra_docs/Rack.md

@@ -28,12 +28,11 @@ Example: Using to serve resized images
     require 'rubygems'
     require 'dragonfly'
 
-    app = Dragonfly[:images]
-    app.configure_with(:rmagick)
+    app = Dragonfly[:images].configure_with(:imagemagick)
 
     run app
 
-This enables the app to use all the RMagick goodies provided by Dragonfly (see {file:Configuration}).
+This enables the app to use all the ImageMagick goodies provided by Dragonfly (see {file:Configuration}).
 By default the {Dragonfly::DataStorage::FileDataStore file data store} is used.
 
 In the console:

data/extra_docs/Rails2.md

@@ -16,7 +16,7 @@ config/initializers/dragonfly.rb:
     require 'dragonfly'
 
     app = Dragonfly[:images]
-    app.configure_with(:rmagick)
+    app.configure_with(:imagemagick)
     app.configure_with(:rails)
 
     app.define_macro(ActiveRecord::Base, :image_accessor)
@@ -34,8 +34,7 @@ Gems
 ----
 environment.rb
 
-    config.gem 'dragonfly', '~>0.7.5'
-    config.gem 'rmagick', :lib => 'RMagick'
+    config.gem 'dragonfly', '~>0.7.7'
     config.gem 'rack-cache', :lib => 'rack/cache'
 
 Capistrano

data/extra_docs/Rails3.md

@@ -16,7 +16,7 @@ config/initializers/dragonfly.rb:
     require 'dragonfly'
 
     app = Dragonfly[:images]
-    app.configure_with(:rmagick)
+    app.configure_with(:imagemagick)
     app.configure_with(:rails)
 
     app.define_macro(ActiveRecord::Base, :image_accessor)
@@ -33,8 +33,7 @@ application.rb:
 Gemfile
 -------
 
-    gem 'dragonfly', '~>0.7.5'
-    gem 'rmagick', :require => 'RMagick'
+    gem 'dragonfly', '~>0.7.7'
     gem 'rack-cache', :require => 'rack/cache'
 
 Capistrano

data/extra_docs/Sinatra.md

@@ -2,7 +2,7 @@ Sinatra
 =======
 You can use {Dragonfly::Job Job}'s `to_response` method like so:
 
-    app = Dragonfly[:images].configure_with(:rmagick)
+    app = Dragonfly[:images].configure_with(:imagemagick)
 
     get '/images/:size.:format' do |size, format|
       app.fetch_file('~/some/image.png').thumb(size).encode(format).to_response(env)
@@ -15,7 +15,7 @@ a path segment.
 
 or you can mount as a middleware, like in rails:
 
-    Dragonfly[:images].configure_with(:rmagick) do |c|
+    Dragonfly[:images].configure_with(:imagemagick) do |c|
       c.url_path_prefix = '/media'
     end
 

data/extra_docs/URLs.md

@@ -56,8 +56,8 @@ And you can override it:
 
     app.fetch('some/uid').url(:suffix => '/yellowbelly')     # "...b21lL3VpZA/yellowbelly"
 
-Content-Disposition and downloaded filename
--------------------------------------------
+Content-Disposition
+-------------------
 You can manually set the content-disposition of the response:
 
     app.content_disposition = :attachment    # should be :inline or :attachment (or :hidden)
@@ -74,6 +74,8 @@ You can also use a block:
       end
     }
 
+Downloaded filename
+-------------------
 To specify the filename the browser uses for 'Save As' dialogues:
 
     app.content_filename = proc{|job, request|
@@ -91,9 +93,9 @@ Routed Endpoints
 ----------------
 You can also use a number of Rack-based routers and create Dragonfly endpoints.
 
-If we have an app set up for using RMagick:
+If we have an app set up for using ImageMagick:
 
-    app = Dragonfly[:images].configure_with(:rmagick)
+    app = Dragonfly[:images].configure_with(:imagemagick)
 
 Then to get the url '/text/hello' to display the text "hello"...
 

data/features/3.0.3.feature

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

data/features/steps/rails_steps.rb

@@ -2,7 +2,7 @@ RAILS_APP_NAME = 'tmp_app'
 FIXTURES_PATH = ROOT_PATH + "/fixtures"
 GEMFILES = {
   '2.3.5' => ROOT_PATH + '/Gemfile.rails.2.3.5',
-  '3.0.0' => ROOT_PATH + '/Gemfile',
+  '3.0.3' => ROOT_PATH + '/Gemfile',
 }
 
 def fixture_path(version)
@@ -17,7 +17,7 @@ end
 
 {
   '2.3.5' => "BUNDLE_GEMFILE=#{GEMFILES['2.3.5']} rails #{RAILS_APP_NAME} -m template.rb",
-  '3.0.0' => "BUNDLE_GEMFILE=#{GEMFILES['3.0.0']} bundle exec rails new #{RAILS_APP_NAME} -m template.rb"
+  '3.0.3' => "BUNDLE_GEMFILE=#{GEMFILES['3.0.3']} bundle exec rails new #{RAILS_APP_NAME} -m template.rb"
 }.each do |version, rails_command|
 
   Given /^a Rails #{version} application set up for using dragonfly$/ do

data/features/support/env.rb

@@ -9,7 +9,7 @@ ROOT_PATH = File.expand_path(File.dirname(__FILE__) + "/../..")
 # A hash of <name for reference> => <dragonfly uid> pairs
 TEMP_FILES = {}
 
-Dragonfly[:images].configure_with(:rmagick)
+Dragonfly[:images].configure_with(:imagemagick)
 Dragonfly[:files].configure do |c|
   c.analyser.register(Dragonfly::Analysis::FileCommandAnalyser)
 end

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

@@ -1,4 +1,4 @@
-<form action="/albums" enctype="multipart/form-data" method="post">
-  <input name="album[cover_image]" type="file" /> 
-  <input type="submit" value="Create" /> 
-</form>
+<% form_for @album, :html => {:multipart => true} do |f| %>
+  <%= f.file_field :cover_image %>
+  <%= f.submit :value => 'Create' %>
+<% end %>

data/fixtures/rails_2.3.5/template.rb

@@ -1,5 +1,4 @@
 gem 'rack-cache', :lib => 'rack/cache'
-gem 'rmagick', :lib => 'RMagick'
 gem 'cucumber'
 generate 'cucumber'