jnicklas-carrierwave 0.2.2 → 0.2.3

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/generators/uploader_generator.rb

@@ -10,7 +10,7 @@ module Merb
 
       template :uploader do |t|
         t.source = 'uploader.rb'
-        t.destination = "app/models/#{file_name}_uploader.rb"
+        t.destination = "app/uploaders/#{file_name}_uploader.rb"
       end
     end
 

data/rails_generators/uploader/templates/uploader.rb

@@ -1,6 +1,4 @@
-class <%= class_name %>Uploader
-
-  include CarrierWave::Uploader
+class <%= class_name %>Uploader < CarrierWave::Uploader::Base
 
   # Include RMagick or ImageScience support
   #     include CarrierWave::RMagick
@@ -10,6 +8,17 @@ class <%= class_name %>Uploader
   storage :file
   #     storage :s3
 
+  # Override the directory where uploaded files will be stored
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "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('_')
+  #     end
+
   # Process files as they are uploaded.
   #     process :scale => [200, 300]
   #
@@ -33,9 +42,4 @@ class <%= class_name %>Uploader
   #       "something.jpg"
   #     end
 
-  # Override the directory where uploaded files will be stored
-  # This is a sensible default for uploaders that are meant to be mounted:
-  def store_dir
-    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
-  end
 end

data/spec/compatibility/paperclip_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'carrierwave/orm/activerecord'
+
+describe CarrierWave::Compatibility::Paperclip do
+
+  before do
+    @uploader_class = Class.new(CarrierWave::Uploader::Base) do
+      include CarrierWave::Compatibility::Paperclip
+    end
+    @model = mock('a model')
+    @model.stub!(:id).and_return(23)
+    @uploader = @uploader_class.new(@model, :monkey)
+  end
+  
+  after do
+    FileUtils.rm_rf(public_path)
+  end
+
+  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"
+    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"
+    end
+
+    it "should interpolate the attachment" do
+      @uploader.stub!(:paperclip_path).and_return("/foo/:attachment/bar")
+      @uploader.store_path("monkey.png").should == "/foo/monkeys/bar"
+    end
+
+    it "should interpolate the id" do
+      @uploader.stub!(:paperclip_path).and_return("/foo/:id/bar")
+      @uploader.store_path("monkey.png").should == "/foo/23/bar"
+    end
+  end
+
+end

data/spec/mount_spec.rb

@@ -12,13 +12,29 @@ describe CarrierWave::Mount do
       @class = Class.new
       @class.send(:extend, CarrierWave::Mount)
       
-      @uploader = Class.new do
-        include CarrierWave::Uploader
-      end
+      @uploader = Class.new(CarrierWave::Uploader::Base)
 
       @class.mount_uploader(:image, @uploader)
       @instance = @class.new
     end
+
+    it "should maintain the ability to super" do
+      pending "I can't make this work with datamapper" do
+        @class.class_eval do
+          def image_uploader
+            super
+          end
+
+          def image=(val)
+            super
+          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
+    end
     
     describe '#image_uploader' do
       it "should return the uploader" do
@@ -45,14 +61,16 @@ describe CarrierWave::Mount do
     
     describe '#image' do
       
-      it "should return nil when nothing has been assigned" do
-        @instance.should_receive(:read_uploader).with(:image).and_return(nil)
-        @instance.image.should be_nil
+      it "should return a blank uploader when nothing has been assigned" do
+        @instance.should_receive(:read_uploader).with(:image).twice.and_return(nil)
+        @instance.image.should be_an_instance_of(@uploader)
+        @instance.image.should be_blank
       end
       
-      it "should return nil when an empty string has been assigned" do
-        @instance.should_receive(:read_uploader).with(:image).and_return('')
-        @instance.image.should be_nil
+      it "should return a blank uploader when an empty string has been assigned" do
+        @instance.should_receive(:read_uploader).with(:image).twice.and_return('')
+        @instance.image.should be_an_instance_of(@uploader)
+        @instance.image.should be_blank
       end
       
       it "should retrieve a file from the storage if a value is stored in the database" do
@@ -96,7 +114,7 @@ describe CarrierWave::Mount do
           end
         end
         @instance.image = stub_file('test.jpg')
-        @instance.image.should be_nil   
+        @instance.image.should be_blank
       end
       
       it "should fail silently if the image fails to be processed" do
@@ -111,6 +129,25 @@ describe CarrierWave::Mount do
       
     end
 
+    describe '#image?' do
+      
+      it "should be false when nothing has been assigned" do
+        @instance.should_receive(:read_uploader).with(:image).and_return(nil)
+        @instance.image?.should be_false
+      end
+      
+      it "should be false when an empty string has been assigned" do
+        @instance.should_receive(:read_uploader).with(:image).and_return('')
+        @instance.image?.should be_false
+      end
+
+      it "should be true when a file has been cached" do
+        @instance.image = stub_file('test.jpg')
+        @instance.image?.should be_true
+      end
+    
+    end
+
     describe '#image_url' do
       
       it "should return nil when nothing has been assigned" do
@@ -175,12 +212,12 @@ describe CarrierWave::Mount do
 
       it "should do nothing when nil is assigned" do
         @instance.image_cache = nil
-        @instance.image.should be_nil
+        @instance.image.should be_blank
       end
 
       it "should do nothing when an empty string is assigned" do
         @instance.image_cache = ''
-        @instance.image.should be_nil
+        @instance.image.should be_blank
       end
 
       it "retrieve from cache when a cache name is assigned" do
@@ -204,7 +241,7 @@ describe CarrierWave::Mount do
 
       it "should do nothing when no file has been uploaded" do
         @instance.store_image!
-        @instance.image.should be_nil
+        @instance.image.should be_blank
       end
 
       it "store an assigned file" do
@@ -220,10 +257,34 @@ describe CarrierWave::Mount do
       end
 
       it "should remove an uploaded file when remove_image? returns true" do
+        @instance.should_receive(:write_uploader).with(:image, "")
         @instance.image = stub_file('test.jpg')
+        path = @instance.image.current_path
         @instance.remove_image = true
         @instance.store_image!
-        @instance.image.should be_nil
+        @instance.image.should be_blank
+        File.exist?(path).should be_false
+      end
+    end
+
+    describe '#remove_image!' do
+
+      before do
+        @instance.stub!(:write_uploader)
+        @instance.stub!(:read_uploader).and_return(nil)
+      end
+
+      it "should do nothing when no file has been uploaded" do
+        @instance.remove_image!
+        @instance.image.should be_blank
+      end
+
+      it "should remove an uploaded file" do
+        @instance.image = stub_file('test.jpg')
+        path = @instance.image.current_path
+        @instance.remove_image!
+        @instance.image.should be_blank
+        File.exist?(path).should be_false
       end
     end
 
@@ -331,8 +392,8 @@ describe CarrierWave::Mount do
         @instance.stub!(:read_uploader).and_return('test.jpg')
       end
       
-      it "should return an instance of a subclass of CarrierWave::Uploader" do
-        @instance.image.should be_a(CarrierWave::Uploader)
+      it "should return an instance of a subclass of CarrierWave::Uploader::Base" do
+        @instance.image.should be_a(CarrierWave::Uploader::Base)
       end
       
       it "should set the path to the store dir" do
@@ -353,9 +414,7 @@ describe CarrierWave::Mount do
       @class = Class.new
       @class.send(:extend, CarrierWave::Mount)
       
-      @uploader = Class.new do
-        include CarrierWave::Uploader
-      end
+      @uploader = Class.new(CarrierWave::Uploader::Base)
 
       @class.mount_uploader(:image, @uploader, :ignore_integrity_errors => false)
       @instance = @class.new
@@ -380,9 +439,7 @@ describe CarrierWave::Mount do
       @class = Class.new
       @class.send(:extend, CarrierWave::Mount)
       
-      @uploader = Class.new do
-        include CarrierWave::Uploader
-      end
+      @uploader = Class.new(CarrierWave::Uploader::Base)
 
       @class.mount_uploader(:image, @uploader, :ignore_processing_errors => false)
       @instance = @class.new
@@ -409,9 +466,7 @@ describe CarrierWave::Mount do
       @class = Class.new
       @class.send(:extend, CarrierWave::Mount)
 
-      @uploader = Class.new do
-        include CarrierWave::Uploader
-      end
+      @uploader = Class.new(CarrierWave::Uploader::Base)
 
       @class.mount_uploader(:image, @uploader, :mount_on => :monkey)
       @instance = @class.new
@@ -433,6 +488,14 @@ describe CarrierWave::Mount do
         @instance.image = stub_file('test.jpg')
         @instance.store_image!
       end
+
+      it "should remove from the given column when remove_image is true" do
+        @instance.image = stub_file('test.jpg')
+        @instance.store_image!
+        @instance.remove_image = true
+        @instance.should_receive(:write_uploader).with(:monkey, "")
+        @instance.store_image!
+      end
     end
   end
 

data/spec/orm/activerecord_spec.rb

@@ -44,9 +44,7 @@ describe CarrierWave::ActiveRecord do
         @class = Event#{$arclass}
       RUBY
       @class.table_name = "events"
-      @uploader = Class.new do
-        include CarrierWave::Uploader
-      end
+      @uploader = Class.new(CarrierWave::Uploader::Base)
       @class.mount_uploader(:image, @uploader)
       @event = @class.new
     end
@@ -54,14 +52,14 @@ describe CarrierWave::ActiveRecord do
     describe '#image' do
       
       it "should return nil when nothing has been assigned" do
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should return nil when an empty string has been assigned" do
         @event[:image] = ''
         @event.save
         @event.reload
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should retrieve a file from the storage if a value is stored in the database" do
@@ -98,12 +96,12 @@ describe CarrierWave::ActiveRecord do
       
       it "should do nothing when nil is assigned" do
         @event.image = nil
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should do nothing when an empty string is assigned" do
         @event.image = ''
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
 
       it "should make the record invalid when an integrity error occurs" do
@@ -133,7 +131,7 @@ describe CarrierWave::ActiveRecord do
       
       it "should do nothing when no file has been assigned" do
         @event.save.should be_true
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should copy the file to the upload directory when a file has been assigned" do
@@ -164,7 +162,7 @@ describe CarrierWave::ActiveRecord do
         @event.remove_image = true
         @event.save!
         @event.reload
-        @event.image.should be_nil
+        @event.image.should be_blank
         @event[:image].should == ''
       end
 

data/spec/orm/datamapper_spec.rb

@@ -7,9 +7,7 @@ DataMapper.setup(:default, 'sqlite3::memory:')
 describe CarrierWave::DataMapper do
   
   before do
-    uploader = Class.new do
-      include CarrierWave::Uploader
-    end
+    uploader = Class.new(CarrierWave::Uploader::Base)
     
     @class = Class.new
     @class.class_eval do
@@ -33,14 +31,14 @@ describe CarrierWave::DataMapper do
   describe '#image' do
     
     it "should return nil when nothing has been assigned" do
-      @event.image.should be_nil
+      @event.image.should be_blank
     end
     
     it "should return nil when an empty string has been assigned" do
       repository(:default).adapter.query("INSERT INTO events (image) VALUES ('')")
       @event = @class.first
       
-      @event.image.should be_nil
+      @event.image.should be_blank
     end
     
     it "should retrieve a file from the storage if a value is stored in the database" do
@@ -79,12 +77,12 @@ describe CarrierWave::DataMapper do
     
     it "should do nothing when nil is assigned" do
       @event.image = nil
-      @event.image.should be_nil
+      @event.image.should be_blank
     end
     
     it "should do nothing when an empty string is assigned" do
       @event.image = ''
-      @event.image.should be_nil
+      @event.image.should be_blank
     end
     
   end
@@ -93,7 +91,7 @@ describe CarrierWave::DataMapper do
     
     it "should do nothing when no file has been assigned" do
       @event.save
-      @event.image.should be_nil
+      @event.image.should be_blank
     end
     
     it "should copy the file to the upload directory when a file has been assigned" do
@@ -134,7 +132,7 @@ describe CarrierWave::DataMapper do
       @event.remove_image = true
       @event.save
       @event.reload
-      @event.image.should be_nil
+      @event.image.should be_blank
       @event.attribute_get(:image).should == ''
     end
 

data/spec/orm/sequel_spec.rb

@@ -7,9 +7,7 @@ DB = Sequel.sqlite
 describe CarrierWave::Sequel do
 
   def setup_variables_for_class(klass)
-    uploader = Class.new do
-      include CarrierWave::Uploader
-    end
+    uploader = Class.new(CarrierWave::Uploader::Base)
     klass.mount_uploader(:image, uploader)
     model = klass.new
     [klass, uploader, model] 
@@ -38,14 +36,14 @@ describe CarrierWave::Sequel do
     describe '#image' do
       
       it "should return nil when nothing has been assigned" do
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should return nil when an empty string has been assigned" do
         @event[:image] = ''
         @event.save
         @event.reload
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should retrieve a file from the storage if a value is stored in the database" do
@@ -82,12 +80,12 @@ describe CarrierWave::Sequel do
       
       it "should do nothing when nil is assigned" do
         @event.image = nil
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should do nothing when an empty string is assigned" do
         @event.image = ''
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
     end
@@ -96,7 +94,7 @@ describe CarrierWave::Sequel do
       
       it "should do nothing when no file has been assigned" do
         @event.save.should be_true
-        @event.image.should be_nil
+        @event.image.should be_blank
       end
       
       it "should copy the file to the upload directory when a file has been assigned" do
@@ -109,38 +107,53 @@ describe CarrierWave::Sequel do
       describe 'with validation' do
 
         before do
-          @class.class_eval do
-            validates_each :image do |object, attribute, value|
-              object.errors[attribute] << 'FAIL!'
+          # Add validations
+          if CarrierWave::Sequel.new_sequel?
+            @class.class_eval do
+              def validate
+                errors.add(:image, 'FAIL!')
+              end
+            end
+          else
+            @class.class_eval do
+              validates_each(:image) do |o,a,v|
+                o.errors.add(a, 'FAIL!')
+              end
             end
           end
+          # Turn off raising the exceptions on save
+          @event.raise_on_save_failure = false
         end
 
         it "should do nothing when a validation fails" do
-          pending "I don't understand how this is supposed to work :S" do
-            @event.image = stub_file('test.jpeg')
-            @event.save.should be_false
-            @event.image.should be_an_instance_of(@uploader)
-            @event.image.current_path.should =~ /^#{public_path('uploads/tmp')}/
-          end
+          @event.image = stub_file('test.jpeg')
+          @event.should_not be_valid
+          @event.save
+          @event.should be_new
+          @event.image.should be_an_instance_of(@uploader)
+          @event.image.current_path.should =~ /^#{public_path('uploads/tmp')}/
         end
       end 
      
       it "should assign the filename to the database" do
-        @event.image = stub_file('test.jpeg')
-        @event.save.should be_true
-        @event.reload
-        @event[:image].should == 'test.jpeg'
+        pending "Sequel support is currently broken" do
+          @event.image = stub_file('test.jpeg')
+          @event.save.should be_true
+          @event.reload
+          @event[:image].should == 'test.jpeg'
+        end
       end
 
       it "should remove the image if remove_image? returns true" do
-        @event.image = stub_file('test.jpeg')
-        @event.save
-        @event.remove_image = true
-        @event.save
-        @event.reload
-        @event.image.should be_nil
-        @event[:image].should == ''
+        pending "Sequel support is currently broken" do
+          @event.image = stub_file('test.jpeg')
+          @event.save
+          @event.remove_image = true
+          @event.save
+          @event.reload
+          @event.image.should be_blank
+          @event[:image].should == ''
+        end
       end
     end
     
@@ -165,10 +178,12 @@ describe CarrierWave::Sequel do
         end
 
         it "should assign an overridden filename to the database" do
-          @event.image = stub_file('test.jpeg')
-          @event.save.should be_true
-          @event.reload
-          @event[:image].should == 'jonas.jpeg'
+          pending "Sequel support is currently broken" do
+            @event.image = stub_file('test.jpeg')
+            @event.save.should be_true
+            @event.reload
+            @event[:image].should == 'jonas.jpeg'
+          end
         end
 
       end

data/spec/spec_helper.rb

@@ -14,9 +14,13 @@ end
 require 'tempfile'
 #require 'ruby-debug'
 require 'spec'
+require 'spec/autorun'
 
 require 'carrierwave'
 
+require 'logger'
+CarrierWave.logger = Logger.new(File.join(File.dirname(__FILE__), 'test.log'))
+
 alias :running :lambda
 
 def file_path( *paths )
@@ -32,6 +36,14 @@ CarrierWave.config[:root] = File.expand_path(File.dirname(__FILE__))
 
 module CarrierWave
   module Test
+    module MockStorage
+      def mock_storage(kind)
+        storage = mock("storage for #{kind} uploader")
+        storage.stub!(:setup!)
+        storage
+      end
+    end
+    
     module MockFiles
       def stub_merb_tempfile(filename)
         raise "#{path} file does not exist" unless File.exist?(file_path(filename))
@@ -81,4 +93,5 @@ end
 Spec::Runner.configure do |config|
   config.include CarrierWave::Test::Matchers
   config.include CarrierWave::Test::MockFiles
+  config.include CarrierWave::Test::MockStorage
 end