dragonfly 0.8.6 → 0.9.0

data/features/support/env.rb

@@ -1,40 +1,13 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'dragonfly'
-require 'spec/expectations'
-require 'test/unit/assertions'
-require File.dirname(__FILE__) + '/../../spec/image_matchers.rb'
-
-ROOT_PATH = File.expand_path(File.dirname(__FILE__) + "/../..")
-
-# A hash of <name for reference> => <dragonfly uid> pairs
-TEMP_FILES = {}
-
-Dragonfly[:images].configure_with(:imagemagick)
-Dragonfly[:files].configure do |c|
-  c.analyser.register(Dragonfly::Analysis::FileCommandAnalyser)
+require 'bundler'
+begin
+  Bundler.setup(:default, :cucumber)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
 
-SAMPLE_IMAGE_PATH = File.dirname(__FILE__)+'/../../samples/beach.png'
-
-Before do
-  # Remove temporary images
-  TEMP_FILES.each do |name, uid|
-    $app.datastore.destroy(uid)
-    TEMP_FILES.delete(name)
-  end
-end
-
-AfterStep do |scenario|
-  Dir["#{ROOT_PATH}/Gemfile*.lock"].each{|f| FileUtils.rm_f(f) }
-end
-
-module MyHelpers
-  
-  def make_request(job)
-    request = Rack::MockRequest.new($app)
-    @response = request.get(job.url)
-  end
-  
-end
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'dragonfly'
 
-World(MyHelpers)
+require 'rspec/expectations'

data/features/support/setup.rb

@@ -0,0 +1,32 @@
+ROOT_PATH = File.expand_path(File.dirname(__FILE__) + "/../..")
+
+require ROOT_PATH + '/spec/support/image_matchers.rb'
+
+# A hash of <name for reference> => <dragonfly uid> pairs
+TEMP_FILES = {}
+
+Dragonfly[:images].configure_with(:imagemagick)
+Dragonfly[:files].configure do |c|
+  c.analyser.register(Dragonfly::Analysis::FileCommandAnalyser)
+end
+
+SAMPLE_IMAGE_PATH = ROOT_PATH + '/samples/beach.png'
+
+Before do
+  # Remove temporary images
+  TEMP_FILES.each do |name, uid|
+    $app.datastore.destroy(uid)
+    TEMP_FILES.delete(name)
+  end
+end
+
+module MyHelpers
+  
+  def make_request(job)
+    request = Rack::MockRequest.new($app)
+    @response = request.get(job.url)
+  end
+  
+end
+
+World(MyHelpers)

data/fixtures/rails_3.0.5/files/app/models/album.rb

@@ -0,0 +1,5 @@
+class Album < ActiveRecord::Base
+  validates_property :format, :of => :cover_image, :in => [:jpg, :png, :gif]
+  validates_length_of :name, :in => 0..5
+  image_accessor :cover_image
+end

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

@@ -0,0 +1,7 @@
+<%= form_for @album, :html => {:multipart => true} do |f| %>
+  <%= @album.errors.full_messages %>
+  <%= f.text_field :name %>
+  <%= f.file_field :cover_image %>
+  <%= f.hidden_field :retained_cover_image %>
+  <%= f.submit :value => 'Create' %>
+<% end %>

data/fixtures/{files → rails_3.0.5/files}/app/views/albums/show.html.erb

@@ -1,4 +1,6 @@
 <%= flash[:notice] %>
+<%= @album.name %>
 Look at this cover image!
 <%= image_tag @album.cover_image.thumb('200x100!').url %>
+<%= image_tag @album.cover_image.remote_url %>
 <%= link_to 'Index', albums_path %>

data/fixtures/rails_3.0.5/files/features/manage_album_images.feature

@@ -0,0 +1,38 @@
+Feature: champion adds cover images to his albums
+  In order to be a champion
+  A user adds an image to his album
+
+  Scenario: Add and view image
+    When I go to the new album page
+    And I attach the file "../../../samples/beach.png" to "album[cover_image]"
+    And I press "Create"
+    Then I should see "successfully created"
+    And I should see "Look at this cover image!"
+    When I look at the generated image
+    Then I should see a PNG image of size 200x100
+
+  Scenario: validation fails
+    When I go to the new album page
+    And I attach the file "../../../samples/sample.docx" to "album[cover_image]"
+    And I press "Create"
+    Then I should see "Cover image format is incorrect. It needs to be one of 'jpg', 'png', 'gif', but was 'docx'"
+
+  Scenario: other validation fails
+    When I go to the new album page
+    And I fill in "album[name]" with "too long"
+    And I attach the file "../../../samples/beach.png" to "album[cover_image]"
+    And I press "Create"
+    Then I should see "Name is too long"
+    When I fill in "album[name]" with "short"
+    And I press "Create"
+    Then I should see "successfully created"
+    And I should see "short"
+    And I should see "Look at this cover image!"
+    When I look at the generated image
+    Then I should see a PNG image of size 200x100
+
+  Scenario: view remote image
+    Given an album "good" with attached file "beach.png"
+    When I go to the page for album "good"
+    And I look at the original image
+    Then I should see a PNG image of size 280x355

data/fixtures/rails_3.0.5/files/features/step_definitions/helper_steps.rb

@@ -0,0 +1,7 @@
+Then "show me the html" do
+  puts page.body
+end
+
+Then 'show "(.*)"' do |code|
+  eval "puts #{code}"
+end

data/fixtures/{files → rails_3.0.5/files}/features/step_definitions/image_steps.rb

@@ -1,9 +1,19 @@
-When /^I look at the generated (.+) image$/ do |image_name|
+Given /^an album "(.+)" with attached file "(.+)"$/ do |name, filename|
+  Album.create! :name => name, :cover_image => Rails.root.join('../../../samples', filename)
+end
+
+When /^I look at the generated image$/ do
   page.body =~ %r{src="(/media[^"]+?)"}
   url = $1
   visit(url)
 end
 
+When /^I look at the original image$/ do
+  page.body =~ %r{src="(/system[^"]+?)"}
+  url = $1
+  visit(url)
+end
+
 Then /^I should see a (.+) image of size (.+)$/ do |format, size|
   tempfile = Tempfile.new('wicked')
   page.body.force_encoding('UTF-8').encode! if page.body.respond_to?(:force_encoding) # For some reason need this on Ruby 1.9.2

data/fixtures/{files → rails_3.0.5/files}/features/support/paths.rb

@@ -3,6 +3,8 @@ module NavigationHelpers
     case page_name
     when "the new album page"
       '/albums/new'
+    when /^the page for album "(.+)"$/
+      album_path(Album.find_by_name($1))
     when /^the image for text "(.+)", size "(.+)"$/
       "/text/#{$1}/#{$2}"
     else

data/fixtures/{rails_3.0.3 → rails_3.0.5}/template.rb

@@ -6,11 +6,11 @@ gem 'cucumber', '0.8.5'
 
 generate 'cucumber:install'
 
-generate 'scaffold albums cover_image_uid:string'
+generate 'scaffold albums cover_image_uid:string name:string'
 rake 'db:migrate'
 
 # Copy over all files from the template dir
-files_dir = File.expand_path(File.dirname(__FILE__) + '/../files')
+files_dir = File.expand_path(File.dirname(__FILE__) + '/files')
 run "cp -r #{files_dir}/** ."
 
 route <<ROUTES

data/irbrc.rb

@@ -2,6 +2,7 @@ require "rubygems"
 require "bundler/setup"
 $:.unshift(File.expand_path('../lib', __FILE__))
 require 'dragonfly'
+include Dragonfly::Serializer
 APP = Dragonfly[:images].configure_with(:imagemagick)
 
 # available_uids = `find #{APP.datastore.root_path} ! -type d`.split("\n").map do |file|
@@ -15,4 +16,4 @@ puts "\nAvailable sample images:\n"
 puts Dir['samples/*']
 puts "\nAvailable constants:\n"
 puts "APP"
-puts
+puts

data/lib/dragonfly.rb

@@ -43,5 +43,12 @@ module Dragonfly
       App[*args]
     end
 
+    # Register saved configurations so we can do e.g.
+    # Dragonfly[:my_app].configure_with(:image_magick)
+    App.register_configuration(:imagemagick){ ImageMagick::Config }
+    App.register_configuration(:image_magick){ ImageMagick::Config }
+    App.register_configuration(:rails){ Config::Rails }
+    App.register_configuration(:heroku){ Config::Heroku }
+
   end
 end

data/lib/dragonfly/active_model_extensions/attachment.rb

@@ -1,29 +1,46 @@
 require 'forwardable'
+require 'dragonfly/active_model_extensions/attachment_class_methods'
 
 module Dragonfly
   module ActiveModelExtensions
 
     class Attachment
 
+      # Exceptions
+      class BadAssignmentKey < RuntimeError; end
+
       extend Forwardable
       def_delegators :job,
         :data, :to_file, :file, :tempfile, :path,
         :process, :encode, :analyse,
         :meta, :meta=,
+        :name, :basename, :ext, :size,
         :url
 
-      def initialize(app, parent_model, attribute_name)
-        @app, @parent_model, @attribute_name = app, parent_model, attribute_name
-        self.extend app.analyser.analysis_methods
-        self.extend app.job_definitions
-        self.uid = parent_uid
-        self.job = app.fetch(uid) if uid
+      def initialize(model)
+        @model = model
+        self.uid = model_uid
+        update_from_uid if uid
+        @should_run_callbacks = true
+        self.class.ensure_uses_cached_magic_attributes
+      end
+
+      def app
+        self.class.app
+      end
+      
+      def attribute
+        self.class.attribute
       end
 
       def assign(value)
+        self.changed = true
+        destroy_retained! if retained?
+        set_uid_and_model_uid(nil)
         if value.nil?
           self.job = nil
           reset_magic_attributes
+          self.class.run_callbacks(:after_unassign, model, self) if should_run_callbacks?
         else
           self.job = case value
           when Job then value.dup
@@ -31,44 +48,34 @@ module Dragonfly
           else app.new_job(value)
           end
           set_magic_attributes
+          update_meta
+          self.class.run_callbacks(:after_assign, model, self) if should_run_callbacks?
+          retain! if should_retain?
         end
-        set_uid_and_parent_uid(nil)
         value
       end
 
+      def changed?
+        !!@changed
+      end
+
       def destroy!
         destroy_previous!
         destroy_content(uid) if uid
       end
 
       def save!
-        sync_with_parent!
+        sync_with_model
+        store_job! if job && !uid
         destroy_previous!
-        if job && !uid
-          set_uid_and_parent_uid job.store(
-            :meta => {
-              :model_class => parent_model.class.name,
-              :model_attachment => attribute_name
-            }
-          )
-          self.job = job.to_fetched_job(uid)
-        end
+        self.changed = false
+        self.retained = false
       end
 
       def to_value
         self if job
       end
 
-      def analyse(meth, *args)
-        has_magic_attribute_for?(meth) ? magic_attribute_for(meth) : job.send(meth)
-      end
-
-      [:size, :ext, :name].each do |meth|
-        define_method meth do
-          analyse(meth)
-        end
-      end
-
       def name=(name)
         job.name = name
         set_magic_attribute(:name, name) if has_magic_attribute_for?(:name)
@@ -84,6 +91,71 @@ module Dragonfly
         assign(encode(*args))
         self
       end
+      
+      def remote_url(opts={})
+        app.remote_url_for(uid, opts) if uid
+      end
+      
+      def apply
+        job.apply
+        self
+      end
+
+      attr_writer :should_run_callbacks
+      
+      def should_run_callbacks?
+        !!@should_run_callbacks
+      end
+
+      # Retaining for avoiding uploading more than once
+
+      def retain!
+        if changed? && job
+          store_job!
+          self.retained = true
+        end
+      end
+
+      attr_writer :should_retain
+      
+      def should_retain?
+        !!@should_retain
+      end
+      
+      def retained?
+        !!@retained
+      end
+      
+      def destroy_retained!
+        destroy_content(retained_attrs[:uid])
+      end
+      
+      def retained_attrs
+        attribute_keys.inject({}) do |hash, key|
+          hash[key] = send(key)
+          hash
+        end if retained?
+      end
+      
+      def retained_attrs=(attrs)
+        if changed? # if already set, ignore and destroy this retained content
+          destroy_content(attrs[:uid])
+        else
+          attrs.each do |key, value|
+            unless attribute_keys.include?(key)
+              raise BadAssignmentKey, "trying to call #{attribute}_#{key} = #{value.inspect} via retained_#{attribute} but this is not allowed!"
+            end
+            model.send("#{attribute}_#{key}=", value)
+          end
+          sync_with_model
+          update_from_uid
+          self.retained = true
+        end
+      end
+      
+      def inspect
+        "<Dragonfly Attachment uid=#{uid.inspect}, app=#{app.inspect}>"
+      end
 
       protected
 
@@ -91,6 +163,18 @@ module Dragonfly
 
       private
 
+      attr_writer :changed, :retained
+
+      def attribute_keys
+        [:uid] + magic_attributes
+      end
+
+      def store_job!
+        opts = self.class.evaluate_storage_opts(model, self)
+        set_uid_and_model_uid job.store(opts)
+        self.job = job.to_fetched_job(uid)
+      end
+
       def destroy_content(uid)
         app.datastore.destroy(uid)
       rescue DataStorage::DataNotFound => e
@@ -104,48 +188,52 @@ module Dragonfly
         end
       end
 
-      def sync_with_parent!
-        # If the parent uid has been set manually
-        if uid != parent_uid
-          self.uid = parent_uid
+      def sync_with_model
+        # If the model uid has been set manually
+        if uid != model_uid
+          self.uid = model_uid
         end
       end
 
-      def set_uid_and_parent_uid(uid)
+      def set_uid_and_model_uid(uid)
         self.uid = uid
-        self.parent_uid = uid
+        self.model_uid = uid
       end
 
-      def parent_uid=(uid)
-        parent_model.send("#{attribute_name}_uid=", uid)
+      def model_uid=(uid)
+        model.send("#{attribute}_uid=", uid)
       end
 
-      def parent_uid
-        parent_model.send("#{attribute_name}_uid")
+      def model_uid
+        model.send("#{attribute}_uid")
       end
 
-      attr_reader :app, :parent_model, :attribute_name
+      attr_reader :model, :uid
       attr_writer :job
       attr_accessor :previous_uid
-      attr_reader :uid
 
       def uid=(uid)
         self.previous_uid = @uid if @uid
         @uid = uid
       end
 
-      def allowed_magic_attributes
-        app.analyser.analysis_method_names + [:size, :ext, :name]
+      def update_meta
+        magic_attributes.each{|property| meta[property] = model.send("#{attribute}_#{property}") }
+        meta[:model_class] = model.class.name
+        meta[:model_attachment] = attribute
+      end
+
+      def update_from_uid
+        self.job = app.fetch(uid)
+        update_meta
       end
 
       def magic_attributes
-        @magic_attributes ||= parent_model.public_methods.select { |name|
-          name.to_s =~ /^#{attribute_name}_(.+)$/ && allowed_magic_attributes.include?($1.to_sym)
-        }.map{|name| name.to_s.sub("#{attribute_name}_", '').to_sym }
+        self.class.magic_attributes
       end
 
       def set_magic_attribute(property, value)
-        parent_model.send("#{attribute_name}_#{property}=", value)
+        model.send("#{attribute}_#{property}=", value)
       end
 
       def set_magic_attributes
@@ -161,7 +249,7 @@ module Dragonfly
       end
 
       def magic_attribute_for(property)
-        parent_model.send("#{attribute_name}_#{property}")
+        model.send("#{attribute}_#{property}")
       end
 
     end