dm-paperclip 2.1.4 → 2.3.0

data/lib/dm-paperclip/thumbnail.rb

@@ -1,40 +1,35 @@
 module Paperclip
   # Handles thumbnailing images that are uploaded.
-  class Thumbnail
+  class Thumbnail < Processor
 
-    attr_accessor :file, :current_geometry, :target_geometry, :format, :whiny_thumbnails, :convert_options
+    attr_accessor :current_geometry, :target_geometry, :format, :whiny, :convert_options
 
     # Creates a Thumbnail object set to work on the +file+ given. It
     # will attempt to transform the image into one defined by +target_geometry+
     # which is a "WxH"-style string. +format+ will be inferred from the +file+
     # unless specified. Thumbnail creation will raise no errors unless
-    # +whiny_thumbnails+ 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, target_geometry, format = nil, convert_options = nil, whiny_thumbnails = true
+    # +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 = {}, attachment = nil
+      super
+      geometry          = options[:geometry]
       @file             = file
-      @crop             = target_geometry[-1,1] == '#'
-      @target_geometry  = Geometry.parse target_geometry
-      @current_geometry = Geometry.from_file file
-      @convert_options  = convert_options
-      @whiny_thumbnails = whiny_thumbnails
+      @crop             = geometry[-1,1] == '#'
+      @target_geometry  = Geometry.parse geometry
+      @current_geometry = Geometry.from_file @file
+      @convert_options  = options[:convert_options]
+      @whiny            = options[:whiny].nil? ? true : options[:whiny]
+      @format           = options[:format]
 
       @current_format   = File.extname(@file.path)
       @basename         = File.basename(@file.path, @current_format)
-      
-      @format = format
-    end
-
-    # Creates a thumbnail, as specified in +initialize+, +make+s it, and returns the
-    # resulting Tempfile.
-    def self.make file, dimensions, format = nil, convert_options = nil, whiny_thumbnails = true
-      new(file, dimensions, format, convert_options, whiny_thumbnails).make
     end
 
     # Returns true if the +target_geometry+ is meant to crop.
     def crop?
       @crop
     end
-    
+
     # Returns true if the image is meant to make use of additional convert options.
     def convert_options?
       not @convert_options.blank?
@@ -48,15 +43,15 @@ module Paperclip
       dst.binmode
 
       command = <<-end_command
-        #{ Paperclip.path_for_command('convert') }
         "#{ File.expand_path(src.path) }[0]"
         #{ transformation_command }
         "#{ File.expand_path(dst.path) }"
       end_command
-      success = system(command.gsub(/\s+/, " "))
 
-      if !success && $?.exitstatus != 0 && @whiny_thumbnails
-        raise PaperclipError, "There was an error processing this thumbnail"
+      begin
+        success = Paperclip.run("convert", command.gsub(/\s+/, " "))
+      rescue PaperclipCommandLineError
+        raise PaperclipError, "There was an error processing the thumbnail for #{@basename}" if @whiny
       end
 
       dst
@@ -72,17 +67,4 @@ module Paperclip
       trans
     end
   end
-
-  # Due to how ImageMagick handles its image format conversion and how Tempfile
-  # handles its naming scheme, it is necessary to override how Tempfile makes
-  # its names so as to allow for file extensions. Idea taken from the comments
-  # on this blog post:
-  # http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions
-  class Tempfile < ::Tempfile
-    # Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
-    def make_tmpname(basename, n)
-      extension = File.extname(basename)
-      sprintf("%s,%d,%d%s", File.basename(basename, extension), $$, n, extension)
-    end
-  end
 end

data/lib/dm-paperclip/upfile.rb

@@ -28,9 +28,20 @@ module Paperclip
       File.size(self)
     end
   end
+end
 
+if defined? StringIO
+  class StringIO
+    attr_accessor :original_filename, :content_type
+    def original_filename
+      @original_filename ||= "stringio.txt"
+    end
+    def content_type
+      @content_type ||= "text/plain"
+    end
+  end
 end
 
 class File #:nodoc:
   include Paperclip::Upfile
-end
+end

data/lib/dm-paperclip/validations.rb

@@ -1,6 +1,41 @@
 module Paperclip
   module Validate
 
+    module ClassMethods
+
+      # Places ActiveRecord-style validations on the size of the file assigned. The
+      # possible options are:
+      # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
+      # * +less_than+: equivalent to :in => 0..options[:less_than]
+      # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
+      # * +message+: error message to display, use :min and :max as replacements
+      def validates_attachment_size(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, Paperclip::Validate::SizeValidator)
+      end
+
+      # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
+      def validates_attachment_thumbnails name, options = {}
+        self.attachment_definitions[name][:whiny_thumbnails] = true
+      end
+
+      # Places ActiveRecord-style validations on the presence of a file.
+      def validates_attachment_presence(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, Paperclip::Validate::RequiredFieldValidator)
+      end
+
+      # Places ActiveRecord-style validations on the content type of the file assigned. The
+      # possible options are:
+      # * +content_type+: Allowed content types.  Can be a single content type or an array.  Allows all by default.
+      # * +message+: The message to display when the uploaded file has an invalid content type.
+      def validates_attachment_content_type(*fields)
+        opts = opts_from_validator_args(fields)
+        add_validator_to_context(opts, fields, Paperclip::Validate::ContentTypeValidator)
+      end
+
+    end
+
     class SizeValidator < DataMapper::Validate::GenericValidator #:nodoc:
       def initialize(field_name, options={})
         super

data/test/attachment_test.rb

@@ -138,11 +138,9 @@ class AttachmentTest < Test::Unit::TestCase
         end
       end
 
-      [:thumb, :large].each do |style|
-        should "call extra_options_for(#{style})" do
-          @dummy.avatar.expects(:extra_options_for).with(style)
-          @dummy.avatar = @file
-        end
+      should "call post_process" do
+        @dummy.avatar.expects(:post_process).once
+        @dummy.avatar = @file
       end
     end
   end
@@ -150,20 +148,20 @@ class AttachmentTest < Test::Unit::TestCase
   context "Assigning an attachment" do
     setup do
       rebuild_model
-      
+
       @not_file = mock
       @not_file.stubs(:nil?).returns(false)
       @not_file.expects(:to_tempfile).returns(self)
       @not_file.expects(:original_filename).returns("filename.png\r\n")
       @not_file.expects(:content_type).returns("image/png\r\n")
       @not_file.expects(:size).returns(10)
-      
+
       @dummy = Dummy.new
       @attachment = @dummy.avatar
       @attachment.expects(:valid_assignment?).with(@not_file).returns(true)
       @attachment.expects(:queue_existing_for_delete)
       @attachment.expects(:post_process)
-      @attachment.expects(:validate)
+      @attachment.expects(:validate).twice
       @dummy.avatar = @not_file
     end
 
@@ -174,33 +172,31 @@ class AttachmentTest < Test::Unit::TestCase
     should "strip whitespace from content_type field" do
       assert_equal "image/png", @dummy.avatar.instance.avatar_content_type
     end
-    
   end
 
   context "Attachment with strange letters" do
     setup do
       rebuild_model
-      
+
       @not_file = mock
       @not_file.stubs(:nil?).returns(false)
       @not_file.expects(:to_tempfile).returns(self)
-      @not_file.expects(:original_filename).returns("sheep_say_b�.png\r\n")
+      @not_file.expects(:original_filename).returns("sheep_say_b_.png\r\n")
       @not_file.expects(:content_type).returns("image/png\r\n")
       @not_file.expects(:size).returns(10)
-      
+
       @dummy = Dummy.new
       @attachment = @dummy.avatar
       @attachment.expects(:valid_assignment?).with(@not_file).returns(true)
       @attachment.expects(:queue_existing_for_delete)
       @attachment.expects(:post_process)
-      @attachment.expects(:validate)
+      @attachment.expects(:validate).twice
       @dummy.avatar = @not_file
     end
-    
+
     should "remove strange letters and replace with underscore (_)" do
       assert_equal "sheep_say_b_.png", @dummy.avatar.original_filename
     end
-    
   end
 
   context "An attachment" do
@@ -230,25 +226,24 @@ class AttachmentTest < Test::Unit::TestCase
       assert_equal "/avatars/original/missing.png", @attachment.url
       assert_equal "/avatars/blah/missing.png", @attachment.url(:blah)
     end
-    
+
     context "with a file assigned in the database" do
       setup do
-        @instance.stubs(:attribute_get).with(:avatar_file_name).returns('5k.png')
-        @instance.stubs(:attribute_get).with(:avatar_content_type).returns("image/png")
-        @instance.stubs(:attribute_get).with(:avatar_file_size).returns(12345)
-        now = Time.now
-        Time.stubs(:now).returns(now)
-        @instance.stubs(:attribute_get).with(:avatar_updated_at).returns(Time.now)
+        @instance.stubs(:avatar_file_name).returns('5k.png')
+        @instance.stubs(:avatar_content_type).returns("image/png")
+        @instance.stubs(:avatar_file_size).returns(12345)
+        @now = Time.now
+        Time.stubs(:now).returns(@now)
+        @instance.stubs(:avatar_updated_at).returns(Time.now)
       end
 
       should "return a correct url even if the file does not exist" do
         assert_nil @attachment.to_file
-        assert_match %r{^/avatars/#{@instance.id}/blah/5k\.png}, @attachment.url(:blah)
+        assert_match %r{^/system/avatars/#{@instance.id}/blah/5k\.png}, @attachment.url(:blah)
       end
 
       should "make sure the updated_at mtime is in the url if it is defined" do
-        time = Time.now
-        assert_match %r{#{time.year}#{time.month}#{time.day}#{time.hour}#{time.min}#{time.sec}$}, @attachment.url(:blah)
+        assert_match %r{#{@now.to_i.to_s}$}, @attachment.url(:blah)
       end
 
       context "with the updated_at field removed" do
@@ -266,7 +261,7 @@ class AttachmentTest < Test::Unit::TestCase
       end
 
       should "return the proper path when filename has multiple .'s" do
-        @instance.stubs(:attribute_get).with(:avatar_file_name).returns("5k.old.png")      
+        @instance.stubs(:avatar_file_name).returns("5k.old.png")      
         assert_equal "./test/../tmp/avatars/dummies/original/#{@instance.id}/5k.old.png", @attachment.path
       end
 
@@ -298,8 +293,8 @@ class AttachmentTest < Test::Unit::TestCase
 
             should "return the real url" do
               assert @attachment.to_file
-              assert_match %r{^/avatars/#{@instance.id}/original/5k\.png}, @attachment.url
-              assert_match %r{^/avatars/#{@instance.id}/small/5k\.jpg}, @attachment.url(:small)
+              assert_match %r{^/system/avatars/#{@instance.id}/original/5k\.png}, @attachment.url
+              assert_match %r{^/system/avatars/#{@instance.id}/small/5k\.jpg}, @attachment.url(:small)
             end
 
             should "commit the files to disk" do
@@ -333,15 +328,12 @@ class AttachmentTest < Test::Unit::TestCase
                 @existing_names = @attachment.styles.keys.collect do |style|
                   @attachment.path(style)
                 end
-                @instance.expects(:attributes=).with({ :avatar_file_name => nil,
-                  :avatar_content_type => nil,
-                  :avatar_file_size => nil })
                 @attachment.assign nil
                 @attachment.save
               end
 
               should "delete the files" do
-                @existing_names.each{|f| assert ! File.exists?(f) }
+                @existing_names.each { |f| assert !File.exists?(f) }
               end
             end
           end

data/test/geometry_test.rb

@@ -62,7 +62,7 @@ class GeometryTest < Test::Unit::TestCase
     should "make sure the modifier gets passed during transformation_to" do
       assert @src = Paperclip::Geometry.parse("123x456")
       assert @dst = Paperclip::Geometry.parse("123x456>")
-      assert_equal "123x456>", @src.transformation_to(@dst).to_s
+      assert_equal "123x456>", @src.transformation_to(@dst).join
     end
 
     should "be generated from a file" do

data/test/helper.rb

@@ -42,6 +42,12 @@ unless defined?(Mash)
   end
 end
 
+Paperclip.configure do |config|
+  config.root               = Merb.root # the application root to anchor relative urls (defaults to Dir.pwd)
+  config.env                = Merb.env  # server env support, defaults to ENV['RACK_ENV'] or 'development'
+  config.use_dm_validations = true      # validate attachment sizes and such, defaults to false
+end
+
 def rebuild_model options = {}
   Object.send(:remove_const, "Dummy") rescue nil
   Object.const_set("Dummy", Class.new())

data/test/storage_test.rb

@@ -24,21 +24,21 @@ class StorageTest < Test::Unit::TestCase
 
     should "get the correct credentials when RAILS_ENV is production" do
       ENV['RAILS_ENV'] = 'production'
-      assert_equal({:key => "12345"},
+      assert_equal({'key' => "12345"},
                    @avatar.parse_credentials('production' => {:key => '12345'},
                                              :development => {:key => "54321"}))
     end
 
     should "get the correct credentials when RAILS_ENV is development" do
       ENV['RAILS_ENV'] = 'development'
-      assert_equal({:key => "54321"},
+      assert_equal({'key' => "54321"},
                    @avatar.parse_credentials('production' => {:key => '12345'},
                                              :development => {:key => "54321"}))
     end
 
     should "return the argument if the key does not exist" do
       ENV['RAILS_ENV'] = "not really an env"
-      assert_equal({:test => "12345"}, @avatar.parse_credentials(:test => "12345"))
+      assert_equal({'test' => "12345"}, @avatar.parse_credentials(:test => "12345"))
     end
   end
 

data/test/thumbnail_test.rb

@@ -48,11 +48,11 @@ class ThumbnailTest < Test::Unit::TestCase
     ].each do |args|
       context "being thumbnailed with a geometry of #{args[0]}" do
         setup do
-          @thumb = Paperclip::Thumbnail.new(@file, args[0])
+          @thumb = Paperclip::Thumbnail.new(@file, :geometry => args[0])
         end
 
         should "start with dimensions of 434x66" do
-          cmd = %Q[identify -format "%wx%h" #{@file.path}] 
+          cmd = %Q[identify -format "%wx%h" #{@file.path}]
           assert_equal "434x66", `#{cmd}`.chomp
         end
 
@@ -66,7 +66,7 @@ class ThumbnailTest < Test::Unit::TestCase
           end
 
           should "be the size we expect it to be" do
-            cmd = %Q[identify -format "%wx%h" #{@thumb_result.path}] 
+            cmd = %Q[identify -format "%wx%h" #{@thumb_result.path}]
             assert_equal args[1], `#{cmd}`.chomp
           end
         end
@@ -75,7 +75,7 @@ class ThumbnailTest < Test::Unit::TestCase
 
     context "being thumbnailed at 100x50 with cropping" do
       setup do
-        @thumb = Paperclip::Thumbnail.new(@file, "100x50#")
+        @thumb = Paperclip::Thumbnail.new(@file, :geometry => "100x50#")
       end
 
       should "report its correct current and target geometries" do
@@ -88,16 +88,17 @@ class ThumbnailTest < Test::Unit::TestCase
       end
 
       should "have whiny_thumbnails turned on by default" do
-        assert @thumb.whiny_thumbnails
+        assert @thumb.whiny
       end
-      
+
       should "have convert_options set to nil by default" do
         assert_equal nil, @thumb.convert_options
       end
 
       should "send the right command to convert when sent #make" do
-        @thumb.expects(:system).with do |arg|
-          arg.match %r{convert\s+"#{File.expand_path(@thumb.file.path)}\[0\]"\s+-resize\s+\"x50\"\s+-crop\s+\"100x50\+114\+0\"\s+\+repage\s+".*?"}
+        Paperclip.expects(:run).with do |cmd, arg|
+          cmd.match 'convert'
+          arg.match %r{"#{File.expand_path(@thumb.file.path)}\[0\]"\s+-resize\s+\"x50\"\s+-crop\s+\"100x50\+114\+0\"\s+\+repage\s+".*?"}
         end
         @thumb.make
       end
@@ -107,10 +108,10 @@ class ThumbnailTest < Test::Unit::TestCase
         assert_match /100x50/, `identify #{dst.path}`
       end
     end
-    
+
     context "being thumbnailed with convert options set" do
       setup do
-        @thumb = Paperclip::Thumbnail.new(@file, "100x50#", format=nil, convert_options="-strip -depth 8", whiny_thumbnails=true)
+        @thumb = Paperclip::Thumbnail.new(@file, :geometry => "100x50#", :format => (format = nil), :convert_options => (convert_options="-strip -depth 8"), :whiny => (whiny_thumbnails=true))
       end
 
       should "have convert_options value set" do
@@ -118,8 +119,9 @@ class ThumbnailTest < Test::Unit::TestCase
       end
 
       should "send the right command to convert when sent #make" do
-        @thumb.expects(:system).with do |arg|
-          arg.match %r{convert\s+"#{File.expand_path(@thumb.file.path)}\[0\]"\s+-resize\s+"x50"\s+-crop\s+"100x50\+114\+0"\s+\+repage\s+-strip\s+-depth\s+8\s+".*?"}
+        Paperclip.expects(:run).with do |cmd, arg|
+          cmd.match 'convert'
+          arg.match %r{"#{File.expand_path(@thumb.file.path)}\[0\]"\s+-resize\s+"x50"\s+-crop\s+"100x50\+114\+0"\s+\+repage\s+-strip\s+-depth\s+8\s+".*?"}
         end
         @thumb.make
       end
@@ -128,10 +130,10 @@ class ThumbnailTest < Test::Unit::TestCase
         dst = @thumb.make
         assert_match /100x50/, `identify #{dst.path}`
       end
-      
+
       context "redefined to have bad convert_options setting" do
         setup do
-          @thumb = Paperclip::Thumbnail.new(@file, "100x50#", format=nil, convert_options="-this-aint-no-option", whiny_thumbnails=true)
+          @thumb = Paperclip::Thumbnail.new(@file, :geometry => "100x50#", :format => nil, :convert_options => "-this-aint-no-option", :whiny => true)
         end
 
         should "error when trying to create the thumbnail" do
@@ -139,7 +141,7 @@ class ThumbnailTest < Test::Unit::TestCase
             @thumb.make
           end
         end
-      end      
+      end
     end
   end
 end