carrierwave 0.3.5.2 → 0.4.0

data/lib/carrierwave/uploader.rb

@@ -25,7 +25,6 @@ module CarrierWave
     class Base
       attr_reader :file
 
-      use CarrierWave::Uploader::Paths
       use CarrierWave::Uploader::Callbacks
       use CarrierWave::Uploader::Proxy
       use CarrierWave::Uploader::Url
@@ -34,10 +33,10 @@ module CarrierWave
       use CarrierWave::Uploader::Store
       use CarrierWave::Uploader::Remove
       use CarrierWave::Uploader::ExtensionWhitelist
-      use CarrierWave::Uploader::DefaultPath
       use CarrierWave::Uploader::Processing
       use CarrierWave::Uploader::Versions
       use CarrierWave::Uploader::DefaultUrl
+      use CarrierWave::Uploader::Configuration
     end # Base
 
   end # Uploader

data/lib/carrierwave/uploader/cache.rb

@@ -1,11 +1,29 @@
 # 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
 
-      depends_on CarrierWave::Uploader::Paths
       depends_on CarrierWave::Uploader::Callbacks
+      depends_on CarrierWave::Uploader::Configuration
 
       ##
       # Returns true if the uploader has been cached
@@ -18,17 +36,6 @@ module CarrierWave
         @cache_id
       end
 
-      ##
-      # Override this in your Uploader to change the directory where files are cached.
-      #
-      # === Returns
-      #
-      # [String] a directory
-      #
-      def cache_dir
-        CarrierWave.config[:cache_dir]
-      end
-
       ##
       # Returns a String which uniquely identifies the currently cached file for later retrieval
       #
@@ -62,11 +69,7 @@ module CarrierWave
             @filename = new_file.filename
             self.original_filename = new_file.filename
 
-            if CarrierWave.config[:cache_to_cache_dir]
-              @file = new_file.copy_to(cache_path, CarrierWave.config[:permissions])
-            else
-              @file = new_file
-            end
+            @file = new_file.copy_to(cache_path, permissions)
           end
         end
       end
@@ -93,7 +96,7 @@ module CarrierWave
     private
 
       def cache_path
-        File.expand_path(File.join(cache_dir, cache_name), public)
+        File.expand_path(File.join(cache_dir, cache_name), root)
       end
 
       attr_reader :cache_id, :original_filename

data/lib/carrierwave/uploader/configuration.rb

@@ -0,0 +1,59 @@
+module CarrierWave
+
+  module Uploader
+    module Configuration
+
+      setup do
+        add_config :root
+        add_config :permissions
+        add_config :storage_engines
+        add_config :s3_access
+        add_config :s3_bucket
+        add_config :s3_access_key_id
+        add_config :s3_secret_access_key
+        add_config :s3_cnamed
+        add_config :grid_fs_database
+        add_config :grid_fs_host
+        add_config :grid_fs_access_url
+        add_config :store_dir
+        add_config :cache_dir
+
+        # Mounting
+        add_config :ignore_integrity_errors
+        add_config :ignore_processing_errors
+        add_config :validate_integrity
+        add_config :validate_processing
+        add_config :mount_on
+      end
+
+      module ClassMethods
+
+        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? && !#{self}.instance_variable_defined?("@#{name}")
+              @#{name} = name && !name.is_a?(Module) && !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
+

data/lib/carrierwave/uploader/remove.rb

@@ -11,7 +11,6 @@ module CarrierWave
       #
       def remove!
         with_callbacks(:remove) do
-          CarrierWave.logger.info 'CarrierWave: removing file'
           @file.delete if @file
           @file = nil
           @cache_id = nil

data/lib/carrierwave/uploader/store.rb

@@ -4,8 +4,8 @@ module CarrierWave
   module Uploader
     module Store
 
-      depends_on CarrierWave::Uploader::Paths
       depends_on CarrierWave::Uploader::Callbacks
+      depends_on CarrierWave::Uploader::Configuration
       depends_on CarrierWave::Uploader::Cache
 
       module ClassMethods
@@ -14,7 +14,7 @@ module CarrierWave
         # 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.config[:storage_engines] so they can be referred
+        # 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.
@@ -35,31 +35,17 @@ module CarrierWave
         #
         def storage(storage = nil)
           if storage.is_a?(Symbol)
-            @storage = get_storage_by_symbol(storage)
-            @storage.setup!
+            @storage = eval(storage_engines[storage])
           elsif storage
             @storage = storage
-            @storage.setup!
           elsif @storage.nil?
             # Get the storage from the superclass if there is one
             @storage = superclass.storage rescue nil
           end
-          if @storage.nil?
-            # If we were not able to find a store any other way, setup the default store
-            @storage ||= get_storage_by_symbol(CarrierWave.config[:storage])
-            @storage.setup!
-          end
           return @storage
         end
-
         alias_method :storage=, :storage
 
-      private
-
-        def get_storage_by_symbol(symbol)
-          eval(CarrierWave.config[:storage_engines][symbol])
-        end
-
       end
 
       ##
@@ -80,19 +66,6 @@ module CarrierWave
         @filename
       end
 
-      ##
-      # Override this in your Uploader to change the directory where the file backend stores files.
-      #
-      # Other backends may or may not use this method, depending on their specific needs.
-      #
-      # === Returns
-      #
-      # [String] a directory
-      #
-      def store_dir
-        CarrierWave.config[:store_dir]
-      end
-
       ##
       # Calculates the path where the file should be stored. If +for_file+ is given, it will be
       # used as the filename, otherwise +CarrierWave::Uploader#filename+ is assumed.

data/lib/carrierwave/uploader/url.rb

@@ -13,7 +13,7 @@ module CarrierWave
         if file.respond_to?(:url) and not file.url.blank?
           file.url
         elsif current_path
-          File.expand_path(current_path).gsub(File.expand_path(public), '')
+          File.expand_path(current_path).gsub(File.expand_path(root), '')
         end
       end
 

data/lib/carrierwave/uploader/versions.rb

@@ -128,10 +128,7 @@ module CarrierWave
       end
 
       def remove_versions!
-        versions.each do |name, v|
-          CarrierWave.logger.info "CarrierWave: removing file for version #{v.version_name}"
-          v.remove!
-        end
+        versions.each { |name, v| v.remove! }
       end
 
       def retrieve_versions_from_cache!(cache_name)

data/rails_generators/uploader/templates/uploader.rb

@@ -16,9 +16,9 @@ class <%= class_name %>Uploader < CarrierWave::Uploader::Base
     "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
   end
 
-  # Provide a default path as a default if there hasn't been a file uploaded
-  #     def default_path
-  #       "images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # Provide a default URL as a default if there hasn't been a file uploaded
+  #     def default_url
+  #       "/images/fallback/" + [version_name, "default.png"].compact.join('_')
   #     end
 
   # Process files as they are uploaded.

data/spec/compatibility/paperclip_spec.rb

@@ -4,6 +4,15 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 require 'carrierwave/orm/activerecord'
 
+module Rails
+  def self.root
+    File.expand_path(File.join('..'), File.dirname(__FILE__))
+  end
+  def self.env
+    "test"
+  end
+end unless defined?(Rails)
+
 describe CarrierWave::Compatibility::Paperclip do
 
   before do
@@ -21,12 +30,12 @@ describe CarrierWave::Compatibility::Paperclip do
 
   describe '#store_path' do
     it "should mimics paperclip default" do
-      @uploader.store_path("monkey.png").should == CarrierWave.config[:root] + "/public/system/monkeys/23/original/monkey.png"
+      @uploader.store_path("monkey.png").should == CarrierWave::Uploader::Base.root + "/system/monkeys/23/original/monkey.png"
     end
 
     it "should interpolate the root path" do
       @uploader.stub!(:paperclip_path).and_return(":rails_root/foo/bar")
-      @uploader.store_path("monkey.png").should == CarrierWave.config[:root] + "/foo/bar"
+      @uploader.store_path("monkey.png").should == Rails.root + "/foo/bar"
     end
 
     it "should interpolate the attachment" do

data/spec/mount_spec.rb

@@ -31,7 +31,6 @@ describe CarrierWave::Mount do
         end
       end
 
-      @instance.image_uploader.should be_an_instance_of(@uploader)
       @instance.image = stub_file('test.jpg')
       @instance.image.should be_an_instance_of(@uploader)
     end
@@ -39,34 +38,10 @@ describe CarrierWave::Mount do
     it "should inherit uploaders to subclasses" do
       @subclass = Class.new(@class)
       @subclass_instance = @subclass.new
-      @subclass_instance.image_uploader.should be_an_instance_of(@uploader)
       @subclass_instance.image = stub_file('test.jpg')
       @subclass_instance.image.should be_an_instance_of(@uploader)
     end
     
-    describe '#image_uploader' do
-      it "should return the uploader" do
-        @instance.image_uploader.should be_an_instance_of(@uploader)
-      end
-    end
-    
-    describe '#image_uploader=' do
-      it "should set the uploader" do
-        @my_uploader = @uploader.new
-        @instance.image_uploader = @my_uploader
-        @instance.image_uploader.should == @my_uploader
-      end
-
-      it "should use the set uploader" do
-        @my_uploader = @uploader.new
-        @my_uploader.store!(stub_file('test.jpg'))
-        @instance.image_uploader = @my_uploader
-        @instance.image_uploader.should == @my_uploader
-        @instance.image.should == @my_uploader
-        @instance.image.current_path.should == public_path('uploads/test.jpg')
-      end
-    end
-    
     describe '#image' do
       
       it "should return a blank uploader when nothing has been assigned" do

data/spec/orm/datamapper_spec.rb

@@ -17,7 +17,7 @@ describe CarrierWave::DataMapper do
 
       storage_names[:default] = 'events'
       
-      property :id, Integer, :key => true
+      property :id, DataMapper::Types::Serial
       property :image, String
       
       mount_uploader :image, uploader

data/spec/spec_helper.rb

@@ -21,7 +21,6 @@ require 'spec/autorun'
 require 'carrierwave'
 
 require 'logger'
-CarrierWave.logger = Logger.new(nil)
 
 alias :running :lambda
 
@@ -33,8 +32,9 @@ def public_path( *paths )
   File.expand_path(File.join(File.dirname(__FILE__), 'public', *paths))
 end
 
-CarrierWave.config[:public] = public_path
-CarrierWave.config[:root] = File.expand_path(File.dirname(__FILE__))
+CarrierWave.configure do |config|
+  config.root = public_path
+end 
 
 module CarrierWave
   module Test

data/spec/storage/grid_fs_spec.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CarrierWave::Storage::GridFS do
+
+  before do
+    @database = Mongo::Connection.new('localhost').db('carrierwave_test')
+    @uploader = mock('an uploader')
+    @uploader.stub!(:grid_fs_database).and_return("carrierwave_test")
+    @uploader.stub!(:grid_fs_host).and_return("localhost")
+    @uploader.stub!(:grid_fs_access_url).and_return(nil)
+
+    @storage = CarrierWave::Storage::GridFS.new(@uploader)
+    @file = CarrierWave::SanitizedFile.new(file_path('test.jpg'))
+  end
+  
+  after do
+    GridFS::GridStore.unlink(@database, 'uploads/bar.txt')
+  end
+
+  describe '#store!' do
+    before do
+      @uploader.stub!(:store_path).and_return('uploads/bar.txt')
+      @grid_fs_file = @storage.store!(@file)
+    end
+    
+    it "should upload the file to gridfs" do
+      GridFS::GridStore.read(@database, 'uploads/bar.txt').should == 'this is stuff'
+    end
+    
+    it "should not have a path" do
+      @grid_fs_file.path.should be_nil
+    end
+    
+    it "should not have a URL" do
+      @grid_fs_file.url.should be_nil
+    end
+    
+    it "should be deletable" do
+      @grid_fs_file.delete
+      GridFS::GridStore.read(@database, 'uploads/bar.txt').should == ''
+    end
+  end
+  
+  describe '#retrieve!' do
+    before do
+      GridFS::GridStore.open(@database, 'uploads/bar.txt', 'w') { |f| f.puts "A test, 1234" }
+      @uploader.stub!(:store_path).with('bar.txt').and_return('uploads/bar.txt')
+      @grid_fs_file = @storage.retrieve!('bar.txt')
+    end
+
+    it "should retrieve the file contents from gridfs" do
+      @grid_fs_file.read.chomp.should == "A test, 1234"
+    end
+    
+    it "should not have a path" do
+      @grid_fs_file.path.should be_nil
+    end
+    
+    it "should not have a URL unless set" do
+      @grid_fs_file.url.should be_nil
+    end
+    
+    it "should return a URL if configured" do
+      @uploader.stub!(:grid_fs_access_url).and_return("/image/show")
+      @grid_fs_file.url.should == "/image/show/uploads/bar.txt"
+    end
+    
+    it "should be deletable" do
+      @grid_fs_file.delete
+      GridFS::GridStore.read(@database, 'uploads/bar.txt').should == ''
+    end
+  end
+
+end