paperclip 4.2.2 → 5.0.0

data/RELEASING.md

@@ -0,0 +1,17 @@
+Releasing paperclip
+
+1. Update `lib/paperclip/version.rb` file accordingly.
+2. Update `NEWS` to reflect the changes since last release.
+3. Commit changes. There shouldn’t be code changes, and thus CI doesn’t need to
+   run, you can then add “[ci skip]” to the commit message.
+4. Tag the release: `git tag -m 'vVERSION' vVERSION`
+5. Push changes: `git push --tags`
+6. Build and publish the gem:
+
+   ```bash
+   gem build paperclip.gemspec
+   gem push paperclip-VERSION.gem
+   ```
+
+7. Announce the new release, making sure to say “thank you” to the contributors
+   who helped shape this version.

data/Rakefile

@@ -11,7 +11,7 @@ task :all do |t|
   if ENV['BUNDLE_GEMFILE']
     exec('rake spec cucumber')
   else
-    exec("rm gemfiles/*.lock")
+    exec("rm -f gemfiles/*.lock")
     Rake::Task["appraisal:gemfiles"].execute
     Rake::Task["appraisal:install"].execute
     exec('rake appraisal')

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

@@ -12,17 +12,20 @@ Feature: Rails integration
   Scenario: Configure defaults for all attachments through Railtie
     Given I add this snippet to config/application.rb:
       """
-      config.paperclip_defaults = {:url => "/paperclip/custom/:attachment/:style/:filename"}
+      config.paperclip_defaults = {
+        :url => "/paperclip/custom/:attachment/:style/:filename",
+        :validate_media_type => false
+      }
       """
     And I attach :attachment
     And I start the rails application
     When I go to the new user page
     And I fill in "Name" with "something"
-    And I attach the file "spec/support/fixtures/5k.png" to "Attachment"
+    And I attach the file "spec/support/fixtures/animated.unknown" to "Attachment"
     And I press "Submit"
     Then I should see "Name: something"
-    And I should see an image with a path of "/paperclip/custom/attachments/original/5k.png"
-    And the file at "/paperclip/custom/attachments/original/5k.png" should be the same as "spec/support/fixtures/5k.png"
+    And I should see an image with a path of "/paperclip/custom/attachments/original/animated.unknown"
+    And the file at "/paperclip/custom/attachments/original/animated.unknown" should be the same as "spec/support/fixtures/animated.unknown"
 
   Scenario: Add custom processors
     Given I add a "test" processor in "lib/paperclip"
@@ -66,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

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

@@ -10,7 +10,7 @@ end
 World(AttachmentHelpers)
 
 When /^I modify my attachment definition to:$/ do |definition|
-  content = in_current_dir { File.read("app/models/user.rb") }
+  content = cd(".") { File.read("app/models/user.rb") }
   name = content[/has_attached_file :\w+/][/:\w+/]
   content.gsub!(/has_attached_file.+end/m, <<-FILE)
       #{definition}
@@ -19,7 +19,7 @@ When /^I modify my attachment definition to:$/ do |definition|
   FILE
 
   write_file "app/models/user.rb", content
-  in_current_dir { FileUtils.rm_rf ".rbx" }
+  cd(".") { FileUtils.rm_rf ".rbx" }
 end
 
 When /^I upload the fixture "([^"]*)"$/ do |filename|
@@ -27,20 +27,20 @@ When /^I upload the fixture "([^"]*)"$/ do |filename|
 end
 
 Then /^the attachment "([^"]*)" should have a dimension of (\d+x\d+)$/ do |filename, dimension|
-  in_current_dir do
+  cd(".") do
     geometry = `identify -format "%wx%h" "#{attachment_path(filename)}"`.strip
-    geometry.should == dimension
+    expect(geometry).to eq(dimension)
   end
 end
 
 Then /^the attachment "([^"]*)" should exist$/ do |filename|
-  in_current_dir do
-    File.exist?(attachment_path(filename)).should be
+  cd(".") do
+    expect(File.exist?(attachment_path(filename))).to be true
   end
 end
 
 When /^I swap the attachment "([^"]*)" with the fixture "([^"]*)"$/ do |attachment_filename, fixture_filename|
-  in_current_dir do
+  cd(".") do
     require 'fileutils'
     FileUtils.rm_f attachment_path(attachment_filename)
     FileUtils.cp fixture_path(fixture_filename), attachment_path(attachment_filename)
@@ -48,35 +48,42 @@ When /^I swap the attachment "([^"]*)" with the fixture "([^"]*)"$/ do |attachme
 end
 
 Then /^the attachment should have the same content type as the fixture "([^"]*)"$/ do |filename|
-  in_current_dir do
-    require 'mime/types'
+  cd(".") do
+    begin
+      # Use mime/types/columnar if available, for reduced memory usage
+      require "mime/types/columnar"
+    rescue LoadError
+      require "mime/types"
+    end
+
     attachment_content_type = `bundle exec #{runner_command} "puts User.last.attachment_content_type"`.strip
-    attachment_content_type.should == MIME::Types.type_for(filename).first.content_type
+    expected = MIME::Types.type_for(filename).first.content_type
+    expect(attachment_content_type).to eq(expected)
   end
 end
 
 Then /^the attachment should have the same file name as the fixture "([^"]*)"$/ do |filename|
-  in_current_dir do
+  cd(".") do
     attachment_file_name = `bundle exec #{runner_command} "puts User.last.attachment_file_name"`.strip
-    attachment_file_name.should == File.name(fixture_path(filename)).to_s
+    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|
-  in_current_dir do
+  cd(".") do
     attachment_file_size = `bundle exec #{runner_command} "puts User.last.attachment_file_size"`.strip
-    attachment_file_size.should == File.size(fixture_path(filename)).to_s
+    expect(attachment_file_size).to eq(File.size(fixture_path(filename)).to_s)
   end
 end
 
 Then /^the attachment file "([^"]*)" should (not )?exist$/ do |filename, not_exist|
-  in_current_dir do
-    check_file_presence([attachment_path(filename)], !not_exist)
+  cd(".") do
+    expect(attachment_path(filename)).not_to be_an_existing_file
   end
 end
 
 Then /^I should have attachment columns for "([^"]*)"$/ do |attachment_name|
-  in_current_dir do
+  cd(".") do
     columns = eval(`bundle exec #{runner_command} "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
     expect_columns = [
       ["#{attachment_name}_file_name", :string],
@@ -84,13 +91,12 @@ Then /^I should have attachment columns for "([^"]*)"$/ do |attachment_name|
       ["#{attachment_name}_file_size", :integer],
       ["#{attachment_name}_updated_at", :datetime]
     ]
-
-    expect_columns.all?{ |column| columns.include? column }.should eq true
+    expect(columns).to include(*expect_columns)
   end
 end
 
 Then /^I should not have attachment columns for "([^"]*)"$/ do |attachment_name|
-  in_current_dir do
+  cd(".") do
     columns = eval(`bundle exec #{runner_command} "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
     expect_columns = [
       ["#{attachment_name}_file_name", :string],
@@ -99,6 +105,6 @@ Then /^I should not have attachment columns for "([^"]*)"$/ do |attachment_name|
       ["#{attachment_name}_updated_at", :datetime]
     ]
 
-    expect_columns.none?{ |column| columns.include? column }.should eq true
+    expect(columns).not_to include(*expect_columns)
   end
 end

data/features/step_definitions/html_steps.rb

@@ -1,5 +1,5 @@
 Then %r{I should see an image with a path of "([^"]*)"} do |path|
-  page.should have_css("img[src^='#{path}']")
+  expect(page).to have_css("img[src^='#{path}']")
 end
 
 Then %r{^the file at "([^"]*)" is the same as "([^"]*)"$} do |web_file, path|
@@ -11,5 +11,5 @@ Then %r{^the file at "([^"]*)" is the same as "([^"]*)"$} do |web_file, path|
     page.body
   end
   actual.force_encoding("UTF-8") if actual.respond_to?(:force_encoding)
-  actual.should == expected
+  expect(actual).to eq(expected)
 end

data/features/step_definitions/rails_steps.rb

@@ -24,7 +24,7 @@ Given /^I generate a new rails application$/ do
 end
 
 Given "I fix the application.rb for 3.0.12" do
-  in_current_dir do
+  cd(".") do
     File.open("config/application.rb", "a") do |f|
       f << "ActionController::Base.config.relative_url_root = ''"
     end
@@ -32,7 +32,7 @@ Given "I fix the application.rb for 3.0.12" do
 end
 
 Given "I allow the attachment to be submitted" do
-  in_current_dir do
+  cd(".") do
     transform_file("app/controllers/users_controller.rb") do |content|
       content.gsub("params.require(:user).permit(:name)",
                    "params.require(:user).permit!")
@@ -41,7 +41,7 @@ Given "I allow the attachment to be submitted" do
 end
 
 Given "I remove turbolinks" do
-  in_current_dir do
+  cd(".") do
     transform_file("app/assets/javascripts/application.js") do |content|
       content.gsub("//= require turbolinks", "")
     end
@@ -70,7 +70,7 @@ def attach_attachment(name, definition = nil)
     snippet += definition
   end
   snippet += "\ndo_not_validate_attachment_file_type :#{name}\n"
-  in_current_dir do
+  cd(".") do
     transform_file("app/models/user.rb") do |content|
       content.sub(/end\Z/, "#{snippet}\nend")
     end
@@ -78,7 +78,7 @@ def attach_attachment(name, definition = nil)
 end
 
 Given "I empty the application.js file" do
-  in_current_dir do
+  cd(".") do
     transform_file("app/assets/javascripts/application.js") do |content|
       ""
     end
@@ -128,7 +128,7 @@ end
 
 Given /^I add this snippet to the User model:$/ do |snippet|
   file_name = "app/models/user.rb"
-  in_current_dir do
+  cd(".") do
     content = File.read(file_name)
     File.open(file_name, 'w') { |f| f << content.sub(/end\Z/, "#{snippet}\nend") }
   end
@@ -136,14 +136,14 @@ end
 
 Given /^I add this snippet to config\/application.rb:$/ do |snippet|
   file_name = "config/application.rb"
-  in_current_dir do
+  cd(".") do
     content = File.read(file_name)
     File.open(file_name, 'w') {|f| f << content.sub(/class Application < Rails::Application.*$/, "class Application < Rails::Application\n#{snippet}\n")}
   end
 end
 
 Given /^I start the rails application$/ do
-  in_current_dir do
+  cd(".") do
     require "./config/environment"
     require "capybara/rails"
   end
@@ -154,7 +154,7 @@ Given /^I reload my application$/ do
 end
 
 When /^I turn off class caching$/ do
-  in_current_dir do
+  cd(".") do
     file = "config/environments/test.rb"
     config = IO.read(file)
     config.gsub!(%r{^\s*config.cache_classes.*$},
@@ -166,7 +166,7 @@ end
 Then /^the file at "([^"]*)" should be the same as "([^"]*)"$/ do |web_file, path|
   expected = IO.read(path)
   actual = read_from_web(web_file)
-  actual.should == expected
+  expect(actual).to eq(expected)
 end
 
 When /^I configure the application to use "([^\"]+)" from this project$/ do |name|
@@ -190,15 +190,9 @@ 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"
-  in_current_dir do
+  cd(".") do
     FileUtils.mkdir_p directory
     File.open(filename, "w") do |f|
       f.write(<<-CLASS)

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/step_definitions/web_steps.rb

@@ -103,107 +103,5 @@ When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
 end
 
 Then /^(?:|I )should see "([^"]*)"$/ do |text|
-  if page.respond_to? :should
-    page.should have_content(text)
-  else
-    assert page.has_content?(text)
-  end
-end
-
-Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
-  regexp = Regexp.new(regexp)
-
-  if page.respond_to? :should
-    page.should have_xpath('//*', :text => regexp)
-  else
-    assert page.has_xpath?('//*', :text => regexp)
-  end
-end
-
-Then /^(?:|I )should not see "([^"]*)"$/ do |text|
-  if page.respond_to? :should
-    page.should have_no_content(text)
-  else
-    assert page.has_no_content?(text)
-  end
-end
-
-Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
-  regexp = Regexp.new(regexp)
-
-  if page.respond_to? :should
-    page.should have_no_xpath('//*', :text => regexp)
-  else
-    assert page.has_no_xpath?('//*', :text => regexp)
-  end
-end
-
-Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
-  with_scope(parent) do
-    field = find_field(field)
-    if field.value.respond_to? :should
-      field.value.should =~ /#{value}/
-    else
-      assert_match(/#{value}/, field.value)
-    end
-  end
-end
-
-Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
-  with_scope(parent) do
-    field = find_field(field)
-    if field.value.respond_to? :should_not
-      field.value.should_not =~ /#{value}/
-    else
-      assert_no_match(/#{value}/, field.value)
-    end
-  end
-end
-
-Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
-  with_scope(parent) do
-    field_checked = find_field(label)['checked']
-    if field_checked.respond_to? :should
-      field_checked.should eq true
-    else
-      assert field_checked
-    end
-  end
-end
-
-Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
-  with_scope(parent) do
-    field_checked = find_field(label)['checked']
-    if field_checked.respond_to? :should
-      field_checked.should eq false
-    else
-      assert !field_checked
-    end
-  end
-end
-
-Then /^(?:|I )should be on (.+)$/ do |page_name|
-  current_path = URI.parse(current_url).path
-  if current_path.respond_to? :should
-    current_path.should == path_to(page_name)
-  else
-    assert_equal path_to(page_name), current_path
-  end
-end
-
-Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
-  query = URI.parse(current_url).query
-  actual_params = query ? CGI.parse(query) : {}
-  expected_params = {}
-  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
-
-  if actual_params.respond_to? :should
-    actual_params.should == expected_params
-  else
-    assert_equal expected_params, actual_params
-  end
-end
-
-Then /^show me the page$/ do
-  save_and_open_page
+  expect(page).to have_content(text)
 end

data/features/support/file_helpers.rb

@@ -1,6 +1,6 @@
 module FileHelpers
   def append_to(path, contents)
-    in_current_dir do
+    cd(".") do
       File.open(path, "a") do |file|
         file.puts
         file.puts contents
@@ -13,7 +13,7 @@ module FileHelpers
   end
 
   def comment_out_gem_in_gemfile(gemname)
-    in_current_dir do
+    cd(".") do
       gemfile = File.read("Gemfile")
       gemfile.sub!(/^(\s*)(gem\s*['"]#{gemname})/, "\\1# \\2")
       File.open("Gemfile", 'w'){ |file| file.write(gemfile) }

data/gemfiles/4.2.awsv2.0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "~> 4.2.0"
+gem "aws-sdk", "~> 2.0.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/4.2.awsv2.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "~> 4.2.0"
+gem "aws-sdk", "~> 2.1.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types", ">= 1.16", "< 4"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/{4.1.gemfile → 4.2.awsv2.gemfile}

@@ -2,18 +2,19 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "1.3.8", :platforms => :ruby
+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.1.0"
-gem "paperclip", :path => "../"
+gem "rails", "~> 4.2.0"
+gem "aws-sdk", "~> 2.0"
 
 group :development, :test do
   gem "mime-types", "~> 1.16"
   gem "builder"
+  gem "rubocop", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/5.0.awsv2.0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "5.0.0"
+gem "aws-sdk", "~> 2.0.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types", ">= 1.16", "< 4"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/5.0.awsv2.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "5.0.0"
+gem "aws-sdk", "~> 2.1.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/{4.2.gemfile → 5.0.awsv2.gemfile}

@@ -2,18 +2,19 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "1.3.8", :platforms => :ruby
+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.rc2"
-gem "paperclip", :path => "../"
+gem "rails", "~> 5.0.0"
+gem "aws-sdk", "~> 2.0"
 
 group :development, :test do
   gem "mime-types", "~> 1.16"
   gem "builder"
+  gem "rubocop", :require => false
 end
 
 gemspec :path => "../"