paperclip 2.8.0 → 3.0.2

data/.gitignore

@@ -3,6 +3,7 @@
 .rvmrc
 .bundle
 tmp
+.DS_Store
 
 test/s3.yml
 test/debug.log

data/.travis.yml

@@ -1,14 +1,16 @@
 rvm:
-  - 1.8.7
   - 1.9.2
-  - ree
-  - rbx-18mode
+  - 1.9.3
+  - jruby-19mode
 
 before_script: "sudo ntpdate -ub ntp.ubuntu.com pool.ntp.org; true"
 script: "bundle exec rake clean test cucumber"
 
 gemfile:
-  - gemfiles/rails2.gemfile
-  - gemfiles/rails3.gemfile
-  - gemfiles/rails3_1.gemfile
-  - gemfiles/rails3_2.gemfile
+  - gemfiles/3.0.gemfile
+  - gemfiles/3.1.gemfile
+  - gemfiles/3.2.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode

data/Appraisals

@@ -1,20 +1,14 @@
-appraise "rails2" do
-  gem "rails", "~> 2.3.14"
+appraise "3.0" do
+  gem "rails", "~> 3.0.12"
   gem "paperclip", :path => "../"
 end
 
-appraise "rails3" do
-  gem "rails", "~> 3.0.10"
+appraise "3.1" do
+  gem "rails", "~> 3.1.4"
   gem "paperclip", :path => "../"
 end
 
-appraise "rails3_1" do
-  gem "rails", "~> 3.1.0"
+appraise "3.2" do
+  gem "rails", "~> 3.2.2"
   gem "paperclip", :path => "../"
 end
-
-appraise "rails3_2" do
-  gem "rails", "~> 3.2.0"
-  gem "paperclip", :path => "../"
-end
-

data/Gemfile

@@ -3,3 +3,5 @@ source "http://rubygems.org"
 gemspec
 
 gem "jruby-openssl", :platform => :jruby
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+gem "sqlite3", :platform => :ruby

data/NEWS

@@ -1,3 +1,27 @@
+New in 3.0.1
+
+* Feature: Introduce Paperlip IO adapter.
+* Bug fix: Regression in AttachmentContentTypeValidator has been fixed.
+
+New in 3.0.0:
+
+* API CHANGE: Paperclip now requires at least Ruby on Rails version 3.0.0
+* API CHANGE: The default :url and :path have changed. The new scheme avoids
+  filesystem conflicts and scales to handle larger numbers of uploads.
+
+  The easiest way to upgrade is to add an explicit :url and :path to your
+  has_attached_file calls:
+
+      has_attached_file :avatar,
+        :path => ":rails_root/public/system/:attachment/:id/:style/:filename",
+        :url => "/system/:attachment/:id/:style/:filename"
+
+* Feature: Adding Rails 3 style validators, and adding `validates_attachment` method as a shorthand.
+* Bug fix: Paperclip's rake tasks now loading records in batch.
+* Bug fix: Attachment style name with leading number now not raising an error.
+* Bug fix: File given to S3 and Fog storage will now be rewinded after flush_write.
+* Feature: You can now pass addional parameter to S3 expiring URL, such as :content_type.
+
 New in 2.7.0:
 
 * Bug fix: Checking the existence of a file on S3 handles all AWS errors.

data/README.md

@@ -24,7 +24,15 @@ The complete [RDoc](http://rdoc.info/gems/paperclip) is online.
 Requirements
 ------------
 
-ImageMagick must be installed and Paperclip must have access to it. To ensure
+### Ruby and Rails
+
+Paperclip now requires Ruby version **>= 1.9.2** and Rails version **>= 3.0** (Only if you're going to use Paperclip with Ruby on Rails.)
+
+If you're still on Ruby 1.8.7 or Ruby on Rails 2.3.x, you can still use Paperclip 2.7.x with your project. Also, everything in this README might not apply to your version of Paperclip, and you should read [the README for version 2.7](http://rubydoc.info/gems/paperclip/2.7.0) instead.
+
+### Image Processor
+
+[ImageMagick](http://www.imagemagick.org) must be installed and Paperclip must have access to it. To ensure
 that it does, on your command line, run `which convert` (one of the ImageMagick
 utilities). This will give you the path where that utility is installed. For
 example, it might return `/usr/local/bin/convert`.
@@ -49,13 +57,15 @@ GhostScript to be installed. On Mac OS X, you can also install that using Homebr
 Installation
 ------------
 
-Paperclip is distributed as a gem, which is how it should be used in your app. It's
-technically still installable as a plugin, but that's discouraged, as Rails plays
-well with gems.
+Paperclip is distributed as a gem, which is how it should be used in your app.
 
 Include the gem in your Gemfile:
 
-    gem "paperclip", "~> 2.0"
+    gem "paperclip", "~> 3.0"
+
+If you're still using Rails 2.3.x, you should do this instead:
+
+    gem "paperclip", "~> 2.7"
 
 Or, if you want to get the latest, you can get master from the main paperclip repository:
 
@@ -66,16 +76,6 @@ mentioned in this README, then you probably need to specify the master branch if
 use them. This README is probably ahead of the latest released version, if you're reading it
 on GitHub.
 
-Anyway, if you don't use Bundler (though you probably should, even in Rails 2), with config.gem
-
-    # In config/environment.rb
-    ...
-    Rails::Initializer.run do |config|
-      ...
-      config.gem "paperclip", :version => "~> 2.4"
-      ...
-    end
-
 For Non-Rails usage:
 
     class ModuleName < ActiveRecord::Base
@@ -106,6 +106,8 @@ In your migrations:
       end
     end
 
+(Or you can use migration generator: `rails generate paperclip user avatar`)
+
 In your edit and new views:
 
     <%= form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
@@ -151,12 +153,33 @@ validation.
 More information about the options to `has_attached_file` is available in the
 documentation of [`Paperclip::ClassMethods`](http://rubydoc.info/gems/paperclip/Paperclip/ClassMethods).
 
-For validations, attachments can be validated with these Paperclip's validation methods:
+For validations, Paperclip introduces several validators to validate your attachment:
+
+* `AttachmentContentTypeValidator`
+* `AttachmentPresenceValidator`
+* `AttachmentSizeValidator`
+
+Example Usage:
+
+    validates :avatar, :attachment_presence => true
+    validates_with AttachmentPresenceValidator, :attributes => :avatar
+
+Validators can also be defined using the old helper style:
 
 * `validates_attachment_presence`
 * `validates_attachment_content_type`
 * `validates_attachment_size`
 
+Example Usage:
+
+    validates_attachment_presence :avatar
+
+Lastly, you can also define multiple validations on a single attachment using `validates_attachment`:
+
+    validates_attachment :avatar, :presence => true,
+      :content_type => { :content_type => "image/jpg" },
+      :size => { :in => 0..10.kilobytes }
+
 Storage
 -------
 
@@ -199,9 +222,9 @@ thumbnail images. By defining a subclass of Paperclip::Processor, you can
 perform any processing you want on the files that are attached. Any file in
 your Rails app's lib/paperclip\_processors directory is automatically loaded by
 paperclip, allowing you to easily define custom processors. You can specify a
-processor with the :processors option to has\_attached\_file:
+processor with the :processors option to `has_attached_file`:
 
-    has_attached\_file :scan, :styles => { :text => { :quality => :better } },
+    has_attached_file :scan, :styles => { :text => { :quality => :better } },
                              :processors => [:ocr]
 
 This would load the hypothetical class Paperclip::Ocr, which would have the
@@ -251,14 +274,24 @@ are called before and after the processing of each attachment), and the
 attachment-specific `before_<attachment>_post_process` and
 `after_<attachment>_post_process`. The callbacks are intended to be as close to
 normal ActiveRecord callbacks as possible, so if you return false (specifically
-\- returning nil is not the same) in a before\_ filter, the post processing step
-will halt. Returning false in an after\_ filter will not halt anything, but you
+\- returning nil is not the same) in a `before_filter`, the post processing step
+will halt. Returning false in an `after_filter` will not halt anything, but you
 can access the model and the attachment if necessary.
 
 _NOTE: Post processing will not even *start* if the attachment is not valid
 according to the validations. Your callbacks and processors will *only* be
 called with valid attachments._
 
+    class Message < ActiveRecord::Base
+      has_attached_file :asset, styles: {thumb: "100x100#"}
+
+      before_post_process :skip_for_audio
+
+      def skip_for_audio
+        ! %w(audio/ogg application/ogg).include?(asset_content_type)
+      end
+    end
+
 URI Obfuscation
 ---------------
 
@@ -441,4 +474,3 @@ License
 -------
 
 Paperclip is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
-

data/Rakefile

@@ -4,11 +4,16 @@ require 'rake/testtask'
 require 'cucumber/rake/task'
 
 desc 'Default: run unit tests.'
-task :default => [:clean, 'appraisal:install', :all]
+task :default => [:clean, :all]
 
 desc 'Test the paperclip plugin under all supported Rails versions.'
 task :all do |t|
-  exec('rake appraisal test cucumber')
+  if ENV['BUNDLE_GEMFILE']
+    exec('rake test cucumber')
+  else
+    Rake::Task["appraisal:install"].execute
+    exec('rake appraisal test cucumber')
+  end
 end
 
 desc 'Test the paperclip plugin.'

data/UPGRADING

@@ -0,0 +1,14 @@
+##################################################
+#  NOTE FOR UPGRADING FROM PRE-3.0 VERSION       #
+##################################################
+
+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:
+
+    has_attached_file :avatar,
+      :path => ":rails_root/public/system/:attachment/:id/:style/:filename",
+      :url => "/system/:attachment/:id/:style/:filename"
+

data/features/basic_integration.feature

@@ -11,8 +11,8 @@ Feature: Rails integration
   Scenario: Filesystem integration test
     Given I add this snippet to the User model:
       """
-      has_attached_file :attachment
-      attr_protected
+      attr_accessible :name, :attachment
+      has_attached_file :attachment, :url => "/system/:attachment/:style/:filename"
       """
     And I start the rails application
     When I go to the new user page
@@ -20,17 +20,17 @@ Feature: Rails integration
     And I attach the file "test/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/1/original/5k.png"
-    And the file at "/system/attachments/1/original/5k.png" should be the same as "test/fixtures/5k.png"
+    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"
 
   Scenario: S3 Integration test
     Given I add this snippet to the User model:
       """
+      attr_accessible :name, :attachment
       has_attached_file :attachment,
                         :storage => :s3,
-                        :path => "/:attachment/:id/:style/:filename",
+                        :path => "/:attachment/:style/:filename",
                         :s3_credentials => Rails.root.join("config/s3.yml")
-      attr_protected
       """
     And I write to "config/s3.yml" with:
       """
@@ -44,5 +44,5 @@ Feature: Rails integration
     And I attach the file "test/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/1/original/5k.png"
-    And the file at "http://s3.amazonaws.com/paperclip/attachments/1/original/5k.png" should be uploaded to S3
+    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

data/features/rake_tasks.feature

@@ -5,9 +5,9 @@ Feature: Rake tasks
     And I run a rails generator to generate a "User" scaffold with "name:string"
     And I run a paperclip generator to add a paperclip "attachment" to the "User" model
     And I run a migration
-    And I add the paperclip rake task to a Rails 2.3 application
     And I add this snippet to the User model:
       """
+      attr_accessible :name, :attachment
       has_attached_file :attachment, :path => ":rails_root/public/system/:attachment/:style/:filename"
       """
 

data/features/step_definitions/attachment_steps.rb

@@ -10,11 +10,13 @@ end
 World(AttachmentHelpers)
 
 When /^I modify my attachment definition to:$/ do |definition|
-  write_file "app/models/user.rb", <<-FILE
-    class User < ActiveRecord::Base
+  content = in_current_dir { File.read("app/models/user.rb") }
+  content.gsub!(/has_attached_file.+end/m, <<-FILE)
       #{definition}
     end
   FILE
+
+  write_file "app/models/user.rb", content
   in_current_dir { FileUtils.rm_rf ".rbx" }
 end
 
@@ -51,6 +53,13 @@ Then /^the attachment should have the same content type as the fixture "([^"]*)"
   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
+  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

data/features/step_definitions/rails_steps.rb

@@ -1,13 +1,15 @@
 Given /^I generate a new rails application$/ do
   steps %{
-    When I run `bundle exec #{new_application_command} #{APP_NAME}`
+    When I run `bundle exec #{new_application_command} #{APP_NAME} --skip-bundle`
     And I cd to "#{APP_NAME}"
     And I turn off class caching
     And I write to "Gemfile" with:
       """
       source "http://rubygems.org"
       gem "rails", "#{framework_version}"
-      gem "sqlite3"
+      gem "sqlite3", :platform => :ruby
+      gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+      gem "jruby-openssl", :platform => :jruby
       gem "capybara"
       gem "gherkin"
       gem "aws-sdk"
@@ -31,33 +33,18 @@ Given /^I run a migration$/ do
 end
 
 Given /^I update my new user view to include the file upload field$/ do
-  if framework_version?("3")
-    steps %{
-      Given I overwrite "app/views/users/new.html.erb" with:
-        """
-        <%= form_for @user, :html => { :multipart => true } do |f| %>
-          <%= f.label :name %>
-          <%= f.text_field :name %>
-          <%= f.label :attachment %>
-          <%= f.file_field :attachment %>
-          <%= submit_tag "Submit" %>
-        <% end %>
-        """
-    }
-  else
-    steps %{
-      Given I overwrite "app/views/users/new.html.erb" with:
-        """
-        <% form_for @user, :html => { :multipart => true } do |f| %>
-          <%= f.label :name %>
-          <%= f.text_field :name %>
-          <%= f.label :attachment %>
-          <%= f.file_field :attachment %>
-          <%= submit_tag "Submit" %>
-        <% end %>
-        """
-    }
-  end
+  steps %{
+    Given I overwrite "app/views/users/new.html.erb" with:
+      """
+      <%= form_for @user, :html => { :multipart => true } do |f| %>
+        <%= f.label :name %>
+        <%= f.text_field :name %>
+        <%= f.label :attachment %>
+        <%= f.file_field :attachment %>
+        <%= submit_tag "Submit" %>
+      <% end %>
+      """
+  }
 end
 
 Given /^I update my user view to include the attachment$/ do
@@ -89,7 +76,7 @@ Given /^I reload my application$/ do
   Rails::Application.reload!
 end
 
-When %r{I turn off class caching} do
+When /^I turn off class caching$/ do
   in_current_dir do
     file = "config/environments/test.rb"
     config = IO.read(file)
@@ -99,30 +86,6 @@ When %r{I turn off class caching} do
   end
 end
 
-Given /^I update my application to use Bundler$/ do
-  if framework_version?("2")
-    boot_config_template = File.read('features/support/fixtures/boot_config.txt')
-    preinitializer_template = File.read('features/support/fixtures/preinitializer.txt')
-    gemfile_template = File.read('features/support/fixtures/gemfile.txt')
-    in_current_dir do
-      content = File.read("config/boot.rb").sub(/Rails\.boot!/, boot_config_template)
-      File.open("config/boot.rb", "w") { |file| file.write(content) }
-      File.open("config/preinitializer.rb", "w") { |file| file.write(preinitializer_template) }
-      File.open("Gemfile", "w") { |file| file.write(gemfile_template.sub(/RAILS_VERSION/, framework_version)) }
-    end
-  end
-end
-
-Given /^I add the paperclip rake task to a Rails 2.3 application$/ do
-  if framework_version?("2.3")
-    require 'fileutils'
-    source = File.expand_path('lib/tasks/paperclip.rake')
-    destination = in_current_dir { File.expand_path("lib/tasks") }
-    FileUtils.cp source, destination
-    append_to "Rakefile", "require 'paperclip'"
-  end
-end
-
 Then /^the file at "([^"]*)" should be the same as "([^"]*)"$/ do |web_file, path|
   expected = IO.read(path)
   actual = if web_file.match %r{^https?://}
@@ -155,28 +118,3 @@ end
 When /^I comment out the gem "([^"]*)" from the Gemfile$/ do |gemname|
   comment_out_gem_in_gemfile gemname
 end
-
-module FileHelpers
-  def append_to(path, contents)
-    in_current_dir do
-      File.open(path, "a") do |file|
-        file.puts
-        file.puts contents
-      end
-    end
-  end
-
-  def append_to_gemfile(contents)
-    append_to('Gemfile', contents)
-  end
-
-  def comment_out_gem_in_gemfile(gemname)
-    in_current_dir do
-      gemfile = File.read("Gemfile")
-      gemfile.sub!(/^(\s*)(gem\s*['"]#{gemname})/, "\\1# \\2")
-      File.open("Gemfile", 'w'){ |file| file.write(gemfile) }
-    end
-  end
-end
-
-World(FileHelpers)