jnicklas-carrierwave 0.1.1 → 0.2.0

data/lib/carrierwave.rb

@@ -4,7 +4,7 @@ module CarrierWave
   class << self
     attr_accessor :config
   end
-  
+
   class UploadError < StandardError; end
   class NoFileError < UploadError; end
   class FormNotMultipart < UploadError
@@ -16,47 +16,62 @@ module CarrierWave
   class InvalidParameter < UploadError; end
   # Should be used by methods used as process callbacks.
   class ProcessingError < UploadError; end
-end
 
-dir = File.join(File.dirname(__FILE__), 'carrierwave')
+  autoload :SanitizedFile, 'carrierwave/sanitized_file'
+  autoload :Uploader, 'carrierwave/uploader'
+  autoload :Mount, 'carrierwave/mount'
+  autoload :RMagick, 'carrierwave/processing/rmagick'
+  autoload :ImageScience, 'carrierwave/processing/image_science'
+
+  module Storage
+    autoload :Abstract, 'carrierwave/storage/abstract'
+    autoload :File, 'carrierwave/storage/file'
+    autoload :S3, 'carrierwave/storage/s3'
+  end
+
+  module Test
+    autoload :Matchers, 'carrierwave/test/matchers'
+  end
 
-require File.join(dir, 'sanitized_file')
-require File.join(dir, 'uploader')
-require File.join(dir, 'mount')
-require File.join(dir, 'storage', 'abstract')
-require File.join(dir, 'storage', 'file')
-require File.join(dir, 'storage', 's3')
+end
 
 CarrierWave.config = {
+  :permissions => 0644,
   :storage => :file,
   :use_cache => true,
   :storage_engines => {
-    :file => CarrierWave::Storage::File,
-    :s3 => CarrierWave::Storage::S3
+    :file => "CarrierWave::Storage::File",
+    :s3 => "CarrierWave::Storage::S3"
   },
   :s3 => {
     :access => :public_read
   },
   :store_dir => 'uploads',
-  :cache_dir => 'uploads/tmp'
+  :cache_dir => 'uploads/tmp',
+  :mount => {
+    :ignore_integrity_errors => true,
+    :ignore_processing_errors => true,
+    :validate_integrity => true,
+    :validate_processing => true
+  }
 }
 
 if defined?(Merb)
   CarrierWave.config[:root] = Merb.root
   CarrierWave.config[:public] = Merb.dir_for(:public)
-  
+
   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'
 end
 
 if defined?(Rails)
   CarrierWave.config[:root] = Rails.root
   CarrierWave.config[:public] = File.join(Rails.root, 'public')
-  
+
   require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'activerecord')
 
   ActiveSupport::Dependencies.load_paths << File.join(Rails.root, "app", "uploaders")
@@ -65,4 +80,4 @@ end
 if defined?(Sinatra)
   CarrierWave.config[:root] = Sinatra::Application.root
   CarrierWave.config[:public] = Sinatra::Application.public
-end
+end

data/lib/generators/uploader_generator.rb

@@ -1,20 +1,20 @@
 module Merb
   module Generators
     class UploaderGenerator < NamedGenerator
-      
+
       def self.source_root
         File.join(File.dirname(__FILE__), '..', '..', 'rails_generators', 'uploader', 'templates')
       end
-      
+
       first_argument :name, :required => true, :desc => "The name of this uploader"
-      
+
       template :uploader do |t|
         t.source = 'uploader.rb'
-        t.destination = "app/uploaders/#{file_name}_uploader.rb"
+        t.destination = "app/models/#{file_name}_uploader.rb"
       end
     end
-    
+
     add :uploader, UploaderGenerator
-    
+
   end
-end
+end

data/rails_generators/uploader/templates/uploader.rb

@@ -1,4 +1,6 @@
-class <%= class_name %>Uploader < CarrierWave::Uploader
+class <%= class_name %>Uploader
+
+  include CarrierWave::Uploader
   
   # Include RMagick or ImageScience support
   #     include CarrierWave::RMagick
@@ -20,6 +22,12 @@ class <%= class_name %>Uploader < CarrierWave::Uploader
   #       process :scale => [50, 50]
   #     end
   
+  # Add a white list of extensions which are allowed to be uploaded,
+  # for images you might use something like this:
+  #     def extension_white_list
+  #       %w(jpg jpeg gif png)
+  #     end
+  
   # Override the filename of the uploaded files
   #     def filename
   #       "something.jpg"

data/spec/mount_spec.rb

@@ -2,8 +2,6 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe CarrierWave::Mount do
   
-  include SanitizedFileSpecHelper
-  
   after do
     FileUtils.rm_rf(public_path)
   end
@@ -14,12 +12,37 @@ describe CarrierWave::Mount do
       @class = Class.new
       @class.send(:extend, CarrierWave::Mount)
       
-      @uploader = Class.new(CarrierWave::Uploader)
+      @uploader = Class.new do
+        include CarrierWave::Uploader
+      end
 
       @class.mount_uploader(:image, @uploader)
       @instance = @class.new
     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 nil when nothing has been assigned" do
@@ -66,6 +89,26 @@ describe CarrierWave::Mount do
         @instance.image = ''
       end
       
+      it "should fail silently if the image fails an integrity check" do
+        @uploader.class_eval do
+          def extension_white_list
+            %(txt)
+          end
+        end
+        @instance.image = stub_file('test.jpg')
+        @instance.image.should be_nil   
+      end
+      
+      it "should fail silently if the image fails to be processed" do
+        @uploader.class_eval do
+          process :monkey
+          def monkey
+            raise CarrierWave::ProcessingError, "Ohh noez!"
+          end
+        end
+        @instance.image = stub_file('test.jpg')
+      end
+      
     end
 
     describe '#image_cache' do
@@ -140,6 +183,51 @@ describe CarrierWave::Mount do
         @instance.image.current_path.should == public_path('uploads/test.jpg')
       end
     end
+    
+    describe '#image_integrity_error' do
+
+      it "should be nil by default" do
+        @instance.image_integrity_error.should be_nil
+      end
+
+      it "should be nil after a file is cached" do
+        @instance.image = stub_file('test.jpg')
+        @instance.image_integrity_error.should be_nil
+      end
+
+      it "should be an error instance after an integrity check has failed" do
+        @uploader.class_eval do
+          def extension_white_list
+            %(txt)
+          end
+        end
+        @instance.image = stub_file('test.jpg')
+        @instance.image_integrity_error.should be_an_instance_of(CarrierWave::IntegrityError)
+      end
+    end
+    
+    describe '#image_processing_error' do
+
+      it "should be nil by default" do
+        @instance.image_processing_error.should be_nil
+      end
+
+      it "should be nil after a file is cached" do
+        @instance.image = stub_file('test.jpg')
+        @instance.image_processing_error.should be_nil
+      end
+
+      it "should be an error instance after an integrity check has failed" do
+        @uploader.class_eval do
+          process :monkey
+          def monkey
+            raise CarrierWave::ProcessingError, "Ohh noez!"
+          end
+        end
+        @instance.image = stub_file('test.jpg')
+        @instance.image_processing_error.should be_an_instance_of(CarrierWave::ProcessingError)
+      end
+    end
 
   end
   
@@ -178,4 +266,60 @@ describe CarrierWave::Mount do
     
   end
   
+  describe '#mount_uploader with :ignore_integrity_errors => false' do
+   
+    before do
+      @class = Class.new
+      @class.send(:extend, CarrierWave::Mount)
+      
+      @uploader = Class.new do
+        include CarrierWave::Uploader
+      end
+
+      @class.mount_uploader(:image, @uploader, :ignore_integrity_errors => false)
+      @instance = @class.new
+    end
+
+    it "should raise an error if the image fails an integrity check" do
+      @uploader.class_eval do
+        def extension_white_list
+          %(txt)
+        end
+      end
+      running {
+        @instance.image = stub_file('test.jpg')
+      }.should raise_error(CarrierWave::IntegrityError)
+    end
+
+  end
+
+  describe '#mount_uploader with :ignore_processing_errors => false' do
+   
+    before do
+      @class = Class.new
+      @class.send(:extend, CarrierWave::Mount)
+      
+      @uploader = Class.new do
+        include CarrierWave::Uploader
+      end
+
+      @class.mount_uploader(:image, @uploader, :ignore_processing_errors => false)
+      @instance = @class.new
+    end
+
+    it "should raise an error if the image fails to be processed" do
+      @uploader.class_eval do
+        process :monkey
+        def monkey
+          raise CarrierWave::ProcessingError, "Ohh noez!"
+        end
+      end
+      running {
+        @instance.image = stub_file('test.jpg')
+      }.should raise_error(CarrierWave::ProcessingError)
+    end
+
+  end
+
+
 end

data/spec/orm/activerecord_spec.rb

@@ -28,8 +28,6 @@ class Event < ActiveRecord::Base; end # setup a basic AR class for testing
 
 describe CarrierWave::ActiveRecord do
   
-  include SanitizedFileSpecHelper
-  
   describe '.mount_uploader' do
     
     before(:all) { TestMigration.up }
@@ -39,7 +37,9 @@ describe CarrierWave::ActiveRecord do
     before do
       @class = Class.new(ActiveRecord::Base)
       @class.table_name = "events"
-      @uploader = Class.new(CarrierWave::Uploader)
+      @uploader = Class.new do
+        include CarrierWave::Uploader
+      end
       @class.mount_uploader(:image, @uploader)
       @event = @class.new
     end
@@ -98,6 +98,27 @@ describe CarrierWave::ActiveRecord do
         @event.image = ''
         @event.image.should be_nil
       end
+
+      it "should make the record invalid when an integrity error occurs" do
+        @uploader.class_eval do
+          def extension_white_list
+            %(txt)
+          end
+        end
+        @event.image = stub_file('test.jpg')
+        @event.should_not be_valid
+      end
+  
+      it "should make the record invalid when a processing error occurs" do
+        @uploader.class_eval do
+          process :monkey
+          def monkey
+            raise CarrierWave::ProcessingError, "Ohh noez!"
+          end
+        end
+        @event.image = stub_file('test.jpg')
+        @event.should_not be_valid
+      end
       
     end
     

data/spec/orm/datamapper_spec.rb

@@ -6,10 +6,10 @@ DataMapper.setup(:default, 'sqlite3::memory:')
 
 describe CarrierWave::DataMapper do
   
-  include SanitizedFileSpecHelper
-  
   before do
-    uploader = Class.new(CarrierWave::Uploader)
+    uploader = Class.new do
+      include CarrierWave::Uploader
+    end
     
     @class = Class.new
     @class.class_eval do

data/spec/orm/sequel_spec.rb

@@ -0,0 +1,170 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'carrierwave/orm/sequel'
+
+DB = Sequel.sqlite
+
+describe CarrierWave::Sequel do
+
+  def setup_variables_for_class(klass)
+    uploader = Class.new do
+      include CarrierWave::Uploader
+    end
+    klass.mount_uploader(:image, uploader)
+    model = klass.new
+    [klass, uploader, model] 
+  end
+
+  describe '.mount_uploader' do
+    
+    before(:all) do
+      DB.create_table :events do
+        primary_key :id
+        column      :image,    :string
+        column      :textfile, :string
+      end
+    end
+
+    after(:all) do
+      DB.drop_table :events
+    end
+    
+    before do
+      @class = Class.new(Sequel::Model)
+      @class.set_dataset :events
+      @class, @uploader, @event = setup_variables_for_class(@class)
+    end
+    
+    describe '#image' do
+      
+      it "should return nil when nothing has been assigned" do
+        @event.image.should be_nil
+      end
+      
+      it "should return nil when an empty string has been assigned" do
+        @event[:image] = ''
+        @event.save
+        @event.reload
+        @event.image.should be_nil
+      end
+      
+      it "should retrieve a file from the storage if a value is stored in the database" do
+        @event[:image] = 'test.jpeg'
+        @event.save
+        @event.reload
+        @event.image.should be_an_instance_of(@uploader)
+      end
+      
+      it "should set the path to the store dir" do
+        @event[:image] = 'test.jpeg'
+        @event.save
+        @event.reload
+        @event.image.current_path.should == public_path('uploads/test.jpeg')
+      end
+    
+    end
+    
+    describe '#image=' do
+      
+      it "should cache a file" do
+        @event.image = stub_file('test.jpeg')
+        @event.image.should be_an_instance_of(@uploader)
+      end
+      
+      it "should write nothing to the database, to prevent overriden filenames to fail because of unassigned attributes" do
+        @event[:image].should be_nil
+      end
+      
+      it "should copy a file into into the cache directory" do
+        @event.image = stub_file('test.jpeg')
+        @event.image.current_path.should =~ /^#{public_path('uploads/tmp')}/
+      end
+      
+      it "should do nothing when nil is assigned" do
+        @event.image = nil
+        @event.image.should be_nil
+      end
+      
+      it "should do nothing when an empty string is assigned" do
+        @event.image = ''
+        @event.image.should be_nil
+      end
+      
+    end
+    
+    describe '#save' do
+      
+      it "should do nothing when no file has been assigned" do
+        @event.save.should be_true
+        @event.image.should be_nil
+      end
+      
+      it "should copy the file to the upload directory when a file has been assigned" do
+        @event.image = stub_file('test.jpeg')
+        @event.save.should be_true
+        @event.image.should be_an_instance_of(@uploader)
+        @event.image.current_path.should == public_path('uploads/test.jpeg')
+      end
+      
+      describe 'with validation' do
+
+        before do
+          @class.class_eval do
+            validates_each :image do |object, attribute, value|
+              object.errors[attribute] << 'FAIL!'
+            end
+          end
+        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
+        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'
+      end
+      
+    end
+    
+    describe 'with overriddent filename' do
+      
+      describe '#save' do
+
+        before do
+          @uploader.class_eval do
+            def filename
+              model.name + File.extname(super)
+            end
+          end
+          @event.stub!(:name).and_return('jonas')
+        end
+
+        it "should copy the file to the upload directory when a file has been assigned" do
+          @event.image = stub_file('test.jpeg')
+          @event.save.should be_true
+          @event.image.should be_an_instance_of(@uploader)
+          @event.image.current_path.should == public_path('uploads/jonas.jpeg')
+        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'
+        end
+
+      end
+
+    end
+    
+  end
+end

data/spec/sanitized_file_spec.rb

@@ -2,8 +2,6 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe CarrierWave::SanitizedFile do
   
-  include SanitizedFileSpecHelper
-  
   before do
     unless File.exists?(file_path('llama.jpg'))
       FileUtils.cp(file_path('test.jpg'), file_path('llama.jpg'))
@@ -206,15 +204,9 @@ describe CarrierWave::SanitizedFile do
         @sanitized_file.extension.should == 'png'
       end
       
-      describe "with permissions set" do
-        before do
-          @sanitized_file.options[:permissions] = 0755
-        end
-
-        it "should set the right permissions" do
-          @sanitized_file.move_to(file_path('gurr.png'))
-          @sanitized_file.should have_permissions(0755)
-        end
+      it "should set the right permissions" do
+        @sanitized_file.move_to(file_path('gurr.png'), 0755)
+        @sanitized_file.should have_permissions(0755)
       end
       
     end
@@ -266,15 +258,9 @@ describe CarrierWave::SanitizedFile do
         new_file.extension.should == 'png'
       end
       
-      describe "with permissions set" do
-        before do
-          @sanitized_file.options[:permissions] = 0755
-        end
-
-        it "should set the right permissions" do
-          new_file = @sanitized_file.copy_to(file_path('gurr.png'))
-          new_file.should have_permissions(0755)
-        end
+      it "should set the right permissions" do
+        new_file = @sanitized_file.copy_to(file_path('gurr.png'), 0755)
+        new_file.should have_permissions(0755)
       end
 
     end
@@ -345,9 +331,9 @@ describe CarrierWave::SanitizedFile do
       end
     end
   
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be false" do
-        @sanitized_file.string?.should be_false
+        @sanitized_file.is_path?.should be_false
       end
     end
   
@@ -363,9 +349,9 @@ describe CarrierWave::SanitizedFile do
 
     it_should_behave_like "all valid sanitized files that are stored on disk"
 
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be false" do
-        @sanitized_file.string?.should be_false
+        @sanitized_file.is_path?.should be_false
       end
     end
     
@@ -391,9 +377,9 @@ describe CarrierWave::SanitizedFile do
       end
     end
     
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be false" do
-        @sanitized_file.string?.should be_false
+        @sanitized_file.is_path?.should be_false
       end
     end
 
@@ -422,9 +408,9 @@ describe CarrierWave::SanitizedFile do
   
     it_should_behave_like "all valid sanitized files that are stored on disk"
 
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be false" do
-        @sanitized_file.string?.should be_false
+        @sanitized_file.is_path?.should be_false
       end
     end
 
@@ -448,9 +434,9 @@ describe CarrierWave::SanitizedFile do
   
     it_should_behave_like "all valid sanitized files that are stored on disk"
 
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be true" do
-        @sanitized_file.string?.should be_true
+        @sanitized_file.is_path?.should be_true
       end
     end
     
@@ -474,9 +460,9 @@ describe CarrierWave::SanitizedFile do
 
     it_should_behave_like "all valid sanitized files that are stored on disk"
 
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be true" do
-        @sanitized_file.string?.should be_true
+        @sanitized_file.is_path?.should be_true
       end
     end
     
@@ -506,9 +492,9 @@ describe CarrierWave::SanitizedFile do
       end
     end
 
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be false" do
-        @empty.string?.should be_false
+        @empty.is_path?.should be_false
       end
     end
 
@@ -572,9 +558,9 @@ describe CarrierWave::SanitizedFile do
       end
     end
 
-    describe '#string?' do
+    describe '#is_path?' do
       it "should be false" do
-        @empty.string?.should be_false
+        @empty.is_path?.should be_false
       end
     end