paperclip 4.3.7 → 5.2.0

data/Rakefile

@@ -9,7 +9,7 @@ task :default => [:clean, :all]
 desc 'Test the paperclip plugin under all supported Rails versions.'
 task :all do |t|
   if ENV['BUNDLE_GEMFILE']
-    exec('rake spec cucumber')
+    exec('rake spec && cucumber')
   else
     exec("rm -f gemfiles/*.lock")
     Rake::Task["appraisal:gemfiles"].execute

data/UPGRADING

@@ -1,14 +1,17 @@
 ##################################################
-#  NOTE FOR UPGRADING FROM PRE-3.0 VERSION       #
+#  NOTE FOR UPGRADING FROM 4.3.0 OR EARLIER      #
 ##################################################
 
-Paperclip 3.0 introduces a non-backward compatible change in your attachment
-path. This will help to prevent attachment name clashes when you have
-multiple attachments with the same name. If you didn't alter your
-attachment's path and are using Paperclip's default, you'll have to add
-`:path` and `:url` to your `has_attached_file` definition. For example:
+Paperclip is now compatible with aws-sdk >= 2.0.0.
 
-    has_attached_file :avatar,
-      :path => ":rails_root/public/system/:attachment/:id/:style/:filename",
-      :url => "/system/:attachment/:id/:style/:filename"
+If you are using S3 storage, aws-sdk >= 2.0.0 requires you to make a few small
+changes:
 
+* You must set the `s3_region`
+* If you are explicitly setting permissions anywhere, such as in an initializer,
+  note that the format of the permissions changed from using an underscore to
+  using a hyphen. For example, `:public_read` needs to be changed to
+  `public-read`.
+
+For a walkthrough of upgrading from 4 to 5 and aws-sdk >= 2.0 you can watch
+http://rubythursday.com/episodes/ruby-snack-27-upgrade-paperclip-and-aws-sdk-in-prep-for-rails-5

data/features/basic_integration.feature

@@ -69,6 +69,7 @@ Feature: Rails integration
       bucket: paperclip
       access_key_id: access_key
       secret_access_key: secret_key
+      s3_region: us-west-2
       """
     And I start the rails application
     When I go to the new user page
@@ -76,5 +77,5 @@ Feature: Rails integration
     And I attach the file "spec/support/fixtures/5k.png" to "Attachment" on S3
     And I press "Submit"
     Then I should see "Name: something"
-    And I should see an image with a path of "http://s3.amazonaws.com/paperclip/attachments/original/5k.png"
-    And the file at "http://s3.amazonaws.com/paperclip/attachments/original/5k.png" should be uploaded to S3
+    And I should see an image with a path of "//s3.amazonaws.com/paperclip/attachments/original/5k.png"
+    And the file at "//s3.amazonaws.com/paperclip/attachments/original/5k.png" should be uploaded to S3

data/features/migration.feature

@@ -68,27 +68,3 @@ Feature: Migration
 
     When I rollback a migration
     Then I should not have attachment columns for "avatar"
-
-  Scenario: Rails 3.2 change method
-    Given I am using Rails newer than 3.1
-    When I write to "db/migrate/01_create_users.rb" with:
-      """
-      class CreateUsers < ActiveRecord::Migration
-        def self.up
-          create_table :users
-        end
-      end
-      """
-    When I write to "db/migrate/02_add_attachment_to_users.rb" with:
-      """
-      class AddAttachmentToUsers < ActiveRecord::Migration
-        def change
-          add_attachment :users, :avatar
-        end
-      end
-      """
-    And I run a migration
-    Then I should have attachment columns for "avatar"
-
-    When I rollback a migration
-    Then I should not have attachment columns for "avatar"

data/features/step_definitions/attachment_steps.rb

@@ -23,7 +23,7 @@ When /^I modify my attachment definition to:$/ do |definition|
 end
 
 When /^I upload the fixture "([^"]*)"$/ do |filename|
-  run_simple %(bundle exec #{runner_command} "User.create!(:attachment => File.open('#{fixture_path(filename)}'))")
+  run_simple %(bundle exec rails runner "User.create!(:attachment => File.open('#{fixture_path(filename)}'))")
 end
 
 Then /^the attachment "([^"]*)" should have a dimension of (\d+x\d+)$/ do |filename, dimension|
@@ -56,7 +56,7 @@ Then /^the attachment should have the same content type as the fixture "([^"]*)"
       require "mime/types"
     end
 
-    attachment_content_type = `bundle exec #{runner_command} "puts User.last.attachment_content_type"`.strip
+    attachment_content_type = `bundle exec rails runner "puts User.last.attachment_content_type"`.strip
     expected = MIME::Types.type_for(filename).first.content_type
     expect(attachment_content_type).to eq(expected)
   end
@@ -64,14 +64,14 @@ end
 
 Then /^the attachment should have the same file name as the fixture "([^"]*)"$/ do |filename|
   cd(".") do
-    attachment_file_name = `bundle exec #{runner_command} "puts User.last.attachment_file_name"`.strip
+    attachment_file_name = `bundle exec rails runner "puts User.last.attachment_file_name"`.strip
     expect(attachment_file_name).to eq(File.name(fixture_path(filename)).to_s)
   end
 end
 
 Then /^the attachment should have the same file size as the fixture "([^"]*)"$/ do |filename|
   cd(".") do
-    attachment_file_size = `bundle exec #{runner_command} "puts User.last.attachment_file_size"`.strip
+    attachment_file_size = `bundle exec rails runner "puts User.last.attachment_file_size"`.strip
     expect(attachment_file_size).to eq(File.size(fixture_path(filename)).to_s)
   end
 end
@@ -84,7 +84,7 @@ end
 
 Then /^I should have attachment columns for "([^"]*)"$/ do |attachment_name|
   cd(".") do
-    columns = eval(`bundle exec #{runner_command} "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
+    columns = eval(`bundle exec rails runner "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
     expect_columns = [
       ["#{attachment_name}_file_name", :string],
       ["#{attachment_name}_content_type", :string],
@@ -97,7 +97,7 @@ end
 
 Then /^I should not have attachment columns for "([^"]*)"$/ do |attachment_name|
   cd(".") do
-    columns = eval(`bundle exec #{runner_command} "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
+    columns = eval(`bundle exec rails runner "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
     expect_columns = [
       ["#{attachment_name}_file_name", :string],
       ["#{attachment_name}_content_type", :string],

data/features/step_definitions/rails_steps.rb

@@ -1,34 +1,33 @@
 Given /^I generate a new rails application$/ do
   steps %{
-    When I run `bundle exec #{new_application_command} #{APP_NAME} --skip-bundle`
+    When I successfully run `rails new #{APP_NAME} --skip-bundle`
     And I cd to "#{APP_NAME}"
+  }
+
+  FileUtils.chdir("tmp/aruba/testapp/")
+
+  steps %{
     And I turn off class caching
-    And I fix the application.rb for 3.0.12
     And I write to "Gemfile" with:
       """
       source "http://rubygems.org"
       gem "rails", "#{framework_version}"
-      gem "sqlite3", "1.3.8", :platform => [:ruby, :rbx]
+      gem "sqlite3", :platform => [:ruby, :rbx]
       gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
       gem "jruby-openssl", :platform => :jruby
       gem "capybara"
       gem "gherkin"
-      gem "aws-sdk"
+      gem "aws-sdk", "~> 2.0.0"
       gem "racc", :platform => :rbx
       gem "rubysl", :platform => :rbx
       """
     And I remove turbolinks
+    And I comment out lines that contain "action_mailer" in "config/environments/*.rb"
     And I empty the application.js file
     And I configure the application to use "paperclip" from this project
   }
-end
 
-Given "I fix the application.rb for 3.0.12" do
-  cd(".") do
-    File.open("config/application.rb", "a") do |f|
-      f << "ActionController::Base.config.relative_url_root = ''"
-    end
-  end
+  FileUtils.chdir("../../..")
 end
 
 Given "I allow the attachment to be submitted" do
@@ -51,6 +50,16 @@ Given "I remove turbolinks" do
   end
 end
 
+Given /^I comment out lines that contain "([^"]+)" in "([^"]+)"$/ do |contains, glob|
+  cd(".") do
+    Dir.glob(glob).each do |file|
+      transform_file(file) do |content|
+        content.gsub(/^(.*?#{contains}.*?)$/) { |line| "# #{line}" }
+      end
+    end
+  end
+end
+
 Given /^I attach :attachment$/ do
   attach_attachment("attachment")
 end
@@ -60,11 +69,7 @@ Given /^I attach :attachment with:$/ do |definition|
 end
 
 def attach_attachment(name, definition = nil)
-  snippet = ""
-  if using_protected_attributes?
-    snippet += "attr_accessible :name, :#{name}\n"
-  end
-  snippet += "has_attached_file :#{name}"
+  snippet = "has_attached_file :#{name}"
   if definition
     snippet += ", \n"
     snippet += definition
@@ -86,19 +91,19 @@ Given "I empty the application.js file" do
 end
 
 Given /^I run a rails generator to generate a "([^"]*)" scaffold with "([^"]*)"$/ do |model_name, attributes|
-  step %[I successfully run `bundle exec #{generator_command} scaffold #{model_name} #{attributes}`]
+  step %[I successfully run `rails generate scaffold #{model_name} #{attributes}`]
 end
 
 Given /^I run a paperclip generator to add a paperclip "([^"]*)" to the "([^"]*)" model$/ do |attachment_name, model_name|
-  step %[I successfully run `bundle exec #{generator_command} paperclip #{model_name} #{attachment_name}`]
+  step %[I successfully run `rails generate paperclip #{model_name} #{attachment_name}`]
 end
 
 Given /^I run a migration$/ do
-  step %[I successfully run `bundle exec rake db:migrate --trace`]
+  step %[I successfully run `rake db:migrate --trace`]
 end
 
 When /^I rollback a migration$/ do
-  step %[I successfully run `bundle exec rake db:rollback STEPS=1 --trace`]
+  step %[I successfully run `rake db:rollback STEPS=1 --trace`]
 end
 
 Given /^I update my new user view to include the file upload field$/ do
@@ -144,8 +149,10 @@ end
 
 Given /^I start the rails application$/ do
   cd(".") do
+    require "rails"
     require "./config/environment"
-    require "capybara/rails"
+    require "capybara"
+    Capybara.app = Rails.application
   end
 end
 
@@ -171,7 +178,7 @@ end
 
 When /^I configure the application to use "([^\"]+)" from this project$/ do |name|
   append_to_gemfile "gem '#{name}', :path => '#{PROJECT_ROOT}'"
-  steps %{And I run `bundle install --local`}
+  steps %{And I successfully run `bundle install --local`}
 end
 
 When /^I configure the application to use "([^\"]+)"$/ do |gem_name|
@@ -190,12 +197,6 @@ When /^I comment out the gem "([^"]*)" from the Gemfile$/ do |gemname|
   comment_out_gem_in_gemfile gemname
 end
 
-Given /^I am using Rails newer than ([\d\.]+)$/ do |version|
-  if framework_version < version
-    pending "Not supported in Rails < #{version}"
-  end
-end
-
 Given(/^I add a "(.*?)" processor in "(.*?)"$/) do |processor, directory|
   filename = "#{directory}/#{processor}.rb"
   cd(".") do

data/features/step_definitions/s3_steps.rb

@@ -1,11 +1,11 @@
 When /^I attach the file "([^"]*)" to "([^"]*)" on S3$/ do |file_path, field|
   definition = Paperclip::AttachmentRegistry.definitions_for(User)[field.downcase.to_sym]
-  path = "https://paperclip.s3.amazonaws.com#{definition[:path]}"
+  path = "https://paperclip.s3.us-west-2.amazonaws.com#{definition[:path]}"
   path.gsub!(':filename', File.basename(file_path))
   path.gsub!(/:([^\/\.]+)/) do |match|
     "([^\/\.]+)"
   end
-  FakeWeb.register_uri(:put, Regexp.new(path), :body => "OK")
+  FakeWeb.register_uri(:put, Regexp.new(path), :body => "<xml></xml>")
   step "I attach the file \"#{file_path}\" to \"#{field}\""
 end
 

data/features/support/env.rb

@@ -7,5 +7,6 @@ $CUCUMBER=1
 World(RSpec::Matchers)
 
 Before do
+  aruba.config.command_launcher = ENV.fetch("DEBUG", nil) ? :debug : :spawn
   @aruba_timeout_seconds = 120
 end

data/features/support/paths.rb

@@ -17,7 +17,7 @@ module NavigationHelpers
         page_name =~ /the (.*) page/
         path_components = $1.split(/\s+/)
         self.send(path_components.push('path').join('_').to_sym)
-      rescue Object => e
+      rescue Object
         raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
           "Now, go and add a mapping in #{__FILE__}"
       end

data/features/support/rails.rb

@@ -35,29 +35,5 @@ module RailsCommandHelpers
   def framework_major_version
     framework_version.split(".").first.to_i
   end
-
-  def using_protected_attributes?
-    framework_major_version < 4
-  end
-
-  def new_application_command
-    "rails new"
-  end
-
-  def generator_command
-    if framework_major_version >= 4
-      "rails generate"
-    else
-      "script/rails generate"
-    end
-  end
-
-  def runner_command
-    if framework_major_version >= 4
-      "rails runner"
-    else
-      "script/rails runner"
-    end
-  end
 end
 World(RailsCommandHelpers)

data/gemfiles/4.2.gemfile

@@ -3,17 +3,15 @@
 source "https://rubygems.org"
 
 gem "sqlite3", "~> 1.3.8", :platforms => :ruby
-gem "jruby-openssl", :platforms => :jruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rubysl", :platforms => :rbx
-gem "racc", :platforms => :rbx
 gem "pry"
 gem "rails", "~> 4.2.0"
 
 group :development, :test do
-  gem "mime-types", "~> 1.16"
+  gem "activerecord-import"
+  gem "mime-types"
   gem "builder"
   gem "rubocop", :require => false
+  gem "rspec"
 end
 
 gemspec :path => "../"

data/gemfiles/{3.2.gemfile → 5.0.gemfile}

@@ -3,17 +3,15 @@
 source "https://rubygems.org"
 
 gem "sqlite3", "~> 1.3.8", :platforms => :ruby
-gem "jruby-openssl", :platforms => :jruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rubysl", :platforms => :rbx
-gem "racc", :platforms => :rbx
 gem "pry"
-gem "rails", "~> 3.2.0"
+gem "rails", "~> 5.0.0"
 
 group :development, :test do
-  gem "mime-types", "~> 1.16"
+  gem "activerecord-import"
+  gem "mime-types"
   gem "builder"
   gem "rubocop", :require => false
+  gem "rspec"
 end
 
 gemspec :path => "../"

data/lib/paperclip.rb

@@ -56,7 +56,6 @@ require 'paperclip/has_attached_file'
 require 'paperclip/attachment_registry'
 require 'paperclip/filename_cleaner'
 require 'paperclip/rails_environment'
-require "paperclip/deprecations"
 
 begin
   # Use mime/types/columnar if available, for reduced memory usage
@@ -91,14 +90,14 @@ module Paperclip
   #   image's orientation. Defaults to true.
   def self.options
     @options ||= {
-      :whiny => true,
-      :image_magick_path => nil,
-      :command_path => nil,
-      :log => true,
-      :log_command => true,
-      :swallow_stderr => true,
-      :content_type_mappings => {},
-      :use_exif_orientation => true
+      command_path: nil,
+      content_type_mappings: {},
+      log: true,
+      log_command: true,
+      read_timeout: nil,
+      swallow_stderr: true,
+      use_exif_orientation: true,
+      whiny: true,
     }
   end
 
@@ -120,7 +119,7 @@ module Paperclip
     # called on it, the attachment will *not* be deleted until +save+ is called. See the
     # Paperclip::Attachment documentation for more specifics. There are a number of options
     # you can set to change the behavior of a Paperclip attachment:
-    # * +url+: The full URL of where the attachment is publically accessible. This can just
+    # * +url+: The full URL of where the attachment is publicly accessible. This can just
     #   as easily point to a directory served directly through Apache as it can to an action
     #   that can control permissions. You can specify the full domain and path, but usually
     #   just an absolute path is sufficient. The leading slash *must* be included manually for
@@ -129,6 +128,9 @@ module Paperclip
     #   Paperclip::Attachment#interpolate for more information on variable interpolaton.
     #     :url => "/:class/:attachment/:id/:style_:filename"
     #     :url => "http://some.other.host/stuff/:class/:id_:extension"
+    #   Note: When using the +s3+ storage option, the +url+ option expects
+    #   particular values. See the Paperclip::Storage::S3#url documentation for
+    #   specifics.
     # * +default_url+: The URL that will be returned if there is no attachment assigned.
     #   This field is interpolated just as the url is. The default value is
     #   "/:attachment/:style/missing.png"
@@ -192,7 +194,6 @@ module Paperclip
     #     end
     #   end
     def has_attached_file(name, options = {})
-      Paperclip::Deprecations.check
       HasAttachedFile.define_on(self, name, options)
     end
   end

data/lib/paperclip/attachment.rb

@@ -2,6 +2,7 @@
 require 'uri'
 require 'paperclip/url_generator'
 require 'active_support/deprecation'
+require 'active_support/core_ext/string/inflections'
 
 module Paperclip
   # The Attachment class manages the files for a given attachment. It saves
@@ -32,6 +33,7 @@ module Paperclip
         :use_timestamp         => true,
         :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails],
         :validate_media_type   => true,
+        :adapter_options       => { hash_digest: Digest::MD5 },
         :check_validity_before_processing => true
       }
     end
@@ -49,7 +51,8 @@ module Paperclip
     # +url+ - a relative URL of the attachment. This is interpolated using +interpolator+
     # +path+ - where on the filesystem to store the attachment. This is interpolated using +interpolator+
     # +styles+ - a hash of options for processing the attachment. See +has_attached_file+ for the details
-    # +only_process+ - style args to be run through the post-processor. This defaults to the empty list
+    # +only_process+ - style args to be run through the post-processor. This defaults to the empty list (which is
+    #                  a special case that indicates all styles should be processed)
     # +default_url+ - a URL for the missing image
     # +default_style+ - the style to use when an argument is not specified e.g. #url, #path
     # +storage+ - the storage mechanism. Defaults to :filesystem
@@ -81,7 +84,7 @@ module Paperclip
       @errors                = {}
       @dirty                 = false
       @interpolator          = options[:interpolator]
-      @url_generator         = options[:url_generator].new(self, @options)
+      @url_generator         = options[:url_generator].new(self)
       @source_file_options   = options[:source_file_options]
       @whiny                 = options[:whiny]
 
@@ -95,7 +98,8 @@ module Paperclip
     # attachment:
     #   new_user.avatar = old_user.avatar
     def assign(uploaded_file)
-      @file = Paperclip.io_adapters.for(uploaded_file)
+      @file = Paperclip.io_adapters.for(uploaded_file,
+                                        @options[:adapter_options])
       ensure_required_accessors!
       ensure_required_validations!
 
@@ -236,6 +240,10 @@ module Paperclip
     # the instance's errors and returns false, cancelling the save.
     def save
       flush_deletes unless @options[:keep_old_files]
+      process = only_process
+      if process.any? && !process.include?(:original)
+        @queued_for_write.except!(:original)
+      end
       flush_writes
       @dirty = false
       true
@@ -322,7 +330,7 @@ module Paperclip
       OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@options[:hash_digest]).new, @options[:hash_secret], data)
     end
 
-    # This method really shouldn't be called that often. It's expected use is
+    # This method really shouldn't be called that often. Its expected use is
     # in the paperclip:refresh rake task and that's it. It will regenerate all
     # thumbnails forcefully, by reobtaining the original file and going through
     # the post-process again.
@@ -347,7 +355,7 @@ module Paperclip
 
     # Returns true if a file has been assigned.
     def file?
-      !original_filename.blank?
+      original_filename.present?
     end
 
     alias :present? :file?
@@ -426,7 +434,7 @@ module Paperclip
     def assign_attributes
       @queued_for_write[:original] = @file
       assign_file_information
-      assign_fingerprint(@file.fingerprint)
+      assign_fingerprint { @file.fingerprint }
       assign_timestamps
     end
 
@@ -436,9 +444,9 @@ module Paperclip
       instance_write(:file_size, @file.size)
     end
 
-    def assign_fingerprint(fingerprint)
+    def assign_fingerprint
       if instance_respond_to?(:fingerprint)
-        instance_write(:fingerprint, fingerprint)
+        instance_write(:fingerprint, yield)
       end
     end
 
@@ -464,7 +472,7 @@ module Paperclip
 
     def reset_file_if_original_reprocessed
       instance_write(:file_size, @queued_for_write[:original].size)
-      assign_fingerprint(@queued_for_write[:original].fingerprint)
+      assign_fingerprint { @queued_for_write[:original].fingerprint }
       reset_updater
     end
 
@@ -500,7 +508,7 @@ module Paperclip
 
       instance.run_paperclip_callbacks(:post_process) do
         instance.run_paperclip_callbacks(:"#{name}_post_process") do
-          unless @options[:check_validity_before_processing] && instance.errors.any?
+          if !@options[:check_validity_before_processing] || !instance.errors.any?
             post_process_styles(*style_args)
           end
         end
@@ -518,15 +526,18 @@ module Paperclip
       begin
         raise RuntimeError.new("Style #{name} has no processors defined.") if style.processors.blank?
         intermediate_files = []
+        original = @queued_for_write[:original]
 
-        @queued_for_write[name] = style.processors.inject(@queued_for_write[:original]) do |file, processor|
+        @queued_for_write[name] = style.processors.
+          reduce(original) do |file, processor|
           file = Paperclip.processor(processor).make(file, style.processor_options, self)
-          intermediate_files << file
+          intermediate_files << file unless file == @queued_for_write[:original]
           file
         end
 
         unadapted_file = @queued_for_write[name]
-        @queued_for_write[name] = Paperclip.io_adapters.for(@queued_for_write[name])
+        @queued_for_write[name] = Paperclip.io_adapters.
+          for(@queued_for_write[name], @options[:adapter_options])
         unadapted_file.close if unadapted_file.respond_to?(:close)
         @queued_for_write[name]
       rescue Paperclip::Errors::NotIdentifiedByImageMagickError => e
@@ -586,7 +597,7 @@ module Paperclip
 
     # You can either specifiy :restricted_characters or you can define your own
     # :filename_cleaner object. This object needs to respond to #call and takes
-    # the filename that will be cleaned. It should return the cleaned filenme.
+    # the filename that will be cleaned. It should return the cleaned filename.
     def filename_cleaner
       @options[:filename_cleaner] || FilenameCleaner.new(@options[:restricted_characters])
     end