paperclip 3.5.2 → 5.2.1

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

@@ -1,6 +1,6 @@
 require 'bundler/gem_tasks'
 require 'appraisal'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 require 'cucumber/rake/task'
 
 desc 'Default: run unit tests.'
@@ -9,19 +9,17 @@ task :default => [:clean, :all]
 desc 'Test the paperclip plugin under all supported Rails versions.'
 task :all do |t|
   if ENV['BUNDLE_GEMFILE']
-    exec('rake test cucumber')
+    exec('rake spec && cucumber')
   else
+    exec("rm -f gemfiles/*.lock")
+    Rake::Task["appraisal:gemfiles"].execute
     Rake::Task["appraisal:install"].execute
-    exec('rake appraisal test cucumber')
+    exec('rake appraisal')
   end
 end
 
 desc 'Test the paperclip plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib' << 'profile'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run integration test'
 Cucumber::Rake::Task.new do |t|

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,35 @@ 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 "test/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/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"
+    And I add a "cool" processor in "lib/paperclip_processors"
+    And I attach :attachment with:
+      """
+      styles: { original: {} }, processors: [:test, :cool]
+      """
+    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 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 "test/fixtures/5k.png"
 
   Scenario: Filesystem integration test
     Given I attach :attachment with:
@@ -32,11 +50,11 @@ Feature: Rails integration
     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 "test/fixtures/5k.png" to "Attachment"
+    And I attach the file "spec/support/fixtures/5k.png" to "Attachment"
     And I press "Submit"
     Then I should see "Name: something"
     And I should see an image with a path of "/system/attachments/original/5k.png"
-    And the file at "/system/attachments/original/5k.png" should be the same as "test/fixtures/5k.png"
+    And the file at "/system/attachments/original/5k.png" should be the same as "spec/support/fixtures/5k.png"
 
   Scenario: S3 Integration test
     Given I attach :attachment with:
@@ -51,12 +69,13 @@ 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
     And I fill in "Name" with "something"
-    And I attach the file "test/fixtures/5k.png" to "Attachment" on S3
+    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

@@ -1,6 +1,6 @@
 module AttachmentHelpers
   def fixture_path(filename)
-    File.expand_path("#{PROJECT_ROOT}/test/fixtures/#{filename}")
+    File.expand_path("#{PROJECT_ROOT}/spec/support/fixtures/#{filename}")
   end
 
   def attachment_path(filename)
@@ -10,35 +10,37 @@ 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}
+      do_not_validate_attachment_file_type #{name}
     end
   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|
-  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|
-  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.exists?(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)
@@ -46,50 +48,56 @@ 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'
-    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
+  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 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
 end
 
 Then /^the attachment should have the same file name as the fixture "([^"]*)"$/ do |filename|
-  in_current_dir 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
+  cd(".") do
+    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|
-  in_current_dir 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
+  cd(".") do
+    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
 
 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
-    columns = eval(`bundle exec #{runner_command} "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
+  cd(".") do
+    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],
       ["#{attachment_name}_file_size", :integer],
       ["#{attachment_name}_updated_at", :datetime]
     ]
-
-    expect_columns.all?{ |column| columns.include? column }.should be_true
+    expect(columns).to include(*expect_columns)
   end
 end
 
 Then /^I should not have attachment columns for "([^"]*)"$/ do |attachment_name|
-  in_current_dir do
-    columns = eval(`bundle exec #{runner_command} "puts User.columns.map{ |column| [column.name, column.type] }.inspect"`.strip)
+  cd(".") do
+    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,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 be_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

@@ -1,38 +1,37 @@
 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", :platform => :ruby
+      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
-    And I reset Bundler environment variable
-    And I successfully run `bundle install --local`
   }
-end
 
-Given "I fix the application.rb for 3.0.12" do
-  in_current_dir 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
-  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 +40,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
@@ -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,16 +69,13 @@ 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
   end
-  in_current_dir do
+  snippet += "\ndo_not_validate_attachment_file_type :#{name}\n"
+  cd(".") do
     transform_file("app/models/user.rb") do |content|
       content.sub(/end\Z/, "#{snippet}\nend")
     end
@@ -77,7 +83,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
@@ -85,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
@@ -127,7 +133,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
@@ -135,16 +141,18 @@ 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 "rails"
     require "./config/environment"
-    require "capybara/rails"
+    require "capybara"
+    Capybara.app = Rails.application
   end
 end
 
@@ -153,7 +161,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.*$},
@@ -165,12 +173,12 @@ 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|
   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|
@@ -189,14 +197,37 @@ 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}"
+Given(/^I add a "(.*?)" processor in "(.*?)"$/) do |processor, directory|
+  filename = "#{directory}/#{processor}.rb"
+  cd(".") do
+    FileUtils.mkdir_p directory
+    File.open(filename, "w") do |f|
+      f.write(<<-CLASS)
+        module Paperclip
+          class #{processor.capitalize} < Processor
+            def make
+              basename = File.basename(file.path, File.extname(file.path))
+              dst_format = options[:format] ? ".\#{options[:format]}" : ''
+
+              dst = Tempfile.new([basename, dst_format])
+              dst.binmode
+
+              convert(':src :dst',
+                src: File.expand_path(file.path),
+                dst: File.expand_path(dst.path)
+              )
+
+              dst
+            end
+          end
+        end
+      CLASS
+    end
   end
 end
 
 def transform_file(filename)
-  if File.exists?(filename)
+  if File.exist?(filename)
     content = File.read(filename)
     File.open(filename, "w") do |f|
       content = yield(content)

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