carrierwave 0.2.1 → 0.2.3

data/lib/carrierwave/uploader/url.rb

@@ -0,0 +1,22 @@
+module CarrierWave
+  module Uploader
+    module Url
+
+      ##
+      # === Returns
+      #
+      # [String] the location where this file is accessible via a url
+      #
+      def url
+        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), '')
+        end
+      end
+
+      alias_method :to_s, :url
+
+    end # Url
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/versions.rb

@@ -0,0 +1,145 @@
+module CarrierWave
+  module Uploader
+    module Versions
+
+      setup do
+        after :cache, :cache_versions!
+        after :store, :store_versions!
+        after :remove, :remove_versions!
+        after :retrieve_from_cache, :retrieve_versions_from_cache!
+        after :retrieve_from_store, :retrieve_versions_from_store!
+      end
+
+      module ClassMethods
+
+        def version_names
+          @version_names ||= []
+        end
+
+        ##
+        # Adds a new version to this uploader
+        #
+        # === Parameters
+        #
+        # [name (#to_sym)] name of the version
+        # [&block (Proc)] a block to eval on this version of the uploader
+        #
+        def version(name, &block)
+          name = name.to_sym
+          unless versions[name]
+            versions[name] = Class.new(self)
+            versions[name].version_names.push(*version_names)
+            versions[name].version_names.push(name)
+            class_eval <<-RUBY
+              def #{name}
+                versions[:#{name}]
+              end
+            RUBY
+          end
+          versions[name].class_eval(&block) if block
+          versions[name]
+        end
+
+        ##
+        # === Returns
+        #
+        # [Hash{Symbol => Class}] a list of versions available for this uploader
+        #
+        def versions
+          @versions ||= {}
+        end
+
+      end # ClassMethods
+
+      ##
+      # Returns a hash mapping the name of each version of the uploader to an instance of it
+      #
+      # === Returns
+      #
+      # [Hash{Symbol => CarrierWave::Uploader}] a list of uploader instances
+      #
+      def versions
+        return @versions if @versions
+        @versions = {}
+        self.class.versions.each do |name, klass|
+          @versions[name] = klass.new(model, mounted_as)
+        end
+        @versions
+      end
+
+      ##
+      # === Returns
+      #
+      # [String] the name of this version of the uploader
+      #
+      def version_name
+        self.class.version_names.join('_').to_sym unless self.class.version_names.blank?
+      end
+
+      ##
+      # When given a version name as a parameter, will return the url for that version
+      # This also works with nested versions.
+      #
+      # === Example
+      #
+      #     my_uploader.url                 # => /path/to/my/uploader.gif
+      #     my_uploader.url(:thumb)         # => /path/to/my/thumb_uploader.gif
+      #     my_uploader.url(:thumb, :small) # => /path/to/my/thumb_small_uploader.gif
+      #
+      # === Parameters
+      #
+      # [*args (Symbol)] any number of versions
+      #
+      # === Returns
+      #
+      # [String] the location where this file is accessible via a url
+      #
+      def url(*args)
+        if(args.first)
+          raise ArgumentError, "Version #{args.first} doesn't exist!" if versions[args.first.to_sym].nil?
+          # recursively proxy to version
+          versions[args.first.to_sym].url(*args[1..-1])
+        else
+          super()
+        end
+      end
+
+    private
+
+      def full_filename(for_file)
+        [version_name, super(for_file)].compact.join('_')
+      end
+
+      def full_original_filename
+        [version_name, super].compact.join('_')
+      end
+
+      def cache_versions!(new_file)
+        versions.each do |name, v|
+          v.send(:cache_id=, cache_id)
+          v.cache!(new_file)
+        end
+      end
+
+      def store_versions!(new_file)
+        versions.each { |name, v| v.store!(new_file) }
+      end
+
+      def remove_versions!
+        versions.each do |name, v|
+          CarrierWave.logger.info "CarrierWave: removing file for version #{v.version_name}"
+          v.remove!
+        end
+      end
+
+      def retrieve_versions_from_cache!(cache_name)
+        versions.each { |name, v| v.retrieve_from_cache!(cache_name) }
+      end
+
+      def retrieve_versions_from_store!(identifier)
+        versions.each { |name, v| v.retrieve_from_store!(identifier) }
+      end
+
+    end # Versions
+  end # Uploader
+end # CarrierWave

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