ripta-dm-paperclip 2.2.9.2 → 2.5.0.1

data/README.rdoc

@@ -1,6 +1,6 @@
 =DataMapper Paperclip
 
-DM-Paperclip is a port of Thoughtbot's Paperclip plugin to work with DataMapper 0.9.  This plugin is fully compatible with
+DM-Paperclip is a port of Thoughtbot's Paperclip plugin to work with DataMapper.  This plugin is fully compatible with
 the original ActiveRecord-oriented Paperclip.  You could take an existing ActiveRecord database and use it with DataMapper.
 The module also includes updates validation handling and automatic including of the necessary 'property' fields into
 your model.
@@ -41,6 +41,17 @@ In your model:
                                    :thumb => "100x100>" }
   end
 
+You will need to add an initializer to configure Paperclip.  If on Rails, can add a config/initializers/paperclip.rb, on Merb
+can use config/init.rb and add it to the Merb::BootLoader.after_app_loads section.  Can also use environment configs, rackup
+file, Rake task, wherever.
+
+  Paperclip.configure do |config|
+    config.root               = Rails.root # the application root to anchor relative urls (defaults to Dir.pwd)
+    config.env                = Rails.env  # server env support, defaults to ENV['RACK_ENV'] or 'development'
+    config.use_dm_validations = true       # validate attachment sizes and such, defaults to false
+    config.processors_path    = 'lib/pc'   # relative path to look for processors, defaults to 'lib/paperclip_processors'
+  end
+
 Your database will need to add four columns, avatar_file_name (varchar), avatar_content_type (varchar), and
 avatar_file_size (integer), and avatar_updated_at (datetime).  You can either add these manually, auto-
 migrate, or use the following migration:

data/Rakefile

@@ -1,11 +1,14 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require(:development)
+
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
-require 'dm-core'
-require 'dm-validations'
 require 'dm-paperclip'
 
 desc 'Default: run unit tests.'
@@ -79,6 +82,11 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_tar = true 
 end
 
+desc 'Generate gemspec'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') { |f| f.puts(spec.to_ruby) }
+end
+
 WIN32 = (PLATFORM =~ /win32|cygwin/) rescue nil
 SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
 

data/lib/dm-paperclip.rb

@@ -25,7 +25,11 @@
 #
 # See the +has_attached_file+ documentation for more details.
 
+require 'erb'
 require 'tempfile'
+
+require 'dm-core'
+
 require 'dm-paperclip/upfile'
 require 'dm-paperclip/iostream'
 require 'dm-paperclip/geometry'
@@ -34,22 +38,70 @@ require 'dm-paperclip/thumbnail'
 require 'dm-paperclip/storage'
 require 'dm-paperclip/interpolations'
 require 'dm-paperclip/attachment'
-if defined? RAILS_ROOT
-  Dir.glob(File.join(File.expand_path(RAILS_ROOT), "lib", "paperclip_processors", "*.rb")).each do |processor|
-    require processor
-  end
-end
-
-# Only include validations if dm-validations is loaded
-require 'dm-paperclip/validations' unless defined?(DataMapper::Validate).nil?
 
 # The base module that gets included in ActiveRecord::Base. See the
 # documentation for Paperclip::ClassMethods for more useful information.
 module Paperclip
 
-  VERSION = "2.2.9.2"
+  VERSION = "2.5.0.1"
+
+  # To configure Paperclip, put this code in an initializer, Rake task, or wherever:
+  #
+  #   Paperclip.configure do |config|
+  #     config.root               = Rails.root # the application root to anchor relative urls (defaults to Dir.pwd)
+  #     config.env                = Rails.env  # server env support, defaults to ENV['RACK_ENV'] or 'development'
+  #     config.use_dm_validations = true       # validate attachment sizes and such, defaults to false
+  #     config.processors_path    = 'lib/pc'   # relative path to look for processors, defaults to 'lib/paperclip_processors'
+  #   end
+  #
+  def self.configure
+    yield @config = Configuration.new
+    Paperclip.config = @config
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.require_processors
+    return if @processors_already_required
+    Dir.glob(File.expand_path("#{Paperclip.config.processors_path}/*.rb")).sort.each do |processor|
+      require processor
+    end
+    @processors_already_required = true
+  end
+
+  class Configuration
+
+    DEFAULT_PROCESSORS_PATH = 'lib/paperclip_processors'
+
+    attr_writer   :root, :env
+    attr_accessor :use_dm_validations
+
+    def root
+      @root ||= Dir.pwd
+    end
+
+    def env
+      @env ||= (ENV['RACK_ENV'] || 'development')
+    end
+
+    def processors_path=(path)
+      @processors_path = File.expand_path(path, root)
+    end
+
+    def processors_path
+      @processors_path ||= File.expand_path("../#{DEFAULT_PROCESSORS_PATH}", root)
+    end
+
+  end
 
   class << self
+
     # Provides configurability to Paperclip. There are a number of options available, such as:
     # * whiny: Will raise an error if Paperclip cannot process thumbnails of 
     #   an uploaded image. Defaults to true.
@@ -121,7 +173,7 @@ module Paperclip
       name = name.to_s.camel_case
       processor = Paperclip.const_get(name)
       unless processor.ancestors.include?(Paperclip::Processor)
-        raise PaperclipError.new("Processor #{name} was not found")
+        raise PaperclipError.new("[paperclip] Processor #{name} was not found")
       end
       processor
     end
@@ -154,7 +206,9 @@ module Paperclip
   end
   
   module Resource
+
     def self.included(base)
+
       base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         class_variable_set(:@@attachment_definitions,nil) unless class_variable_defined?(:@@attachment_definitions)
         def self.attachment_definitions
@@ -165,8 +219,21 @@ module Paperclip
           @@attachment_definitions = obj
         end
       RUBY
+
       base.extend Paperclip::ClassMethods
+
+      # Done at this time to ensure that the user
+      # had a chance to configure the app in an initializer
+      if Paperclip.config.use_dm_validations
+        require 'dm-validations'
+        require 'dm-paperclip/validations'
+        base.extend Paperclip::Validate::ClassMethods
+      end
+
+      Paperclip.require_processors
+
     end
+
   end
 
   module ClassMethods
@@ -258,44 +325,12 @@ module Paperclip
         ! attachment_for(name).original_filename.blank?
       end
 
-      unless defined?(DataMapper::Validate).nil?
+      if Paperclip.config.use_dm_validations
         add_validator_to_context(opts_from_validator_args([name]), [name], Paperclip::Validate::CopyAttachmentErrors)
       end
-    end
-
-    unless defined?(DataMapper::Validate).nil?
-      # 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
-    
+
     # Returns the attachment definitions defined by each call to
     # has_attached_file.
     def attachment_definitions

data/lib/dm-paperclip/attachment.rb

@@ -7,7 +7,7 @@ module Paperclip
     def self.default_options
       @default_options ||= {
         :url           => "/system/:attachment/:id/:style/:filename",
-        :path          => ":web_root/public:url",
+        :path          => ":rails_root/public:url",
         :styles        => {},
         :default_url   => "/:attachment/:style/missing.png",
         :default_style => :original,
@@ -77,14 +77,16 @@ module Paperclip
       return nil if uploaded_file.nil?
 
       if uploaded_file.respond_to?(:[])
+        uploaded_file = uploaded_file.to_mash
+        
         @queued_for_write[:original]   = uploaded_file['tempfile']
-        instance_write(:file_name,       uploaded_file['filename'].strip.gsub(/[^\w\d\.\-]+/, '_')[/[^\\]+$/])
-        instance_write(:content_type,    uploaded_file['content_type'].strip)
-        instance_write(:file_size,       uploaded_file['size'].to_i)
+        instance_write(:file_name,       uploaded_file['filename'].strip.gsub(/[^\w\d\.\-]+/, '_'))
+        instance_write(:content_type,    uploaded_file['content_type'] ? uploaded_file['content_type'].strip : uploaded_file['tempfile'].content_type.to_s.strip)
+        instance_write(:file_size,       uploaded_file['size'] ? uploaded_file['size'].to_i : uploaded_file['tempfile'].size.to_i)
         instance_write(:updated_at,      Time.now)
       else
-        @queued_for_write[:original]   = uploaded_file.to_tempfile
-        instance_write(:file_name,       uploaded_file.original_filename.strip.gsub(/[^\w\d\.\-]+/, '_')[/[^\\]+$/])
+        @queued_for_write[:original]   = uploaded_file.tempfile
+        instance_write(:file_name,       uploaded_file.original_filename.strip.gsub(/[^\w\d\.\-]+/, '_'))
         instance_write(:content_type,    uploaded_file.content_type.to_s.strip)
         instance_write(:file_size,       uploaded_file.size.to_i)
         instance_write(:updated_at,      Time.now)
@@ -111,7 +113,7 @@ module Paperclip
     # update time appended to the url
     def url style = default_style, include_updated_timestamp = true
       the_url = original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style)
-      include_updated_timestamp && updated_at ? [the_url, updated_at].compact.join(the_url.include?("?") ? "&" : "?") : the_url
+      include_updated_timestamp && updated_at ? [the_url, updated_at.to_time.to_i].compact.join(the_url.include?("?") ? "&" : "?") : the_url
     end
 
     # Returns the path of the attachment as defined by the :path option. If the
@@ -272,8 +274,8 @@ module Paperclip
     end
 
     def valid_assignment? file #:nodoc:
-      if file.respond_to?(:[])
-        file[:filename] && file[:content_type]
+      if file.is_a?(Hash) || (defined?(Mash) && file.is_a?(Mash))
+        file[:filename] || file['filename']
       else
         file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
       end

data/lib/dm-paperclip/interpolations.rb

@@ -50,25 +50,25 @@ module Paperclip
     def timestamp attachment, style
       attachment.instance_read(:updated_at).to_s
     end
-    
+
     def web_root attachment, style
       if Object.const_defined?('Merb')
         merb_root(attachment, style)
-      elsif Object.const_defined("RAILS_ROOT")
+      elsif Object.const_defined("Rails")
         rails_root(attachment, style)
       else
         ""
       end
     end
 
-    # Returns the RAILS_ROOT constant.
+    # Returns the Rails.root constant.
     def rails_root attachment, style
-      Object.const_defined?('RAILS_ROOT') ? RAILS_ROOT : nil
+      Object.const_defined?('Rails') ? Rails.root : nil
     end
 
-    # Returns the RAILS_ENV constant.
+    # Returns the Rails.env constant.
     def rails_env attachment, style
-      Object.const_defined?('RAILS_ENV') ? RAILS_ENV : nil
+      Object.const_defined?('Rails') ? Rails.env : nil
     end
 
     def merb_root attachment, style
@@ -82,7 +82,7 @@ module Paperclip
     # Returns the snake cased, pluralized version of the class name.
     # e.g. "users" for the User class.
     def class attachment, style
-      attachment.instance.class.to_s.snake_case.pluralize
+      attachment.instance.class.to_s.underscore.pluralize
     end
 
     # Returns the basename of the file. e.g. "file" for "file.jpg"

data/lib/dm-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(File.basename(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
@@ -55,4 +56,4 @@ if defined? Tempfile
       end
     end
   end
-end
+end

data/lib/dm-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,18 +30,16 @@ 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
-      alias_method :to_io, :to_file
 
       def flush_writes #:nodoc:
-        @queued_for_write.each do |style, 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))
+        @queued_for_write.each do |style_name, file|
+          FileUtils.mkdir_p(File.dirname(path(style_name)))
+          log("saving #{path(style_name)}")
+          FileUtils.cp(file.path, path(style_name))
+          FileUtils.chmod(0644, path(style_name))
         end
         @queued_for_write = {}
       end
@@ -79,26 +77,26 @@ 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
-    #   'http' or 'https'. Defaults to 'http' when your :s3_permissions are 'public-read' (the
+    #   The default for Paperclip is :public_read.
+    # * +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}
     # * +bucket+: This is the name of the S3 bucket that will store your files. Remember
@@ -112,7 +110,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
@@ -128,19 +126,27 @@ module Paperclip
     #   separate parts of your file name.
     module S3
       def self.extended base
-        warn('[DEPRECATION] S3 support through RightAWS is deprecated. S3 support will ' +
-             'be changed to AWS::S3 in a future version.')
-        require 'right_aws'
+        begin
+          require 'aws/s3'
+        rescue LoadError => e
+          e.message << " (You may need to install the aws-s3 gem)"
+          raise e
+        end
+
         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')
+          @s3_permissions = @options[:s3_permissions] || :public_read
+          @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == :public_read ? 'http' : 'https')
           @s3_headers     = @options[:s3_headers]     || {}
           @s3_host_alias  = @options[:s3_host_alias]
           @url            = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
+          AWS::S3::Base.establish_connection!( @s3_options.merge(
+            :access_key_id => @s3_credentials[:access_key_id],
+            :secret_access_key => @s3_credentials[:secret_access_key]
+          ))
         end
         Paperclip.interpolates(:s3_alias_url) do |attachment, style|
           "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
@@ -152,15 +158,9 @@ module Paperclip
           "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
         end
       end
-
-      def s3
-        @s3 ||= RightAws::S3.new(@s3_credentials[:access_key_id],
-                                 @s3_credentials[:secret_access_key],
-                                 @s3_options)
-      end
-
-      def s3_bucket
-        @s3_bucket ||= s3.bucket(@bucket, true, @s3_permissions)
+      
+      def expiring_url(time = 3600)
+        AWS::S3::S3Object.url_for(path, bucket_name, :expires_in => time )
       end
 
       def bucket_name
@@ -172,16 +172,26 @@ module Paperclip
       end
 
       def parse_credentials creds
-        creds = find_credentials(creds).to_mash
+        creds = find_credentials(creds).to_mash.stringify_keys!
         if defined? Merb && Merb.respond_to?(:env)
-          (creds[Merb.env] || creds)
+          (creds[Merb.env] || creds).symbolize_keys
+        elsif defined? RAILS_ENV
+          (creds[RAILS_ENV] || creds).symbolize_keys
+        elsif defined? Rails && Rails.respond_to(:env)
+          (creds[Rails.env] || creds).symbolize_keys
+        elsif defined? RACK_ENV
+          (creds[RACK_ENV] || creds).symbolize_keys
         else
-          (creds[RAILS_ENV] || creds)
+          creds.symbolize_keys
         end
       end
-
+      
       def exists?(style = default_style)
-        s3_bucket.key(path(style)) ? true : false
+        if original_filename
+          AWS::S3::S3Object.exists?(path(style), bucket_name)
+        else
+          false
+        end
       end
 
       def s3_protocol
@@ -191,18 +201,24 @@ 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] || s3_bucket.key(path(style))
+        return @queued_for_write[style] if @queued_for_write[style]
+        file = Tempfile.new(path(style))
+        file.write(AWS::S3::S3Object.value(path(style), bucket_name))
+        file.rewind
+        return file
       end
-      alias_method :to_io, :to_file
 
       def flush_writes #:nodoc:
         @queued_for_write.each do |style, file|
           begin
             log("saving #{path(style)}")
-            key = s3_bucket.key(path(style))
-            key.data = file
-            key.put(nil, @s3_permissions, {'Content-type' => instance_read(:content_type)}.merge(@s3_headers))
-          rescue RightAws::AwsError => e
+            AWS::S3::S3Object.store(path(style),
+                                    file,
+                                    bucket_name,
+                                    {:content_type => instance_read(:content_type),
+                                     :access => @s3_permissions,
+                                    }.merge(@s3_headers))
+          rescue AWS::S3::ResponseError => e
             raise
           end
         end
@@ -213,22 +229,20 @@ module Paperclip
         @queued_for_delete.each do |path|
           begin
             log("deleting #{path}")
-            if file = s3_bucket.key(path)
-              file.delete
-            end
-          rescue RightAws::AwsError
+            AWS::S3::S3Object.delete(path, bucket_name)
+          rescue AWS::S3::ResponseError
             # Ignore this.
           end
         end
         @queued_for_delete = []
       end
-
+      
       def find_credentials creds
         case creds
         when File
-          YAML.load_file(creds.path)
+          YAML::load(ERB.new(File.read(creds.path)).result)
         when String
-          YAML.load_file(creds)
+          YAML::load(ERB.new(File.read(creds)).result)
         when Hash
           creds
         else