carrierwave 0.2.1 → 0.2.3

data/README.rdoc

@@ -36,9 +36,7 @@ this should give you a file in:
 
 Check out this file for some hints on how you can customize your uploader. It should look something like this:
 
-    class AvatarUploader
-      include CarrierWave::Uploader
-
+    class AvatarUploader < CarrierWave::Uploader::Base
       storage :file
     end
 
@@ -97,9 +95,7 @@ Now you can cache files by assigning them to the attribute, they will automatica
 
 In order to change where uploaded files are put, just override the +store_dir+ method:
 
-    class MyUploader
-      include CarrierWave::Uploader
-
+    class MyUploader < CarrierWave::Uploader::Base
       def store_dir
         'public/my/upload/directory'
       end
@@ -111,10 +107,9 @@ This works for the file storage as well as Amazon S3.
 
 Often you'll want to add different versions of the same file. The classic example is image thumbnails. There is built in support for this:
 
-    class MyUploader
-      include CarrierWave::Uploader
+    class MyUploader < CarrierWave::Uploader::Base
       include CarrierWave::RMagick
-      
+
       process :resize => [800, 800]
 
       version :thumb do
@@ -135,8 +130,7 @@ One important thing to remember is that process is called *before* versions are
 
 It is possible to nest versions within versions:
 
-    class MyUploader
-      include CarrierWave::Uploader
+    class MyUploader < CarrierWave::Uploader::Base
 
       version :animal do
         version :human
@@ -174,6 +168,16 @@ in the case of images, a small thumbnail would be a good indicator:
 
 NOTE: this feature currently requires write access to your filesystem. If write access is unavailable (e.g. Heroku) you will not be able to upload files. You can prevent CarrierWave from writing to the file system by setting `CarrierWave.config[:cache_to_cache_dir] = false`. This will however break redisplays of forms.
 
+== Providing a default path
+
+In many cases, especially when working with images, it might be a good idea to provide a default path, a fallback in case no file has been uploaded. You can do this easily by overriding the +default_path+ method in your uploader:
+
+    class MyUploader < CarrierWave::Uploader::Base
+      def default_path
+        "images/fallback/" + [version_name, "default.png"].compact.join('_')
+      end
+    end
+
 == Using Amazon S3
 
 You'll need to configure a bucket, access id and secret key like this:
@@ -186,9 +190,7 @@ Do this in an initializer in Rails, and in a +before_app_loads+ block in Merb.
 
 And then in your uploader, set the storage to :s3
 
-    class AvatarUploader
-      include CarrierWave::Uploader
-
+    class AvatarUploader < 
       storage :s3
     end
 
@@ -198,15 +200,13 @@ That's it! You can still use the +CarrierWave::Uploader#url+ method to return th
 
 If you're uploading images, you'll probably want to manipulate them in some way, you might want to create thumbnail images for example. CarrierWave comes with a small library to make manipulating images with RMagick easier, you'll need to include it in your Uploader:
 
-    class AvatarUploader
-      include CarrierWave::Uploader
+    class AvatarUploader < CarrierWave::Uploader::Base
       include CarrierWave::RMagick
     end
 
 The RMagick module gives you a few methods, like +CarrierWave::RMagick#crop_resized+ which manipulate the image file in some way. You can set a +process+ callback, which will call that method any time a file is uploaded.
 
-    class AvatarUploader
-      include CarrierWave::Uploader
+    class AvatarUploader < CarrierWave::Uploader::Base
       include CarrierWave::RMagick
       
       process :crop_resized => [200, 200]
@@ -223,13 +223,28 @@ Check out the manipulate! method, which makes it easy for you to write your own
 
 ImageScience works the same way as RMagick.
 
-    class AvatarUploader
-      include CarrierWave::Uploader
+    class AvatarUploader < CarrierWave::Uploader::Base
       include CarrierWave::ImageScience
       
       process :crop_resized => [200, 200]
     end
 
+== Migrating
+
+If you are using Paperclip, you can use the provided compatibility module:
+
+    class AvatarUploader < CarrierWave::Uploader::Base
+      include CarrierWave::Compatibility::Paperclip
+    end
+
+See the documentation for +Paperclip::Compatibility::Paperclip+ for more detaills.
+
+Be sure to use mount_on to specify the correct column:
+
+    mount_uploader :avatar, AvatarUploader, :mount_on => :avatar_file_name
+
+Unfortunately AttachmentFoo differs too much in philosophy for there to be a sensible compatibility mode. Patches for migrating from other solutions will be happily accepted.
+
 == Documentation
 
 Full rdoc documentation is {available at Rubyforge}[http://carrierwave.rubyforge.org/].

data/Rakefile

@@ -9,7 +9,7 @@ require 'spec/rake/spectask'
 require 'cucumber/rake/task'
 
 NAME = "carrierwave"
-GEM_VERSION = "0.2.1"
+GEM_VERSION = "0.2.3"
 AUTHOR = "Jonas Nicklas"
 EMAIL = "jonas.nicklas@gmail.com"
 HOMEPAGE = "http://www.example.com"

data/lib/carrierwave.rb

@@ -1,8 +1,27 @@
 require 'fileutils'
+require 'carrierwave/core_ext/module_setup'
+require 'carrierwave/core_ext/inheritable_attributes'
 
 module CarrierWave
   class << self
-    attr_accessor :config
+    attr_accessor :config, :logger
+
+    def logger
+      return @logger if @logger
+      require 'logger'
+      @logger = Logger.new(STDOUT)
+    end
+
+    ##
+    # Generates a unique cache id for use in the caching system
+    #
+    # === Returns
+    #
+    # [String] a cache id in the format YYYYMMDD-HHMM-PID-RND
+    #
+    def generate_cache_id
+      Time.now.strftime('%Y%m%d-%H%M') + '-' + Process.pid.to_s + '-' + ("%04d" % rand(9999))
+    end
   end
 
   class UploadError < StandardError; end
@@ -18,7 +37,6 @@ module CarrierWave
   class ProcessingError < UploadError; end
 
   autoload :SanitizedFile, 'carrierwave/sanitized_file'
-  autoload :Uploader, 'carrierwave/uploader'
   autoload :Mount, 'carrierwave/mount'
   autoload :RMagick, 'carrierwave/processing/rmagick'
   autoload :ImageScience, 'carrierwave/processing/image_science'
@@ -29,6 +47,26 @@ module CarrierWave
     autoload :S3, 'carrierwave/storage/s3'
   end
 
+  module Uploader
+    autoload :Base, 'carrierwave/uploader'
+    autoload :Cache, 'carrierwave/uploader/cache'
+    autoload :Store, 'carrierwave/uploader/store'
+    autoload :Callbacks, 'carrierwave/uploader/callbacks'
+    autoload :Processing, 'carrierwave/uploader/processing'
+    autoload :Versions, 'carrierwave/uploader/versions'
+    autoload :Remove, 'carrierwave/uploader/remove'
+    autoload :Paths, 'carrierwave/uploader/paths'
+    autoload :ExtensionWhitelist, 'carrierwave/uploader/extension_whitelist'
+    autoload :DefaultPath, 'carrierwave/uploader/default_path'
+    autoload :Proxy, 'carrierwave/uploader/proxy'
+    autoload :Url, 'carrierwave/uploader/url'
+    autoload :Mountable, 'carrierwave/uploader/mountable'
+  end
+
+  module Compatibility
+    autoload :Paperclip, 'carrierwave/compatibility/paperclip'
+  end
+
   module Test
     autoload :Matchers, 'carrierwave/test/matchers'
   end
@@ -57,20 +95,30 @@ CarrierWave.config = {
   }
 }
 
-if defined?(Merb)
-
+if defined?(Merb::Plugins)
   CarrierWave.config[:root] = Merb.root
   CarrierWave.config[:public] = Merb.dir_for(:public)
 
+  Merb::BootLoader.before_app_loads do
+    # Set logger
+    CarrierWave.logger ||= Merb.logger
+    # Setup path for uploaders and load all of them before classes are loaded
+    Merb.push_path(:uploaders, Merb.root / 'app' / 'uploaders', '*.rb')
+    Dir.glob(File.join(Merb.load_paths[:uploaders])).each {|f| require f }
+  end
+
   orm_path = File.dirname(__FILE__) / 'carrierwave' / 'orm' / Merb.orm
   require orm_path if File.exist?(orm_path + '.rb')
 
-  Merb.push_path(:uploader, Merb.root / "app" / "uploaders")
-
   Merb.add_generators File.dirname(__FILE__) / 'generators' / 'uploader_generator'
 
 elsif defined?(Rails)
-
+  begin
+    CarrierWave.logger = Rails.logger
+  rescue
+    # Rails < 2.1
+    CarrierWave.logger = RAILS_DEFAULT_LOGGER
+  end
   CarrierWave.config[:root] = Rails.root
   CarrierWave.config[:public] = File.join(Rails.root, 'public')
 

data/lib/carrierwave/compatibility/paperclip.rb

@@ -0,0 +1,91 @@
+# This file contains code taken from Paperclip
+# 
+# LICENSE
+# 
+# The MIT License
+# 
+# Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module CarrierWave
+  module Compatibility
+
+    ##
+    # Mix this module into an Uploader to make it mimic Paperclip's storage paths
+    # This will make your Uploader use the same default storage path as paperclip
+    # does. If you need to override it, you can override the +paperclip_path+ method
+    # and provide a Paperclip style path:
+    #
+    #     class MyUploader < CarrierWave::Uploader::Base
+    #       include CarrierWave::Compatibility::Paperclip
+    #       
+    #       def paperclip_path
+    #         ":rails_root/public/uploads/:id/:attachment/:style_:basename.:extension"
+    #       end
+    #     end
+    #
+    module Paperclip
+
+      def store_path(for_file=filename)
+        path = paperclip_path
+        path ||= File.join(*[store_dir, paperclip_style.to_s, for_file].compact)
+        interpolate_paperclip_path(path, for_file)
+      end
+
+      def store_dir
+        ":rails_root/public/system/:attachment/:id"
+      end
+
+      def paperclip_default_style
+        :original
+      end
+
+      def paperclip_path
+      end
+
+      def paperclip_style
+        version_name || paperclip_default_style
+      end
+
+    private
+
+      def interpolate_paperclip_path(path, filename)
+        mappings.inject(path) do |agg, pair|
+          agg.gsub(":#{pair[0]}", pair[1].call(self, filename).to_s)
+        end
+      end
+
+      def mappings
+        {
+          :rails_root   => lambda{|u, f| CarrierWave.config[:root] },
+          :rails_env    => lambda{|u, f| CarrierWave.config[:env] },
+          :class        => lambda{|u, f| u.model.class.name.underscore.pluralize},
+          :id           => lambda{|u, f| u.model.id },
+          :id_partition => lambda{|u, f| ("%09d" % u.model.id).scan(/\d{3}/).join("/")},
+          :attachment   => lambda{|u, f| u.mounted_as.to_s.downcase.pluralize },
+          :style        => lambda{|u, f| u.paperclip_style },
+          :basename     => lambda{|u, f| f.gsub(/#{File.extname(f)}$/, "") },
+          :extension    => lambda{|u, f| File.extname(f).gsub(/^\.+/, "")}
+        }
+      end
+
+    end # Paperclip
+  end # Compatibility
+end # CarrierWave

data/lib/carrierwave/core_ext/inheritable_attributes.rb

@@ -0,0 +1,102 @@
+# Stolen from Rails 3
+
+# Copyright (c) 2005-2009 David Heinemeier Hansson
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Retain for backward compatibility.  Methods are now included in Class.
+class Class
+  # Defines class-level inheritable attribute reader. Attributes are available to subclasses,
+  # each subclass has a copy of parent's attribute.
+  #
+  # @param *syms<Array[#to_s]> Array of attributes to define inheritable reader for.
+  # @return <Array[#to_s]> Array of attributes converted into inheritable_readers.
+  #
+  # @api public
+  #
+  # @todo Do we want to block instance_reader via :instance_reader => false
+  # @todo It would be preferable that we do something with a Hash passed in
+  #   (error out or do the same as other methods above) instead of silently
+  #   moving on). In particular, this makes the return value of this function
+  #   less useful.
+  def extlib_inheritable_reader(*ivars)
+    instance_reader = ivars.pop[:reader] if ivars.last.is_a?(Hash)
+
+    ivars.each do |ivar|
+      self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{ivar}
+          return @#{ivar} if self.object_id == #{self.object_id} || defined?(@#{ivar})
+          ivar = superclass.#{ivar}
+          return nil if ivar.nil? && !#{self}.instance_variable_defined?("@#{ivar}")
+          @#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) && !ivar.is_a?(TrueClass) && !ivar.is_a?(FalseClass) ? ivar.dup : ivar
+        end
+      RUBY
+      unless instance_reader == false
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ivar}
+            self.class.#{ivar}
+          end
+        RUBY
+      end
+    end
+  end
+
+  # Defines class-level inheritable attribute writer. Attributes are available to subclasses,
+  # each subclass has a copy of parent's attribute.
+  #
+  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to
+  #   define inheritable writer for.
+  # @option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined.
+  # @return <Array[#to_s]> An Array of the attributes that were made into inheritable writers.
+  #
+  # @api public
+  #
+  # @todo We need a style for class_eval <<-HEREDOC. I'd like to make it
+  #   class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.
+  def extlib_inheritable_writer(*ivars)
+    instance_writer = ivars.pop[:writer] if ivars.last.is_a?(Hash)
+    ivars.each do |ivar|
+      self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{ivar}=(obj)
+          @#{ivar} = obj
+        end
+      RUBY
+      unless instance_writer == false
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ivar}=(obj) self.class.#{ivar} = obj end
+        RUBY
+      end
+    end
+  end
+
+  # Defines class-level inheritable attribute accessor. Attributes are available to subclasses,
+  # each subclass has a copy of parent's attribute.
+  #
+  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to
+  #   define inheritable accessor for.
+  # @option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined.
+  # @return <Array[#to_s]> An Array of attributes turned into inheritable accessors.
+  #
+  # @api public
+  def extlib_inheritable_accessor(*syms)
+    extlib_inheritable_reader(*syms)
+    extlib_inheritable_writer(*syms)
+  end
+end

data/lib/carrierwave/core_ext/module_setup.rb

@@ -0,0 +1,49 @@
+# Stolen from Rails 3
+
+# Copyright (c) 2005-2009 David Heinemeier Hansson
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class Module
+  attr_accessor :_setup_block
+  attr_accessor :_dependencies
+  
+  def setup(&blk)
+    @_setup_block = blk
+  end
+  
+  def use(mod)
+    return if self < mod
+    
+    (mod._dependencies || []).each do |dep|
+      use dep
+    end
+    # raise "Circular dependencies" if self < mod
+    include mod
+    extend mod.const_get("ClassMethods") if mod.const_defined?("ClassMethods")
+    class_eval(&mod._setup_block) if mod._setup_block
+  end
+  
+  def depends_on(mod)
+    return if self < mod
+    @_dependencies ||= []
+    @_dependencies << mod
+  end
+end