carrierwave-rails3 0.4.5

data/lib/carrierwave/test/matchers.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Test
+
+    ##
+    # These are some matchers that can be used in RSpec specs, to simplify the testing
+    # of uploaders.
+    #
+    module Matchers
+
+      class BeIdenticalTo # :nodoc:
+        def initialize(expected)
+          @expected = expected
+        end
+        def matches?(actual)
+          @actual = actual
+          FileUtils.identical?(@actual, @expected)
+        end
+        def failure_message
+          "expected #{@actual.inspect} to be identical to #{@expected.inspect}"
+        end
+        def negative_failure_message
+          "expected #{@actual.inspect} to not be identical to #{@expected.inspect}"
+        end
+      end
+
+      def be_identical_to(expected)
+        BeIdenticalTo.new(expected)
+      end
+
+      class HavePermissions # :nodoc:
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          (File.stat(@actual.path).mode & 0777) == @expected
+        end
+
+        def failure_message
+          "expected #{@actual.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0777).to_s(8)}"
+        end
+
+        def negative_failure_message
+          "expected #{@actual.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
+        end
+      end
+
+      def have_permissions(expected)
+        HavePermissions.new(expected)
+      end
+
+      class BeNoLargerThan # :nodoc:
+        def initialize(width, height)
+          @width, @height = width, height
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          image = ImageLoader.load_image(@actual.current_path)
+          @actual_width = image.width
+          @actual_height = image.height
+          @actual_width <= @width && @actual_height <= @height
+        end
+
+        def failure_message
+          "expected #{@actual.current_path.inspect} to be no larger than #{@width} by #{@height}, but it was #{@actual_width} by #{@actual_height}."
+        end
+
+        def negative_failure_message
+          "expected #{@actual.current_path.inspect} to be larger than #{@width} by #{@height}, but it wasn't."
+        end
+
+      end
+
+      def be_no_larger_than(width, height)
+        BeNoLargerThan.new(width, height)
+      end
+
+      class HaveDimensions # :nodoc:
+        def initialize(width, height)
+          @width, @height = width, height
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          image = ImageLoader.load_image(@actual.current_path)
+          @actual_width = image.width
+          @actual_height = image.height
+          @actual_width == @width && @actual_height == @height
+        end
+
+        def failure_message
+          "expected #{@actual.current_path.inspect} to have an exact size of #{@width} by #{@height}, but it was #{@actual_width} by #{@actual_height}."
+        end
+
+        def negative_failure_message
+          "expected #{@actual.current_path.inspect} not to have an exact size of #{@width} by #{@height}, but it did."
+        end
+
+      end
+
+      def have_dimensions(width, height)
+        HaveDimensions.new(width, height)
+      end
+
+      class ImageLoader # :nodoc:
+        def self.load_image(filename)
+          if defined? MiniMagick
+            MiniMagickWrapper.new(filename)
+          else
+            unless defined? Magick
+              begin
+                require 'rmagick'
+              rescue LoadError
+                require 'RMagick'
+              rescue LoadError
+                puts "WARNING: Failed to require rmagick, image processing may fail!"
+              end
+            end
+            MagickWrapper.new(filename)
+          end
+        end
+      end
+
+      class MagickWrapper # :nodoc:
+        attr_reader :image
+        def width
+          image.columns
+        end
+
+        def height
+          image.rows
+        end
+
+        def initialize(filename)
+          @image = ::Magick::Image.read(filename).first
+        end
+      end
+
+      class MiniMagickWrapper # :nodoc:
+        attr_reader :image
+        def width
+          image[:width]
+        end
+
+        def height
+          image[:height]
+        end
+
+        def initialize(filename)
+          @image = ::MiniMagick::Image.from_file(filename)
+        end
+      end
+
+    end # Matchers
+  end # Test
+end # CarrierWave
+

data/lib/carrierwave/uploader.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module CarrierWave
+
+  ##
+  # See CarrierWave::Uploader::Base
+  #
+  module Uploader
+
+    ##
+    # An uploader is a class that allows you to easily handle the caching and storage of
+    # uploaded files. Please refer to the README for configuration options.
+    #
+    # Once you have an uploader you can use it in isolation:
+    #
+    #     my_uploader = MyUploader.new
+    #     my_uploader.cache!(File.open(path_to_file))
+    #     my_uploader.retrieve_from_store!('monkey.png')
+    #
+    # Alternatively, you can mount it on an ORM or other persistence layer, with
+    # +CarrierWave::Mount#mount_uploader+. There are extensions for activerecord and datamapper
+    # these are *very* simple (they are only a dozen lines of code), so adding your own should
+    # be trivial.
+    #
+    class Base
+      attr_reader :file
+
+      include CarrierWave::Uploader::Callbacks
+      include CarrierWave::Uploader::Proxy
+      include CarrierWave::Uploader::Url
+      include CarrierWave::Uploader::Mountable
+      include CarrierWave::Uploader::Cache
+      include CarrierWave::Uploader::Store
+      include CarrierWave::Uploader::Download
+      include CarrierWave::Uploader::Remove
+      include CarrierWave::Uploader::ExtensionWhitelist
+      include CarrierWave::Uploader::Processing
+      include CarrierWave::Uploader::Versions
+      include CarrierWave::Uploader::DefaultUrl
+      include CarrierWave::Uploader::Configuration
+    end # Base
+
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/cache.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+module CarrierWave
+
+  class FormNotMultipart < UploadError
+    def message
+      "You tried to assign a String or a Pathname to an uploader, for security reasons, this is not allowed.\n\n If this is a file upload, please check that your upload form is multipart encoded."
+    end
+  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 self.generate_cache_id
+    Time.now.strftime('%Y%m%d-%H%M') + '-' + Process.pid.to_s + '-' + ("%04d" % rand(9999))
+  end
+
+  module Uploader
+    module Cache
+      extend ActiveSupport::Concern
+
+      include CarrierWave::Uploader::Callbacks
+      include CarrierWave::Uploader::Configuration
+
+      module ClassMethods
+
+        ##
+        # Removes cached files which are older than one day. You could call this method
+        # from a rake task to clean out old cached files.
+        #
+        # You can call this method directly on the module like this:
+        #
+        #   CarrierWave.clean_cached_files!
+        #
+        # === Note
+        # 
+        # This only works as long as you haven't done anything funky with your cache_dir.
+        # It's recommended that you keep cache files in one place only.
+        #
+        def clean_cached_files!
+          Dir.glob(File.expand_path(File.join(cache_dir, '*'), CarrierWave.root)).each do |dir|
+            time = dir.scan(/(\d{4})(\d{2})(\d{2})-(\d{2})(\d{2})/).first.map { |t| t.to_i }
+            time = Time.utc(*time)
+            if time < (Time.now - (60*60*24))
+              FileUtils.rm_rf(dir)
+            end
+          end
+        end
+      end
+
+      ##
+      # Returns true if the uploader has been cached
+      #
+      # === Returns
+      #
+      # [Bool] whether the current file is cached
+      #
+      def cached?
+        @cache_id
+      end
+
+      ##
+      # Returns a String which uniquely identifies the currently cached file for later retrieval
+      #
+      # === Returns
+      #
+      # [String] a cache name, in the format YYYYMMDD-HHMM-PID-RND/filename.txt
+      #
+      def cache_name
+        File.join(cache_id, full_original_filename) if cache_id and original_filename
+      end
+
+      ##
+      # Caches the given file. Calls process! to trigger any process callbacks.
+      #
+      # === Parameters
+      #
+      # [new_file (File, IOString, Tempfile)] any kind of file object
+      #
+      # === Raises
+      #
+      # [CarrierWave::FormNotMultipart] if the assigned parameter is a string
+      #
+      def cache!(new_file)
+        new_file = CarrierWave::SanitizedFile.new(new_file)
+        raise CarrierWave::FormNotMultipart if new_file.is_path?
+
+        unless new_file.empty?
+          with_callbacks(:cache, new_file) do
+            self.cache_id = CarrierWave.generate_cache_id unless cache_id
+
+            @filename = new_file.filename
+            self.original_filename = new_file.filename
+
+            @file = new_file.copy_to(cache_path, permissions)
+          end
+        end
+      end
+
+      ##
+      # Retrieves the file with the given cache_name from the cache.
+      #
+      # === Parameters
+      #
+      # [cache_name (String)] uniquely identifies a cache file
+      #
+      # === Raises
+      #
+      # [CarrierWave::InvalidParameter] if the cache_name is incorrectly formatted.
+      #
+      def retrieve_from_cache!(cache_name)
+        with_callbacks(:retrieve_from_cache, cache_name) do
+          self.cache_id, self.original_filename = cache_name.to_s.split('/', 2)
+          @filename = original_filename
+          @file = CarrierWave::SanitizedFile.new(cache_path)
+        end
+      end
+
+    private
+
+      def cache_path
+        File.expand_path(File.join(cache_dir, cache_name), root)
+      end
+
+      attr_reader :cache_id, :original_filename
+
+      # We can override the full_original_filename method in other modules
+      alias_method :full_original_filename, :original_filename
+
+      def cache_id=(cache_id)
+        raise CarrierWave::InvalidParameter, "invalid cache id" unless cache_id =~ /\A[\d]{8}\-[\d]{4}\-[\d]+\-[\d]{4}\z/
+        @cache_id = cache_id
+      end
+
+      def original_filename=(filename)
+        raise CarrierWave::InvalidParameter, "invalid filename" unless filename =~ /\A[a-z0-9\.\-\+_]+\z/i
+        @original_filename = filename
+      end
+
+    end # Cache
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/callbacks.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Uploader
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      included do
+        class_inheritable_accessor :_before_callbacks, :_after_callbacks
+      end
+
+      def with_callbacks(kind, *args)
+        self.class._before_callbacks_for(kind).each { |callback| self.send(callback, *args) }
+        yield
+        self.class._after_callbacks_for(kind).each { |callback| self.send(callback, *args) }
+      end
+
+      module ClassMethods
+        
+        def _before_callbacks_for(kind) #:nodoc:
+          (self._before_callbacks || { kind => [] })[kind] || []
+        end
+
+        def _after_callbacks_for(kind) #:nodoc:
+          (self._after_callbacks || { kind => [] })[kind] || []
+        end
+
+        def before(kind, callback)          
+          self._before_callbacks ||= {}
+          self._before_callbacks[kind] = _before_callbacks_for(kind) + [callback]
+        end
+
+        def after(kind, callback)
+          self._after_callbacks ||= {}
+          self._after_callbacks[kind] = _after_callbacks_for(kind) + [callback]
+        end
+      end # ClassMethods
+
+    end # Callbacks
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/configuration.rb

@@ -0,0 +1,134 @@
+module CarrierWave
+
+  module Uploader
+    module Configuration
+      extend ActiveSupport::Concern
+
+      included do
+        add_config :root
+        add_config :permissions
+        add_config :storage_engines
+        add_config :s3_access # for old aws/s3
+        add_config :s3_access_policy # for aws
+        add_config :s3_bucket
+        add_config :s3_access_key_id
+        add_config :s3_secret_access_key
+        add_config :s3_cnamed
+        add_config :s3_headers
+        add_config :s3_multi_thread
+        add_config :cloud_files_username
+        add_config :cloud_files_api_key
+        add_config :cloud_files_container
+        add_config :grid_fs_database
+        add_config :grid_fs_host
+        add_config :grid_fs_port
+        add_config :grid_fs_username
+        add_config :grid_fs_password
+        add_config :grid_fs_access_url
+        add_config :store_dir
+        add_config :cache_dir
+        add_config :enable_processing
+
+        # Mounting
+        add_config :ignore_integrity_errors
+        add_config :ignore_processing_errors
+        add_config :validate_integrity
+        add_config :validate_processing
+        add_config :mount_on
+        
+        configure do |config|
+          config.permissions = 0644
+          config.storage_engines = {
+            :file => "CarrierWave::Storage::File",
+            :s3 => "CarrierWave::Storage::S3",
+            :grid_fs => "CarrierWave::Storage::GridFS",
+            :right_s3 => "CarrierWave::Storage::RightS3",
+            :cloud_files => "CarrierWave::Storage::CloudFiles"
+          }
+          config.storage = :file
+          #config.s3_access = :public_read
+          #config.s3_access_policy = 'public-read' # Now set in library
+          config.s3_headers = {}
+          config.s3_multi_thread = true
+          config.grid_fs_database = 'carrierwave'
+          config.grid_fs_host = 'localhost'
+          config.grid_fs_port = 27017
+          config.store_dir = 'uploads'
+          config.cache_dir = 'uploads/tmp'
+          config.ignore_integrity_errors = true
+          config.ignore_processing_errors = true
+          config.validate_integrity = true
+          config.validate_processing = true
+          config.root = CarrierWave.root
+          config.enable_processing = true
+        end
+      end
+
+      module ClassMethods
+
+        ##
+        # Sets the storage engine to be used when storing files with this uploader.
+        # Can be any class that implements a #store!(CarrierWave::SanitizedFile) and a #retrieve!
+        # method. See lib/carrierwave/storage/file.rb for an example. Storage engines should
+        # be added to CarrierWave::Uploader::Base.storage_engines so they can be referred
+        # to by a symbol, which should be more convenient
+        #
+        # If no argument is given, it will simply return the currently used storage engine.
+        #
+        # === Parameters
+        #
+        # [storage (Symbol, Class)] The storage engine to use for this uploader
+        #
+        # === Returns
+        #
+        # [Class] the storage engine to be used with this uploader
+        #
+        # === Examples
+        #
+        #     storage :file
+        #     storage CarrierWave::Storage::File
+        #     storage MyCustomStorageEngine
+        #
+        def storage(storage = nil)
+          if storage.is_a?(Symbol)
+            @storage = eval(storage_engines[storage])
+          elsif storage
+            @storage = storage
+          elsif @storage.nil?
+            # Get the storage from the superclass if there is one
+            @storage = superclass.storage rescue nil
+          end
+          return @storage
+        end
+        alias_method :storage=, :storage
+
+
+        def add_config(name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def self.#{name}(value=nil)
+              @#{name} = value if value
+              return @#{name} if self.object_id == #{self.object_id} || defined?(@#{name})
+              name = superclass.#{name}
+              return nil if name.nil? && !instance_variable_defined?("@#{name}")
+              @#{name} = name && !name.is_a?(Module) && !name.is_a?(Symbol) && !name.is_a?(Numeric) && !name.is_a?(TrueClass) && !name.is_a?(FalseClass) ? name.dup : name
+            end
+
+            def self.#{name}=(value)
+              @#{name} = value
+            end
+
+            def #{name}
+              self.class.#{name}
+            end
+          RUBY
+        end
+
+        def configure
+          yield self
+        end
+      end
+
+    end
+  end
+end
+