carrierwave 0.5.2 → 0.5.3

data/README.rdoc

@@ -1,9 +1,5 @@
 = CarrierWave
 
-http://carrierwave.rubyforge.org
-
-== Summary
-
 This gem provides a simple and extremely flexible way to upload files from Ruby applications.
 It works well with Rack based web applications, such as Ruby on Rails.
 
@@ -15,10 +11,10 @@ It works well with Rack based web applications, such as Ruby on Rails.
 
 == Getting Help
 
-* Please direct any questions to the {mailing list}[http://groups.google.com/group/carrierwave]
-* Please report any issues on the {issue tracker}[http://github.com/jnicklas/carrierwave/issues]
+* Please ask the {Groogle Group}[http://groups.google.com/group/carrierwave] for help if you have any questions.
+* Please report bugs on the {issue tracker}[http://github.com/jnicklas/carrierwave/issues] but read the "getting help" section in the wiki first.
 
-== Getting Started
+== Installation
 
 Install the latest stable release:
 
@@ -28,12 +24,10 @@ In Rails, add it to your Gemfile:
 
     gem 'carrierwave'
 
-== Rails 2.3.x Compatibility
-
-CarrierWave is only compatible with Rails 3 and later as of version 0.5. If you want to use
-Rails 2, please use the latest gem in the 0.4.X series.
+Note that CarrierWave is not compatible with Rails 2 as of version 0.5. If you want to use
+Rails 2, please use the 0.4-stable branch on GitHub.
 
-== Quick Start
+== Getting Started
 
 Start off by generating an uploader:
 
@@ -96,6 +90,12 @@ automatically be stored when the record is saved.
     u.avatar.url # => '/url/to/file.png'
     u.avatar.current_path # => 'path/to/file.png'
 
+If using DataMapper, make sure to disable auto_validation on the mounted column.
+
+If using Mongoid, note that embedded documents files aren't saved when parent documents are saved.
+You must explicitly call save on embedded documents in order to save their attached files.
+You can read more about this {here}[https://github.com/jnicklas/carrierwave/issues#issue/81]
+
 == Changing the storage directory
 
 In order to change where uploaded files are put, just override the +store_dir+
@@ -154,7 +154,7 @@ contain Russian letters:
       end
     end
 
-Also make sure that allowing non-latin characters won't cause a compatibily issue with a third-party
+Also make sure that allowing non-latin characters won't cause a compatibility issue with a third-party
 plugins or client-side software.
 
 == Adding versions
@@ -277,7 +277,7 @@ this easily by overriding the +default_url+ method in your uploader:
 
 You might come to a situation where you want to retroactively change a version
 or add a new one. You can use the recreate_versions! method to recreate the
-versions from the base file. This uses a naive approach which will reupload and
+versions from the base file. This uses a naive approach which will re-upload and
 process all versions.
 
    instance = MyUploader.new
@@ -309,7 +309,7 @@ If you're using Rails, create an initializer for this:
 
     config/initializers/carrierwave.rb
 
-== Testing CarrierWave
+== Testing with CarrierWave
 
 It's a good idea to test you uploaders in isolation. In order to speed up your
 tests, it's recommended to switch off processing in your tests, and to use the
@@ -365,63 +365,87 @@ Fog[http://github.com/geemus/fog] is used to support Amazon S3. Ensure you have
 
     gem install fog
 
-You'll need to configure a bucket, access id and secret key like this in an initializer:
+You'll need to provide your fog_credentials and a fog_directory (also known as a bucket) in an initializer.
+You can also pass in additional options, as documented fully in lib/storage/fog.rb. Here's a full example:
 
     CarrierWave.configure do |config|
-      config.s3_access_key_id = 'xxxxxx'
-      config.s3_secret_access_key = 'xxxxxx'
-      config.s3_bucket = 'name_of_bucket'
+      config.fog_credentials = {
+        :provider               => 'AWS',       # required
+        :aws_access_key_id      => 'xxx',       # required
+        :aws_secret_access_key  => 'yyy',       # required
+        :region                 => 'eu-west-1'  # optional, defaults to 'us-east-1'
+      }
+      config.fog_directory  = 'name_of_directory'                     # required
+      config.fog_host       = 'https://assets.example.com'            # optional, defaults to nil
+      config.fog_public     = false                                   # optional, defaults to true
+      config.fog_attributes = {'Cache-Control'=>'max-age=315576000'}  # optional, defaults to {}
     end
 
-You'll need to create the bucket on Amazon S3 if it doesn't already exist.
-
-In your uploader, set the storage to :s3
+In your uploader, set the storage to :fog
 
     class AvatarUploader < CarrierWave::Uploader::Base
-      storage :s3
+      storage :fog
     end
 
-You can specify a region. US Standard "us-east-1" is the default.
+That's it! You can still use the <code>CarrierWave::Uploader#url</code> method to return the url to the file on Amazon S3.
 
-    CarrierWave.configure do |config|
-      config.s3_region = 'eu-west-1'
-    end
-
-Available options are defined in Fog Storage[http://github.com/geemus/fog/blob/master/lib/fog/aws/storage.rb]
-
-    'eu-west-1' => 's3-eu-west-1.amazonaws.com'
-    'us-east-1' => 's3.amazonaws.com'
-    'ap-southeast-1' => 's3-ap-southeast-1.amazonaws.com'
-    'us-west-1' => 's3-us-west-1.amazonaws.com'
+== Using Rackspace Cloud Files
 
-That's it! You can still use the <code>CarrierWave::Uploader#url</code> method to return
-the url to the file on Amazon S3.
+Fog[http://github.com/geemus/fog] is used to support Rackspace Cloud Files. Ensure you have it installed:
 
-== Using Rackspace Cloud Files
+    gem install fog
 
-Cloud Files support requires a {Rackspace Cloud}[http://rackspacecloud.com] username and API key.
-You must also create a container for Carrierwave to use, and mark it public (publish it to the CDN)
+You'll need to configure a directory (also known as a container), username and api key like this in an initializer:
 
     CarrierWave.configure do |config|
-      config.cloud_files_username = 'xxxxxx'
-      config.cloud_files_api_key = 'xxxxxxxxxxxxxxxxxxxxx'
-      config.cloud_files_container = 'name_of_bucket'
+      config.fog_credentials = {
+        :provider           => 'Rackspace',
+        :rackspace_username => 'xxxxxx',
+        :rackspace_api_key  => 'yyyyyy'
+      }
+      config.fog_directory = 'name_of_directory'
     end
 
 You can optionally include your CDN host name in the configuration.
 This is *highly* recommended, as without it every request requires a lookup
 of this information.
 
-    config.cloud_files_cdn_host = "c000000.cdn.rackspacecloud.com"
+    config.fog_host = "c000000.cdn.rackspacecloud.com"
 
-In your uploader, set the storage to :cloud_files
+In your uploader, set the storage to :fog
 
     class AvatarUploader < CarrierWave::Uploader::Base
-      storage :cloud_files
+      storage :fog
     end
 
 That's it! You can still use the <code>CarrierWave::Uploader#url</code> method to return
-the url to the file on the Cloud Files CDN.
+the url to the file on Rackspace Cloud Files.
+
+== Using Google Storage for Developers
+
+Fog[http://github.com/geemus/fog] is used to support Google Storage for Developers. Ensure you have it installed:
+
+    gem install fog
+
+You'll need to configure a directory (also known as a bucket), access key id and secret access key like this in an initializer:
+
+    CarrierWave.configure do |config|
+      config.fog_credentials = {
+        :provider                         => 'Google',
+        :google_storage_access_key_id     => 'xxxxxx',
+        :google_storage_secret_access_key => 'yyyyyy'
+      }
+      config.fog_directory = 'name_of_directory'
+    end
+
+In your uploader, set the storage to :fog
+
+    class AvatarUploader < CarrierWave::Uploader::Base
+      storage :fog
+    end
+
+That's it! You can still use the <code>CarrierWave::Uploader#url</code> method to return
+the url to the file on Google.
 
 == Using MongoDB's GridFS store
 
@@ -512,7 +536,7 @@ for the RMagick processor.
       process :resize_to_fill => [200, 200]
     end
 
-== Migrating
+== Migrating from Paperclip
 
 If you are using Paperclip, you can use the provided compatibility module:
 
@@ -521,19 +545,19 @@ If you are using Paperclip, you can use the provided compatibility module:
     end
 
 See the documentation for <code>CarrierWave::Compatibility::Paperclip</code> for more
-detaills.
+details.
 
 Be sure to use mount_on to specify the correct column:
 
     mount_uploader :avatar, AvatarUploader, :mount_on => :avatar_file_name
 
-Unfortunately AttachmentFoo differs too much in philosophy for there to be a
+Unfortunately attachment_fu differs too much in philosophy for there to be a
 sensible compatibility mode. Patches for migrating from other solutions will be
 happily accepted.
 
 == i18n
 
-The activerecord validations use the Rails i18n framework. Add these keys to
+The Active Record validations use the Rails i18n framework. Add these keys to
 your translations file:
 
     errors:
@@ -541,6 +565,36 @@ your translations file:
         carrierwave_processing_error: 'Cannot resize image.'
         carrierwave_integrity_error: 'Not an image.'
 
+== Contributing to CarrierWave
+
+CarrierWave thrives on a large number of {contributors}[https://github.com/jnicklas/carrierwave/contributors],
+and pull requests are very welcome. Before submitting a pull request, please make sure that your changes are well tested.
+
+You'll need to install bundler and the gem dependencies:
+
+    gem install bundler
+    bundle install
+
+You should now be able to run the local tests:
+
+    bundle exec rake
+
+You can also run the remote specs by creating a ~/.fog file:
+
+    :carrierwave:
+      :aws_access_key_id: xxx
+      :aws_secret_access_key: yyy
+      :rackspace_username: xxx
+      :rackspace_api_key: yyy
+      :google_storage_access_key_id: xxx
+      :google_storage_secret_access_key: yyy
+
+You should now be able to run the remote tests:
+
+    REMOTE=true bundle exec rake
+
+Please test with the latest Ruby 1.8.x and 1.9.x versions using RVM if possible.
+
 == License
 
 Copyright (c) 2008 Jonas Nicklas
@@ -563,25 +617,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-== Development
-
-In order to setup a development environment and run the specs, you'll
-need to install bundler:
-
-    gem install bundler
-
-And then install the dependencies:
-
-    bundle install
-
-You should now be able to run the tests:
-
-    bundle exec rake
-
-You can also run the remote specs for Amazon S3 and Rackspace Cloud Files like so:
-
-    S3_SPEC=true CARRIERWAVE_TEST_BUCKET= S3_ACCESS_KEY_ID= S3_SECRET_ACCESS_KEY= bundle exec rake
-    CLOUDFILES_SPEC=true CLOUD_FILES_USER_NAME= CLOUD_FILES_API_KEY= CARRIERWAVE_TEST_CONTAINER= bundle exec rake
-
-Issues are reported on GitHub, pull requests are very welcome!

data/lib/carrierwave.rb

@@ -35,6 +35,7 @@ module CarrierWave
   module Storage
     autoload :Abstract, 'carrierwave/storage/abstract'
     autoload :File, 'carrierwave/storage/file'
+    autoload :Fog, 'carrierwave/storage/fog'
     autoload :S3, 'carrierwave/storage/s3'
     autoload :GridFS, 'carrierwave/storage/grid_fs'
     autoload :RightS3, 'carrierwave/storage/right_s3'
@@ -84,6 +85,12 @@ elsif defined?(Rails)
       initializer "carrierwave.setup_paths" do
         CarrierWave.root = Rails.root.join(Rails.public_path).to_s
       end
+
+      initializer "carrierwave.active_record" do
+        ActiveSupport.on_load :active_record do
+          require 'carrierwave/orm/activerecord'
+        end
+      end
     end
   end
 
@@ -93,8 +100,6 @@ elsif defined?(Sinatra)
 
 end
 
-
-require 'carrierwave/orm/activerecord' if defined?(ActiveRecord)
 require 'carrierwave/orm/datamapper' if defined?(DataMapper)
 require 'carrierwave/orm/sequel' if defined?(Sequel)
 require 'carrierwave/orm/mongoid' if defined?(Mongoid)

data/lib/carrierwave/compatibility/paperclip.rb

@@ -77,17 +77,17 @@ module CarrierWave
       end
 
       def mappings
-        {
-          :rails_root   => lambda{|u, f| Rails.root },
-          :rails_env    => lambda{|u, f| Rails.env },
-          :class        => lambda{|u, f| u.model.class.name.underscore.pluralize},
-          :id           => lambda{|u, f| u.model.id },
-          :id_partition => lambda{|u, f| ("%09d" % u.model.id).scan(/\d{3}/).join("/")},
-          :attachment   => lambda{|u, f| u.mounted_as.to_s.downcase.pluralize },
-          :style        => lambda{|u, f| u.paperclip_style },
-          :basename     => lambda{|u, f| f.gsub(/#{File.extname(f)}$/, "") },
-          :extension    => lambda{|u, f| File.extname(f).gsub(/^\.+/, "")}
-        }
+        [
+          [:rails_root   , lambda{|u, f| Rails.root }],
+          [:rails_env    , lambda{|u, f| Rails.env }],
+          [:class        , lambda{|u, f| u.model.class.name.underscore.pluralize}],
+          [:id_partition , lambda{|u, f| ("%09d" % u.model.id).scan(/\d{3}/).join("/")}],
+          [:id           , lambda{|u, f| u.model.id }],
+          [:attachment   , lambda{|u, f| u.mounted_as.to_s.downcase.pluralize }],
+          [:style        , lambda{|u, f| u.paperclip_style }],
+          [:basename     , lambda{|u, f| f.gsub(/#{File.extname(f)}$/, "") }],
+          [:extension    , lambda{|u, f| File.extname(f).gsub(/^\.+/, "")}]
+        ]
       end
 
     end # Paperclip

data/lib/carrierwave/orm/activerecord.rb

@@ -24,9 +24,16 @@ module CarrierWave
       validates_integrity_of column if uploader_option(column.to_sym, :validate_integrity)
       validates_processing_of column if uploader_option(column.to_sym, :validate_processing)
 
-      after_save "store_#{column}!"
-      before_save "write_#{column}_identifier"
-      after_destroy "remove_#{column}!"
+      after_save :"store_#{column}!"
+      before_save :"write_#{column}_identifier"
+      after_destroy :"remove_#{column}!"
+
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        def #{column}=(new_file)
+          #{column}_will_change!
+          super
+        end
+      RUBY
 
     end
 

data/lib/carrierwave/processing/image_science.rb

@@ -34,6 +34,8 @@ module CarrierWave
     # [height (Integer)] the height to scale the image to
     #
     def resize_to_fit(new_width, new_height)
+      cache_stored_file! if !cached?
+
       ::ImageScience.with_image(self.current_path) do |img|
         width, height = extract_dimensions(img.width, img.height, new_width, new_height)
         img.resize( width, height ) do |file|
@@ -55,6 +57,8 @@ module CarrierWave
     # [height (Integer)] the height to scale the image to
     #
     def resize_to_fill(new_width, new_height)
+      cache_stored_file! if !cached?
+
       ::ImageScience.with_image(self.current_path) do |img|
         width, height = extract_dimensions_for_crop(img.width, img.height, new_width, new_height)
         x_offset, y_offset = extract_placement_for_crop(width, height, new_width, new_height)
@@ -97,6 +101,8 @@ module CarrierWave
     # [height (Integer)] the height to scale the image to
     #
     def resize_to_limit(new_width, new_height)
+      cache_stored_file! if !cached?
+
       ::ImageScience.with_image(self.current_path) do |img|
         if img.width > new_width or img.height > new_height
           resize_to_fit(new_width, new_height)

data/lib/carrierwave/processing/mini_magick.rb

@@ -249,6 +249,7 @@ module CarrierWave
     # [CarrierWave::ProcessingError] if manipulation failed.
     #
     def manipulate!
+      cache_stored_file! if !cached?
       image = ::MiniMagick::Image.open(current_path)
       image = yield(image)
       image.write(current_path)

data/lib/carrierwave/processing/rmagick.rb

@@ -244,6 +244,7 @@ module CarrierWave
     # [CarrierWave::ProcessingError] if manipulation failed.
     #
     def manipulate!(options={})
+      cache_stored_file! if !cached?
       image = ::Magick::Image.read(current_path)
 
       frames = if image.size > 1

data/lib/carrierwave/sanitized_file.rb

@@ -148,7 +148,7 @@ module CarrierWave
     #
     def read
       if is_path?
-        File.open(@file, "rb").read
+        File.open(@file, "rb") {|file| file.read}
       else
         @file.rewind if @file.respond_to?(:rewind)
         @file.read

data/lib/carrierwave/storage/cloud_files.rb

@@ -7,12 +7,16 @@ module CarrierWave
     ##
     # Uploads things to Rackspace Cloud Files webservices using the Rackspace libraries (cloudfiles gem).
     # In order for CarrierWave to connect to Cloud Files, you'll need to specify an username, api key
-    # and container
+    # and container.  Optional arguments are config.cloud_files_snet (using the private internal 
+    # Rackspace network for communication) and config.cloud_files_auth_url (for connecting to Rackspace's 
+    # UK infrastructure or an OpenStack Swift installation)
     #
     #     CarrierWave.configure do |config|
     #       config.cloud_files_username = "xxxxxx"
     #       config.cloud_files_api_key = "xxxxxx"
     #       config.cloud_files_container = "my_container"
+    #       config.cloud_files_auth_url = "https://lon.auth.api.rackspacecloud.com/v1.0"
+    #       config.cloud_files_snet = true
     #     end
     #
     # You can optionally include your CDN host name in the configuration.
@@ -60,7 +64,12 @@ module CarrierWave
         # Remove the file from Cloud Files
         #
         def delete
-          cf_container.delete_object(@path)
+          begin
+            cf_container.delete_object(@path)
+          rescue ::CloudFiles::Exception::NoSuchObject
+            # If the file's not there, don't panic
+            nil
+          end
         end
 
         ##
@@ -75,7 +84,11 @@ module CarrierWave
           if @uploader.cloud_files_cdn_host
             "http://" + @uploader.cloud_files_cdn_host + "/" + @path
           else
-            cf_container.object(@path).public_url
+            begin
+              cf_container.object(@path).public_url
+            rescue ::CloudFiles::Exception::NoSuchObject
+              nil
+            end
           end
         end
 
@@ -114,7 +127,10 @@ module CarrierWave
           end
 
           def cf_connection
-            @cf_connection ||= ::CloudFiles::Connection.new(@uploader.cloud_files_username, @uploader.cloud_files_api_key)
+            config = {:username => @uploader.cloud_files_username, :api_key => @uploader.cloud_files_api_key}
+            config[:auth_url] = @uploader.cloud_files_auth_url if @uploader.respond_to?(:cloud_files_auth_url)
+            config[:snet] = @uploader.cloud_files_snet if @uploader.respond_to?(:cloud_files_snet)
+            @cf_connection ||= ::CloudFiles::Connection.new(config)
           end
 
           def cf_container