paperclip 3.0.4 → 3.1.0

data/Appraisals

@@ -1,14 +1,14 @@
 appraise "3.0" do
-  gem "rails", "~> 3.0.12"
+  gem "rails", "~> 3.0.15"
   gem "paperclip", :path => "../"
 end
 
 appraise "3.1" do
-  gem "rails", "~> 3.1.4"
+  gem "rails", "~> 3.1.6"
   gem "paperclip", :path => "../"
 end
 
 appraise "3.2" do
-  gem "rails", "~> 3.2.3"
+  gem "rails", "~> 3.2.6"
   gem "paperclip", :path => "../"
 end

data/NEWS

@@ -1,3 +1,46 @@
+New in 3.1.0:
+
+* Feature: Paperclip now support new migration syntax (sexy migration) that reads better:
+
+      class AddAttachmentToUsers < ActiveRecord::Migration
+        def self.up
+          create_table :users do |t|
+            t.attachment :avatar
+          end
+        end
+      end
+
+  Also, schema-definition level syntax has been added:
+
+      add_attachment :users, :avatar
+      remove_attachment :users, :avatar
+
+* Feature: Migration now support Rails 3.2+ `change` method.
+* API CHANGE: Old `t.has_attached_file` and `drop_attached_file` are now deprecated. You're advised
+  to update your migration file before the next MAJOR version.
+* Bug fix: Tempfile now rewinded before generating fingerprint
+* API CHANGE: Tempfiles are now unlinked after `after_flush_writes`
+
+  If you need to interact with the generated tempfiles, please define an `after_flush_writes` method
+  in your model. You'll be able to access files via `@queue_for_write` instance variable.
+
+* Bug fix: `:s3_protocol` can now be defined as either String or Symbol
+* Bug fix: Tempfiles are now rewinded before get passed into `after_flush_writes`
+* Feature: Added expiring_url method to Fog Storage
+* API CHANGE: Paperclip now tested against AWS::SDK 1.5.2 onward
+* Bug fix: Improved the output of the content_type validator so the actual failure is displayed
+* Feature: Animated formats now identified using ImageMagick.
+* Feature: AttachmentAdapter now support fetching attachment with specific style.
+* Feature: Paperclip default options can now be configured in Rails.configuration.
+* Feature: add Geometry#resize_to to calculate dimensions of new source.
+* Bug fix: Fixed a bug whereby a file type with multiple mime types but no official type would cause
+  the best_content_type to throw an error on trying nil.content_type.
+* Bug fix: Fix problem when the gem cannot be installed on the system that has Asepsis installed.
+
+New in 3.0.4:
+
+* Feature: Adds support for S3 scheme-less URL generation.
+
 New in 3.0.3:
 
 * Bug fix: ThumbnailProcessor now correctly detects and preserve animated GIF.

data/README.md

@@ -94,15 +94,13 @@ In your model:
 
 In your migrations:
 
-    class AddAvatarColumnsToUser < ActiveRecord::Migration
+    class AddAvatarColumnsToUsers < ActiveRecord::Migration
       def self.up
-        change_table :users do |t|
-          t.has_attached_file :avatar
-        end
+        add_attachment :users, :avatar
       end
 
       def self.down
-        drop_attached_file :users, :avatar
+        remove_attachment :users, :avatar
       end
     end
 
@@ -180,6 +178,84 @@ Lastly, you can also define multiple validations on a single attachment using `v
       :content_type => { :content_type => "image/jpg" },
       :size => { :in => 0..10.kilobytes }
 
+Defaults
+--------
+Global defaults for all your paperclip attachments can be defined by changing the Paperclip::Attachment.default_options Hash, this can be useful for setting your default storage settings per example so you won't have to define them in every has_attached_file definition.
+
+If you're using Rails you can define a Hash with default options in config/application.rb or in any of the config/environments/*.rb files on config.paperclip_defaults, these well get merged into Paperclip::Attachment.default_options as your Rails app boots. An example:
+
+```ruby
+module YourApp
+  class Application < Rails::Application
+    # Other code...
+
+    config.paperclip_defaults = {:storage => :fog, :fog_credentials => {:provider => "Local", :local_root => "#{Rails.root}/public"}, :fog_directory => "", :fog_host => "localhost"}
+  end
+end
+```
+
+Another option is to directly modify the Paperclip::Attachment.default_options Hash, this method works for non-Rails applications or is an option if you prefer to place the Paperclip default settings in an initializer.
+
+An example Rails initializer would look something like this:
+
+```ruby
+Paperclip::Attachment.default_options[:storage] = :fog
+Paperclip::Attachment.default_options[:fog_credentials] = {:provider => "Local", :local_root => "#{Rails.root}/public"}
+Paperclip::Attachment.default_options[:fog_directory] = ""
+Paperclip::Attachment.default_options[:fog_host] = "http://localhost:3000"}
+```
+
+Migrations
+----------
+
+Paperclip defines several migration methods which can be used to create necessary columns in your
+model. There are two types of method:
+
+### Table Definition
+
+    class AddAttachmentToUsers < ActiveRecord::Migration
+      def self.up
+        create_table :users do |t|
+          t.attachment :avatar
+        end
+      end
+    end
+
+If you're using Rails 3.2 or newer, this method works in `change` method as well:
+
+    class AddAttachmentToUsers < ActiveRecord::Migration
+      def change
+        create_table :users do |t|
+          t.attachment :avatar
+        end
+      end
+    end
+
+### Schema Definition
+
+    class AddAttachmentToUsers < ActiveRecord::Migration
+      def self.up
+        add_attachment :users, :avatar
+      end
+
+      def self.down
+        remove_attachment :users, :avatar
+      end
+    end
+
+If you're using Rails 3.2 or newer, you only need `add_attachment` in your `change` method:
+
+    class AddAttachmentToUsers < ActiveRecord::Migration
+      def change
+        add_attachment :users, :avatar
+      end
+    end
+
+### Vintage syntax
+
+Vintage syntax (such as `t.has_attached_file` and `drop_attaached_file`) are still supported in
+Paperclip 3.x, but you're advised to update those migration files to use this new syntax.
+
 Storage
 -------
 

data/features/basic_integration.feature

@@ -8,12 +8,30 @@ Feature: Rails integration
     And I update my new user view to include the file upload field
     And I update my user view to include the attachment
 
+  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"}
+      """
+    Given I add this snippet to the User model:
+      """
+      attr_accessible :name, :attachment
+      has_attached_file :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 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 add this snippet to the User model:
       """
       attr_accessible :name, :attachment
-      has_attached_file :attachment, :url => "/system/:attachment/:style/:filename",
-                                     :styles => { :square => "100x100#" }
+      has_attached_file :attachment, :url => "/system/:attachment/:style/:filename"
       """
     And I start the rails application
     When I go to the new user page

data/features/migration.feature

@@ -0,0 +1,94 @@
+Feature: Migration
+
+  Background:
+    Given I generate a new rails application
+    And I write to "app/models/user.rb" with:
+      """
+      class User < ActiveRecord::Base; end
+      """
+
+  Scenario: Vintage syntax
+    When I write to "db/migrate/01_add_attachment_to_users.rb" with:
+      """
+      class AddAttachmentToUsers < ActiveRecord::Migration
+        def self.up
+          create_table :users do |t|
+            t.has_attached_file :avatar
+          end
+        end
+
+        def self.down
+          drop_attached_file :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"
+
+  Scenario: New syntax with create_table
+    When I write to "db/migrate/01_add_attachment_to_users.rb" with:
+      """
+      class AddAttachmentToUsers < ActiveRecord::Migration
+        def self.up
+          create_table :users do |t|
+            t.attachment :avatar
+          end
+        end
+      end
+      """
+    And I run a migration
+    Then I should have attachment columns for "avatar"
+
+  Scenario: New syntax outside of create_table
+    When I write to "db/migrate/01_create_users.rb" with:
+      """
+      class CreateUsers < ActiveRecord::Migration
+        def self.up
+          create_table :users
+        end
+      end
+      """
+    And I write to "db/migrate/02_add_attachment_to_users.rb" with:
+      """
+      class AddAttachmentToUsers < ActiveRecord::Migration
+        def self.up
+          add_attachment :users, :avatar
+        end
+
+        def self.down
+          remove_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"
+
+  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

@@ -72,3 +72,31 @@ Then /^the attachment file "([^"]*)" should (not )?exist$/ do |filename, not_exi
     check_file_presence([attachment_path(filename)], !not_exist)
   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)
+    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
+  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)
+    expect_columns = [
+      ["#{attachment_name}_file_name", :string],
+      ["#{attachment_name}_content_type", :string],
+      ["#{attachment_name}_file_size", :integer],
+      ["#{attachment_name}_updated_at", :datetime]
+    ]
+
+    expect_columns.none?{ |column| columns.include? column }.should be_true
+  end
+end

data/features/step_definitions/rails_steps.rb

@@ -29,7 +29,11 @@ Given /^I run a paperclip generator to add a paperclip "([^"]*)" to the "([^"]*)
 end
 
 Given /^I run a migration$/ do
-  step %[I successfully run `bundle exec rake db:migrate`]
+  step %[I successfully run `bundle exec rake db:migrate --trace`]
+end
+
+When /^I rollback a migration$/ do
+  step %[I successfully run `bundle exec rake db:rollback STEPS=1 --trace`]
 end
 
 Given /^I update my new user view to include the file upload field$/ do
@@ -65,6 +69,14 @@ Given /^I add this snippet to the User model:$/ do |snippet|
   end
 end
 
+Given /^I add this snippet to config\/application.rb:$/ do |snippet|
+  file_name = "config/application.rb"
+  in_current_dir 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
     require "./config/environment"
@@ -118,3 +130,9 @@ end
 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

data/features/step_definitions/web_steps.rb

@@ -181,7 +181,7 @@ Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label
     end
   end
 end
- 
+
 Then /^(?:|I )should be on (.+)$/ do |page_name|
   current_path = URI.parse(current_url).path
   if current_path.respond_to? :should
@@ -195,8 +195,8 @@ 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(',')} 
-  
+  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

data/gemfiles/3.0.gemfile

@@ -5,7 +5,7 @@ source "http://rubygems.org"
 gem "jruby-openssl", :platform=>:jruby
 gem "activerecord-jdbcsqlite3-adapter", :platform=>:jruby
 gem "sqlite3", :platform=>:ruby
-gem "rails", "~> 3.0.12"
+gem "rails", "~> 3.0.15"
 gem "paperclip", :path=>"../"
 
 gemspec :path=>"../"

data/gemfiles/3.1.gemfile

@@ -5,7 +5,7 @@ source "http://rubygems.org"
 gem "jruby-openssl", :platform=>:jruby
 gem "activerecord-jdbcsqlite3-adapter", :platform=>:jruby
 gem "sqlite3", :platform=>:ruby
-gem "rails", "~> 3.1.4"
+gem "rails", "~> 3.1.6"
 gem "paperclip", :path=>"../"
 
 gemspec :path=>"../"

data/gemfiles/3.2.gemfile

@@ -5,7 +5,7 @@ source "http://rubygems.org"
 gem "jruby-openssl", :platform=>:jruby
 gem "activerecord-jdbcsqlite3-adapter", :platform=>:jruby
 gem "sqlite3", :platform=>:ruby
-gem "rails", "~> 3.2.3"
+gem "rails", "~> 3.2.6"
 gem "paperclip", :path=>"../"
 
 gemspec :path=>"../"

data/lib/generators/paperclip/templates/paperclip_migration.rb.erb

@@ -1,19 +1,15 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def self.up
+    change_table :<%= table_name %> do |t|
 <% attachment_names.each do |attachment| -%>
-    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_name, :string
-    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_content_type, :string
-    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_size, :integer
-    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at, :datetime
+      t.has_attached_file :<%= attachment %>
 <% end -%>
+    end
   end
 
   def self.down
 <% attachment_names.each do |attachment| -%>
-    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_name
-    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_content_type
-    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_size
-    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at
+    drop_attached_file :<%= table_name %>, :<%= attachment %>
 <% end -%>
   end
 end

data/lib/paperclip.rb

@@ -34,6 +34,7 @@ require 'paperclip/processor'
 require 'paperclip/tempfile'
 require 'paperclip/thumbnail'
 require 'paperclip/interpolations'
+require 'paperclip/tempfile_factory'
 require 'paperclip/style'
 require 'paperclip/attachment'
 require 'paperclip/attachment_options'
@@ -214,6 +215,7 @@ end
 
 # This stuff needs to be run after Paperclip is defined.
 require 'paperclip/io_adapters/registry'
+require 'paperclip/io_adapters/abstract_adapter'
 require 'paperclip/io_adapters/identity_adapter'
 require 'paperclip/io_adapters/file_adapter'
 require 'paperclip/io_adapters/stringio_adapter'