fog-dragonfly 0.8.1

data/extra_docs/Heroku.md

@@ -0,0 +1,50 @@
+Heroku
+======
+
+The default configuration won't work out of the box for Heroku, because
+
+- Heroku doesn't allow saving files to the filesystem (although it does use tempfiles)
+- We won't need {http://tomayko.com/src/rack-cache/ Rack::Cache} on Heroku because it already uses the caching proxy {http://varnish.projects.linpro.no/ Varnish}, which we can make use of
+
+Instead of the normal {Dragonfly::DataStorage::FileDataStore FileDataStore}, we can use the {Dragonfly::DataStorage::S3DataStore S3DataStore}.
+
+Assuming you have an S3 account set up...
+
+Gem dependencies:
+
+    - aws-s3 (require as aws/s3)
+    - dragonfly
+
+Initializer (e.g. config/initializers/dragonfly.rb):
+
+    require 'dragonfly'
+    app = Dragonfly[:images]
+
+    app.configure_with(:imagemagick)
+    app.configure_with(:rails)
+    app.configure_with(:heroku, 'my_bucket_name') if Rails.env.production?
+
+    app.define_macro(ActiveRecord::Base, :image_accessor)
+
+The datastore remains as the {Dragonfly::DataStorage::FileDataStore FileDataStore} for non-production environments.
+
+environment.rb (application.rb in Rails 3):
+
+    # make sure the last arg is the same as the app's configured prefix
+    config.middleware.insert_before 'Rack::Lock', 'Dragonfly::Middleware', :images, '/media'
+
+We don't store the S3 access key and secret in the repository, rather we use Heroku's
+{http://docs.heroku.com/config-vars config variables} using the command line (we only have to do this once).
+
+From your app's directory:
+
+    heroku config:add S3_KEY=XXXXXXXXX S3_SECRET=XXXXXXXXXX
+
+Obviously replace 'XXXXXXXXX' with your access key and secret.
+
+Now you can benefit from super-fast images served straight from Heroku's cache!
+
+NOTE: HEROKU'S CACHE IS CLEARED EVERY TIME YOU DEPLOY!!!
+
+If this is an issue, you may want to look into using something like a Memcached add-on, or maybe an after-deploy hook for hitting specific Dragonfly urls you want to cache, etc.
+It won't be a problem for most sites though.

data/extra_docs/Index.md

@@ -0,0 +1,36 @@
+Dragonfly is a {http://rack.rubyforge.org Rack} framework for on-the-fly image handling in Ruby.
+
+It is suitable for using with web frameworks such as Rails(2.3 and 3), Sinatra, etc.
+
+I actually lied about image handling - it can be used for any type of content.
+
+See the links on the right for more info.
+
+**NOTE: the API has changed since v0.6.2!
+[Docs for v0.6.2 are here](v0.6.2/index.html) for a very limited time.**
+
+Installation
+------------
+
+    gem install dragonfly
+
+Add-ons
+-------
+For third-party add-ons, see [the Add-ons wiki](http://github.com/markevans/dragonfly/wiki/Dragonfly-add-ons)
+
+Issues
+------
+Please use the <a href="http://github.com/markevans/dragonfly/issues">github issue tracker</a>.
+
+Suggestions/Questions
+---------------------
+{http://groups.google.com/group/dragonfly-users}
+
+Credits
+-------
+- [Mark Evans](http://github.com/markevans) (author)
+- Loads of helpful comments, issues, questions, suggestions and insults from others - you know who you are!
+
+Copyright
+---------
+Copyright (c) 2009-2010 Mark Evans. See LICENSE for details.

data/extra_docs/MimeTypes.md

@@ -0,0 +1,40 @@
+Mime Types
+==========
+
+Responses from the Dragonfly app have the HTTP 'Content-Type' header set.
+
+This is decided by the first found from:
+
+1. The requested format (e.g. when encode is specifically called)
+2. The original file extension (you can configure it to ignore this if you wish)
+3. Analyse the content using the analyser's 'mime_type' method (if exists)
+4. Analyse the content using the analyser's 'format' method (if exists)
+5. Use the fallback mime-type (default 'application/octet-stream')
+
+Note that 'format' means 'jpg', 'png', etc. whereas mime-type would be 'image/jpeg', image/png', etc.
+Formats are mapped to mime-types using the app's registered list of mime-types.
+
+Registered mime-types
+---------------------
+Registered mime-types default to the list given by Rack (see {http://rack.rubyforge.org/doc/Rack/Mime.html#MIME_TYPES Rack mime-types}).
+
+To register a mime-type for the format 'egg':
+
+    Dragonfly[:my_app].register_mime_type(:egg, 'fried/egg')
+
+You can also do this inside a configuration block.
+
+Analysers
+---------
+The {Dragonfly::Analysis::FileCommandAnalyser FileCommandAnalyser} has a `mime_type` method and the
+{Dragonfly::Analysis::ImageMagickAnalyser ImageMagickAnalyser} has a `format` method.
+
+These are both registered by default when you use the preconfigured 'dragonfly/rails/images' file.
+
+Fallback mime-type
+------------------
+By default this is 'application/octet-stream', but it can be changed using
+
+    Dragonfly[:my_app].fallback_mime_type = 'meaty/beef'
+
+This can also be done inside a configuration block.

data/extra_docs/Models.md

@@ -0,0 +1,266 @@
+Using with Models
+=================
+
+You can extend ActiveModel-compatible models to make working with content such as images
+as easy as working with strings or numbers!
+
+The examples below assume an initialized Dragonfly app, e.g.
+
+    app = Dragonfly[:images]
+
+ActiveRecord
+------------
+If you've required 'dragonfly/rails/images', then the following step will be already done for you.
+Otherwise:
+
+    app.define_macro(ActiveRecord::Base, :image_accessor)
+
+defines the macro `image_accessor` on any ActiveRecord models.
+
+Mongoid
+-------
+
+    app.define_macro_on_include(Mongoid::Document, :image_accessor)
+
+defines the macro `image_accessor` on any models that include `Mongoid::Document`
+
+Adding accessors
+----------------
+Now we have the method `image_accessor` available in our model classes, which we can use as many times as we like
+
+    class Album
+      image_accessor :cover_image
+      image_accessor :band_photo  # Note: this is a different image altogether, not a thumbnail of cover_image
+    end
+
+Each accessor (e.g. `cover_image`) depends on a string field to actually hold the datastore uid,
+named by appending the suffix `_uid` (e.g. `cover_image_uid`).
+
+For example, ActiveRecord models need a migration such as:
+
+    class MyMigration < ActiveRecord::Migration
+
+      def self.up
+        add_column :albums, :cover_image_uid, :string
+        add_column :albums, :band_photo_uid, :string
+      end
+
+      def self.down
+        remove_column :albums, :cover_image_uid
+        remove_column :albums, :band_photo_uid
+      end
+
+    end
+
+Using the accessors
+-------------------
+
+We can use the attribute much like other other model attributes:
+
+    @album = Album.new
+
+    @album.cover_image = "\377???JFIF\000\..."             # can assign as a string...
+    @album.cover_image = File.new('path/to/my_image.png')  # ... or as a file...
+    @album.cover_image = some_tempfile                     # ... or as a tempfile...
+    @album.cover_image = @album.band_photo                 # ... or as another Dragonfly attachment
+
+    @album.cover_image          # => #<Dragonfly::ActiveModelExtensions::Attachment:0x103ef6128...
+
+    @album.cover_image = nil
+    @album.cover_image          # => nil
+
+We can inspect properties of the attribute
+
+    @album.cover_image.width                          # => 280
+    @album.cover_image.height                         # => 140
+    @album.cover_image.number_of_colours              # => 34703
+    @album.cover_image.mime_type                      # => 'image/png'
+
+The properties available (i.e. 'width', etc.) come from the app's registered analysers - see {file:Analysers.md Analysers}.
+
+We can play around with the data
+
+    @album.cover_image.data                           # => "\377???JFIF\000\..."
+    @album.cover_image.to_file('out.png')             # writes to file 'out.png' and returns a readable file object
+    @album.cover_image.tempfile                       # => #<File:/var/folders/st/strHv74sH044JPabSiODz... a closed Tempfile object
+    @album.cover_image.file                           # => #<File:/var/folders/st/strHv74sH044JPabSiODz... a readable (open) File object
+    @album.cover_image.file do |f|                    # Yields an open file object, returns the return value of
+      data = f.read(256)                              #  the block, and closes the file object
+    end
+    @album.cover_image.path                           # => '/var/folders/st/strHv74sH044JPabSiODz...' i.e. the path of the tempfile
+    @album.cover_image.size                           # => 134507 (size in bytes)
+
+We can process the data
+
+    image = @album.cover_image.process(:thumb, '20x20')   # returns a 'Job' object, with similar properties
+    image.width                                          # => 20
+    @album.cover_image.width                              # => 280 (no change)
+
+The available processing methods available (i.e. 'thumb', etc.) come from the {Dragonfly} app's registered processors - see {file:Processing.md Processing}
+
+We can encode the data
+
+    image = @album.cover_image.encode(:gif)   # returns a 'Job' object, with similar properties
+    image.format                              # => :gif
+    @album.cover_image.format                 # => :png (no change)
+
+The encoding is implemented by the {Dragonfly} app's registered encoders (which will usually just be one) - see {file:Encoding.md Encoding}
+
+We can use configured shortcuts for processing/encoding, and chain them:
+
+    @album.cover_image.thumb('300x200#ne')     # => returns a 'Job' object, with similar properties
+
+We can chain all these things much like ActiveRecord scopes:
+
+    @album.cover_image.png.thumb('300x200#ne').process(:greyscale).encode(:tiff)
+
+Because the processing/encoding methods are lazy, no actual processing or encoding is done until a method like `data`, `file`, `to_file`, `width`, etc. is called.
+You can force the processing to be done if you must by then calling `apply`.
+
+    @album.cover_image.process(:greyscale).apply
+
+Persisting
+----------
+When the model is saved, a before_save callback persists the data to the {Dragonfly::App App}'s configured datastore (see {file:DataStorage.md DataStorage})
+The uid column is then filled in.
+
+    @album = Album.new
+
+    @album.cover_image_uid                                   # => nil
+
+    @album.cover_image = File.new('path/to/my_image.png')
+    @album.cover_image_uid                                   # => nil
+
+    @album.save
+    @album.cover_image_uid                                   # => '2009/12/05/file.png' (some unique uid, used by the datastore)
+
+URLs
+----
+Once the model is saved, we can get a url for the image (which is served by the Dragonfly {Dragonfly::App App} itself), and for its processed/encoded versions:
+
+    @album.cover_image.url                           # => '/media/BAhbBlsHOgZmIhgy...'
+    @album.cover_image.thumb('300x200#nw').url       # => '/media/BAhbB1sYusgZhgyM...'
+    @album.cover_image.process(:greyscale).jpg.url   # => '/media/BnA6CnRodW1iIg8z...'
+
+Because the processing/encoding methods (including shortcuts like `thumb` and `jpg`) are lazy, no processing or encoding is actually done.
+
+Validations
+-----------
+`validates_presence_of` and `validates_size_of` work out of the box, and Dragonfly also provides `validates_property`.
+
+    class Album
+
+      validates_presence_of :cover_image
+      validates_size_of :cover_image, :maximum => 500.kilobytes
+
+      validates_property :format, :of => :cover_image, :in => [:jpeg, :png, :gif]
+      # ..or..
+      validates_property :mime_type, :of => :cover_image, :in => %w(image/jpeg image/png image/gif)
+
+      validates_property :width, :of => :cover_image, :in => (0..400), :message => "é demais cara!"
+
+      # ...
+    end
+
+The property argument of `validates_property` will generally be one of the registered analyser properties as described in {file:Analysers.md Analysers}.
+However it would actually work for arbitrary properties, including those of non-dragonfly model attributes.
+
+Name and extension
+------------------
+If the object assigned is a file, or responds to `original_filename` (as is the case with file uploads in Rails, etc.), then `name` will be set.
+
+    @album.cover_image = File.new('path/to/my_image.png')
+
+    @album.cover_image.name    # => 'my_image.png'
+    @album.cover_image.ext     # => 'png'
+
+Meta data
+---------
+You can store metadata along with the content data of your attachment:
+
+    @album.cover_image = File.new('path/to/my_image.png')
+    @album.cover_image.meta = {:taken => Date.yesterday}
+    @album.save!
+
+    @album.cover_image.meta      # => {:model_class=>"Album",
+                                 #     :model_attachment=>:cover_image,
+                                 #     :taken=>Sat, 11 Sep 2010}
+
+As you can see, a couple of things are added by the model. You can also access this directly on the {Dragonfly::Job Job} object.
+
+    app.fetch(@album.cover_image_uid).meta     # => {:model_class=>"Album", ...}
+
+"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
+for caching an attribute for performance reasons, etc.
+
+For the properties `name`, `ext`, `size` and any of the registered analysis methods (e.g. `width`, etc. in the examples above),
+this is done automatically for you, if the corresponding accessor exists.
+
+For example - with ActiveRecord, given the migration:
+
+    add_column :albums, :cover_image_width, :integer
+
+This will automatically be set when assigned:
+
+    @album.cover_image = File.new('path/to/my_image.png')
+
+    @album.cover_image_width  # => 280
+
+They can be used to avoid retrieving data from the datastore for analysis
+
+    @album = Album.first
+
+    @album.cover_image.width     # => 280    - no need to retrieve data - takes it from `cover_image_width`
+    @album.cover_image.size      # => 134507 - but this needs to retrieve data from the data store, then analyse
+
+
+Custom Model
+------------
+The accessors only require that your model class implements `before_save`, `before_destroy` and `validates_each`
+(if using validations), as well as of course the `..._uid` field for storing the datastore uid.
+
+Here is an example of a minimal ActiveModel `Album` model:
+
+    class CustomModel::Base
+
+      extend ActiveModel::Callbacks
+      define_model_callbacks :save, :destroy
+
+      include ActiveModel::Validations   # if needed
+
+      def save
+        _run_save_callbacks {
+          # do some saving!
+        }
+      end
+
+      def destroy
+        _run_destroy_callbacks {
+          # do some destroying!
+        }
+      end
+
+    end
+
+Define our `image_accessor` macro...
+
+    app.define_macro(CustomModel::Base, :image_accessor)
+
+...which is used by `Album`:
+
+    class Album < CustomModel::Base
+
+      def cover_image_uid=
+        # ...
+      end
+
+      def cover_image_uid
+        # ...
+      end
+
+      image_accessor :cover_image
+
+    end

data/extra_docs/Mongo.md

@@ -0,0 +1,45 @@
+Mongo
+=====
+Dragonfly can be used with any ActiveModel-compatible model, therefore libraries like [Mongoid](http://mongoid.org) work out of the box.
+
+Furthermore, Mongo DB has support for storing blob-like objects directly in the database (using MongoDB 'GridFS'),
+so you can make use of this with the supplied {Dragonfly::DataStorage::MongoDataStore MongoDataStore}.
+
+For more info about ActiveModel, see {file:Models}.
+
+For more info about using the Mongo data store, see {file:DataStorage}.
+
+Example setup in Rails, using Mongoid
+-------------------------------------
+In config/initializers/dragonfly.rb:
+
+    require 'dragonfly'
+
+    app = Dragonfly[:images]
+
+    # Get database name from config/mongoid.yml
+    db = YAML.load_file(Rails.root.join('config/mongoid.yml'))[Rails.env]['database']
+
+    # 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
+
+    # Allow all mongoid models to use the macro 'image_accessor'
+    app.define_macro_on_include(Mongoid::Document, :image_accessor)
+
+    # ... any other setup, see Rails docs
+
+Then in models:
+
+    class Album
+      include Mongoid::Document
+
+      field :cover_image_uid
+      image_accessor :cover_image
+
+      # ...
+    end
+
+See {file:Models} for more info.

data/extra_docs/Processing.md

@@ -0,0 +1,130 @@
+Processing
+==========
+
+Changing data in some way, e.g. resizing an image, comes under the banner of Processing.
+
+You can register as many processors as you like.
+
+Let's say we have a Dragonfly app
+
+    app = Dragonfly[:images]
+
+and an image object (actually a {Dragonfly::Job Job} object)...
+
+    image = app.fetch('some/uid')
+
+...OR a Dragonfly model accessor...
+
+    image = @album.cover_image
+
+We can process it using any processing methods that have been registered with the processor.
+
+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::ImageMagickProcessor)
+
+gives us these methods:
+
+    image.process(:thumb, '400x300#')            # see below
+
+    image.process(:crop, :width => 40, :height => 50, :x => 20, :y => 30)
+    image.process(:crop, :width => 40, :height => 50, :gravity => 'ne')
+
+    image.process(:flip)                         # flips it vertically
+    image.process(:flop)                         # flips it horizontally
+
+    image.process(:greyscale, :depth => 128)     # default depth 256
+
+    image.process(:resize, '40x40')
+    image.process(:resize_and_crop, :width => 40, :height=> 50, :gravity => 'ne')
+
+    image.process(:rotate, 45, :background_colour => 'transparent')   # default bg black
+
+The method `thumb` takes a geometry string and calls `resize`, `resize_and_crop` or `crop` accordingly.
+
+    image.process(:thumb, '400x300')             # calls resize
+
+Below are some examples of geometry strings:
+
+    '400x300'            # resize, maintain aspect ratio
+    '400x300!'           # force resize, don't maintain aspect ratio
+    '400x'               # resize width, maintain aspect ratio
+    'x300'               # resize height, maintain aspect ratio
+    '400x300>'           # resize only if the image is larger than this
+    '400x300<'           # resize only if the image is smaller than this
+    '50x50%'             # resize width and height to 50%
+    '400x300^'           # resize width, height to minimum 400,300, maintain aspect ratio
+    '2000@'              # resize so max area in pixels is 2000
+    '400x300#'           # resize, crop if necessary to maintain aspect ratio (centre gravity)
+    '400x300#ne'         # as above, north-east gravity
+    '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
+---------------
+
+    new_image = image.process(:some_method)
+
+doesn't actually do anything until you call something on the returned {Dragonfly::Job Job} object, like `url`, `data`, etc.
+
+Bang method
+-----------
+
+    image.process!(:some_method)
+
+modifies the image object itself, rather than returning a new object.
+
+Custom Processors
+-----------------
+
+To register a single custom processor:
+
+    app.processor.add :watermark do |temp_object, *args|
+      # use temp_object.data, temp_object.path, temp_object.file, etc.
+      SomeLibrary.add_watermark(temp_object.data, 'some/watermark/file.png')
+      # return a String, File or Tempfile
+    end
+
+    new_image = image.process(:watermark)
+
+You can create a class like the RMagick one above, in which case all public methods will be counted as processing methods.
+Each method takes the temp_object as its argument, plus any other args.
+
+    class MyProcessor
+
+      def coolify(temp_object, opts={})
+        SomeLib.coolify(temp_object.data, opts)
+      end
+
+      def uglify(temp_object, ugliness)
+        `uglify -i #{temp_object.path} -u #{ugliness}`
+      end
+
+      private
+
+      def my_helper_method
+        # do stuff
+      end
+
+    end
+
+    app.processor.register(MyProcessor)
+
+    new_image = image.coolify(:some => :args)
+
+    new_image = image.uglify(:loads)