paperclip 2.3.16 → 2.4.0

data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb

@@ -41,7 +41,7 @@ module Paperclip
         def failure_message
           "".tap do |str|
             str << "Content types #{@allowed_types.join(", ")} should be accepted" if @allowed_types.present?
-            str << "\n" if @allowed_types.present && @rejected_types.present?
+            str << "\n" if @allowed_types.present? && @rejected_types.present?
             str << "Content types #{@rejected_types.join(", ")} should be rejected by #{@attachment_name}" if @rejected_types.present?
           end
         end
@@ -49,7 +49,7 @@ module Paperclip
         def negative_failure_message
           "".tap do |str|
             str << "Content types #{@allowed_types.join(", ")} should be rejected" if @allowed_types.present?
-            str << "\n" if @allowed_types.present && @rejected_types.present?
+            str << "\n" if @allowed_types.present? && @rejected_types.present?
             str << "Content types #{@rejected_types.join(", ")} should be accepted by #{@attachment_name}" if @rejected_types.present?
           end
         end

data/lib/paperclip/missing_attachment_styles.rb

@@ -0,0 +1,86 @@
+
+require 'set'
+module Paperclip
+
+  class << self
+    attr_accessor :classes_with_attachments
+    attr_writer :registered_attachments_styles_path
+    def registered_attachments_styles_path
+      @registered_attachments_styles_path ||= Rails.root.join('public/system/paperclip_attachments.yml').to_s
+    end
+  end
+
+  self.classes_with_attachments = Set.new
+
+
+  # Get list of styles saved on previous deploy (running rake paperclip:refresh:missing_styles)
+  def self.get_registered_attachments_styles
+    YAML.load_file(Paperclip.registered_attachments_styles_path)
+  rescue Errno::ENOENT
+    nil
+  end
+  private_class_method :get_registered_attachments_styles
+
+  def self.save_current_attachments_styles!
+    File.open(Paperclip.registered_attachments_styles_path, 'w') do |f|
+      YAML.dump(current_attachments_styles, f)
+    end
+  end
+
+  # Returns hash with styles for all classes using Paperclip.
+  # Unfortunately current version does not work with lambda styles:(
+  #   {
+  #     :User => {:avatar => [:small, :big]},
+  #     :Book => {
+  #       :cover => [:thumb, :croppable]},
+  #       :sample => [:thumb, :big]},
+  #     }
+  #   }
+  def self.current_attachments_styles
+    Hash.new.tap do |current_styles|
+      Paperclip.classes_with_attachments.each do |klass|
+        klass.attachment_definitions.each do |attachment_name, attachment_attributes|
+          # TODO: is it even possible to take into account Procs?
+          next if attachment_attributes[:styles].kind_of?(Proc)
+          attachment_attributes[:styles].try(:keys).try(:each) do |style_name|
+            klass_sym = klass.to_s.to_sym
+            current_styles[klass_sym] ||= Hash.new
+            current_styles[klass_sym][attachment_name.to_sym] ||= Array.new
+            current_styles[klass_sym][attachment_name.to_sym] << style_name.to_sym
+            current_styles[klass_sym][attachment_name.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq!
+          end  
+        end  
+      end  
+    end
+  end
+  private_class_method :current_attachments_styles
+
+  # Returns hash with styles missing from recent run of rake paperclip:refresh:missing_styles
+  #   {
+  #     :User => {:avatar => [:big]},
+  #     :Book => {
+  #       :cover => [:croppable]},
+  #     }
+  #   }
+  def self.missing_attachments_styles
+    current_styles = current_attachments_styles
+    registered_styles = get_registered_attachments_styles
+
+    Hash.new.tap do |missing_styles|
+      current_styles.each do |klass, attachment_definitions|
+        attachment_definitions.each do |attachment_name, styles|
+          registered = registered_styles[klass][attachment_name] rescue []
+          missed = styles - registered 
+          if missed.present?
+            klass_sym = klass.to_s.to_sym
+            missing_styles[klass_sym] ||= Hash.new
+            missing_styles[klass_sym][attachment_name.to_sym] ||= Array.new
+            missing_styles[klass_sym][attachment_name.to_sym].concat(missed.to_a)
+            missing_styles[klass_sym][attachment_name.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq!
+          end
+        end
+      end  
+    end
+  end
+
+end

data/lib/paperclip/storage/filesystem.rb

@@ -46,6 +46,9 @@ module Paperclip
           end
           FileUtils.chmod(0666&~File.umask, path(style_name))
         end
+
+        after_flush_writes # allows attachment to clean up temp files
+
         @queued_for_write = {}
       end
 

data/lib/paperclip/storage/fog.rb

@@ -42,12 +42,15 @@ module Paperclip
 
         base.instance_eval do
           @fog_directory    = @options[:fog_directory]
-          @fog_credentials  = @options[:fog_credentials]
+          @fog_credentials  = parse_credentials(@options[:fog_credentials])
           @fog_host         = @options[:fog_host]
-          @fog_public       = @options[:fog_public] || true
+          @fog_public       = @options.key?(:fog_public) ? @options[:fog_public] : true
           @fog_file         = @options[:fog_file] || {}
 
-          @url = ':fog_public_url'
+          unless @url.to_s.match(/^:fog.*url$/)
+            @path  = @path.gsub(/:url/, @url)
+            @url   = ':fog_public_url'
+          end
           Paperclip.interpolates(:fog_public_url) do |attachment, style|
             attachment.public_url(style)
           end unless Paperclip::Interpolations.respond_to? :fog_public_url
@@ -79,6 +82,9 @@ module Paperclip
             retry
           end
         end
+
+        after_flush_writes # allows attachment to clean up temp files
+
         @queued_for_write = {}
       end
 
@@ -117,8 +123,27 @@ module Paperclip
         end
       end
 
+      def parse_credentials(creds)
+        creds = find_credentials(creds).stringify_keys
+        env = Object.const_defined?(:Rails) ? Rails.env : nil
+        (creds[env] || creds).symbolize_keys
+      end
+
       private
 
+      def find_credentials(creds)
+        case creds
+        when File
+          YAML::load(ERB.new(File.read(creds.path)).result)
+        when String, Pathname
+          YAML::load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          raise ArgumentError, "Credentials are not a path, file, or hash."
+        end
+      end
+
       def connection
         @connection ||= ::Fog::Storage.new(@fog_credentials)
       end
@@ -126,8 +151,6 @@ module Paperclip
       def directory
         @directory ||= connection.directories.new(:key => @fog_directory)
       end
-
     end
-
   end
 end

data/lib/paperclip/storage/s3.rb

@@ -196,6 +196,9 @@ module Paperclip
             raise
           end
         end
+
+        after_flush_writes # allows attachment to clean up temp files
+
         @queued_for_write = {}
       end
 

data/lib/paperclip/style.rb

@@ -49,6 +49,10 @@ module Paperclip
       attachment.send(:extra_options_for, name)
     end
 
+    def source_file_options
+      attachment.send(:extra_source_file_options_for, name)
+    end
+
     # returns the geometry string for this style
     # if a proc has been supplied, we call it here
     def geometry
@@ -63,7 +67,7 @@ module Paperclip
       @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|
+      [:processors, :geometry, :format, :whiny, :convert_options, :source_file_options].each do |k|
         (arg = send(k)) && args[k] = arg
       end
       args
@@ -72,7 +76,7 @@ module Paperclip
     # 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, :animated].include?(key)
+      if [:name, :convert_options, :whiny, :processors, :geometry, :format, :animated, :source_file_options].include?(key)
         send(key)
       elsif defined? @other_args[key]
         @other_args[key]
@@ -80,7 +84,7 @@ module Paperclip
     end
 
     def []=(key, value)
-      if [:name, :convert_options, :whiny, :processors, :geometry, :format, :animated].include?(key)
+      if [:name, :convert_options, :whiny, :processors, :geometry, :format, :animated, :source_file_options].include?(key)
         send("#{key}=".intern, value)
       else
         @other_args[key] = value

data/lib/paperclip/thumbnail.rb

@@ -14,14 +14,25 @@ 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 = {}, attachment = nil
+    #
+    # Options include:
+    #
+    #   +geometry+ - the desired width and height of the thumbnail (required)
+    #   +file_geometry_parser+ - an object with a method named +from_file+ that takes an image file and produces its geometry and a +transformation_to+. Defaults to Paperclip::Geometry
+    #   +string_geometry_parser+ - an object with a method named +parse+ that takes a string and produces an object with +width+, +height+, and +to_s+ accessors. Defaults to Paperclip::Geometry
+    #   +source_file_options+ - flags passed to the +convert+ command that influence how the source file is read
+    #   +convert_options+ - flags passed to the +convert+ command that influence how the image is processed
+    #   +whiny+ - whether to raise an error when processing fails. Defaults to true
+    #   +format+ - the desired filename extension
+    #   +animated+ - whether to merge all the layers in the image. Defaults to true
+    def initialize(file, options = {}, attachment = nil)
       super
 
-      geometry             = options[:geometry]
+      geometry             = options[:geometry] # this is not an option
       @file                = file
       @crop                = geometry[-1,1] == '#'
-      @target_geometry     = Geometry.parse geometry
-      @current_geometry    = Geometry.from_file @file
+      @target_geometry     = (options[:string_geometry_parser] || Geometry).parse(geometry)
+      @current_geometry    = (options[:file_geometry_parser] || Geometry).from_file(@file)
       @source_file_options = options[:source_file_options]
       @convert_options     = options[:convert_options]
       @whiny               = options[:whiny].nil? ? true : options[:whiny]

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module Paperclip
-  VERSION = "2.3.16" unless defined? Paperclip::VERSION
+  VERSION = "2.4.0" unless defined? Paperclip::VERSION
 end

data/lib/tasks/paperclip.rake

@@ -60,6 +60,22 @@ namespace :paperclip do
         end
       end
     end
+
+    desc "Regenerates missing thumbnail styles for all classes using Paperclip."
+    task :missing_styles => :environment do
+      # Force loading all model classes to never miss any has_attached_file declaration:
+      Dir[Rails.root + 'app/models/**/*.rb'].each { |path| load path }
+      Paperclip.missing_attachments_styles.each do |klass, attachment_definitions|
+        attachment_definitions.each do |attachment_name, missing_styles|
+          puts "Regenerating #{klass} -> #{attachment_name} -> #{missing_styles.inspect}"
+          ENV['CLASS'] = klass.to_s
+          ENV['ATTACHMENT'] = attachment_name.to_s
+          ENV['STYLES'] = missing_styles.join(',')
+          Rake::Task['paperclip:refresh:thumbnails'].execute
+        end
+      end  
+      Paperclip.save_current_attachments_styles!
+    end
   end
 
   desc "Cleans out invalid attachments. Useful after you've added new validations."

data/test/attachment_test.rb

@@ -263,6 +263,29 @@ class AttachmentTest < Test::Unit::TestCase
     end
   end
 
+  context "An attachment with :source_file_options" do
+    setup do
+      rebuild_model :styles => {
+                      :thumb => "100x100",
+                      :large => "400x400"
+                    },
+                    :source_file_options => {
+                      :all => "-density 400",
+                      :thumb => "-depth 8"
+                    }
+      @dummy = Dummy.new
+      @dummy.avatar
+    end
+
+    should "report the correct options when sent #extra_source_file_options_for(:thumb)" do
+      assert_equal "-depth 8 -density 400", @dummy.avatar.send(:extra_source_file_options_for, :thumb), @dummy.avatar.source_file_options.inspect
+    end
+
+    should "report the correct options when sent #extra_source_file_options_for(:large)" do
+      assert_equal "-density 400", @dummy.avatar.send(:extra_source_file_options_for, :large)
+    end
+  end
+
   context "An attachment with :only_process" do
     setup do
       rebuild_model :styles => {
@@ -424,6 +447,10 @@ class AttachmentTest < Test::Unit::TestCase
 
   context "An attachment with :processors that is a proc" do
     setup do
+      class Paperclip::Test < Paperclip::Processor; end
+      @file = StringIO.new("...")
+      Paperclip::Test.stubs(:make).returns(@file)
+
       rebuild_model :styles => { :normal => '' }, :processors => lambda { |a| [ :test ] }
       @attachment = Dummy.new.avatar
     end
@@ -476,7 +503,12 @@ class AttachmentTest < Test::Unit::TestCase
       end
 
       before_should "call #make with the right parameters passed as second argument" do
-        expected_params = @style_params[:once].merge({:processors => [:thumbnail, :test], :whiny => true, :convert_options => ""})
+        expected_params = @style_params[:once].merge({
+          :processors => [:thumbnail, :test],
+          :whiny => true,
+          :convert_options => "",
+          :source_file_options => ""
+        })
         Paperclip::Thumbnail.expects(:make).with(anything, expected_params, anything).returns(@file)
       end
 
@@ -1011,7 +1043,7 @@ class AttachmentTest < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "an attachment with delete_file option set to false" do
     setup do
       rebuild_model :preserve_files => true
@@ -1019,19 +1051,61 @@ class AttachmentTest < Test::Unit::TestCase
       @file = File.new(File.join(File.dirname(__FILE__), "fixtures", "5k.png"), 'rb')
       @dummy.avatar = @file
       @dummy.save!
-      @attachment = @dummy.avatar 
-      @path = @attachment.path      
+      @attachment = @dummy.avatar
+      @path = @attachment.path
     end
-    
-    should "not delete the files from storage when attachment is destroyed" do      
+
+    should "not delete the files from storage when attachment is destroyed" do
       @attachment.destroy
       assert File.exists?(@path)
     end
-    
-    should "not dleete the file when model is destroy" do
+
+    should "not delete the file when model is destroy" do
       @dummy.destroy
       assert File.exists?(@path)
     end
   end
 
+  context "setting an interpolation class" do
+    should "produce the URL with the given interpolations" do
+      Interpolator = Class.new do
+        def self.interpolate(pattern, attachment, style_name)
+          "hello"
+        end
+      end
+
+      instance = Dummy.new
+      attachment = Paperclip::Attachment.new(:avatar, instance, :interpolator => Interpolator)
+
+      assert_equal "hello", attachment.url
+    end
+  end
+
+  context "An attached file" do
+    setup do
+      rebuild_model
+      @dummy = Dummy.new
+      @file = File.new(File.join(File.dirname(__FILE__), "fixtures", "5k.png"), 'rb')
+      @dummy.avatar = @file
+      @dummy.save!
+      @attachment = @dummy.avatar
+      @path = @attachment.path
+    end
+
+    should "not be deleted when the model fails to destroy" do
+      @dummy.stubs(:destroy).raises(Exception)
+
+      assert_raise Exception do
+        @dummy.destroy
+      end
+
+      assert File.exists?(@path)
+    end
+
+    should "be deleted when the model is destroyed" do
+      @dummy.destroy
+      assert ! File.exists?(@path)
+    end
+  end
+
 end

data/test/fixtures/fog.yml

@@ -0,0 +1,8 @@
+development:
+    provider: AWS
+    aws_access_key_id: AWS_ID
+    aws_secret_access_key: AWS_SECRET
+test:
+    provider: AWS
+    aws_access_key_id: AWS_ID
+    aws_secret_access_key: AWS_SECRET

data/test/fog_test.rb

@@ -6,6 +6,67 @@ Fog.mock!
 class FogTest < Test::Unit::TestCase
   context "" do
 
+    context "with credentials provided in a path string" do
+      setup do
+        rebuild_model :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                      :storage => :fog,
+                      :url => '/:attachment/:filename',
+                      :fog_directory => "paperclip",
+                      :fog_credentials => File.join(File.dirname(__FILE__), 'fixtures', 'fog.yml')
+        @dummy = Dummy.new
+        @dummy.avatar = File.new(File.join(File.dirname(__FILE__), 'fixtures', '5k.png'), 'rb')
+      end
+
+      should "have the proper information loading credentials from a file" do
+        assert_equal @dummy.avatar.instance_variable_get("@fog_credentials")[:provider], 'AWS'
+      end
+    end
+
+    context "with credentials provided in a File object" do
+      setup do
+        rebuild_model :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                      :storage => :fog,
+                      :url => '/:attachment/:filename',
+                      :fog_directory => "paperclip",
+                      :fog_credentials => File.open(File.join(File.dirname(__FILE__), 'fixtures', 'fog.yml'))
+        @dummy = Dummy.new
+        @dummy.avatar = File.new(File.join(File.dirname(__FILE__), 'fixtures', '5k.png'), 'rb')
+      end
+
+      should "have the proper information loading credentials from a file" do
+        assert_equal @dummy.avatar.instance_variable_get("@fog_credentials")[:provider], 'AWS'
+      end
+    end
+
+    context "with default values for path and url" do
+      setup do
+        rebuild_model :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                      :storage => :fog,
+                      :url => '/:attachment/:filename',
+                      :fog_directory => "paperclip",
+                      :fog_credentials => {
+                        :provider => 'AWS',
+                        :aws_access_key_id => 'AWS_ID',
+                        :aws_secret_access_key => 'AWS_SECRET'
+                      }
+        @dummy = Dummy.new
+        @dummy.avatar = File.new(File.join(File.dirname(__FILE__), 'fixtures', '5k.png'), 'rb')
+      end
+      should "be able to interpolate the path without blowing up" do
+        puts @dummy.avatar.instance_variable_get("@path")
+        assert_equal File.expand_path(File.join(File.dirname(__FILE__), "../public/avatars/5k.png")),
+                     @dummy.avatar.path
+      end
+
+      should "clean up file objects" do
+        File.stubs(:exist?).returns(true)
+        Paperclip::Tempfile.any_instance.expects(:close).at_least_once()
+        Paperclip::Tempfile.any_instance.expects(:unlink).at_least_once()
+        
+        @dummy.save!
+      end
+    end
+
     setup do
       @fog_directory = 'papercliptests'
 
@@ -112,6 +173,19 @@ class FogTest < Test::Unit::TestCase
         end
       end
 
+      context "with fog_public set to false" do
+        setup do
+          rebuild_model(@options.merge(:fog_public => false))
+          @dummy = Dummy.new
+          @dummy.avatar = StringIO.new('.')
+          @dummy.save
+        end
+
+        should 'set the @fog_public instance variable to false' do
+          assert_equal false, @dummy.avatar.instance_variable_get('@fog_public')
+        end
+      end
+
     end
 
   end