dragonfly 0.9.15 → 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e67b985fbe6f3f97fc92af0803738713e5dcabae
+  data.tar.gz: 2f2587a40ef4dd9a431e20760cf8ec94530836d0
+SHA512:
+  metadata.gz: ada62ec2fad0a91f4a8131d8b3ea53ee38631f5bde95f02e3eb30a094895ed744d4e8a861e40a1ea9fa31a9d3cbd7f7ed4ba0e87c9ed68c407363f391cb7cb65
+  data.tar.gz: 90753f8280e3f8e29e4c6de826b5f5d0dc20d2f71df6a239bb05e6e75ac00f23dfeb6c4985140ef319bfba4913a7975292dc65a1910b481b64de03b61dc05650

data/.gitignore

@@ -1,16 +1,9 @@
-*.sw?
 .DS_Store
-coverage
-**.sqlite3
 pkg
 .yardoc
 doc
-fixtures/*/tmp_app
-.ginger
 .bundle
-.rvmrc
-spec/spec.log
 Gemfile.lock
 .s3_spec.yml
 ***.rbc
-spec/support/tmp.rb
+dragonfly.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
 gemspec
+gem 'pry', :group => :development

data/History.md

@@ -1,3 +1,53 @@
+1.0.0 (2013-11-24)
+===================
+Changes
+-------
+- configuration
+  - `Dragonfly[:images]` -> `Dragonfly.app` and `Dragonfly.app(:named_app)`
+  - configuration block DSL overhaul
+  - Rails is set up using a generator, not by requiring the file "dragonfly/rails/images"
+  - Rack::Cache is not inserted by Dragonfly - this is up to the user
+- data store spec
+  - `store`/`retrieve` -> `read`/`write`
+  - `write` takes a `Content`, not a `TempObject` (though the interface is much the same)
+  - return nil on `read` to signify not found instead of raising
+- S3, Couch and Mongo data stores extracted into separate gems
+- models
+  - easier and simpler to include in custom models using `Dragonfly::Model`
+  - `image_accessor`, `asset_accessor`, `xxx_accessor`, etc. -> single `dragonfly_accessor`
+  - user needs to extend `Dragonfly::Model::Validations` manually to use dragonfly validations
+- Custom processors, datastores, generators and analysers are made easier by `Content` object which has convenience methods
+- Removed "encoders" - these are covered by processors now
+- Removed "job" shortcuts - they are not needed as processors can invoke other processors
+- No "smart" determination of mime-type - just use file extension (anything more than that can be done by the user)
+- metadata is required to be serializable to/from JSON
+- removed `allow_fetch_file` and `allow_fetch_url` in favour of more fine-control with `fetch_file_whitelist` and `fetch_url_whitelist`
+- switch off dealing with legacy urls by default
+- proper requires throughout the code instead of autoloading
+- simple 500 response for unknown errors
+
+Features
+--------
+- model attachment default (by specifying a path to a e.g. a default image)
+- `convert` and `thumb` processors take a `'frame'` option
+- `thumb` takes a `'format'` option
+- `fetch_file` and `model.attachment_url=` accept a data uri string
+- `Attachment#xxx_stored`, e.g. `my_model.my_attachment_stored?` (`my_attachment` here being the attachment name)
+- `define` for creating custom methods on `Job`/`Attachment` objects
+- `url_path_prefix` for when mounted in Rack with a "SCRIPT_NAME"
+- when customizing response headers, ability to remove headers by setting to `nil`
+- better logging
+  - for each response
+  - for shell commands
+
+Fixes
+-----
+- inserting CookieMonster doesn't depend on existence of `ActionDispatch::Cookies`
+- `image?` returns false for pdfs
+- `fetch_url` raises more useful `ErrorResponse` on error
+- shell commands don't print warnings to stderr
+- ability to assign attachment/job from other app
+
 0.9.15 (2013-05-04)
 ===================
 Features
@@ -171,7 +221,7 @@ Fixes
 - Improved performance of `resize_and_crop` method, using imagemagick built-in '^' operator
 - Improved server security validations
 - Deal with Excon::Errors::SocketError: EOFError errors which get thrown sometimes from S3 connection
-- Allow files with '..' (but not '../') in the middle of their name in file data store 
+- Allow files with '..' (but not '../') in the middle of their name in file data store
 
 0.9.0 (2011-04-27)
 ==================
@@ -258,7 +308,7 @@ Features
 --------
 - New ImageMagick generator, processor, encoder and analyser, which are now defaults
   (thanks to Henry Phan for work on this)
-  
+
 Fixes
 -----
 - Works with Rails 3.0.2 uploaded files (which has a changed API)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 Mark Evans
+Copyright (c) 2009-2013 Mark Evans
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,119 +1,65 @@
 Dragonfly
 ===========
+Hello!!
+Dragonfly is a highly customizable ruby gem for handling images and other attachments and is already in use on thousands of websites.
 
-Dragonfly is a <a href="http://rack.rubyforge.org">Rack</a> framework for on-the-fly image handling.
-
-Ideal for using with Ruby on Rails (2.3 and 3), Sinatra and all that gubbins.
-
-However, Dragonfly is NOT JUST FOR RAILS, and NOT JUST FOR IMAGES!!
-
-**IMPORTANT: if you're running a version between 0.7.0 and 0.9.12, please update to at least 0.9.14 for a security update [details here](https://groups.google.com/forum/?fromgroups=#!topic/dragonfly-users/3c3WIU3VQTo)**
-
-For the lazy Rails user...
---------------------------
-**Gemfile**:
-
+If you want to generate image thumbnails in Rails ...
 ```ruby
-gem 'rack-cache', :require => 'rack/cache'
-gem 'dragonfly', '~>0.9.15'
-```
-
-**Initializer** (e.g. config/initializers/dragonfly.rb):
-
-```ruby
-require 'dragonfly/rails/images'
+class User < ActiveRecord::Base  # model
+  dragonfly_accessor :photo
+end
 ```
-
-**Migration**:
-
-```ruby
-add_column :albums, :cover_image_uid,  :string
-add_column :albums, :cover_image_name, :string  # Optional - only if you want urls
-                                                # to end with the original filename
+```erb
+<%= image_tag @user.photo.thumb('300x200#')  # view  %>
 ```
 
-**Model**:
-
+... or generate text images on-demand in Sinatra ...
 ```ruby
-class Album < ActiveRecord::Base
-  image_accessor :cover_image            # 'image_accessor' is provided by Dragonfly
-                                         # this defines a reader/writer for cover_image
-  # ...
+get "/:text" do |text|
+  Dragonfly.app.generate(:text, text, "font-size" => 32).to_response(env)
 end
 ```
 
-**View** (for uploading via a file field):
-
-```erb
-<% form_for @album, :html => {:multipart => true} do |f| %>
-  ...
-  <%= f.file_field :cover_image %>
-  ...
-<% end %>
-```
-
-NB: REMEMBER THE MULTIPART BIT!!!
-
-You can avoid having to re-upload when validations fail with
+... or just generally manage attachments in your web app ...
+```ruby
+wav = Dragonfly.app.fetch_url("http://free.music/lard.wav")  # GET from t'interwebs
+mp3 = wav.to_mp3  # to_mp3 is a custom processor
+uid = mp3.store   # store in the configured datastore, e.g. S3
 
-```erb
-<%= f.hidden_field :retained_cover_image %>
+url = Dragonfly.app.remote_url_for(uid)  # ===> http://s3.amazon.com/my-stuff/lard.mp3
 ```
 
-remove the attachment with
-
-```erb
-<%= f.check_box :remove_cover_image %>
-```
+... then Dragonfly is for you! See [the documentation](http://markevans.github.io/dragonfly) to get started!
 
-assign from some other url with
+Documentation
+=============
+<a href="http://markevans.github.io/dragonfly"><big><strong>THE MAIN DOCUMENTATION IS HERE!!!</strong></big></a>
 
-```erb
-<%= f.text_field :cover_image_url %>
-```
+<a href="http://rubydoc.info/github/markevans/dragonfly/frames">RDoc documentation is here</a>
 
-and display a thumbnail (on the upload form) with
+Dragonfly has changed somewhat since version 0.9 - if for whatever reason you can't upgrade, then
+<a href="http://markevans.github.io/dragonfly/v0.9.15">the docs for version 0.9.x are here</a>.
 
-```erb
-<%= image_tag @album.cover_image.thumb('100x100').url if @album.cover_image_uid %>
-```
+Installation
+============
 
-**View** (to display):
+    gem install dragonfly
 
-```erb
-<%= image_tag @album.cover_image.url %>
-<%= image_tag @album.cover_image.thumb('400x200#').url %>
-<%= image_tag @album.cover_image.jpg.url %>
-<%= image_tag @album.cover_image.process(:greyscale).encode(:tiff).url %>
-...etc.
+or in your Gemfile
+```ruby
+gem 'dragonfly', '~> 1.0.0'
 ```
 
-The above relies on imagemagick being installed. Dragonfly doesn't depend on it per se, but the default configuration `'dragonfly/rails/images'`
-uses it. For alternative configurations, see below.
-
-If using Capistrano with the above, you probably will want to keep the cache between deploys, so in deploy.rb:
-
+Require with
 ```ruby
-namespace :dragonfly do
-  desc "Symlink the Rack::Cache files"
-  task :symlink, :roles => [:app] do
-    run "mkdir -p #{shared_path}/tmp/dragonfly && ln -nfs #{shared_path}/tmp/dragonfly #{release_path}/tmp/dragonfly"
-  end
-end
-after 'deploy:update_code', 'dragonfly:symlink'
+require 'dragonfly'
 ```
 
-Sinatra, CouchDB, Mongo, Rack, S3, custom storage, processing, and more...
---------------------------------------------------------------------------
-Dragonfly is not just for Rails - it's primarily a Rack app, so you can use it as a standalone app, or with Sinatra, Merb, etc.
+Plugins and Add-ons
+===================
+See [the Add-ons wiki](http://github.com/markevans/dragonfly/wiki/Dragonfly-add-ons).
 
-It's highly customizable, and works with any data type (not just images).
-
-For more info, consult the <a href="http://markevans.github.com/dragonfly"><big><strong>DOCUMENTATION</strong></big></a>
-
-Add-ons
-=======
-For third-party add-ons, see [the Add-ons wiki](http://github.com/markevans/dragonfly/wiki/Dragonfly-add-ons)
+Please feel free to contribute!!
 
 Issues
 ======
@@ -125,8 +71,5 @@ Suggestions/Questions
 
 Credits
 =======
-- [Mark Evans](http://github.com/markevans) (author)
-
-Copyright
-========
-Copyright (c) 2009-2010 Mark Evans. See LICENSE for details.
+[Mark Evans](http://github.com/markevans) (author) with awesome contributions from
+<a href="https://github.com/markevans/dragonfly/graphs/contributors">these guys</a>

data/dev/irbrc.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+require "bundler/setup"
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'dragonfly'
+include Dragonfly::Serializer
+
+APP = Dragonfly.app.configure do
+  plugin :imagemagick
+  datastore :memory
+end
+
+class Model
+  extend Dragonfly::Model
+  attr_accessor :image_uid, :image_name, :image_width, :small_image_uid
+  dragonfly_accessor :image
+  dragonfly_accessor :small_image
+end
+
+puts "Loaded stuff from dragonfly irbrc"
+puts "\nAvailable sample images:\n"
+puts Dir['samples/*']
+puts "\nAvailable constants:\n"
+puts "APP"
+puts "\nModel:\n"
+puts "dragonfly_accessor :image with image_name, image_width"
+puts
+

data/dev/rails_template.rb

@@ -0,0 +1,38 @@
+gem 'dragonfly', :path => File.expand_path('../..', __FILE__)
+generate "dragonfly"
+generate "scaffold", "photo image_uid:string image_name:string"
+rake "db:migrate"
+route %(
+  get "text/:text" => Dragonfly.app.endpoint { |params, app|
+    app.generate(:text, params[:text])
+  }
+)
+route "root :to => 'photos#index'"
+run "rm -rf public/index.html"
+
+inject_into_file 'app/models/photo.rb', :after => "class Photo < ActiveRecord::Base\n" do
+  %(
+    attr_accessible :image rescue nil
+    dragonfly_accessor :image
+  )
+end
+
+gsub_file 'app/views/photos/_form.html.erb', /^.*:image_.*$/, ''
+
+inject_into_file 'app/views/photos/_form.html.erb', :before => %(<div class="actions">\n) do
+  %(
+    <div class="field">
+      <%= f.label :image %><br>
+      <%= f.file_field :image %>
+    </div>
+
+    <%= image_tag @photo.image.thumb('100x100').url if @photo.image_uid %>
+  )
+end
+
+gsub_file "app/controllers/photos_controller.rb", "permit(", "permit(:image, "
+
+append_file 'app/views/photos/show.html.erb', %(
+ <%= image_tag @photo.image.thumb('300x300').url if @photo.image_uid? %>
+)
+

data/dev/test.ru

@@ -0,0 +1,56 @@
+require "rubygems"
+require "bundler/setup"
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'dragonfly'
+
+Dragonfly.logger = Logger.new(STDOUT)
+Dragonfly.app.configure do
+  plugin :imagemagick
+  url_format '/images/:job'
+  fetch_file_whitelist [String]
+end
+
+class App
+  def call(env)
+    image = Dragonfly.app.fetch_file('grid.jpg')
+    request = Rack::Request.new(env)
+    error = nil
+    if request['code']
+      begin
+        img_src = eval("image.#{request['code']}").url
+      rescue StandardError => e
+        error = e
+      end
+    end
+    [
+      200,
+      {'Content-Type' => 'text/html'},
+      [%(
+        <style>
+          form, input {
+            font-size: 32px;
+          }
+          p.error {
+            color: red;
+            font-size: 24px;
+          }
+        </style>
+        <p class="error">#{error}</p>
+        <table>
+          <tr>
+            <th>Original (#{image.width}x#{image.height})</th>
+            <td><img src="#{image.url}" /></td>
+          </tr>
+          <tr>
+            <th><form>image.<input size="40" autofocus placeholder="thumb('200x100')" name="code" value="#{request['code']}" /></form></th>
+            <td><img src="#{img_src}" /></td>
+          </tr>
+        </table>
+      )]
+    ]
+  end
+end
+
+use Dragonfly::Middleware
+run App.new
+

data/dev/test_rails

@@ -0,0 +1,19 @@
+#!env ruby
+dir = ARGV[0]
+
+unless dir
+  puts "Usage:"
+  puts "\t#{$0} DESTINATION"
+  exit
+end
+
+run = proc{|command|
+  puts "\n*** Running: #{command} ***\n"
+  system command
+}
+
+template_path = File.expand_path('../rails_template.rb', __FILE__)
+
+run["rm -rf #{dir}"]
+run["rails new #{dir} -m #{template_path} -J -T"]
+

data/dragonfly.gemspec

@@ -24,28 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency("rack", [">= 0"])
   spec.add_runtime_dependency("multi_json", ["~> 1.0"])
 
-  spec.add_development_dependency("capybara", [">= 0"])
-  spec.add_development_dependency("cucumber", ["~> 1.2.1"])
-  spec.add_development_dependency("cucumber-rails", ["~> 1.3.0"])
-  spec.add_development_dependency("database_cleaner", [">= 0"])
-  spec.add_development_dependency("fog", [">= 0"])
-  spec.add_development_dependency("github-markup", [">= 0"])
-  spec.add_development_dependency("mongo", [">= 0"])
-  spec.add_development_dependency("couchrest", ["~> 1.0"])
-  spec.add_development_dependency("rack-cache", [">= 0"])
-  spec.add_development_dependency("rails", ["~> 3.2.0"])
+  spec.add_development_dependency("activemodel")
   spec.add_development_dependency("rspec", ["~> 2.5"])
-  spec.add_development_dependency("webmock", [">= 0"])
-  spec.add_development_dependency("yard", [">= 0"])
+  spec.add_development_dependency("webmock")
   if RUBY_PLATFORM == "java"
-    spec.add_development_dependency("jdbc-sqlite3", [">= 0"])
-    spec.add_development_dependency("activerecord-jdbcsqlite3-adapter", [">= 0"])
-    spec.add_development_dependency("jruby-openssl", [">= 0"])
-  else
-    spec.add_development_dependency("redcarpet", ["~> 1.0"])
-    spec.add_development_dependency("bluecloth", [">= 0"])
-    spec.add_development_dependency("bson_ext", [">= 0"])
-    spec.add_development_dependency("sqlite3", [">= 0"])
+    spec.add_development_dependency("jruby-openssl")
   end
-
 end