paperclip 2.3.1.1 → 2.3.2

data/lib/paperclip/iostream.rb

@@ -4,7 +4,8 @@ module IOStream
 
   # Returns a Tempfile containing the contents of the readable object.
   def to_tempfile
-    tempfile = Tempfile.new("stream")
+    name = respond_to?(:original_filename) ? original_filename : (respond_to?(:path) ? path : "stream")
+    tempfile = Paperclip::Tempfile.new("stream" + File.extname(name))
     tempfile.binmode
     self.stream_to(tempfile)
   end
@@ -25,7 +26,7 @@ module IOStream
     while self.read(in_blocks_of, buffer) do
       dstio.write(buffer)
     end
-    dstio.rewind    
+    dstio.rewind
     dstio
   end
 end

data/lib/paperclip/matchers.rb

@@ -2,3 +2,32 @@ require 'paperclip/matchers/have_attached_file_matcher'
 require 'paperclip/matchers/validate_attachment_presence_matcher'
 require 'paperclip/matchers/validate_attachment_content_type_matcher'
 require 'paperclip/matchers/validate_attachment_size_matcher'
+
+module Paperclip
+  module Shoulda
+    # Provides rspec-compatible matchers for testing Paperclip attachments.
+    #
+    # In spec_helper.rb, you'll need to require the matchers:
+    #
+    #   require "paperclip/matchers"
+    #
+    # And include the module:
+    #
+    #   Spec::Runner.configure do |config|
+    #     config.include Paperclip::Shoulda::Matchers
+    #   end
+    #
+    # Example:
+    #   describe User do
+    #     it { should have_attached_file(:avatar) }
+    #     it { should validate_attachment_presence(:avatar) }
+    #     it { should validate_attachment_content_type(:avatar).
+    #                   allowing('image/png', 'image/gif').
+    #                   rejecting('text/plain', 'text/xml') }
+    #     it { should validate_attachment_size(:avatar).
+    #                   less_than(2.megabytes) }
+    #   end
+    module Matchers
+    end
+  end
+end

data/lib/paperclip/matchers/have_attached_file_matcher.rb

@@ -1,6 +1,13 @@
 module Paperclip
   module Shoulda
     module Matchers
+      # Ensures that the given instance or class has an attachment with the
+      # given name.
+      #
+      # Example:
+      #   describe User do
+      #     it { should have_attached_file(:avatar) }
+      #   end
       def have_attached_file name
         HaveAttachedFileMatcher.new(name)
       end
@@ -12,6 +19,7 @@ module Paperclip
 
         def matches? subject
           @subject = subject
+          @subject = @subject.class unless Class === @subject
           responds? && has_column? && included?
         end
 

data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb

@@ -1,6 +1,15 @@
 module Paperclip
   module Shoulda
     module Matchers
+      # Ensures that the given instance or class validates the content type of
+      # the given attachment as specified.
+      #
+      # Example:
+      #   describe User do
+      #     it { should validate_attachment_content_type(:icon).
+      #                   allowing('image/png', 'image/gif').
+      #                   rejecting('text/plain', 'text/xml') }
+      #   end
       def validate_attachment_content_type name
         ValidateAttachmentContentTypeMatcher.new(name)
       end
@@ -22,6 +31,7 @@ module Paperclip
 
         def matches? subject
           @subject = subject
+          @subject = @subject.class unless Class === @subject
           @allowed_types && @rejected_types &&
           allowed_types_allowed? && rejected_types_rejected?
         end
@@ -32,7 +42,7 @@ module Paperclip
         end
 
         def negative_failure_message
-          "Content types #{@allowed_types.join(", ")} should be rejected" + 
+          "Content types #{@allowed_types.join(", ")} should be rejected" +
           " and #{@rejected_types.join(", ")} accepted by #{@attachment_name}"
         end
 
@@ -46,9 +56,8 @@ module Paperclip
           types.all? do |type|
             file = StringIO.new(".")
             file.content_type = type
-            attachment = @subject.new.attachment_for(@attachment_name)
-            attachment.assign(file)
-            attachment.errors[:content_type].nil?
+            (subject = @subject.new).attachment_for(@attachment_name).assign(file)
+            subject.valid? && subject.errors[:"#{@attachment_name}_content_type"].blank?
           end
         end
 
@@ -63,4 +72,3 @@ module Paperclip
     end
   end
 end
-

data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb

@@ -1,6 +1,12 @@
 module Paperclip
   module Shoulda
     module Matchers
+      # Ensures that the given instance or class validates the presence of the
+      # given attachment.
+      #
+      # describe User do
+      #   it { should validate_attachment_presence(:avatar) }
+      # end
       def validate_attachment_presence name
         ValidateAttachmentPresenceMatcher.new(name)
       end
@@ -12,6 +18,7 @@ module Paperclip
 
         def matches? subject
           @subject = subject
+          @subject = @subject.class unless Class === @subject
           error_when_not_valid? && no_error_when_valid?
         end
 
@@ -30,19 +37,18 @@ module Paperclip
         protected
 
         def error_when_not_valid?
-          @attachment = @subject.new.send(@attachment_name)
-          @attachment.assign(nil)
-          not @attachment.errors[:presence].nil?
+          (subject = @subject.new).send(@attachment_name).assign(nil)
+          subject.valid?
+          not subject.errors[:"#{@attachment_name}_file_name"].blank?
         end
 
         def no_error_when_valid?
           @file = StringIO.new(".")
-          @attachment = @subject.new.send(@attachment_name)
-          @attachment.assign(@file)
-          @attachment.errors[:presence].nil?
+          (subject = @subject.new).send(@attachment_name).assign(@file)
+          subject.valid?
+          subject.errors[:"#{@attachment_name}_file_name"].blank?
         end
       end
     end
   end
 end
-

data/lib/paperclip/matchers/validate_attachment_size_matcher.rb

@@ -1,6 +1,16 @@
 module Paperclip
   module Shoulda
     module Matchers
+      # Ensures that the given instance or class validates the size of the
+      # given attachment as specified.
+      #
+      # Examples:
+      #   it { should validate_attachment_size(:avatar).
+      #                 less_than(2.megabytes) }
+      #   it { should validate_attachment_size(:icon).
+      #                 greater_than(1024) }
+      #   it { should validate_attachment_size(:icon).
+      #                 in(0..100) }
       def validate_attachment_size name
         ValidateAttachmentSizeMatcher.new(name)
       end
@@ -28,6 +38,7 @@ module Paperclip
 
         def matches? subject
           @subject = subject
+          @subject = @subject.class unless Class === @subject
           lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
         end
 
@@ -54,9 +65,11 @@ module Paperclip
         def passes_validation_with_size(new_size)
           file = StringIO.new(".")
           override_method(file, :size){ new_size }
-          attachment = @subject.new.attachment_for(@attachment_name)
-          attachment.assign(file)
-          attachment.errors[:size].nil?
+          override_method(file, :to_tempfile){ file }
+
+          (subject = @subject.new).send(@attachment_name).assign(file)
+          subject.valid?
+          subject.errors[:"#{@attachment_name}_file_size"].blank?
         end
 
         def lower_than_low?
@@ -80,4 +93,3 @@ module Paperclip
     end
   end
 end
-

data/lib/paperclip/processor.rb

@@ -6,7 +6,7 @@ module Paperclip
   #
   # Processors are required to be defined inside the Paperclip module and
   # are also required to be a subclass of Paperclip::Processor. There is
-  # only one method you *must* implement to properly be a subclass: 
+  # only one method you *must* implement to properly be a subclass:
   # #make, but #initialize may also be of use. Both methods accept 3
   # arguments: the file that will be operated on (which is an instance of
   # File), a hash of options that were defined in has_attached_file's
@@ -33,7 +33,7 @@ module Paperclip
       new(file, options, attachment).make
     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

data/lib/paperclip/railtie.rb

@@ -0,0 +1,22 @@
+require 'paperclip'
+
+module Paperclip
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      ActiveSupport.on_load :active_record do
+        Paperclip::Railtie.insert
+      end
+      rake_tasks do
+        load "tasks/paperclip.rake"
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, Paperclip)
+      File.send(:include, Paperclip::Upfile)
+    end
+  end
+end

data/lib/paperclip/storage.rb

@@ -8,21 +8,21 @@ module Paperclip
     # * +path+: The location of the repository of attachments on disk. This can (and, in
     #   almost all cases, should) be coordinated with the value of the +url+ option to
     #   allow files to be saved into a place where Apache can serve them without
-    #   hitting your app. Defaults to 
+    #   hitting your app. Defaults to
     #   ":rails_root/public/:attachment/:id/:style/:basename.:extension"
-    #   By default this places the files in the app's public directory which can be served 
-    #   directly. If you are using capistrano for deployment, a good idea would be to 
-    #   make a symlink to the capistrano-created system directory from inside your app's 
+    #   By default this places the files in the app's public directory which can be served
+    #   directly. If you are using capistrano for deployment, a good idea would be to
+    #   make a symlink to the capistrano-created system directory from inside your app's
     #   public directory.
     #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
     #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
     module Filesystem
       def self.extended base
       end
-      
-      def exists?(style = default_style)
+
+      def exists?(style_name = default_style)
         if original_filename
-          File.exist?(path(style))
+          File.exist?(path(style_name))
         else
           false
         end
@@ -30,17 +30,17 @@ module Paperclip
 
       # Returns representation of the data of the file assigned to the given
       # style, in the format most representative of the current storage.
-      def to_file style = default_style
-        @queued_for_write[style] || (File.new(path(style), 'rb') if exists?(style))
+      def to_file style_name = default_style
+        @queued_for_write[style_name] || (File.new(path(style_name), 'rb') if exists?(style_name))
       end
 
       def flush_writes #:nodoc:
-        @queued_for_write.each do |style, file|
+        @queued_for_write.each do |style_name, file|
           file.close
-          FileUtils.mkdir_p(File.dirname(path(style)))
-          log("saving #{path(style)}")
-          FileUtils.mv(file.path, path(style))
-          FileUtils.chmod(0644, path(style))
+          FileUtils.mkdir_p(File.dirname(path(style_name)))
+          log("saving #{path(style_name)}")
+          FileUtils.mv(file.path, path(style_name))
+          FileUtils.chmod(0644, path(style_name))
         end
         @queued_for_write = {}
       end
@@ -78,25 +78,25 @@ module Paperclip
     #   database.yml file, so different environments can use different accounts:
     #     development:
     #       access_key_id: 123...
-    #       secret_access_key: 123... 
+    #       secret_access_key: 123...
     #     test:
     #       access_key_id: abc...
-    #       secret_access_key: abc... 
+    #       secret_access_key: abc...
     #     production:
     #       access_key_id: 456...
-    #       secret_access_key: 456... 
+    #       secret_access_key: 456...
     #   This is not required, however, and the file may simply look like this:
     #     access_key_id: 456...
-    #     secret_access_key: 456... 
+    #     secret_access_key: 456...
     #   In which case, those access keys will be used in all environments. You can also
     #   put your bucket name in this file, instead of adding it to the code directly.
-    #   This is useful when you want the same account but a different bucket for 
+    #   This is useful when you want the same account but a different bucket for
     #   development versus production.
     # * +s3_permissions+: This is a String that should be one of the "canned" access
     #   policies that S3 provides (more information can be found here:
     #   http://docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies)
     #   The default for Paperclip is :public_read.
-    # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either 
+    # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
     #   'http' or 'https'. Defaults to 'http' when your :s3_permissions are :public_read (the
     #   default), and 'https' when your :s3_permissions are anything else.
     # * +s3_headers+: A hash of headers such as {'Expires' => 1.year.from_now.httpdate}
@@ -111,7 +111,7 @@ module Paperclip
     # * +url+: There are three 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).
     #   Lastly, you can specify a CNAME (which requires the CNAME to be specified as
-    #   :s3_alias_url. You can read more about CNAMEs and S3 at 
+    #   :s3_alias_url. You can read more about CNAMEs and S3 at
     #   http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
     #   Normally, this won't matter in the slightest and you can leave the default (which is
     #   path-style, or :s3_path_url). But in some cases paths don't work and you need to use
@@ -160,6 +160,10 @@ module Paperclip
         end
       end
 
+      def expiring_url(time = 3600)
+        AWS::S3::S3Object.url_for(path, bucket_name, :expires_in => time )
+      end
+
       def bucket_name
         @bucket
       end
@@ -170,9 +174,9 @@ module Paperclip
 
       def parse_credentials creds
         creds = find_credentials(creds).stringify_keys
-        (creds[RAILS_ENV] || creds).symbolize_keys
+        (creds[Rails.env] || creds).symbolize_keys
       end
-      
+
       def exists?(style = default_style)
         if original_filename
           AWS::S3::S3Object.exists?(path(style), bucket_name)
@@ -223,12 +227,12 @@ module Paperclip
         end
         @queued_for_delete = []
       end
-      
+
       def find_credentials creds
         case creds
         when File
           YAML::load(ERB.new(File.read(creds.path)).result)
-        when String
+        when String, Pathname
           YAML::load(ERB.new(File.read(creds)).result)
         when Hash
           creds

data/lib/paperclip/style.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+module Paperclip
+  # The Style class holds the definition of a thumbnail style,  applying
+  # whatever processing is required to normalize the definition and delaying
+  # the evaluation of block parameters until useful context is available.
+
+  class Style
+
+    attr_reader :name, :attachment, :format
+
+    # Creates a Style object. +name+ is the name of the attachment,
+    # +definition+ is the style definition from has_attached_file, which
+    # can be string, array or hash
+    def initialize name, definition, attachment
+      @name = name
+      @attachment = attachment
+      if definition.is_a? Hash
+        @geometry = definition.delete(:geometry)
+        @format = definition.delete(:format)
+        @processors = definition.delete(:processors)
+        @other_args = definition
+      else
+        @geometry, @format = [definition, nil].flatten[0..1]
+        @other_args = {}
+      end
+      @format  = nil if @format.blank?
+    end
+
+    # retrieves from the attachment the processors defined in the has_attached_file call
+    # (which method (in the attachment) will call any supplied procs)
+    # There is an important change of interface here: a style rule can set its own processors
+    # by default we behave as before, though.
+    def processors
+      @processors || attachment.processors
+    end
+
+    # retrieves from the attachment the whiny setting
+    def whiny
+      attachment.whiny
+    end
+
+    # returns true if we're inclined to grumble
+    def whiny?
+      !!whiny
+    end
+
+    def convert_options
+      attachment.send(:extra_options_for, name)
+    end
+
+    # returns the geometry string for this style
+    # if a proc has been supplied, we call it here
+    def geometry
+      @geometry.respond_to?(:call) ? @geometry.call(attachment.instance) : @geometry
+    end
+
+    # Supplies the hash of options that processors expect to receive as their second argument
+    # Arguments other than the standard geometry, format etc are just passed through from
+    # initialization and any procs are called here, just before post-processing.
+    def processor_options
+      args = {}
+      @other_args.each do |k,v|
+        args[k] = v.respond_to?(:call) ? v.call(attachment) : v
+      end
+      [:processors, :geometry, :format, :whiny, :convert_options].each do |k|
+        (arg = send(k)) && args[k] = arg
+      end
+      args
+    end
+
+    # Supports getting and setting style properties with hash notation to ensure backwards-compatibility
+    # eg. @attachment.styles[:large][:geometry]@ will still work
+    def [](key)
+      if [:name, :convert_options, :whiny, :processors, :geometry, :format].include?(key)
+        send(key)
+      elsif defined? @other_args[key]
+        @other_args[key]
+      end
+    end
+
+    def []=(key, value)
+      if [:name, :convert_options, :whiny, :processors, :geometry, :format].include?(key)
+        send("#{key}=".intern, value)
+      else
+        @other_args[key] = value
+      end
+    end
+
+  end
+end