oahu-dragonfly 0.8.2

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "oahu-dragonfly"
+  gem.email = "mark@new-bamboo.co.uk"
+  gem.summary = %Q{Ideal gem for handling attachments in Rails, Sinatra and Rack applications.}
+  gem.description = %Q{Dragonfly is a framework that enables on-the-fly processing for any content type.
+  It is especially suited to image handling. Its uses range from image thumbnails to standard attachments to on-demand text generation.}
+  gem.homepage = "http://github.com/markevans/dragonfly"
+  gem.license = "MIT"
+  gem.authors = ["Mark Evans"]
+  gem.add_runtime_dependency('rack')
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => [:spec, :features]
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = []
+end
+YARD::Rake::YardocTask.new 'yard:changed' do |t|
+  t.files   = `git status | grep '.rb' | grep modified | grep -v yard | cut -d' ' -f4`.split
+  t.options = []
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.2

data/config.ru

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler/setup"
+$:.unshift(File.expand_path('../lib', __FILE__))
+require 'dragonfly'
+require 'rack/cache'
+
+APP = Dragonfly[:images].configure_with(:imagemagick)
+
+use Rack::Cache,
+  :verbose     => true,
+  :metastore   => 'file:/var/cache/rack/meta',
+  :entitystore => 'file:/var/cache/rack/body'
+
+run APP

data/docs.watchr

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

data/dragonfly.gemspec

@@ -0,0 +1,297 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dragonfly}
+  s.version = "0.8.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Evans"]
+  s.date = %q{2011-01-11}
+  s.email = %q{mark@new-bamboo.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".specopts",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.rails.2.3.5",
+    "History.md",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "config.ru",
+    "docs.watchr",
+    "dragonfly.gemspec",
+    "extra_docs/Analysers.md",
+    "extra_docs/Caching.md",
+    "extra_docs/Configuration.md",
+    "extra_docs/DataStorage.md",
+    "extra_docs/Encoding.md",
+    "extra_docs/GeneralUsage.md",
+    "extra_docs/Generators.md",
+    "extra_docs/Heroku.md",
+    "extra_docs/Index.md",
+    "extra_docs/MimeTypes.md",
+    "extra_docs/Models.md",
+    "extra_docs/Mongo.md",
+    "extra_docs/Processing.md",
+    "extra_docs/Rack.md",
+    "extra_docs/Rails2.md",
+    "extra_docs/Rails3.md",
+    "extra_docs/Sinatra.md",
+    "extra_docs/URLs.md",
+    "features/3.0.3.feature",
+    "features/images.feature",
+    "features/no_processing.feature",
+    "features/rails_2.3.5.feature",
+    "features/steps/common_steps.rb",
+    "features/steps/dragonfly_steps.rb",
+    "features/steps/rails_steps.rb",
+    "features/support/env.rb",
+    "fixtures/files/app/models/album.rb",
+    "fixtures/files/app/views/albums/new.html.erb",
+    "fixtures/files/app/views/albums/show.html.erb",
+    "fixtures/files/config/initializers/dragonfly.rb",
+    "fixtures/files/features/manage_album_images.feature",
+    "fixtures/files/features/step_definitions/image_steps.rb",
+    "fixtures/files/features/support/paths.rb",
+    "fixtures/files/features/text_images.feature",
+    "fixtures/rails_2.3.5/template.rb",
+    "fixtures/rails_3.0.3/template.rb",
+    "irbrc.rb",
+    "lib/dragonfly.rb",
+    "lib/dragonfly/active_model_extensions.rb",
+    "lib/dragonfly/active_model_extensions/attachment.rb",
+    "lib/dragonfly/active_model_extensions/class_methods.rb",
+    "lib/dragonfly/active_model_extensions/instance_methods.rb",
+    "lib/dragonfly/active_model_extensions/validations.rb",
+    "lib/dragonfly/analyser.rb",
+    "lib/dragonfly/analysis/file_command_analyser.rb",
+    "lib/dragonfly/analysis/image_magick_analyser.rb",
+    "lib/dragonfly/analysis/r_magick_analyser.rb",
+    "lib/dragonfly/app.rb",
+    "lib/dragonfly/config/heroku.rb",
+    "lib/dragonfly/config/image_magick.rb",
+    "lib/dragonfly/config/r_magick.rb",
+    "lib/dragonfly/config/rails.rb",
+    "lib/dragonfly/configurable.rb",
+    "lib/dragonfly/core_ext/array.rb",
+    "lib/dragonfly/core_ext/hash.rb",
+    "lib/dragonfly/core_ext/object.rb",
+    "lib/dragonfly/core_ext/string.rb",
+    "lib/dragonfly/core_ext/symbol.rb",
+    "lib/dragonfly/data_storage.rb",
+    "lib/dragonfly/data_storage/file_data_store.rb",
+    "lib/dragonfly/data_storage/mongo_data_store.rb",
+    "lib/dragonfly/data_storage/s3data_store.rb",
+    "lib/dragonfly/encoder.rb",
+    "lib/dragonfly/encoding/image_magick_encoder.rb",
+    "lib/dragonfly/encoding/r_magick_encoder.rb",
+    "lib/dragonfly/function_manager.rb",
+    "lib/dragonfly/generation/hash_with_css_style_keys.rb",
+    "lib/dragonfly/generation/image_magick_generator.rb",
+    "lib/dragonfly/generation/r_magick_generator.rb",
+    "lib/dragonfly/generator.rb",
+    "lib/dragonfly/image_magick_utils.rb",
+    "lib/dragonfly/job.rb",
+    "lib/dragonfly/job_builder.rb",
+    "lib/dragonfly/job_definitions.rb",
+    "lib/dragonfly/job_endpoint.rb",
+    "lib/dragonfly/loggable.rb",
+    "lib/dragonfly/middleware.rb",
+    "lib/dragonfly/processing/image_magick_processor.rb",
+    "lib/dragonfly/processing/r_magick_processor.rb",
+    "lib/dragonfly/processor.rb",
+    "lib/dragonfly/r_magick_utils.rb",
+    "lib/dragonfly/rails/images.rb",
+    "lib/dragonfly/response.rb",
+    "lib/dragonfly/routed_endpoint.rb",
+    "lib/dragonfly/serializer.rb",
+    "lib/dragonfly/simple_cache.rb",
+    "lib/dragonfly/simple_endpoint.rb",
+    "lib/dragonfly/temp_object.rb",
+    "samples/beach.png",
+    "samples/egg.png",
+    "samples/round.gif",
+    "samples/sample.docx",
+    "samples/taj.jpg",
+    "spec/argument_matchers.rb",
+    "spec/dragonfly/active_model_extensions/active_model_setup.rb",
+    "spec/dragonfly/active_model_extensions/active_record_setup.rb",
+    "spec/dragonfly/active_model_extensions/model_spec.rb",
+    "spec/dragonfly/active_model_extensions/spec_helper.rb",
+    "spec/dragonfly/analyser_spec.rb",
+    "spec/dragonfly/analysis/file_command_analyser_spec.rb",
+    "spec/dragonfly/analysis/image_magick_analyser_spec.rb",
+    "spec/dragonfly/analysis/r_magick_analyser_spec.rb",
+    "spec/dragonfly/analysis/shared_analyser_spec.rb",
+    "spec/dragonfly/app_spec.rb",
+    "spec/dragonfly/config/r_magick_spec.rb",
+    "spec/dragonfly/configurable_spec.rb",
+    "spec/dragonfly/core_ext/array_spec.rb",
+    "spec/dragonfly/core_ext/hash_spec.rb",
+    "spec/dragonfly/core_ext/string_spec.rb",
+    "spec/dragonfly/core_ext/symbol_spec.rb",
+    "spec/dragonfly/data_storage/data_store_spec.rb",
+    "spec/dragonfly/data_storage/file_data_store_spec.rb",
+    "spec/dragonfly/data_storage/mongo_data_store_spec.rb",
+    "spec/dragonfly/data_storage/s3_data_store_spec.rb",
+    "spec/dragonfly/encoding/image_magick_encoder_spec.rb",
+    "spec/dragonfly/encoding/r_magick_encoder_spec.rb",
+    "spec/dragonfly/function_manager_spec.rb",
+    "spec/dragonfly/generation/hash_with_css_style_keys_spec.rb",
+    "spec/dragonfly/generation/image_magick_generator_spec.rb",
+    "spec/dragonfly/generation/r_magick_generator_spec.rb",
+    "spec/dragonfly/generation/shared_generator_spec.rb",
+    "spec/dragonfly/image_magick_utils_spec.rb",
+    "spec/dragonfly/job_builder_spec.rb",
+    "spec/dragonfly/job_definitions_spec.rb",
+    "spec/dragonfly/job_endpoint_spec.rb",
+    "spec/dragonfly/job_spec.rb",
+    "spec/dragonfly/loggable_spec.rb",
+    "spec/dragonfly/middleware_spec.rb",
+    "spec/dragonfly/processing/image_magick_processor_spec.rb",
+    "spec/dragonfly/processing/r_magick_processor_spec.rb",
+    "spec/dragonfly/processing/shared_processing_spec.rb",
+    "spec/dragonfly/routed_endpoint_spec.rb",
+    "spec/dragonfly/serializer_spec.rb",
+    "spec/dragonfly/simple_cache_spec.rb",
+    "spec/dragonfly/simple_endpoint_spec.rb",
+    "spec/dragonfly/temp_object_spec.rb",
+    "spec/image_matchers.rb",
+    "spec/simple_matchers.rb",
+    "spec/spec_helper.rb",
+    "yard/handlers/configurable_attr_handler.rb",
+    "yard/setup.rb",
+    "yard/templates/default/fulldoc/html/css/common.css",
+    "yard/templates/default/layout/html/layout.erb",
+    "yard/templates/default/module/html/configuration_summary.erb",
+    "yard/templates/default/module/setup.rb"
+  ]
+  s.homepage = %q{http://github.com/markevans/dragonfly}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Dragonfly is an on-the-fly Rack-based image handling framework. It is suitable for use with Rails, Sinatra and other web frameworks. Although it's mainly used for images, it can handle any content type.}
+  s.test_files = [
+    "spec/argument_matchers.rb",
+    "spec/dragonfly/active_model_extensions/active_model_setup.rb",
+    "spec/dragonfly/active_model_extensions/active_record_setup.rb",
+    "spec/dragonfly/active_model_extensions/model_spec.rb",
+    "spec/dragonfly/active_model_extensions/spec_helper.rb",
+    "spec/dragonfly/analyser_spec.rb",
+    "spec/dragonfly/analysis/file_command_analyser_spec.rb",
+    "spec/dragonfly/analysis/image_magick_analyser_spec.rb",
+    "spec/dragonfly/analysis/r_magick_analyser_spec.rb",
+    "spec/dragonfly/analysis/shared_analyser_spec.rb",
+    "spec/dragonfly/app_spec.rb",
+    "spec/dragonfly/config/r_magick_spec.rb",
+    "spec/dragonfly/configurable_spec.rb",
+    "spec/dragonfly/core_ext/array_spec.rb",
+    "spec/dragonfly/core_ext/hash_spec.rb",
+    "spec/dragonfly/core_ext/string_spec.rb",
+    "spec/dragonfly/core_ext/symbol_spec.rb",
+    "spec/dragonfly/data_storage/data_store_spec.rb",
+    "spec/dragonfly/data_storage/file_data_store_spec.rb",
+    "spec/dragonfly/data_storage/mongo_data_store_spec.rb",
+    "spec/dragonfly/data_storage/s3_data_store_spec.rb",
+    "spec/dragonfly/encoding/image_magick_encoder_spec.rb",
+    "spec/dragonfly/encoding/r_magick_encoder_spec.rb",
+    "spec/dragonfly/function_manager_spec.rb",
+    "spec/dragonfly/generation/hash_with_css_style_keys_spec.rb",
+    "spec/dragonfly/generation/image_magick_generator_spec.rb",
+    "spec/dragonfly/generation/r_magick_generator_spec.rb",
+    "spec/dragonfly/generation/shared_generator_spec.rb",
+    "spec/dragonfly/image_magick_utils_spec.rb",
+    "spec/dragonfly/job_builder_spec.rb",
+    "spec/dragonfly/job_definitions_spec.rb",
+    "spec/dragonfly/job_endpoint_spec.rb",
+    "spec/dragonfly/job_spec.rb",
+    "spec/dragonfly/loggable_spec.rb",
+    "spec/dragonfly/middleware_spec.rb",
+    "spec/dragonfly/processing/image_magick_processor_spec.rb",
+    "spec/dragonfly/processing/r_magick_processor_spec.rb",
+    "spec/dragonfly/processing/shared_processing_spec.rb",
+    "spec/dragonfly/routed_endpoint_spec.rb",
+    "spec/dragonfly/serializer_spec.rb",
+    "spec/dragonfly/simple_cache_spec.rb",
+    "spec/dragonfly/simple_endpoint_spec.rb",
+    "spec/dragonfly/temp_object_spec.rb",
+    "spec/image_matchers.rb",
+    "spec/simple_matchers.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<aws-s3>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, ["= 0.8.5"])
+      s.add_development_dependency(%q<cucumber-rails>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0.5.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.4"])
+      s.add_development_dependency(%q<gherkin>, ["= 2.1.4"])
+      s.add_development_dependency(%q<mongo>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, ["= 1.5.0.beta.2"])
+      s.add_development_dependency(%q<rack>, ["~> 1.1"])
+      s.add_development_dependency(%q<rack-cache>, [">= 0"])
+      s.add_development_dependency(%q<rails>, ["= 3.0.3"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bson_ext>, [">= 0"])
+      s.add_development_dependency(%q<rmagick>, ["= 2.12.2"])
+      s.add_development_dependency(%q<sqlite3-ruby>, ["= 1.3.0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+    else
+      s.add_dependency(%q<aws-s3>, [">= 0"])
+      s.add_dependency(%q<capybara>, [">= 0"])
+      s.add_dependency(%q<cucumber>, ["= 0.8.5"])
+      s.add_dependency(%q<cucumber-rails>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0.5.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.4"])
+      s.add_dependency(%q<gherkin>, ["= 2.1.4"])
+      s.add_dependency(%q<mongo>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, ["= 1.5.0.beta.2"])
+      s.add_dependency(%q<rack>, ["~> 1.1"])
+      s.add_dependency(%q<rack-cache>, [">= 0"])
+      s.add_dependency(%q<rails>, ["= 3.0.3"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<rmagick>, ["= 2.12.2"])
+      s.add_dependency(%q<sqlite3-ruby>, ["= 1.3.0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<aws-s3>, [">= 0"])
+    s.add_dependency(%q<capybara>, [">= 0"])
+    s.add_dependency(%q<cucumber>, ["= 0.8.5"])
+    s.add_dependency(%q<cucumber-rails>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0.5.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.4"])
+    s.add_dependency(%q<gherkin>, ["= 2.1.4"])
+    s.add_dependency(%q<mongo>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, ["= 1.5.0.beta.2"])
+    s.add_dependency(%q<rack>, ["~> 1.1"])
+    s.add_dependency(%q<rack-cache>, [">= 0"])
+    s.add_dependency(%q<rails>, ["= 3.0.3"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 1.3"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<rmagick>, ["= 2.12.2"])
+    s.add_dependency(%q<sqlite3-ruby>, ["= 1.3.0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+  end
+end
+

data/extra_docs/Analysers.md

@@ -0,0 +1,66 @@
+Analysers
+=========
+Analysers are registered with Dragonfly apps for adding methods to {file:GeneralUsage Job} objects and {file:Models model attachments} such as `width`, `height`, etc.
+
+ImageMagick Analyser
+--------------------
+See {file:ImageMagick}.
+
+FileCommandAnalyser
+-------------------
+The {Dragonfly::Analysis::FileCommandAnalyser FileCommandAnalyser} is registered by default by the
+{Dragonfly::Config::Rails Rails configuration} used by 'dragonfly/rails/images'.
+
+As the name suggests, it uses the UNIX 'file' command.
+
+If not already registered:
+
+    app.analyser.register(Dragonfly::Analysis::FileCommandAnalyser)
+
+gives us:
+
+    image.mime_type    # => 'image/png'
+
+It doesn't use the filesystem by default (it operates on in-memory strings), but we can make it do so by using
+
+    app.analyser.register(Dragonfly::Analysis::FileCommandAnalyser) do |a|
+      a.use_filesystem = true
+    end
+
+Custom Analysers
+----------------
+
+To register a single custom analyser:
+
+    app.analyser.add :wobbliness do |temp_object|
+      # can use temp_object.data, temp_object.path, temp_object.file, etc.
+      SomeLibrary.assess_wobbliness(temp_object.data)
+    end
+
+    image.wobbliness    # => 71
+
+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
+
+      def coolness(temp_object)
+        temp_object.size / 30
+      end
+
+      def uglyness(temp_object)
+        `ugly -i #{temp_object.path}`
+      end
+
+      private
+
+      def my_helper_method
+        # do stuff
+      end
+
+    end
+
+    app.analyser.register(MyAnalyser)
+
+    image.coolness    # => -4.1
+    image.uglyness    # => "VERY"

data/extra_docs/Caching.md

@@ -0,0 +1,23 @@
+Caching
+=======
+
+Processing and encoding can be an expensive operation. The first time we visit the url,
+the image is processed, and there might be a short delay and getting the response.
+
+However, dragonfly apps send `Cache-Control` and `ETag` headers in the response, so we can easily put a caching
+proxy like {http://varnish.projects.linpro.no Varnish}, {http://www.squid-cache.org Squid},
+{http://tomayko.com/src/rack-cache/ Rack::Cache}, etc. in front of the app, so that subsequent requests are served
+super-quickly straight out of the cache.
+
+The file 'dragonfly/rails/images' puts Rack::Cache in front of Dragonfly by default, but for better performance
+you may wish to look into something like Varnish.
+
+Given a dragonfly app
+
+    app = Dragonfly[:images]
+
+You can configure the 'Cache-Control' header with
+
+    app.cache_duration = 3600*24*365*3  # time in seconds
+
+For a well-written discussion of Cache-Control and ETag headers, see {http://tomayko.com/writings/things-caches-do}.