carrierwave 0.3.2 → 0.3.3

data/features/step_definitions/mount_steps.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+When /^I assign the file '([^\']*)' to the '([^\']*)' column$/ do |path, column|
+  @instance.send("#{column}=", File.open(file_path(path)))
+end
+
+Given /^the uploader class is mounted on the '([^\']*)' column$/ do |column|
+  @mountee_klass.mount_uploader column.to_sym, @klass
+end
+
+When /^I retrieve the file later from the cache name for the column '([^\']*)'$/ do |column|
+  new_instance = @instance.class.new
+  new_instance.send("#{column}_cache=", @instance.send("#{column}_cache"))
+  @instance = new_instance
+end
+
+Then /^the url for the column '([^\']*)' should be '([^\']*)'$/ do |column, url|
+  @instance.send("#{column}_url").should == url
+end

data/features/step_definitions/store_steps.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+Given /^the file '(.*?)' is stored at '(.*?)'$/ do |file, stored|
+  FileUtils.mkdir_p(File.dirname(file_path(stored)))
+  FileUtils.cp(file_path(file), file_path(stored))
+end
+
+When /^I store the file$/ do
+  @uploader.store!
+end
+
+When /^I store the file '(.*?)'$/ do |file|
+  @uploader.store!(File.open(file_path(file)))
+end
+
+When /^I retrieve the file '(.*?)' from the store$/ do |identifier|
+  @uploader.retrieve_from_store!(identifier)
+end

data/features/support/activerecord.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'activerecord'
+require 'carrierwave/mount'
+require 'carrierwave/orm/activerecord'
+
+# change this if sqlite is unavailable
+dbconfig = {
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+}
+
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Migration.verbose = false
+
+class TestMigration < ActiveRecord::Migration
+  def self.up
+    create_table :users, :force => true do |t|
+      t.column :avatar, :string
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+
+Before do
+  TestMigration.up
+end

data/features/support/datamapper.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'dm-core'
+require 'carrierwave/mount'
+require 'carrierwave/orm/datamapper'
+
+DataMapper.setup(:default, 'sqlite3::memory:')

data/features/support/env.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require File.join(File.dirname(__FILE__), 'activerecord')
+require File.join(File.dirname(__FILE__), 'datamapper')
+
+if ENV["AS"]
+  puts "--> using ActiveSupport"
+  require 'activesupport'
+elsif ENV["EXTLIB"]
+  puts "--> using Extlib"
+  require 'extlib'
+end
+
+require 'tempfile'
+#require 'ruby-debug'
+require 'spec'
+
+require 'carrierwave'
+
+alias :running :lambda
+
+def file_path( *paths )
+  File.expand_path(File.join(File.dirname(__FILE__), '..', *paths))
+end
+
+CarrierWave.config[:public] = file_path('public')
+CarrierWave.config[:root] = file_path
+
+After do
+  FileUtils.rm_rf(file_path("public"))
+end

data/features/versions_basics.feature

@@ -0,0 +1,50 @@
+Feature: uploader with file storage and versions
+  In order to be awesome
+  As a developer using CarrierWave
+  I want to upload files to the filesystem
+  
+  Background:
+    Given an uploader class that uses the 'file' storage
+    And that the uploader class has a version named 'thumb'
+    And an instance of that class 
+  
+  Scenario: store a file
+    When I store the file 'fixtures/bork.txt'
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/uploads/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the uploader should have the url '/uploads/bork.txt'
+    And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'
+  
+  Scenario: cache a file and then store it
+    When I cache the file 'fixtures/bork.txt'
+    Then there should be a file called 'bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    Then there should be a file called 'thumb_bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    And the file called 'bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+    And there should not be a file at 'public/uploads/bork.txt'
+    And there should not be a file at 'public/uploads/thumb_bork.txt'
+    When I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    And there should be a file at 'public/uploads/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the uploader should have the url '/uploads/bork.txt'
+    And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'
+  
+  Scenario: retrieving a file from cache then storing
+    Given the file 'fixtures/bork.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/bork.txt'
+    Given the file 'fixtures/monkey.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_bork.txt'
+    When I retrieve the cache name '20090212-2343-8336-0348/bork.txt' from the cache
+    And I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/uploads/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_bork.txt' should be identical to the file at 'fixtures/monkey.txt'
+
+  Scenario: retrieving a file from store
+    Given the file 'fixtures/bork.txt' is stored at 'public/uploads/bork.txt'
+    Given the file 'fixtures/monkey.txt' is stored at 'public/uploads/thumb_bork.txt'
+    When I retrieve the file 'bork.txt' from the store
+    Then the uploader should have the url '/uploads/bork.txt'
+    And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'

data/features/versions_nested_versions.feature

@@ -0,0 +1,70 @@
+Feature: uploader with nested versions
+  In order to optimize performance for processing
+  As a developer using CarrierWave
+  I want to set nested versions
+  
+  Background:
+    Given an uploader class that uses the 'file' storage
+    And that the uploader class has a version named 'thumb'
+    And yo dawg, I put a version called 'mini' in your version called 'thumb'
+    And yo dawg, I put a version called 'micro' in your version called 'thumb'
+    And an instance of that class 
+  
+  Scenario: store a file
+    When I store the file 'fixtures/bork.txt'
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/uploads/thumb_bork.txt'
+    Then there should be a file at 'public/uploads/thumb_mini_bork.txt'
+    Then there should be a file at 'public/uploads/thumb_micro_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_mini_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_micro_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the uploader should have the url '/uploads/bork.txt'
+    And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'
+    And the uploader's nested version 'mini' nested in 'thumb' should have the url '/uploads/thumb_mini_bork.txt'
+    And the uploader's nested version 'micro' nested in 'thumb' should have the url '/uploads/thumb_micro_bork.txt'
+  
+  Scenario: cache a file and then store it
+    When I cache the file 'fixtures/bork.txt'
+    Then there should be a file called 'bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    Then there should be a file called 'thumb_bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    And the file called 'bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+    And there should not be a file at 'public/uploads/bork.txt'
+    And there should not be a file at 'public/uploads/thumb_bork.txt'
+    When I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    And there should be a file at 'public/uploads/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the uploader should have the url '/uploads/bork.txt'
+    And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'
+    And the uploader's nested version 'mini' nested in 'thumb' should have the url '/uploads/thumb_mini_bork.txt'
+    And the uploader's nested version 'micro' nested in 'thumb' should have the url '/uploads/thumb_micro_bork.txt'
+  
+  Scenario: retrieving a file from cache then storing
+    Given the file 'fixtures/bork.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/bork.txt'
+    Given the file 'fixtures/monkey.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_bork.txt'
+    Given the file 'fixtures/bork.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_mini_bork.txt'
+    Given the file 'fixtures/monkey.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_micro_bork.txt'
+    When I retrieve the cache name '20090212-2343-8336-0348/bork.txt' from the cache
+    And I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/uploads/thumb_bork.txt'
+    Then there should be a file at 'public/uploads/thumb_mini_bork.txt'
+    Then there should be a file at 'public/uploads/thumb_micro_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_bork.txt' should be identical to the file at 'fixtures/monkey.txt'
+    And the file at 'public/uploads/thumb_mini_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/uploads/thumb_micro_bork.txt' should be identical to the file at 'fixtures/monkey.txt'
+
+  Scenario: retrieving a file from store
+    Given the file 'fixtures/bork.txt' is stored at 'public/uploads/bork.txt'
+    Given the file 'fixtures/monkey.txt' is stored at 'public/uploads/thumb_bork.txt'
+    Given the file 'fixtures/monkey.txt' is stored at 'public/uploads/thumb_mini_bork.txt'
+    Given the file 'fixtures/monkey.txt' is stored at 'public/uploads/thumb_micro_bork.txt'
+    When I retrieve the file 'bork.txt' from the store
+    Then the uploader should have the url '/uploads/bork.txt'
+    And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'
+    And the uploader's nested version 'mini' nested in 'thumb' should have the url '/uploads/thumb_mini_bork.txt'
+    And the uploader's nested version 'micro' nested in 'thumb' should have the url '/uploads/thumb_micro_bork.txt'

data/features/versions_overridden_filename.feature

@@ -0,0 +1,51 @@
+Feature: uploader with file storage and overriden filename
+  In order to customize the filaname of uploaded files
+  As a developer using CarrierWave
+  I want to upload files to the filesystem with an overriden filename and different verions
+  
+  Background:
+    Given an uploader class that uses the 'file' storage
+    And that the uploader class has a version named 'thumb'
+    And that the uploader has the filename overridden to 'grark.png'
+    And an instance of that class
+  
+    Scenario: store a file
+      When I store the file 'fixtures/bork.txt'
+      Then there should be a file at 'public/uploads/grark.png'
+      Then there should be a file at 'public/uploads/thumb_grark.png'
+      And the file at 'public/uploads/grark.png' should be identical to the file at 'fixtures/bork.txt'
+      And the file at 'public/uploads/thumb_grark.png' should be identical to the file at 'fixtures/bork.txt'
+      And the uploader should have the url '/uploads/grark.png'
+      And the uploader's version 'thumb' should have the url '/uploads/thumb_grark.png'
+
+    Scenario: cache a file and then store it
+      When I cache the file 'fixtures/bork.txt'
+      Then there should be a file called 'bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+      Then there should be a file called 'thumb_bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+      And the file called 'bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+      And there should not be a file at 'public/uploads/grark.png'
+      And there should not be a file at 'public/uploads/thumb_grark.png'
+      When I store the file
+      Then there should be a file at 'public/uploads/grark.png'
+      And there should be a file at 'public/uploads/thumb_grark.png'
+      And the file at 'public/uploads/grark.png' should be identical to the file at 'fixtures/bork.txt'
+      And the file at 'public/uploads/thumb_grark.png' should be identical to the file at 'fixtures/bork.txt'
+      And the uploader should have the url '/uploads/grark.png'
+      And the uploader's version 'thumb' should have the url '/uploads/thumb_grark.png'
+
+    Scenario: retrieving a file from cache then storing
+      Given the file 'fixtures/bork.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/bork.txt'
+      Given the file 'fixtures/monkey.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_bork.txt'
+      When I retrieve the cache name '20090212-2343-8336-0348/bork.txt' from the cache
+      And I store the file
+      Then there should be a file at 'public/uploads/grark.png'
+      Then there should be a file at 'public/uploads/thumb_grark.png'
+      And the file at 'public/uploads/grark.png' should be identical to the file at 'fixtures/bork.txt'
+      And the file at 'public/uploads/thumb_grark.png' should be identical to the file at 'fixtures/monkey.txt'
+
+    Scenario: retrieving a file from store
+      Given the file 'fixtures/bork.txt' is stored at 'public/uploads/bork.txt'
+      Given the file 'fixtures/monkey.txt' is stored at 'public/uploads/thumb_bork.txt'
+      When I retrieve the file 'bork.txt' from the store
+      Then the uploader should have the url '/uploads/bork.txt'
+      And the uploader's version 'thumb' should have the url '/uploads/thumb_bork.txt'

data/features/versions_overriden_store_dir.feature

@@ -0,0 +1,41 @@
+Feature: uploader with file storage and versions with overridden store dir
+  In order to be awesome
+  As a developer using CarrierWave
+  I want to upload files to the filesystem
+  
+  Background:
+    Given an uploader class that uses the 'file' storage
+    And that the uploader class has a version named 'thumb'
+    And that the version 'thumb' has the store_dir overridden to 'public/monkey/llama'
+    And an instance of that class
+  
+  Scenario: store a file
+    When I store the file 'fixtures/bork.txt'
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/monkey/llama/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/monkey/llama/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+  
+  Scenario: cache a file and then store it
+    When I cache the file 'fixtures/bork.txt'
+    Then there should be a file called 'bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    Then there should be a file called 'thumb_bork.txt' somewhere in a subdirectory of 'public/uploads/tmp'
+    And the file called 'bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+    And the file called 'thumb_bork.txt' in a subdirectory of 'public/uploads/tmp' should be identical to the file at 'fixtures/bork.txt'
+    And there should not be a file at 'public/uploads/bork.txt'
+    And there should not be a file at 'public/monkey/llama/thumb_bork.txt'
+    When I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/monkey/llama/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/monkey/llama/thumb_bork.txt' should be identical to the file at 'fixtures/bork.txt'
+  
+  Scenario: retrieving a file from cache then storing
+    Given the file 'fixtures/bork.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/bork.txt'
+    Given the file 'fixtures/monkey.txt' is cached file at 'public/uploads/tmp/20090212-2343-8336-0348/thumb_bork.txt'
+    When I retrieve the cache name '20090212-2343-8336-0348/bork.txt' from the cache
+    And I store the file
+    Then there should be a file at 'public/uploads/bork.txt'
+    Then there should be a file at 'public/monkey/llama/thumb_bork.txt'
+    And the file at 'public/uploads/bork.txt' should be identical to the file at 'fixtures/bork.txt'
+    And the file at 'public/monkey/llama/thumb_bork.txt' should be identical to the file at 'fixtures/monkey.txt'

data/lib/carrierwave.rb

@@ -6,6 +6,9 @@ require 'carrierwave/core_ext/module_setup'
 require 'carrierwave/core_ext/inheritable_attributes'
 
 module CarrierWave
+
+  VERSION = "0.3.3"
+
   class << self
     attr_accessor :config, :logger
 
@@ -135,3 +138,8 @@ elsif defined?(Sinatra)
   CarrierWave.config[:public] = Sinatra::Application.public
 
 end
+
+# MongoMapper is framework agnostic so we could need this in any environment.
+if defined?(MongoMapper)
+  require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongomapper")
+end

data/lib/carrierwave/orm/mongomapper.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'mongomapper'
+
+module CarrierWave
+  module MongoMapper
+    include CarrierWave::Mount
+    ##
+    # See +CarrierWave::Mount#mount_uploader+ for documentation
+    #
+    def mount_uploader(column, uploader, options={}, &block)
+      # We need to set the mount_on column (or key in MongoMapper's case)
+      # since MongoMapper will attempt to set the filename on 
+      # the uploader instead of the file on a Document's initialization.
+      options[:mount_on] ||= "#{column}_filename"
+      key options[:mount_on]
+      
+      super
+      alias_method :read_uploader, :[]
+      alias_method :write_uploader, :[]=
+      after_save "store_#{column}!".to_sym
+      before_save "write_#{column}_identifier".to_sym
+      after_destroy "remove_#{column}!".to_sym
+    end
+  end # MongoMapper
+end # CarrierWave
+
+MongoMapper::Document::ClassMethods.send(:include, CarrierWave::MongoMapper)

data/lib/carrierwave/processing/rmagick.rb

@@ -1,9 +1,11 @@
 # encoding: utf-8
 
-begin
-  require 'rmagick'
-rescue LoadError
-  require 'RMagick'
+unless Module.const_defined?('Magick')
+  begin
+    require 'rmagick'
+  rescue LoadError
+    require 'RMagick'
+  end
 end
 
 module CarrierWave

data/lib/carrierwave/storage/abstract.rb

@@ -14,19 +14,19 @@ module CarrierWave
       def initialize(uploader)
         @uploader = uploader
       end
-      
+
       def self.setup!; end
-      
+
       def identifier
         uploader.filename
       end
-      
+
       def store!(file)
       end
-      
+
       def retrieve!(identifier)
       end
-      
+
     end # Abstract
   end # Storage
 end # CarrierWave

data/lib/carrierwave/storage/s3.rb

@@ -29,6 +29,18 @@ module CarrierWave
     #
     # The default is :public_read, it should work in most cases.
     #
+    # You can change the generated url to a cnamed domain by setting the cnamed config:
+    #
+    #     CarrierWave.config[:s3][:cnamed] = true
+    #
+    # No the resulting url will be
+    #     
+    #     http://bucket_name.domain.tld/path/to/file
+    #
+    # instead of
+    #
+    #     http://s3.amazonaws.com/bucket_name.domain.tld/path/to/file
+    #
     class S3 < Abstract
 
       class File
@@ -86,7 +98,11 @@ module CarrierWave
         # [String] file's url
         #
         def url
-          ["http://s3.amazonaws.com", bucket, @path].compact.join('/')
+          if CarrierWave::config[:s3][:cnamed]
+            ["http://", bucket, @path].compact.join('/')
+          else
+            ["http://s3.amazonaws.com", bucket, @path].compact.join('/')
+          end
         end
 
         def about