paperclip 2.2.3 → 2.2.4

data/lib/paperclip.rb

@@ -43,7 +43,7 @@ end
 # documentation for Paperclip::ClassMethods for more useful information.
 module Paperclip
 
-  VERSION = "2.2.3"
+  VERSION = "2.2.4"
 
   class << self
     # Provides configurability to Paperclip. There are a number of options available, such as:

data/lib/paperclip/attachment.rb

@@ -28,8 +28,11 @@ module Paperclip
       options = self.class.default_options.merge(options)
 
       @url               = options[:url]
+      @url               = @url.call(self) if @url.is_a?(Proc)
       @path              = options[:path]
+      @path              = @path.call(self) if @path.is_a?(Proc)
       @styles            = options[:styles]
+      @styles            = @styles.call(self) if @styles.is_a?(Proc)
       @default_url       = options[:default_url]
       @validations       = options[:validations]
       @default_style     = options[:default_style]
@@ -188,24 +191,31 @@ module Paperclip
     # necessary.
     def self.interpolations
       @interpolations ||= {
-        :rails_root   => lambda{|attachment,style| RAILS_ROOT },
-        :rails_env    => lambda{|attachment,style| RAILS_ENV },
-        :class        => lambda do |attachment,style|
-                           attachment.instance.class.name.underscore.pluralize
-                         end,
-        :basename     => lambda do |attachment,style|
-                           attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
-                         end,
-        :extension    => lambda do |attachment,style| 
-                           ((style = attachment.styles[style]) && style[:format]) ||
-                           File.extname(attachment.original_filename).gsub(/^\.+/, "")
-                         end,
-        :id           => lambda{|attachment,style| attachment.instance.id },
-        :id_partition => lambda do |attachment, style|
-                           ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
-                         end,
-        :attachment   => lambda{|attachment,style| attachment.name.to_s.downcase.pluralize },
-        :style        => lambda{|attachment,style| style || attachment.default_style },
+        :rails_root    => lambda{|attachment,style| RAILS_ROOT },
+        :rails_env     => lambda{|attachment,style| RAILS_ENV },
+        :class         => lambda do |attachment,style|
+                            attachment.instance.class.name.underscore.pluralize
+                          end,
+        :basename      => lambda do |attachment,style|
+                            attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
+                          end,
+        :extension     => lambda do |attachment,style| 
+                            ((style = attachment.styles[style]) && style[:format]) ||
+                            File.extname(attachment.original_filename).gsub(/^\.+/, "")
+                          end,
+        :id            => lambda{|attachment,style| attachment.instance.id },
+        :id_partition  => lambda do |attachment, style|
+                            ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
+                          end,
+        :attachment    => lambda{|attachment,style| attachment.name.to_s.downcase.pluralize },
+        :style         => lambda{|attachment,style| style || attachment.default_style },
+        :relative_root => lambda do |attachment,style| 
+                            if ActionController::AbstractRequest.respond_to?(:relative_url_root)
+                              ActionController::AbstractRequest.relative_url_root
+                            elsif ActionController::Base.respond_to?(:relative_url_root)
+                              ActionController::Base.relative_url_root
+                            end
+                          end
       }
     end
 
@@ -350,7 +360,7 @@ module Paperclip
           raise RuntimeError.new("Style #{name} has no processors defined.") if args[:processors].blank?
           @queued_for_write[name] = args[:processors].inject(@queued_for_write[:original]) do |file, processor|
             log("Processing #{name} #{file} in the #{processor} processor.")
-            Paperclip.processor(processor).make(file, args)
+            Paperclip.processor(processor).make(file, args, self)
           end
         rescue PaperclipError => e
           log("An error was received while processing: #{e.inspect}")
@@ -387,7 +397,7 @@ module Paperclip
 
     def flush_errors #:nodoc:
       @errors.each do |error, message|
-        instance.errors.add(name, message) if message
+        [message].flatten.each {|m| instance.errors.add(name, m) }
       end
     end
 

data/lib/paperclip/processor.rb

@@ -17,18 +17,19 @@ module Paperclip
   # See Paperclip.run for more information about using command-line
   # utilities from within Processors.
   class Processor
-    attr_accessor :file, :options
+    attr_accessor :file, :options, :attachment
 
-    def initialize file, options = {}
+    def initialize file, options = {}, attachment = nil
       @file = file
       @options = options
+      @attachment = attachment
     end
 
     def make
     end
 
-    def self.make file, options = {}
-      new(file, options).make
+    def self.make file, options = {}, attachment = nil
+      new(file, options, attachment).make
     end
   end
   

data/lib/paperclip/storage.rb

@@ -106,6 +106,8 @@ module Paperclip
     # * +bucket+: This is the name of the S3 bucket that will store your files. Remember
     #   that the bucket must be unique across all of Amazon S3. If the bucket does not exist
     #   Paperclip will attempt to create it. The bucket name will not be interpolated.
+    #   You can define the bucket as a Proc if you want to determine it's name at runtime.
+    #   Paperclip will call that Proc with attachment as the only argument.
     # * +url+: There are two options for the S3 url. You can choose to have the bucket's name
     #   placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
     #   Normally, this won't matter in the slightest and you can leave the default (which is
@@ -122,6 +124,7 @@ module Paperclip
         base.instance_eval do
           @s3_credentials = parse_credentials(@options[:s3_credentials])
           @bucket         = @options[:bucket]         || @s3_credentials[:bucket]
+          @bucket         = @bucket.call(self) if @bucket.is_a?(Proc)
           @s3_options     = @options[:s3_options]     || {}
           @s3_permissions = @options[:s3_permissions] || 'public-read'
           @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == 'public-read' ? 'http' : 'https')

data/lib/paperclip/thumbnail.rb

@@ -10,7 +10,7 @@ module Paperclip
     # unless specified. Thumbnail creation will raise no errors unless
     # +whiny+ is true (which it is, by default. If +convert_options+ is
     # set, the options will be appended to the convert command upon image conversion 
-    def initialize file, options = {}
+    def initialize file, options = {}, attachment = nil
       super
       geometry          = options[:geometry]
       @file             = file

data/test/attachment_test.rb

@@ -106,6 +106,36 @@ class AttachmentTest < Test::Unit::TestCase
     end
   end
 
+  context "An attachment with a :relative_root interpolation" do
+    setup do
+      rebuild_model :url => ":relative_root/:id.png"
+      @dummy = Dummy.new
+      @dummy.stubs(:id).returns(1024)
+      @dummy.avatar = StringIO.new(".")
+
+      ActionController::Base.stubs(:respond_to?).with(:relative_url_root).returns(false)
+      ActionController::Base.stubs(:relative_url_root).returns("/base")
+      ActionController::AbstractRequest.stubs(:respond_to?).with(:relative_url_root).returns(false)
+      ActionController::AbstractRequest.stubs(:relative_url_root).returns("/request")
+    end
+
+    should "return the proper path when the path is nil" do
+      assert_equal "/1024.png", @dummy.avatar.url(:original, false)
+    end
+
+    should "return the proper path when using Rails < 2.1" do
+      ActionController::AbstractRequest.expects(:respond_to?).with(:relative_url_root).returns(true)
+      ActionController::AbstractRequest.expects(:relative_url_root).returns("/request")
+      assert_equal "/request/1024.png", @dummy.avatar.url(:original, false)
+    end
+
+    should "return the proper path when using Rails >= 2.1" do
+      ActionController::Base.expects(:respond_to?).with(:relative_url_root).returns(true)
+      ActionController::Base.expects(:relative_url_root).returns("/base")
+      assert_equal "/base/1024.png", @dummy.avatar.url(:original, false)
+    end
+  end
+
   context "An attachment with :convert_options" do
     setup do
       rebuild_model :styles => {
@@ -165,6 +195,60 @@ class AttachmentTest < Test::Unit::TestCase
       Paperclip::Attachment.any_instance.expects(:extra_options_for).with(:large)
     end
   end
+  
+  context "An attachment with :path that is a proc" do
+    setup do
+      rebuild_model :path => lambda{ |attachment| "path/#{attachment.instance.other}.:extension" }
+      
+      @file = File.new(File.join(File.dirname(__FILE__),
+                                 "fixtures",
+                                 "5k.png"), 'rb')
+      @dummyA = Dummy.new(:other => 'a')
+      @dummyA.avatar = @file
+      @dummyB = Dummy.new(:other => 'b')
+      @dummyB.avatar = @file
+    end
+    
+    teardown { @file.close }
+    
+    should "return correct path" do
+      assert_equal "path/a.png", @dummyA.avatar.path
+      assert_equal "path/b.png", @dummyB.avatar.path
+    end
+  end
+  
+  context "An attachment with :styles that is a proc" do
+    setup do
+      rebuild_model :styles => lambda{ |attachment| {:thumb => "50x50#", :large => "400x400"} }
+      
+      @attachment = Dummy.new.avatar
+    end
+    
+    should "have the correct geometry" do
+      assert_equal "50x50#", @attachment.styles[:thumb][:geometry]
+    end
+  end
+  
+  context "An attachment with :url that is a proc" do
+    setup do
+      rebuild_model :url => lambda{ |attachment| "path/#{attachment.instance.other}.:extension" }
+      
+      @file = File.new(File.join(File.dirname(__FILE__),
+                                 "fixtures",
+                                 "5k.png"), 'rb')
+      @dummyA = Dummy.new(:other => 'a')
+      @dummyA.avatar = @file
+      @dummyB = Dummy.new(:other => 'b')
+      @dummyB.avatar = @file
+    end
+    
+    teardown { @file.close }
+    
+    should "return correct url" do
+      assert_equal "path/a.png", @dummyA.avatar.url(:original, false)
+      assert_equal "path/b.png", @dummyB.avatar.url(:original, false)
+    end
+  end
 
   geometry_specs = [ 
     [ lambda{|z| "50x50#" }, :png ],
@@ -211,6 +295,22 @@ class AttachmentTest < Test::Unit::TestCase
       end
     end
   end
+  
+  context "An attachment with erroring processor" do
+    setup do
+      rebuild_model :processor => [:thumbnail], :styles => { :small => '' }, :whiny_thumbnails => true
+      @dummy = Dummy.new
+      Paperclip::Thumbnail.expects(:make).raises(Paperclip::PaperclipError, "cannot be processed.")
+      @file = StringIO.new("...")
+      @file.stubs(:to_tempfile).returns(@file)
+      @dummy.avatar = @file
+    end
+
+    should "correctly forward processing error message to the instance" do
+      @dummy.valid?
+      assert_contains @dummy.errors.full_messages, "Avatar cannot be processed."
+    end
+  end
 
   context "An attachment with multiple processors" do
     setup do
@@ -229,8 +329,13 @@ class AttachmentTest < Test::Unit::TestCase
 
       before_should "call #make on all specified processors" do
         expected_params = @style_params[:once].merge({:processors => [:thumbnail, :test], :whiny => nil, :convert_options => ""})
-        Paperclip::Thumbnail.expects(:make).with(@file, expected_params).returns(@file)
-        Paperclip::Test.expects(:make).with(@file, expected_params).returns(@file)
+        Paperclip::Thumbnail.expects(:make).with(@file, expected_params, @dummy.avatar).returns(@file)
+        Paperclip::Test.expects(:make).with(@file, expected_params, @dummy.avatar).returns(@file)
+      end
+      
+      before_should "call #make with attachment passed as third argument" do
+        expected_params = @style_params[:once].merge({:processors => [:thumbnail, :test], :whiny => nil, :convert_options => ""})
+        Paperclip::Test.expects(:make).with(@file, expected_params, @dummy.avatar).returns(@file)
       end
     end
   end

data/test/helper.rb

@@ -9,6 +9,7 @@ gem 'sqlite3-ruby'
 
 require 'active_record'
 require 'active_support'
+require 'action_controller'
 begin
   require 'ruby-debug'
 rescue LoadError

data/test/processor_test.rb

@@ -4,7 +4,7 @@ class ProcessorTest < Test::Unit::TestCase
   should "instantiate and call #make when sent #make to the class" do
     processor = mock
     processor.expects(:make).with()
-    Paperclip::Processor.expects(:new).with(:one, :two).returns(processor)
-    Paperclip::Processor.make(:one, :two)
+    Paperclip::Processor.expects(:new).with(:one, :two, :three).returns(processor)
+    Paperclip::Processor.make(:one, :two, :three)
   end
 end

data/test/storage_test.rb

@@ -126,6 +126,19 @@ class StorageTest < Test::Unit::TestCase
       end
     end
   end
+  
+  context "An attachment with S3 storage and bucket defined as a Proc" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :bucket => lambda { |attachment| "bucket_#{attachment.instance.other}" },
+                    :s3_credentials => {:not => :important}
+    end
+    
+    should "get the right bucket name" do
+      assert "bucket_a", Dummy.new(:other => 'a').avatar.bucket_name
+      assert "bucket_b", Dummy.new(:other => 'b').avatar.bucket_name
+    end
+  end
 
   context "An attachment with S3 storage and specific s3 headers set" do
     setup do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paperclip
 version: !ruby/object:Gem::Version 
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors: 
 - Jon Yurek
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-07 00:00:00 -05:00
+date: 2009-02-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency