paperclip 2.4.5 → 2.5.0

data/.gitignore

@@ -0,0 +1,22 @@
+*~
+*.swp
+.rvmrc
+.bundle
+tmp
+
+test/s3.yml
+test/debug.log
+test/paperclip.db
+test/doc
+test/pkg
+test/tmp
+
+public
+paperclip*.gem
+capybara*.html
+
+*.rbc
+.rbx
+
+*SPIKE*
+*emfile.lock

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - rbx-2.0
+
+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

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "rails2" do
+  gem "rails", "~> 2.3.14"
+  gem "paperclip", :path => "../"
+end
+
+appraise "rails3" do
+  gem "rails", "~> 3.0.10"
+  gem "paperclip", :path => "../"
+end
+
+appraise "rails3_1" do
+  gem "rails", "~> 3.1.0"
+  gem "paperclip", :path => "../"
+end

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "jruby-openssl", :platform => :jruby

data/NEWS

@@ -0,0 +1,23 @@
+New in 2.5.0:
+
+* Performance: Only connect to S3 when absolutely needed.
+* Bug fix: STI with cached classes respect new options.
+* Bug fix: conditional validations broke, and now work again.
+* Feature: URL generation is now parameterized and can be changed with plugins or custom code.
+* Feature: :convert_options and :source_file_options to control the ImageMagick processing.
+* Performance: String geometry specifications now parse more quickly.
+* Bug fix: Handle files with question marks in the filename.
+* Bug fix: Don't raise an error when generating an expiring URL on an unassigned attachment.
+* Bug fix: The rake task runs over all instances of an ActiveRecord model, ignoring default scopes.
+* Feature: DB migration has_attached_file and drop_attached_file methods.
+* Bug fix: Switch from AWS::S3 to AWS::SDK for the S3 backend.
+* Bug fix: URL generator uses '?' in the URL unless it already appears and there is no prior '='.
+* Bug fix: Always convert the content type to a string before stripping blanks.
+* Feature: The :keep_old_files option preserves the files in storage even when the attachment is cleared or changed.
+* Performance: Optimize Fog's public_url access by avoiding it when possible.
+* Bug fix: Avoid a runtime error when generating the ID partition for an unsaved attachment.
+* Performance: Do not calculate the fingerprint if it is never persisted.
+* Bug fix: Process the :original style before all others, in case of a dependency.
+* Feature: S3 headers can be set at runtime by passing a proc object as the value.
+* Bug fix: Generating missing attachment styles for a model which has had its attachment changed should not raise.
+* Bug fix: Do not collide with the built-in Ruby hashing method.

data/README.md

@@ -1,6 +1,9 @@
-# Paperclip [![Build Status](https://secure.travis-ci.org/thoughtbot/paperclip.png?branch=master)](http://travis-ci.org/thoughtbot/paperclip)
+Paperclip
+=========
 
-Paperclip is intended as an easy file attachment library for ActiveRecord. The
+[![Build Status](https://secure.travis-ci.org/thoughtbot/paperclip.png?branch=master)](http://travis-ci.org/thoughtbot/paperclip) [![Dependency Status](https://gemnasium.com/thoughtbot/paperclip.png?travis)](https://gemnasium.com/thoughtbot/paperclip)
+
+Paperclip is intended as an easy file attachment library for Active Record. The
 intent behind it was to keep setup as easy as possible and to treat files as
 much like other attributes as possible. This means they aren't saved to their
 final locations on disk, nor are they deleted if set to nil, until
@@ -12,11 +15,12 @@ packages). Attached files are saved to the filesystem and referenced in the
 browser by an easily understandable specification, which has sensible and
 useful defaults.
 
-See the documentation for `has_attached_file` in Paperclip::ClassMethods for
+See the documentation for `has_attached_file` in [`Paperclip::ClassMethods`](http://rubydoc.info/gems/paperclip/Paperclip/ClassMethods) for
 more detailed options.
 
 The complete [RDoc](http://rdoc.info/gems/paperclip) is online.
 
+
 Requirements
 ------------
 
@@ -32,14 +36,16 @@ In development mode, you might add this line to `config/environments/development
 
     Paperclip.options[:command_path] = "/usr/local/bin/"
 
-If you're on Mac OSX, you'll want to run the following with Homebrew:
+If you're on Mac OS X, you'll want to run the following with Homebrew:
 
     brew install imagemagick
 
-If you are dealing with pdf uploads or running the test suite, also run:
+If you are dealing with pdf uploads or running the test suite, you'll also need
+GhostScript to be installed. On Mac OS X, you can also install that using Homebrew:
 
     brew install gs
 
+
 Installation
 ------------
 
@@ -49,9 +55,18 @@ well with gems.
 
 Include the gem in your Gemfile:
 
-    gem "paperclip", "~> 2.4"
+    gem "paperclip", "~> 2.0"
+
+Or, if you want to get the latest, you can get master from the main paperclip repository:
 
-Or, if you don't use Bundler (though you probably should, even in Rails 2), with config.gem
+    gem "paperclip", :git => "git://github.com/thoughtbot/paperclip.git"
+    
+If you're trying to use features that don't seem to be in the latest released gem, but are
+mentioned in this README, then you probably need to specify the master branch if you want to
+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
     ...
@@ -60,6 +75,7 @@ Or, if you don't use Bundler (though you probably should, even in Rails 2), with
       config.gem "paperclip", :version => "~> 2.4"
       ...
     end
+    
 For Non-Rails usage:
 
     class ModuleName < ActiveRecord::Base
@@ -80,17 +96,13 @@ In your migrations:
 
     class AddAvatarColumnsToUser < ActiveRecord::Migration
       def self.up
-        add_column :users, :avatar_file_name,    :string
-        add_column :users, :avatar_content_type, :string
-        add_column :users, :avatar_file_size,    :integer
-        add_column :users, :avatar_updated_at,   :datetime
+        change_table :users do |t|
+          t.has_attached_file :avatar
+        end
       end
 
       def self.down
-        remove_column :users, :avatar_file_name
-        remove_column :users, :avatar_content_type
-        remove_column :users, :avatar_file_size
-        remove_column :users, :avatar_updated_at
+        drop_attached_file :users, :avatar
       end
     end
 
@@ -121,44 +133,60 @@ Usage
 -----
 
 The basics of paperclip are quite simple: Declare that your model has an
-attachment with the has_attached_file method, and give it a name. Paperclip
-will wrap up up to four attributes (all prefixed with that attachment's name,
+attachment with the `has_attached_file` method, and give it a name.
+
+Paperclip will wrap up up to four attributes (all prefixed with that attachment's name,
 so you can have multiple attachments per model if you wish) and give them a
-friendly front end. The attributes are `<attachment>_file_name`,
-`<attachment>_file_size`, `<attachment>_content_type`, and `<attachment>_updated_at`.
-Only `<attachment>_file_name` is required for paperclip to operate. More
-information about the options to has_attached_file is available in the
-documentation of Paperclip::ClassMethods.
+friendly front end. These attributes are:
+
+* `<attachment>_file_name`
+* `<attachment>_file_size`
+* `<attachment>_content_type`
+* `<attachment>_updated_at`
 
-Attachments can be validated with Paperclip's validation methods,
-validates_attachment_presence, validates_attachment_content_type, and
-validates_attachment_size.
+By default, only `<attachment>_file_name` is required for paperclip to operate.
+You'll need to add `<attachment>_content_type` in case you want to use content type
+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:
+
+* `validates_attachment_presence`
+* `validates_attachment_content_type`
+* `validates_attachment_size`
 
 Storage
 -------
 
 The files that are assigned as attachments are, by default, placed in the
-directory specified by the :path option to has_attached_file. By default, this
-location is ":rails_root/public/system/:attachment/:id/:style/:filename". This
+directory specified by the `:path` option to `has_attached_file`. By default, this
+location is `:rails_root/public/system/:attachment/:id/:style/:filename`. This
 location was chosen because on standard Capistrano deployments, the
-public/system directory is symlinked to the app's shared directory, meaning it
-will survive between deployments. For example, using that :path, you may have a
+`public/system` directory is symlinked to the app's shared directory, meaning it
+will survive between deployments. For example, using that `:path`, you may have a
 file at
 
     /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
 
-_NOTE: This is a change from previous versions of Paperclip, but is overall a
+_**NOTE**: This is a change from previous versions of Paperclip, but is overall a
 safer choice for the default file store._
 
-You may also choose to store your files using Amazon's S3 service. You can find
-more information about S3 storage at the description for
-Paperclip::Storage::S3.
+You may also choose to store your files using Amazon's S3 service. To do so, include
+the `aws-sdk` gem in your Gemfile:
+
+    gem 'aws-sdk'
+
+And then you can specify using S3 from `has_attached_file`. 
+You can find more information about configuring and using S3 storage in
+[the `Paperclip::Storage::S3` documentation](http://rubydoc.info/gems/paperclip/Paperclip/Storage/S3).
 
 Files on the local filesystem (and in the Rails app's public directory) will be
 available to the internet at large. If you require access control, it's
 possible to place your files in a different location. You will need to change
-both the :path and :url options in order to make sure the files are unavailable
-to the public. Both :path and :url allow the same set of interpolated
+both the `:path` and `:url` options in order to make sure the files are unavailable
+to the public. Both `:path` and `:url` allow the same set of interpolated
 variables.
 
 Post Processing
@@ -169,11 +197,11 @@ a set of styles for an attachment, by default it is expected that those
 "styles" are actually "thumbnails". However, you can do much more than just
 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
+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
@@ -188,7 +216,8 @@ geometry and a format, which the file will be converted to, like so:
 
 This will convert the "thumb" style to a 32x32 square in png format, regardless
 of what was uploaded. If the format is not specified, it is kept the same (i.e.
-jpgs will remain jpgs).
+jpgs will remain jpgs). For more information on the accepted style formats, see
+[http://www.imagemagick.org/script/command-line-processing.php#geometry](here).
 
 Multiple processors can be specified, and they will be invoked in the order
 they are defined in the :processors array. Each successive processor will
@@ -222,8 +251,8 @@ 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
@@ -349,7 +378,7 @@ Now you don't have to remember to refresh thumbnails in production everytime you
 Unfortunately it does not work with dynamic styles - it just ignores them.
 
 If you already have working app and don't want `rake paperclip:refresh:missing_styles` to refresh old pictures, you need to tell
-Paperclip about existing styles. Simply create paperclip_attachments.yml file by hand. For example:
+Paperclip about existing styles. Simply create paperclip\_attachments.yml file by hand. For example:
 
     class User < ActiveRecord::Base
       has_attached_file :avatar, :styles => {:thumb => 'x100', :croppable => '600x600>', :big => '1000x1000>'}
@@ -412,3 +441,4 @@ 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

@@ -1,15 +1,8 @@
-require 'rubygems'
-require 'bundler/setup'
+require 'bundler/gem_tasks'
 require 'appraisal'
-
-require 'rake'
 require 'rake/testtask'
-require 'rdoc/task'
 require 'cucumber/rake/task'
 
-$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
-require 'paperclip'
-
 desc 'Default: run unit tests.'
 task :default => [:clean, 'appraisal:install', :all]
 
@@ -36,20 +29,6 @@ task :shell do |t|
   exec 'irb -I lib/ -I lib/paperclip -r rubygems -r active_record -r tempfile -r init'
 end
 
-desc 'Generate documentation for the paperclip plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = 'Paperclip'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-desc 'Update documentation on website'
-task :sync_docs => 'rdoc' do
-  `rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/paperclip`
-end
-
 desc 'Clean up files.'
 task :clean do |t|
   FileUtils.rm_rf "doc"
@@ -60,27 +39,3 @@ task :clean do |t|
   FileUtils.rm "test/paperclip.db" rescue nil
   Dir.glob("paperclip-*.gem").each{|f| FileUtils.rm f }
 end
-
-desc 'Build the gemspec.'
-task :gemspec do |t|
-  exec 'gem build paperclip.gemspec'
-end
-
-desc "Print a list of the files to be put into the gem"
-task :manifest => :clean do
-  spec.files.each do |file|
-    puts file
-  end
-end
-
-desc "Generate a gemspec file for GitHub"
-task :gemspec => :clean do
-  File.open("#{spec.name}.gemspec", 'w') do |f|
-    f.write spec.to_ruby
-  end
-end
-
-desc "Build the gem into the current directory"
-task :gem => :gemspec do
-  `gem build #{spec.name}.gemspec`
-end

data/cucumber/paperclip_steps.rb

@@ -0,0 +1,6 @@
+When /^I attach an? "([^\"]*)" "([^\"]*)" file to an? "([^\"]*)" on S3$/ do |attachment, extension, model|
+  stub_paperclip_s3(model, attachment, extension)
+  attach_file attachment,
+              "features/support/paperclip/#{model.gsub(" ", "_").underscore}/#{attachment}.#{extension}"
+end
+

data/features/basic_integration.feature

@@ -0,0 +1,46 @@
+Feature: Rails integration
+
+  Background:
+    Given I generate a new rails application
+    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 update my new user view to include the file upload field
+    And I update my user view to include the attachment
+
+  Scenario: Filesystem integration test
+    Given I add this snippet to the User model:
+      """
+      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 "/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"
+
+  Scenario: S3 Integration test
+    Given I add this snippet to the User model:
+      """
+      has_attached_file :attachment,
+                        :storage => :s3,
+                        :path => "/:attachment/:id/:style/:filename",
+                        :s3_credentials => Rails.root.join("config/s3.yml")
+      """
+    And I write to "config/s3.yml" with:
+      """
+      bucket: paperclip
+      access_key_id: access_key
+      secret_access_key: secret_key
+      """
+    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 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