paperclip 3.4.0 → 6.1.0

data/lib/tasks/paperclip.rake

@@ -1,3 +1,5 @@
+require 'paperclip/attachment_registry'
+
 module Paperclip
   module Task
     def self.obtain_class
@@ -9,13 +11,23 @@ module Paperclip
     def self.obtain_attachments(klass)
       klass = Paperclip.class_for(klass.to_s)
       name = ENV['ATTACHMENT'] || ENV['attachment']
-      raise "Class #{klass.name} has no attachments specified" unless klass.respond_to?(:attachment_definitions)
-      if !name.blank? && klass.attachment_definitions.keys.map(&:to_s).include?(name.to_s)
+
+      attachment_names = Paperclip::AttachmentRegistry.names_for(klass)
+
+      if attachment_names.empty?
+        raise "Class #{klass.name} has no attachments specified"
+      end
+
+      if name.present? && attachment_names.map(&:to_s).include?(name.to_s)
         [ name ]
       else
-        klass.attachment_definitions.keys
+        attachment_names
       end
     end
+
+    def self.log_error(error)
+      $stderr.puts error
+    end
   end
 end
 
@@ -31,10 +43,16 @@ namespace :paperclip do
       styles = (ENV['STYLES'] || ENV['styles'] || '').split(',').map(&:to_sym)
       names.each do |name|
         Paperclip.each_instance_with_attachment(klass, name) do |instance|
-          instance.send(name).reprocess!(*styles)
+          attachment = instance.send(name)
+          begin
+            attachment.reprocess!(*styles)
+          rescue StandardError => e
+            Paperclip::Task.log_error("exception while processing #{klass} ID #{instance.id}:")
+            Paperclip::Task.log_error(" " + e.message + "\n")
+          end
           unless instance.errors.blank?
-            puts "errors while processing #{klass} ID #{instance.id}:"
-            puts " " + instance.errors.full_messages.join("\n ") + "\n"
+            Paperclip::Task.log_error("errors while processing #{klass} ID #{instance.id}:")
+            Paperclip::Task.log_error(" " + instance.errors.full_messages.join("\n ") + "\n")
           end
         end
       end
@@ -46,7 +64,8 @@ namespace :paperclip do
       names = Paperclip::Task.obtain_attachments(klass)
       names.each do |name|
         Paperclip.each_instance_with_attachment(klass, name) do |instance|
-          if file = Paperclip.io_adapters.for(instance.send(name))
+          attachment = instance.send(name)
+          if file = Paperclip.io_adapters.for(attachment, attachment.options[:adapter_options])
             instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
             instance.send("#{name}_content_type=", file.content_type.to_s.strip)
             instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
@@ -60,8 +79,7 @@ namespace :paperclip do
 
     desc "Regenerates missing thumbnail styles for all classes using Paperclip."
     task :missing_styles => :environment do
-      # Force loading all model classes to never miss any has_attached_file declaration:
-      Dir[Rails.root + 'app/models/**/*.rb'].each { |path| load path }
+      Rails.application.eager_load!
       Paperclip.missing_attachments_styles.each do |klass, attachment_definitions|
         attachment_definitions.each do |attachment_name, missing_styles|
           puts "Regenerating #{klass} -> #{attachment_name} -> #{missing_styles.inspect}"
@@ -73,6 +91,19 @@ namespace :paperclip do
       end
       Paperclip.save_current_attachments_styles!
     end
+
+    desc "Regenerates fingerprints for a given CLASS (and optional ATTACHMENT). Useful when changing digest."
+    task :fingerprints => :environment do
+      klass = Paperclip::Task.obtain_class
+      names = Paperclip::Task.obtain_attachments(klass)
+      names.each do |name|
+        Paperclip.each_instance_with_attachment(klass, name) do |instance|
+          attachment = instance.send(name)
+          attachment.assign(attachment)
+          instance.save(:validate => false)
+        end
+      end
+    end
   end
 
   desc "Cleans out invalid attachments. Useful after you've added new validations."
@@ -91,4 +122,20 @@ namespace :paperclip do
       end
     end
   end
+
+  desc "find missing attachments. Useful to know which attachments are broken"
+  task :find_broken_attachments => :environment do
+    klass = Paperclip::Task.obtain_class
+    names = Paperclip::Task.obtain_attachments(klass)
+    names.each do |name|
+      Paperclip.each_instance_with_attachment(klass, name) do |instance|
+        attachment = instance.send(name)
+        if attachment.exists?
+          print "."
+        else
+          Paperclip::Task.log_error("#{instance.class}##{attachment.name}, #{instance.id}, #{attachment.url}")
+        end
+      end
+    end
+  end
 end

data/paperclip.gemspec

@@ -10,44 +10,45 @@ Gem::Specification.new do |s|
   s.homepage          = "https://github.com/thoughtbot/paperclip"
   s.summary           = "File attachments as attributes for ActiveRecord"
   s.description       = "Easy upload management for ActiveRecord"
-
-  s.rubyforge_project = "paperclip"
+  s.license           = "MIT"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  if File.exists?('UPGRADING')
+  if File.exist?('UPGRADING')
     s.post_install_message = File.read("UPGRADING")
   end
 
   s.requirements << "ImageMagick"
-  s.required_ruby_version = ">= 1.9.2"
+  s.required_ruby_version = ">= 2.1.0"
 
-  s.add_dependency('activerecord', '>= 3.0.0')
-  s.add_dependency('activemodel', '>= 3.0.0')
-  s.add_dependency('activesupport', '>= 3.0.0')
-  s.add_dependency('cocaine', '~> 0.4.0')
+  s.add_dependency('activemodel', '>= 4.2.0')
+  s.add_dependency('activesupport', '>= 4.2.0')
+  s.add_dependency('terrapin', '~> 0.6.0')
   s.add_dependency('mime-types')
+  s.add_dependency('mimemagic', '~> 0.3.0')
 
+  s.add_development_dependency('activerecord', '>= 4.2.0')
   s.add_development_dependency('shoulda')
+  s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('appraisal')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk', '>= 1.2.0')
+  s.add_development_dependency('aws-sdk-s3')
   s.add_development_dependency('bourne')
-  s.add_development_dependency('sqlite3', '~> 1.3.4')
-  s.add_development_dependency('cucumber', '~> 1.2.1')
-  s.add_development_dependency('aruba')
+  s.add_development_dependency('cucumber-rails')
+  s.add_development_dependency('cucumber-expressions', '4.0.3') # TODO: investigate failures on 4.0.4
+  s.add_development_dependency('aruba', '~> 0.9.0')
   s.add_development_dependency('nokogiri')
   s.add_development_dependency('capybara')
   s.add_development_dependency('bundler')
-  s.add_development_dependency('cocaine', '~> 0.2')
-  s.add_development_dependency('fog', '>= 1.4.0', "< 1.7.0")
-  s.add_development_dependency('pry')
+  s.add_development_dependency('fog-aws')
+  s.add_development_dependency('fog-local')
   s.add_development_dependency('launchy')
   s.add_development_dependency('rake')
   s.add_development_dependency('fakeweb')
   s.add_development_dependency('railties')
-  s.add_development_dependency('actionmailer')
+  s.add_development_dependency('generator_spec')
+  s.add_development_dependency('timecop')
 end

data/shoulda_macros/paperclip.rb

@@ -103,7 +103,11 @@ module Paperclip
   end
 end
 
-if defined?(ActionController::Integration::Session)
+if defined?(ActionDispatch::Integration::Session)
+  class ActionDispatch::IntegrationTest::Session  #:nodoc:
+    include Paperclip::Shoulda
+  end
+elsif defined?(ActionController::Integration::Session)
   class ActionController::Integration::Session  #:nodoc:
     include Paperclip::Shoulda
   end
@@ -119,6 +123,12 @@ else
   end
 end
 
-class Test::Unit::TestCase #:nodoc:
- extend  Paperclip::Shoulda
+if defined?(Minitest)
+  class Minitest::Unit::TestCase #:nodoc:
+    extend Paperclip::Shoulda
+  end
+elsif defined?(Test)
+  class Test::Unit::TestCase #:nodoc:
+    extend Paperclip::Shoulda
+  end
 end

data/spec/paperclip/attachment_definitions_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "Attachment Definitions" do
+  it 'returns all of the attachments on the class' do
+    reset_class "Dummy"
+    Dummy.has_attached_file :avatar, {path: "abc"}
+    Dummy.has_attached_file :other_attachment, {url: "123"}
+    Dummy.do_not_validate_attachment_file_type :avatar
+    expected = {avatar: {path: "abc"}, other_attachment: {url: "123"}}
+
+    expect(Dummy.attachment_definitions).to eq expected
+  end
+end

data/spec/paperclip/attachment_processing_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'Attachment Processing' do
+  before { rebuild_class }
+
+  context 'using validates_attachment_content_type' do
+    it 'processes attachments given a valid assignment' do
+      file = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment_content_type :avatar, content_type: "image/png"
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles)
+
+      attachment.assign(file)
+    end
+
+    it 'does not process attachments given an invalid assignment with :not' do
+      file = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment_content_type :avatar, not: "image/png"
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles).never
+
+      attachment.assign(file)
+    end
+
+    it 'does not process attachments given an invalid assignment with :content_type' do
+      file = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment_content_type :avatar, content_type: "image/tiff"
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles).never
+
+      attachment.assign(file)
+    end
+
+    it 'allows what would be an invalid assignment when validation :if clause returns false' do
+      invalid_assignment = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment_content_type :avatar, content_type: "image/tiff", if: lambda{false}
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles)
+
+      attachment.assign(invalid_assignment)
+    end
+  end
+
+  context 'using validates_attachment' do
+    it 'processes attachments given a valid assignment' do
+      file = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment :avatar, content_type: {content_type: "image/png"}
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles)
+
+      attachment.assign(file)
+    end
+
+    it 'does not process attachments given an invalid assignment with :not' do
+      file = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment :avatar, content_type: {not: "image/png"}
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles).never
+
+      attachment.assign(file)
+    end
+
+    it 'does not process attachments given an invalid assignment with :content_type' do
+      file = File.new(fixture_file("5k.png"))
+      Dummy.validates_attachment :avatar, content_type: {content_type: "image/tiff"}
+      instance = Dummy.new
+      attachment = instance.avatar
+      attachment.expects(:post_process_styles).never
+
+      attachment.assign(file)
+    end
+  end
+end

data/spec/paperclip/attachment_registry_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe 'Attachment Registry' do
+  before do
+    Paperclip::AttachmentRegistry.clear
+  end
+
+  context '.names_for' do
+    it 'includes attachment names for the given class' do
+      foo = Class.new
+      Paperclip::AttachmentRegistry.register(foo, :avatar, {})
+
+      assert_equal [:avatar], Paperclip::AttachmentRegistry.names_for(foo)
+    end
+
+    it 'does not include attachment names for other classes' do
+      foo = Class.new
+      bar = Class.new
+      Paperclip::AttachmentRegistry.register(foo, :avatar, {})
+      Paperclip::AttachmentRegistry.register(bar, :lover, {})
+
+      assert_equal [:lover], Paperclip::AttachmentRegistry.names_for(bar)
+    end
+
+    it 'produces the empty array for a missing key' do
+      assert_empty Paperclip::AttachmentRegistry.names_for(Class.new)
+    end
+  end
+
+  context '.each_definition' do
+    it 'calls the block with the class, attachment name, and options' do
+      foo = Class.new
+      expected_accumulations = [
+        [foo, :avatar, { yo: "greeting" }],
+        [foo, :greeter, { ciao: "greeting" }]
+      ]
+      expected_accumulations.each do |args|
+        Paperclip::AttachmentRegistry.register(*args)
+      end
+      accumulations = []
+
+      Paperclip::AttachmentRegistry.each_definition do |*args|
+        accumulations << args
+      end
+
+      assert_equal expected_accumulations, accumulations
+    end
+  end
+
+  context '.definitions_for' do
+    it 'produces the attachment name and options' do
+      expected_definitions = {
+        avatar: { yo: "greeting" },
+        greeter: { ciao: "greeting" }
+      }
+      foo = Class.new
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        yo: "greeting"
+      )
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :greeter,
+        ciao: "greeting"
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(foo)
+
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'produces defintions for subclasses' do
+      expected_definitions = { avatar: { yo: "greeting" } }
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        expected_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
+
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'produces defintions for subclasses but deep merging them' do
+      foo_definitions = { avatar: { yo: "greeting" } }
+      bar_definitions = { avatar: { ciao: "greeting" } }
+      expected_definitions = {
+        avatar: {
+          yo: "greeting",
+          ciao: "greeting"
+        }
+      }
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        foo_definitions[:avatar]
+      )
+      Paperclip::AttachmentRegistry.register(
+        bar,
+        :avatar,
+        bar_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
+
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'allows subclasses to override attachment defitions' do
+      foo_definitions = { avatar: { yo: "greeting" } }
+      bar_definitions = { avatar: { yo: "hello" } }
+
+      expected_definitions = {
+        avatar: {
+          yo: "hello"
+        }
+      }
+
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        foo_definitions[:avatar]
+      )
+      Paperclip::AttachmentRegistry.register(
+        bar,
+        :avatar,
+        bar_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
+
+      assert_equal expected_definitions, definitions
+    end
+  end
+
+  context '.clear' do
+    it 'removes all of the existing attachment definitions' do
+      foo = Class.new
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :greeter,
+        ciao: "greeting"
+      )
+
+      Paperclip::AttachmentRegistry.clear
+
+      assert_empty Paperclip::AttachmentRegistry.names_for(foo)
+    end
+  end
+end