samlown-carrierwave 0.4.5

data/features/versions_overriden_store_dir.feature

@@ -0,0 +1,41 @@
+Feature: uploader with file storage and versions with overridden store dir
+  In order to be awesome
+  As a developer using CarrierWave
+  I want to upload files to the filesystem
+  
+  Background:
+    Given an uploader class that uses the 'file' storage
+    And that the uploader class has a version named 'thumb'
+    And that the version 'thumb' has the store_dir overridden to 'public/monkey/llama'
+    And an instance of that class
+  
+  Scenario: store a file
+    When I store the file 'fixtures/bork.txt'
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/monkey/llama/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/monkey/llama/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+  
+  Scenario: cache a file and then store it
+    When I cache the file 'fixtures/bork.txt'
+    Then there should be a file called 'bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    Then there should be a file called 'thumb_bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    And the file called 'bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+    And the file called 'thumb_bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+    And there should not be a file at 'public/uploads/bork.txt'
+    And there should not be a file at 'public/monkey/llama/thumb_bork.txt'
+    When I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/monkey/llama/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/monkey/llama/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+  
+  Scenario: retrieving a file from cache then storing
+    Given the file 'fixtures/bork.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/bork.txt'
+    Given the file 'fixtures/monkey.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_bork.txt'
+    When I retrieve the cache name '20090212-2343-8336-0348/bork.txt' from the cache
+    And I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/monkey/llama/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/monkey/llama/thumb_bork.txt' should be identical to the file at 'fixtures/monkey.txt'

data/lib/carrierwave.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require 'fileutils'
+require 'carrierwave/core_ext/blank'
+require 'carrierwave/core_ext/module_setup'
+require 'carrierwave/core_ext/inheritable_attributes'
+require 'carrierwave/core_ext/file'
+
+module CarrierWave
+
+  VERSION = "0.4.5"
+
+  class << self
+    attr_accessor :root
+
+    def configure(&block)
+      CarrierWave::Uploader::Base.configure(&block)
+    end
+
+    def clean_cached_files!
+      CarrierWave::Uploader::Base.clean_cached_files!
+    end
+  end
+
+  class UploadError < StandardError; end
+  class IntegrityError < UploadError; end
+  class InvalidParameter < UploadError; end
+  class ProcessingError < UploadError; end
+  class DownloadError < UploadError; end
+
+  autoload :SanitizedFile, 'carrierwave/sanitized_file'
+  autoload :Mount, 'carrierwave/mount'
+  autoload :RMagick, 'carrierwave/processing/rmagick'
+  autoload :ImageScience, 'carrierwave/processing/image_science'
+  autoload :MiniMagick, 'carrierwave/processing/mini_magick'
+
+  module Storage
+    autoload :Abstract, 'carrierwave/storage/abstract'
+    autoload :File, 'carrierwave/storage/file'
+    autoload :S3, 'carrierwave/storage/s3'
+    autoload :GridFS, 'carrierwave/storage/grid_fs'
+    autoload :RightS3, 'carrierwave/storage/right_s3'
+    autoload :CloudFiles, 'carrierwave/storage/cloud_files'
+  end
+
+  module Uploader
+    autoload :Base, 'carrierwave/uploader'
+    autoload :Cache, 'carrierwave/uploader/cache'
+    autoload :Store, 'carrierwave/uploader/store'
+    autoload :Download, 'carrierwave/uploader/download'
+    autoload :Callbacks, 'carrierwave/uploader/callbacks'
+    autoload :Processing, 'carrierwave/uploader/processing'
+    autoload :Versions, 'carrierwave/uploader/versions'
+    autoload :Remove, 'carrierwave/uploader/remove'
+    autoload :ExtensionWhitelist, 'carrierwave/uploader/extension_whitelist'
+    autoload :DefaultUrl, 'carrierwave/uploader/default_url'
+    autoload :Proxy, 'carrierwave/uploader/proxy'
+    autoload :Url, 'carrierwave/uploader/url'
+    autoload :Mountable, 'carrierwave/uploader/mountable'
+    autoload :Configuration, 'carrierwave/uploader/configuration'
+  end
+
+  module Compatibility
+    autoload :Paperclip, 'carrierwave/compatibility/paperclip'
+  end
+
+  module Test
+    autoload :Matchers, 'carrierwave/test/matchers'
+  end
+
+end
+
+if defined?(Merb)
+
+  CarrierWave.root = Merb.dir_for(:public)
+  Merb::BootLoader.before_app_loads do
+    # 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
+
+elsif defined?(Rails)
+
+  CarrierWave.root = File.join(Rails.root, 'public')
+  ActiveSupport::Dependencies.load_paths << File.join(Rails.root, "app", "uploaders")
+
+elsif defined?(Sinatra)
+
+  CarrierWave.root = Sinatra::Application.public
+
+end
+
+
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'activerecord') if defined?(ActiveRecord)
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'datamapper') if defined?(DataMapper)
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'sequel') if defined?(Sequel)
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongomapper") if defined?(MongoMapper)
+require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongoid") if defined?(Mongoid)

data/lib/carrierwave/compatibility/paperclip.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+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
+    #
+    # ---
+    #
+    # 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 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| Rails.root },
+          :rails_env    => lambda{|u, f| Rails.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/blank.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+unless "".respond_to?(:blank?)
+  # blank? methods for several different class types
+  class Object
+    # Returns true if the object is nil or empty (if applicable)
+    def blank?
+      nil? || (respond_to?(:empty?) && empty?)
+    end
+  end # class Object
+
+  class Numeric
+    # Numerics can't be blank
+    def blank?
+      false
+    end
+  end # class Numeric
+
+  class NilClass
+    # Nils are always blank
+    def blank?
+      true
+    end
+  end # class NilClass
+
+  class TrueClass
+    # True is not blank.
+    def blank?
+      false
+    end
+  end # class TrueClass
+
+  class FalseClass
+    # False is always blank.
+    def blank?
+      true
+    end
+  end # class FalseClass
+
+  class String
+    # Strips out whitespace then tests if the string is empty.
+    def blank?
+      strip.empty?
+    end
+  end # class String
+end

data/lib/carrierwave/core_ext/file.rb

@@ -0,0 +1,11 @@
+class File
+  def size
+    File.size(path)
+  end
+
+  def empty?
+    size == 0
+  rescue Errno::ENOENT
+    false
+  end
+end

data/lib/carrierwave/core_ext/inheritable_attributes.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+# 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, &block)
+    options = ivars.extract_options!
+
+    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.duplicable? ? ivar.dup : ivar
+        end
+      RUBY
+      unless options[:instance_reader] == false
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ivar}
+            self.class.#{ivar}
+          end
+      RUBY
+      end
+      instance_variable_set(:"@#{ivar}", yield) if block_given?
+    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)
+    options = ivars.extract_options!
+
+    ivars.each do |ivar|
+      self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{ivar}=(obj)
+          @#{ivar} = obj
+        end
+      RUBY
+      unless options[:instance_writer] == false
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ivar}=(obj) self.class.#{ivar} = obj end
+        RUBY
+      end
+
+      self.send("#{ivar}=", yield) if block_given?
+    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, &block)
+    extlib_inheritable_reader(*syms)
+    extlib_inheritable_writer(*syms, &block)
+  end
+end

data/lib/carrierwave/core_ext/module_setup.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+# 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