twm_paperclip 2.3.6 → 2.3.8t

data/{README.rdoc → README.md}

@@ -1,4 +1,24 @@
-=Paperclip
+=TWM Paperclip
+
+The TWM Paperclip branch is intended to make life using the S3 storage engine
+easier.
+
+In attempting to use it on one of my personal projects, I found two showstopper
+issues that I had to get around:
+
+  1. When storing JPG thumbnails of PDF documents, the JPGs were uploaded to
+     S3 with the mime_type "application/pdf", which breaks behaviour in many
+     browsers and is semantically incorrect.
+
+  2. When these PDFs were protected documents (stored with S3 under a secure
+     URL), I needed the thumbnails to be uploaded to S3 as publicly accessible
+
+This patch is not elegant, and should not be contributed as it is to Paperclip
+core. However it does illustrate some key use-cases that should be considered
+for core Paperclip.
+
+Paperclip
+=========
 
 Paperclip is intended as an easy file attachment library for ActiveRecord. The
 intent behind it was to keep setup as easy as possible and to treat files as
@@ -12,64 +32,77 @@ 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 for
 more detailed options.
 
-The complete RDoc[http://rdoc.info/projects/thoughtbot/paperclip] is online.
+The complete [RDoc](http://rdoc.info/gems/paperclip) is online.
 
-==Quick Start
+Installation
+------------
 
-In your model:
+Include the gem in your Gemfile:
 
-  class User < ActiveRecord::Base
-    has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
-  end
+    gem "paperclip", "~> 2.3"
 
-In your migrations:
+Or as a plugin:
+
+  ruby script/plugin install git://github.com/thoughtbot/paperclip.git
+
+Quick Start
+-----------
+
+In your model:
 
-  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
+    class User < ActiveRecord::Base
+      has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
     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
+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
+      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
+      end
     end
-  end
 
 In your edit and new views:
 
-  <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
-    <%= form.file_field :avatar %>
-  <% end %>
+    <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
+      <%= form.file_field :avatar %>
+    <% end %>
 
 In your controller:
 
-  def create
-    @user = User.create( params[:user] )
-  end
+    def create
+      @user = User.create( params[:user] )
+    end
 
 In your show view:
 
-  <%= image_tag @user.avatar.url %>
-  <%= image_tag @user.avatar.url(:medium) %>
-  <%= image_tag @user.avatar.url(:thumb) %>
+    <%= image_tag @user.avatar.url %>
+    <%= image_tag @user.avatar.url(:medium) %>
+    <%= image_tag @user.avatar.url(:thumb) %>
 
-==Usage
+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,
 so you can have multiple attachments per model if you wish) and give the 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
+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.
 
@@ -77,7 +110,8 @@ Attachments can be validated with Paperclip's validation methods,
 validates_attachment_presence, validates_attachment_content_type, and
 validates_attachment_size.
 
-==Storage
+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
@@ -87,10 +121,10 @@ 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
+    /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
-safer choice for the default file store.
+_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
@@ -103,7 +137,8 @@ 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
+Post Processing
+---------------
 
 Paperclip supports an extensible selection of post-processors. When you define
 a set of styles for an attachment, by default it is expected that those
@@ -114,8 +149,8 @@ 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:
 
-  has_attached_file :scan, :styles => { :text => { :quality => :better } },
-                           :processors => [:ocr]
+    has_attached_file :scan, :styles => { :text => { :quality => :better } },
+                             :processors => [:ocr]
 
 This would load the hypothetical class Paperclip::Ocr, which would have the
 hash "{ :quality => :better }" passed to it along with the uploaded file. For
@@ -125,7 +160,7 @@ The default processor is Paperclip::Thumbnail. For backwards compatability
 reasons, you can pass a single geometry string or an array containing a
 geometry and a format, which the file will be converted to, like so:
 
-  has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
+    has_attached_file :avatar, :styles => { :thumb => ["32x32#", :png] }
 
 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.
@@ -137,39 +172,42 @@ be given the result of the previous processor's execution. All processors will
 receive the same parameters, which are what you define in the :styles hash.
 For example, assuming we had this definition:
 
-  has_attached_file :scan, :styles => { :text => { :quality => :better } },
-                           :processors => [:rotator, :ocr]
+    has_attached_file :scan, :styles => { :text => { :quality => :better } },
+                             :processors => [:rotator, :ocr]
 
 then both the :rotator processor and the :ocr processor would receive the
 options "{ :quality => :better }". This parameter may not mean anything to one
 or more or the processors, and they are expected to ignore it.
 
-NOTE: Because processors operate by turning the original attachment into the
-styles, no processors will be run if there are no styles defined.
+_NOTE: Because processors operate by turning the original attachment into the
+styles, no processors will be run if there are no styles defined._
 
-==Events
+Events
+------
 
 Before and after the Post Processing step, Paperclip calls back to the model
 with a few callbacks, allowing the model to change or cancel the processing
-step. The callbacks are "before_post_process" and "after_post_process" (which
+step. The callbacks are `before_post_process` and `after_post_process` (which
 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
+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
 can access the model and the attachment if necessary.
 
-NOTE: Post processing will not even *start* if the attachment is not valid
+_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.
+called with valid attachments._
 
-==Testing
+Testing
+-------
 
 Paperclip provides rspec-compatible matchers for testing attachments. See the
 documentation on Paperclip::Shoulda::Matchers for more information.
 
-==Contributing
+Contributing
+------------
 
 If you'd like to contribute a feature or bugfix: Thanks! To make sure your
 fix/feature has a high chance of being included, please read the following
@@ -180,3 +218,19 @@ guidelines:
 2. Make sure there are tests! We will not accept any patch that is not tested.
    It's a rare time when explicit tests aren't needed. If you have questions
    about writing tests for paperclip, please ask the mailing list.
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+Paperclip is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+
+Thank you to all [the contributors](https://github.com/thoughtbot/paperclip/contributors)!
+
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+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/lib/paperclip/attachment.rb

@@ -235,6 +235,9 @@ module Paperclip
       else
         true
       end
+    rescue Errno::EACCES => e
+      warn "#{e} - skipping file"
+      false
     end
 
     # Returns true if a file has been assigned.

data/lib/paperclip/storage/s3.rb

@@ -94,8 +94,8 @@ module Paperclip
         end
       end
 
-      def expiring_url(time = 3600)
-        AWS::S3::S3Object.url_for(path, bucket_name, :expires_in => time )
+      def expiring_url(time = 3600, style = default_style)
+        AWS::S3::S3Object.url_for(path(style), bucket_name, :expires_in => time )
       end
 
       def bucket_name
@@ -147,21 +147,28 @@ module Paperclip
             log("saving #{path(style)}")
             # Nasty hack, thumbnails for PDFs generated in jpg/png/gif are NOT the content_type of the original file!
             # Override the content_type based on these extensions.
-            content_type = case(file.path)
-              when /.jpg$/
-                "image/jpeg"
-              when /.png$/
-                "image/png"
-              when /.gif$/
-                "image/gif"
-              else
-                instance_read(:content_type)
+            access = @s3_permissions
+            unless style == :default_style
+              content_type = case(file.path)
+                when /.jpg$/
+                  "image/jpeg"
+                  access = :public_read
+                when /.png$/
+                  "image/png"
+                  access = :public_read
+                when /.gif$/
+                  "image/gif"
+                  access = :public_read
+                else
+                  instance_read(:content_type)
+              end
             end
             AWS::S3::S3Object.store(path(style),
                                     file,
                                     bucket_name,
-                                    {:content_type => content_type,#instance_read(:content_type),
-                                     :access => @s3_permissions,
+                                    {
+                                      :content_type => content_type,#instance_read(:content_type),
+                                      :access => access,
                                     }.merge(@s3_headers))
           rescue AWS::S3::NoSuchBucket => e
             create_bucket

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module Paperclip
-  VERSION = "2.3.6" unless defined? Paperclip::VERSION
+  VERSION = "2.3.8t" unless defined? Paperclip::VERSION
 end

data/lib/paperclip.rb

@@ -113,6 +113,12 @@ module Paperclip
       processor
     end
 
+    def each_instance_with_attachment(klass, name)
+      Object.const_get(klass).all.each do |instance|
+        yield(instance) if instance.send(:"#{name}?")
+      end
+    end
+
     # Log a paperclip-specific line. Uses ActiveRecord::Base.logger
     # by default. Set Paperclip.options[:log] to false to turn off.
     def log message

data/lib/tasks/paperclip.rake

@@ -1,38 +1,20 @@
 def obtain_class
   class_name = ENV['CLASS'] || ENV['class']
   raise "Must specify CLASS" unless class_name
-  @klass = Object.const_get(class_name)
+  class_name
 end
 
-def obtain_attachments
+def obtain_attachments(klass)
+  klass = Object.const_get(klass.to_s)
   name = ENV['ATTACHMENT'] || ENV['attachment']
-  raise "Class #{@klass.name} has no attachments specified" unless @klass.respond_to?(:attachment_definitions)
-  if !name.blank? && @klass.attachment_definitions.keys.include?(name)
+  raise "Class #{klass.name} has no attachments specified" unless klass.respond_to?(:attachment_definitions)
+  if !name.blank? && klass.attachment_definitions.keys.include?(name)
     [ name ]
   else
-    @klass.attachment_definitions.keys
+    klass.attachment_definitions.keys
   end
 end
 
-def for_all_attachments
-  klass = obtain_class
-  names = obtain_attachments
-  ids   = klass.connection.select_values(klass.send(:construct_finder_sql, :select => 'id'))
-
-  ids.each do |id|
-    instance = klass.find(id)
-    names.each do |name|
-      result = if instance.send("#{ name }?")
-                 yield(instance, name)
-               else
-                 true
-               end
-      print result ? "." : "x"; $stdout.flush
-    end
-  end
-  puts " Done."
-end
-
 namespace :paperclip do
   desc "Refreshes both metadata and thumbnails."
   task :refresh => ["paperclip:refresh:metadata", "paperclip:refresh:thumbnails"]
@@ -41,24 +23,31 @@ namespace :paperclip do
     desc "Regenerates thumbnails for a given CLASS (and optional ATTACHMENT)."
     task :thumbnails => :environment do
       errors = []
-      for_all_attachments do |instance, name|
-        result = instance.send(name).reprocess!
-        errors << [instance.id, instance.errors] unless instance.errors.blank?
-        result
+      klass = obtain_class
+      names = obtain_attachments(klass)
+      names.each do |name|
+        Paperclip.each_instance_with_attachment(klass, name) do |instance|
+          result = instance.send(name).reprocess!
+          errors << [instance.id, instance.errors] unless instance.errors.blank?
+        end
       end
       errors.each{|e| puts "#{e.first}: #{e.last.full_messages.inspect}" }
     end
 
     desc "Regenerates content_type/size metadata for a given CLASS (and optional ATTACHMENT)."
     task :metadata => :environment do
-      for_all_attachments do |instance, name|
-        if file = instance.send(name).to_file
-          instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
-          instance.send("#{name}_content_type=", file.content_type.strip)
-          instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
-          instance.save(false)
-        else
-          true
+      klass = obtain_class
+      names = obtain_attachments(klass)
+      names.each do |name|
+        Paperclip.each_instance_with_attachment(klass, name) do |instance|
+          if file = instance.send(name).to_file
+            instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
+            instance.send("#{name}_content_type=", file.content_type.strip)
+            instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
+            instance.save(false)
+          else
+            true
+          end
         end
       end
     end
@@ -66,13 +55,17 @@ namespace :paperclip do
 
   desc "Cleans out invalid attachments. Useful after you've added new validations."
   task :clean => :environment do
-    for_all_attachments do |instance, name|
-      instance.send(name).send(:validate)
-      if instance.send(name).valid?
-        true
-      else
-        instance.send("#{name}=", nil)
-        instance.save
+    klass = obtain_class
+    names = obtain_attachments(klass)
+    names.each do |name|
+      Paperclip.each_instance_with_attachment(klass, name) do |instance|
+        instance.send(name).send(:validate)
+        if instance.send(name).valid?
+          true
+        else
+          instance.send("#{name}=", nil)
+          instance.save
+        end
       end
     end
   end

data/test/integration_test.rb

@@ -34,6 +34,22 @@ class IntegrationTest < Test::Unit::TestCase
     should "create its thumbnails properly" do
       assert_match /\b50x50\b/, `identify "#{@dummy.avatar.path(:thumb)}"`
     end
+    
+    context 'reprocessing with unreadable original' do
+      setup { File.chmod(0000, @dummy.avatar.path) }
+      
+      should "not raise an error" do
+        assert_nothing_raised do
+          @dummy.avatar.reprocess!
+        end
+      end
+      
+      should "return false" do
+        assert ! @dummy.avatar.reprocess!
+      end
+      
+      teardown { File.chmod(0644, @dummy.avatar.path) }
+    end
 
     context "redefining its attachment styles" do
       setup do

data/test/paperclip_test.rb

@@ -43,6 +43,23 @@ class PaperclipTest < Test::Unit::TestCase
     end
   end
 
+  context "Paperclip.each_instance_with_attachment" do
+    setup do
+      @file = File.new(File.join(FIXTURES_DIR, "5k.png"), 'rb')
+      d1 = Dummy.create(:avatar => @file)
+      d2 = Dummy.create
+      d3 = Dummy.create(:avatar => @file)
+      @expected = [d1, d3]
+    end
+    should "yield every instance of a model that has an attachment" do
+      actual = []
+      Paperclip.each_instance_with_attachment("Dummy", "avatar") do |instance|
+        actual << instance
+      end
+      assert_same_elements @expected, actual
+    end
+  end
+
   should "raise when sent #processor and the name of a class that exists but isn't a subclass of Processor" do
     assert_raises(Paperclip::PaperclipError){ Paperclip.processor(:attachment) }
   end

data/test/storage_test.rb

@@ -7,6 +7,29 @@ class StorageTest < Test::Unit::TestCase
       Object.const_set(:Rails, stub('Rails', :env => env))
     end
   end
+  
+  context "filesystem" do
+    setup do
+      rebuild_model :styles => { :thumbnail => "25x25#" }
+      @dummy = Dummy.create!
+
+      @dummy.avatar = File.open(File.join(File.dirname(__FILE__), "fixtures", "5k.png"))
+    end
+    
+    should "allow file assignment" do
+      assert @dummy.save
+    end
+    
+    should "store the original" do
+      @dummy.save
+      assert File.exists?(@dummy.avatar.path)
+    end
+    
+    should "store the thumbnail" do
+      @dummy.save
+      assert File.exists?(@dummy.avatar.path(:thumbnail))
+    end
+  end
 
   context "Parsing S3 credentials" do
     setup do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: twm_paperclip
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
+  hash: 3788463
+  prerelease: true
   segments: 
   - 2
   - 3
-  - 6
-  version: 2.3.6
+  - 8t
+  version: 2.3.8t
 platform: ruby
 authors: 
 - Jon Yurek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 -05:00
+date: 2011-02-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -123,9 +123,9 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
-- README.rdoc
+- README.md
 - LICENSE
 - Rakefile
 - init.rb
@@ -206,12 +206,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: 
 - ImageMagick
 rubyforge_project: paperclip