carrierwave 0.2.1 → 0.2.3

data/spec/uploader/remove_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CarrierWave::Uploader do
+
+  before do
+    @uploader_class = Class.new(CarrierWave::Uploader::Base)
+    @uploader = @uploader_class.new
+  end
+
+  after do
+    FileUtils.rm_rf(public_path)
+  end
+
+  describe '#remove!' do
+    before do
+      @file = File.open(file_path('test.jpg'))
+
+      @stored_file = mock('a stored file')
+      @stored_file.stub!(:path).and_return('/path/to/somewhere')
+      @stored_file.stub!(:url).and_return('http://www.example.com')
+      @stored_file.stub!(:identifier).and_return('this-is-me')
+
+      @uploader_class.storage.stub!(:store!).and_return(@stored_file)
+      @uploader_class.storage.stub!(:destroy!)
+      @uploader.store!(@file)
+    end
+
+    it "should reset the current path" do
+      @uploader.remove!
+      @uploader.current_path.should be_nil
+    end
+
+    it "should not be cached" do
+      @uploader.remove!
+      @uploader.should_not be_cached
+    end
+
+    it "should reset the url" do
+      @uploader.cache!(@file)
+      @uploader.remove!
+      @uploader.url.should be_nil
+    end
+
+    it "should reset the identifier" do
+      @uploader.remove!
+      @uploader.identifier.should be_nil
+    end
+
+    it "should instruct the storage engine to remove the file" do
+      @uploader_class.storage.should_receive(:destroy!).with(@uploader, @uploader.file)
+      @uploader.remove!
+    end
+
+    it "should reset the cache_name" do
+      @uploader.cache!(@file)
+      @uploader.remove!
+      @uploader.cache_name.should be_nil
+    end
+
+    it "should do nothing when trying to remove an empty file" do
+      running { @uploader.remove! }.should_not raise_error
+    end
+  end
+
+end

data/spec/uploader/store_spec.rb

@@ -0,0 +1,260 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CarrierWave::Uploader do
+
+  before do
+    @uploader_class = Class.new(CarrierWave::Uploader::Base)
+    @uploader = @uploader_class.new
+  end
+
+  after do
+    FileUtils.rm_rf(public_path)
+  end
+
+  describe ".storage" do
+    before do
+      CarrierWave::Storage::File.stub!(:setup!)
+      CarrierWave::Storage::S3.stub!(:setup!)
+    end
+
+    it "should set the storage if an argument is given" do
+      storage = mock('some kind of storage')
+      storage.should_receive(:setup!)
+      @uploader_class.storage storage
+      @uploader_class.storage.should == storage
+    end
+
+    it "should default to file" do
+      @uploader_class.storage.should == CarrierWave::Storage::File
+    end
+
+    it "should set the storage from the configured shortcuts if a symbol is given" do
+      @uploader_class.storage :file
+      @uploader_class.storage.should == CarrierWave::Storage::File
+    end
+
+    it "should remember the storage when inherited" do
+      @uploader_class.storage :s3
+      subclass = Class.new(@uploader_class)
+      subclass.storage.should == CarrierWave::Storage::S3
+    end
+
+    it "should be changeable when inherited" do
+      @uploader_class.storage :s3
+      subclass = Class.new(@uploader_class)
+      subclass.storage.should == CarrierWave::Storage::S3
+      subclass.storage :file
+      subclass.storage.should == CarrierWave::Storage::File
+    end
+  end
+
+  describe '#store_dir' do
+    it "should default to the config option" do
+      @uploader.store_dir.should == 'uploads'
+    end
+  end
+
+  describe '#filename' do
+    it "should default to nil" do
+      @uploader.filename.should be_nil
+    end
+  end
+
+  describe '#store!' do
+    before do
+      @file = File.open(file_path('test.jpg'))
+
+      @stored_file = mock('a stored file')
+      @stored_file.stub!(:path).and_return('/path/to/somewhere')
+      @stored_file.stub!(:url).and_return('http://www.example.com')
+      @stored_file.stub!(:identifier).and_return('this-is-me')
+
+      @uploader_class.storage.stub!(:store!).and_return(@stored_file)
+    end
+
+    it "should set the current path" do
+      @uploader.store!(@file)
+      @uploader.current_path.should == '/path/to/somewhere'
+    end
+
+    it "should not be cached" do
+      @uploader.store!(@file)
+      @uploader.should_not be_cached
+    end
+
+    it "should set the url" do
+      @uploader.store!(@file)
+      @uploader.url.should == 'http://www.example.com'
+    end
+
+    it "should set the identifier" do
+      @uploader.store!(@file)
+      @uploader.identifier.should == 'this-is-me'
+    end
+
+    it "should, if a file is given as argument, cache that file" do
+      @uploader.should_receive(:cache!).with(@file)
+      @uploader.store!(@file)
+    end
+
+    it "should use a previously cached file if no argument is given" do
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.should_not_receive(:cache!)
+      @uploader.store!
+    end
+
+    it "should instruct the storage engine to store the file" do
+      @uploader.cache!(@file)
+      @uploader_class.storage.should_receive(:store!).with(@uploader, @uploader.file).and_return(:monkey)
+      @uploader.store!
+    end
+
+    it "should reset the cache_name" do
+      @uploader.cache!(@file)
+      @uploader.store!
+      @uploader.cache_name.should be_nil
+    end
+
+    it "should cache the result given by the storage engine" do
+      @uploader.store!(@file)
+      @uploader.file.should == @stored_file
+    end
+
+    it "should do nothing when trying to store an empty file" do
+      @uploader.store!(nil)
+    end
+
+    it "should not re-store a retrieved file" do
+      @stored_file = mock('a stored file')
+      @uploader_class.storage.stub!(:retrieve!).and_return(@stored_file)
+
+      @uploader_class.storage.should_not_receive(:store!)
+      @uploader.retrieve_from_store!('monkey.txt')
+      @uploader.store!
+    end
+  end
+
+  describe '#retrieve_from_store!' do
+    before do
+      @stored_file = mock('a stored file')
+      @stored_file.stub!(:path).and_return('/path/to/somewhere')
+      @stored_file.stub!(:url).and_return('http://www.example.com')
+      @stored_file.stub!(:identifier).and_return('this-is-me')
+
+      @uploader_class.storage.stub!(:retrieve!).and_return(@stored_file)
+    end
+
+    it "should set the current path" do
+      @uploader.retrieve_from_store!('monkey.txt')
+      @uploader.current_path.should == '/path/to/somewhere'
+    end
+
+    it "should not be cached" do
+      @uploader.retrieve_from_store!('monkey.txt')
+      @uploader.should_not be_cached
+    end
+
+    it "should set the url" do
+      @uploader.retrieve_from_store!('monkey.txt')
+      @uploader.url.should == 'http://www.example.com'
+    end
+
+    it "should set the identifier" do
+      @uploader.retrieve_from_store!('monkey.txt')
+      @uploader.identifier.should == 'this-is-me'
+    end
+
+    it "should instruct the storage engine to retrieve the file and store the result" do
+      @uploader_class.storage.should_receive(:retrieve!).with(@uploader, 'monkey.txt').and_return(@stored_file)
+      @uploader.retrieve_from_store!('monkey.txt')
+      @uploader.file.should == @stored_file
+    end
+
+    it "should overwrite a file that has already been cached" do
+      @uploader.retrieve_from_cache!('20071201-1234-345-2255/test.jpeg')
+      @uploader.retrieve_from_store!('bork.txt')
+      @uploader.file.should == @stored_file
+    end
+  end
+
+  describe 'with an overridden, reversing, filename' do
+    before do
+      @uploader_class.class_eval do
+        def filename
+          super.reverse unless super.blank?
+        end
+      end
+    end
+
+    describe '#store!' do
+      before do
+        @file = File.open(file_path('test.jpg'))
+
+        @stored_file = mock('a stored file')
+        @stored_file.stub!(:path).and_return('/path/to/somewhere')
+        @stored_file.stub!(:url).and_return('http://www.example.com')
+
+        @uploader_class.storage.stub!(:store!).and_return(@stored_file)
+      end
+
+      after do
+        CarrierWave.config[:use_cache] = true
+      end
+
+      it "should set the current path" do
+        @uploader.store!(@file)
+        @uploader.current_path.should == '/path/to/somewhere'
+      end
+
+      it "should set the url" do
+        @uploader.store!(@file)
+        @uploader.url.should == 'http://www.example.com'
+      end
+
+      it "should, if a file is given as argument, reverse the filename" do
+        @uploader.store!(@file)
+        @uploader.filename.should == 'gpj.tset'
+      end
+
+      it "should, if a files is given as an argument and use_cache is false, reverse the filename" do
+        CarrierWave.config[:use_cache] = false
+        @uploader.store!(@file)
+        @uploader.filename.should == 'gpj.tset'
+      end
+
+    end
+
+    describe '#retrieve_from_store!' do
+      before do
+        @stored_file = mock('a stored file')
+        @stored_file.stub!(:path).and_return('/path/to/somewhere')
+        @stored_file.stub!(:url).and_return('http://www.example.com')
+
+        @uploader_class.storage.stub!(:retrieve!).and_return(@stored_file)
+      end
+
+      it "should set the current path" do
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.current_path.should == '/path/to/somewhere'
+      end
+
+      it "should set the url" do
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.url.should == 'http://www.example.com'
+      end
+
+      it "should pass the identifier to the storage engine" do
+        @uploader_class.storage.should_receive(:retrieve!).with(@uploader, 'monkey.txt').and_return(@stored_file)
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.file.should == @stored_file
+      end
+
+      it "should not set the filename" do
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.filename.should be_nil
+      end
+    end
+
+  end
+
+end

data/spec/uploader/url_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CarrierWave::Uploader do
+
+  before do
+    @uploader_class = Class.new(CarrierWave::Uploader::Base)
+    @uploader = @uploader_class.new
+  end
+
+  after do
+    FileUtils.rm_rf(public_path)
+  end
+
+  describe '#url' do
+    before do
+      CarrierWave.stub!(:generate_cache_id).and_return('20071201-1234-345-2255')
+    end
+
+    it "should default to nil" do
+      @uploader.url.should be_nil
+    end
+
+    it "should raise ArgumentError when version doesn't exist" do
+      lambda { @uploader.url(:thumb) }.should raise_error ArgumentError
+    end
+
+    it "should not raise ArgumentError when versions version exists" do
+      @uploader_class.version(:thumb)
+      lambda { @uploader.url(:thumb) }.should_not raise_error ArgumentError
+    end
+
+    it "should get the directory relative to public, prepending a slash" do
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.url.should == '/uploads/tmp/20071201-1234-345-2255/test.jpg'
+    end
+
+    it "should get the directory relative to public for a specific version" do
+      @uploader_class.version(:thumb)
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.url(:thumb).should == '/uploads/tmp/20071201-1234-345-2255/thumb_test.jpg'
+    end
+
+    it "should get the directory relative to public for a nested version" do
+      @uploader_class.version(:thumb) do
+        version(:mini)
+      end
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.url(:thumb, :mini).should == '/uploads/tmp/20071201-1234-345-2255/thumb_mini_test.jpg'
+    end
+
+    it "should return file#url if available" do
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.file.stub!(:url).and_return('http://www.example.com/someurl.jpg')
+      @uploader.url.should == 'http://www.example.com/someurl.jpg'
+    end
+
+    it "should get the directory relative to public, if file#url is blank" do
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.file.stub!(:url).and_return('')
+      @uploader.url.should == '/uploads/tmp/20071201-1234-345-2255/test.jpg'
+    end
+  end
+
+  describe '#to_s' do
+    before do
+      CarrierWave.stub!(:generate_cache_id).and_return('20071201-1234-345-2255')
+    end
+
+    it "should default to nil" do
+      @uploader.to_s.should be_nil
+    end
+
+    it "should get the directory relative to public, prepending a slash" do
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.to_s.should == '/uploads/tmp/20071201-1234-345-2255/test.jpg'
+    end
+
+    it "should return file#url if available" do
+      @uploader.cache!(File.open(file_path('test.jpg')))
+      @uploader.file.stub!(:url).and_return('http://www.example.com/someurl.jpg')
+      @uploader.to_s.should == 'http://www.example.com/someurl.jpg'
+    end
+  end
+
+end

data/spec/uploader/versions_spec.rb

@@ -0,0 +1,275 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CarrierWave::Uploader do
+
+  before do
+    @uploader_class = Class.new(CarrierWave::Uploader::Base)
+    @uploader = @uploader_class.new
+  end
+
+  after do
+    FileUtils.rm_rf(public_path)
+  end
+
+  describe '.version' do
+    it "should add it to .versions" do
+      @uploader_class.version :thumb
+      @uploader_class.versions[:thumb].should be_a(Class)
+      @uploader_class.versions[:thumb].ancestors.should include(@uploader_class)
+    end
+
+    it "should add an accessor which returns the version" do
+      @uploader_class.version :thumb
+      @uploader.thumb.should be_a(@uploader_class)
+    end
+
+    it "should add it to #versions which returns the version" do
+      @uploader_class.version :thumb
+      @uploader.versions[:thumb].should be_a(@uploader_class)
+    end
+
+    it "should set the version name" do
+      @uploader_class.version :thumb
+      @uploader.version_name.should == nil
+      @uploader.thumb.version_name.should == :thumb
+    end
+
+    it "should set the version names on the class" do
+      @uploader_class.version :thumb
+      @uploader.class.version_names.should == []
+      @uploader.thumb.class.version_names.should == [:thumb]
+    end
+
+    it "should remember mount options" do
+      model = mock('a model')
+      @uploader_class.version :thumb
+      @uploader = @uploader_class.new(model, :gazelle)
+
+      @uploader.thumb.model.should == model
+      @uploader.thumb.mounted_as.should == :gazelle
+    end
+
+    it "should apply any overrides given in a block" do
+      @uploader_class.version :thumb do
+        def store_dir
+          public_path('monkey/apache')
+        end
+      end
+      @uploader.store_dir.should == 'uploads'
+      @uploader.thumb.store_dir.should == public_path('monkey/apache')
+    end
+
+    it "should reopen the same class when called multiple times" do
+      @uploader_class.version :thumb do
+        def self.monkey
+          "monkey"
+        end
+      end
+      @uploader_class.version :thumb do
+        def self.llama
+          "llama"
+        end
+      end
+      @uploader_class.version(:thumb).monkey.should == "monkey"
+      @uploader_class.version(:thumb).llama.should == "llama"
+    end
+
+    describe 'with nested versions' do
+      before do
+        @uploader_class.version :thumb do
+          version :mini
+          version :micro
+        end
+      end
+
+      it "should add an array of version names" do
+        @uploader.class.version_names.should == []
+        @uploader.thumb.class.version_names.should == [:thumb]
+        @uploader.thumb.mini.class.version_names.should == [:thumb, :mini]
+        @uploader.thumb.micro.class.version_names.should == [:thumb, :micro]
+      end
+
+      it "should set the version name for the instances" do
+        @uploader.version_name.should be_nil
+        @uploader.thumb.version_name.should == :thumb
+        @uploader.thumb.mini.version_name.should == :thumb_mini
+        @uploader.thumb.micro.version_name.should == :thumb_micro
+      end
+
+    end
+
+  end
+
+  describe 'with a version' do
+    before do
+      @uploader_class.version(:thumb)
+    end
+
+    describe '#cache!' do
+
+      before do
+        CarrierWave.stub!(:generate_cache_id).and_return('20071201-1234-345-2255')
+      end
+
+      it "should set store_path with versions" do
+        @uploader.cache!(File.open(file_path('test.jpg')))
+        @uploader.store_path.should == 'uploads/test.jpg'
+        @uploader.thumb.store_path.should == 'uploads/thumb_test.jpg'
+        @uploader.thumb.store_path('kebab.png').should == 'uploads/thumb_kebab.png'
+      end
+
+      it "should move it to the tmp dir with the filename prefixed" do
+        @uploader.cache!(File.open(file_path('test.jpg')))
+        @uploader.current_path.should == public_path('uploads/tmp/20071201-1234-345-2255/test.jpg')
+        @uploader.thumb.current_path.should == public_path('uploads/tmp/20071201-1234-345-2255/thumb_test.jpg')
+        @uploader.file.exists?.should be_true
+        @uploader.thumb.file.exists?.should be_true
+      end
+    end
+
+    describe '#retrieve_from_cache!' do
+      it "should set the path to the tmp dir" do
+        @uploader.retrieve_from_cache!('20071201-1234-345-2255/test.jpg')
+        @uploader.current_path.should == public_path('uploads/tmp/20071201-1234-345-2255/test.jpg')
+        @uploader.thumb.current_path.should == public_path('uploads/tmp/20071201-1234-345-2255/thumb_test.jpg')
+      end
+
+      it "should set store_path with versions" do
+        @uploader.retrieve_from_cache!('20071201-1234-345-2255/test.jpg')
+        @uploader.store_path.should == 'uploads/test.jpg'
+        @uploader.thumb.store_path.should == 'uploads/thumb_test.jpg'
+        @uploader.thumb.store_path('kebab.png').should == 'uploads/thumb_kebab.png'
+      end
+    end
+
+    describe '#store!' do
+      before do
+        @uploader_class.storage = mock_storage('base')
+        @uploader_class.version(:thumb).storage = mock_storage('thumb')
+
+        @file = File.open(file_path('test.jpg'))
+
+        @base_stored_file = mock('a stored file')
+        @base_stored_file.stub!(:path).and_return('/path/to/somewhere')
+        @base_stored_file.stub!(:url).and_return('http://www.example.com')
+
+        @thumb_stored_file = mock('a thumb version of a stored file')
+        @thumb_stored_file.stub!(:path).and_return('/path/to/somewhere/thumb')
+        @thumb_stored_file.stub!(:url).and_return('http://www.example.com/thumb')
+
+        @uploader_class.storage.stub!(:store!).and_return(@base_stored_file)
+        @uploader_class.version(:thumb).storage.stub!(:store!).and_return(@thumb_stored_file)
+      end
+
+      after do
+        CarrierWave.config[:use_cache] = true
+      end
+
+      it "should set the current path for the version" do
+        @uploader.store!(@file)
+        @uploader.current_path.should == '/path/to/somewhere'
+        @uploader.thumb.current_path.should == '/path/to/somewhere/thumb'
+      end
+
+      it "should set the url" do
+        @uploader.store!(@file)
+        @uploader.url.should == 'http://www.example.com'
+        @uploader.thumb.url.should == 'http://www.example.com/thumb'
+      end
+
+      it "should, if a file is given as argument, set the store_path" do
+        @uploader.store!(@file)
+        @uploader.store_path.should == 'uploads/test.jpg'
+        @uploader.thumb.store_path.should == 'uploads/thumb_test.jpg'
+        @uploader.thumb.store_path('kebab.png').should == 'uploads/thumb_kebab.png'
+      end
+
+      it "should instruct the storage engine to store the file and its version" do
+        @uploader.cache!(@file)
+        @uploader_class.storage.should_receive(:store!).with(@uploader, @uploader.file).and_return(:monkey)
+        @uploader_class.version(:thumb).storage.should_receive(:store!).with(@uploader.thumb, @uploader.thumb.file).and_return(:gorilla)
+        @uploader.store!
+      end
+
+    end
+
+    describe '#remove!' do
+      before do
+        @uploader_class.storage = mock_storage('base')
+        @uploader_class.version(:thumb).storage = mock_storage('thumb')
+
+        @file = File.open(file_path('test.jpg'))
+
+        @base_stored_file = mock('a stored file')
+        @thumb_stored_file = mock('a thumb version of a stored file')
+
+        @uploader_class.storage.stub!(:store!).and_return(@base_stored_file)
+        @uploader_class.version(:thumb).storage.stub!(:store!).and_return(@thumb_stored_file)
+
+        @uploader_class.storage.stub!(:store!).and_return(@base_stored_file)
+        @uploader_class.version(:thumb).storage.stub!(:store!).and_return(@thumb_stored_file)
+
+        @uploader_class.storage.stub!(:destroy!)
+        @uploader_class.version(:thumb).storage.stub!(:destroy!)
+
+        @uploader.store!(@file)
+      end
+
+      after do
+        CarrierWave.config[:use_cache] = true
+      end
+
+      it "should reset the current path for the version" do
+        @uploader.remove!
+        @uploader.current_path.should be_nil
+        @uploader.thumb.current_path.should be_nil
+      end
+
+      it "should reset the url" do
+        @uploader.remove!
+        @uploader.url.should be_nil
+        @uploader.thumb.url.should be_nil
+      end
+
+      it "should instruct the storage engine to remove the file and its versions" do
+        @uploader_class.storage.should_receive(:destroy!).with(@uploader, @uploader.file)
+        @uploader_class.version(:thumb).storage.should_receive(:destroy!).with(@uploader.thumb, @uploader.thumb.file)
+        @uploader.remove!
+      end
+
+    end
+
+
+    describe '#retrieve_from_store!' do
+      before do
+        @stored_file = mock('a stored file')
+        @stored_file.stub!(:path).and_return('/path/to/somewhere')
+        @stored_file.stub!(:url).and_return('http://www.example.com')
+
+        @uploader_class.storage.stub!(:retrieve!).and_return(@stored_file)
+      end
+
+      it "should set the current path" do
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.current_path.should == '/path/to/somewhere'
+      end
+
+      it "should set the url" do
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.url.should == 'http://www.example.com'
+      end
+
+      it "should pass the identifier to the storage engine" do
+        @uploader_class.storage.should_receive(:retrieve!).with(@uploader, 'monkey.txt').and_return(@stored_file)
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.file.should == @stored_file
+      end
+
+      it "should not set the filename" do
+        @uploader.retrieve_from_store!('monkey.txt')
+        @uploader.filename.should be_nil
+      end
+    end
+  end
+
+end