carrierwave 0.4.5 → 0.4.6

data/README.rdoc

@@ -66,7 +66,7 @@ Most of the time you are going to want to use CarrierWave together with an ORM.
 It is quite simple to mount uploaders on columns in your model, so you can
 simply assign files and get going:
 
-=== ActiveRecord, DataMapper, Sequel, MongoMapper
+=== ActiveRecord, DataMapper, Sequel, Mongoid
 
 Make sure you are loading CarrierWave after loading your ORM, otherwise you'll
 need to require the relevant extension manually, e.g.:
@@ -169,7 +169,7 @@ in that case. Suppose your +user+ model has an uploader mounted on +avatar+
 file, just add a hidden field called +avatar_cache+. In Rails, this would look
 like this:
 
-    <% form_for @user do |f| %>
+    <% form_for @user, :html => {:multipart => true} do |f| %>
       <p>
         <label>My Avatar</label>
         <%= f.file_field :avatar %>
@@ -180,7 +180,7 @@ like this:
 It might be a good idea to show the user that a file has been uploaded, in the
 case of images, a small thumbnail would be a good indicator:
 
-    <% form_for @user do |f| %>
+    <% form_for @user, :html => {:multipart => true} do |f| %>
       <p>
         <label>My Avatar</label>
         <%= image_tag(@user.avatar_url) if @user.avatar? %>
@@ -194,7 +194,7 @@ case of images, a small thumbnail would be a good indicator:
 If you want to remove a previously uploaded file on a mounted uploader, you can
 easily add a checkbox to the form which will remove the file when checked.
 
-    <% form_for @user do |f| %>
+    <% form_for @user, :html => {:multipart => true} do |f| %>
       <p>
         <label>My Avatar</label>
         <%= image_tag(@user.avatar_url) if @user.avatar? %>
@@ -217,7 +217,7 @@ Your users may find it convenient to upload a file from a location on the Intern
 via a URL. CarrierWave makes this simple, just add the appropriate column to your
 form and you're good to go:
 
-    <% form_for @user do |f| %>
+    <% form_for @user, :html => {:multipart => true} do |f| %>
       <p>
         <label>My Avatar URL:</label>
         <%= image_tag(@user.avatar_url) if @user.avatar? %>
@@ -237,6 +237,22 @@ this easily by overriding the +default_url+ method in your uploader:
       end
     end
 
+== Recreating versions
+
+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
+process all versions.
+
+   instance = MyUploader.new
+   instance.recreate_versions!
+
+Or on a mounted uploader:
+
+   User.all.each do |user|
+     user.avatar.recreate_versions!
+   end
+
 == Configuring CarrierWave
 
 CarrierWave has a broad range of configuration options, which you can configure,
@@ -303,6 +319,11 @@ CarrierWave comes with some RSpec matchers which you may find useful:
 
 == Using Amazon S3
 
+Older versions of CarrierWave used the +aws-s3+ and +right_aws+ libraries. The Aws[http://github.com/appoxy/aws]
+is now used meaning european buckets are supported out the box. Ensure you have it installed:
+
+    gem install aws
+
 You'll need to configure a bucket, access id and secret key like this:
 
     CarrierWave.configure do |config|
@@ -322,15 +343,6 @@ And then in your uploader, set the storage to :s3
 That's it! You can still use the <code>CarrierWave::Uploader#url</code> method to return
 the url to the file on Amazon S3.
 
-Alternatively, and especially if your bucket is located in Europe, you can use the
-RightAWS library by setting the storage to :right_s3
-
-    class AvatarUploader < CarrierWave::Uploader::Base
-      storage :right_s3
-    end
-
-CarrierWave uses the RightAWS S3 Interface directly, meaning that the performance issues
-mentioned by Jonathan Yurek for paperclip do not apply: http://groups.google.com/group/paperclip-plugin/browse_thread/thread/d4dc166a9a5f0df4#
 
 == Using Rackspace Cloud Files
 
@@ -338,11 +350,17 @@ Cloud Files support requires a {Rackspace Cloud}[http://rackspacecloud.com] user
 You must also create a container for Carrierwave to use, and mark it public (publish it to the CDN)
 
     CarrierWave.configure do |config|
-      config.cloud_files_user_name = 'xxxxxx'
+      config.cloud_files_username = 'xxxxxx'
       config.cloud_files_api_key = 'xxxxxxxxxxxxxxxxxxxxx'
       config.cloud_files_container = 'name_of_bucket'
     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"
+
 Do this in an initializer in Rails, and in a +before_app_loads+ block in Merb.
 
 And then in your uploader, set the storage to :cloud_files

data/lib/carrierwave.rb

@@ -94,5 +94,4 @@ end
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'activerecord') if defined?(ActiveRecord)
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'datamapper') if defined?(DataMapper)
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", 'sequel') if defined?(Sequel)
-require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongomapper") if defined?(MongoMapper)
 require File.join(File.dirname(__FILE__), "carrierwave", "orm", "mongoid") if defined?(Mongoid)

data/lib/carrierwave/compatibility/paperclip.rb

@@ -72,7 +72,7 @@ module CarrierWave
 
       def interpolate_paperclip_path(path, filename)
         mappings.inject(path) do |agg, pair|
-          agg.gsub(":#{pair[0]}", pair[1].call(self, filename).to_s)
+          agg.gsub(":#{pair[0]}") { pair[1].call(self, filename).to_s }
         end
       end
 
@@ -92,4 +92,4 @@ module CarrierWave
 
     end # Paperclip
   end # Compatibility
-end # CarrierWave
+end # CarrierWave

data/lib/carrierwave/orm/activerecord.rb

@@ -6,7 +6,7 @@ module CarrierWave
   module ActiveRecord
 
     include CarrierWave::Mount
-    
+
     ##
     # See +CarrierWave::Mount#mount_uploader+ for documentation
     #
@@ -39,9 +39,11 @@ module CarrierWave
     #
     def validates_integrity_of(*attrs)
       options = attrs.last.is_a?(Hash) ? attrs.last : {}
-      options[:message] ||= I18n.t('carrierwave.errors.integrity', :default => 'is not an allowed type of file.')
       validates_each(*attrs) do |record, attr, value|
-        record.errors.add attr, options[:message] if record.send("#{attr}_integrity_error")
+        if record.send("#{attr}_integrity_error")
+          message = options[:message] || I18n.t('carrierwave.errors.integrity', :default => 'is not an allowed type of file.')
+          record.errors.add attr, message
+        end
       end
     end
 
@@ -61,9 +63,11 @@ module CarrierWave
     #
     def validates_processing_of(*attrs)
       options = attrs.last.is_a?(Hash) ? attrs.last : {}
-      options[:message] ||= I18n.t('carrierwave.errors.processing', :default => 'failed to be processed.')
       validates_each(*attrs) do |record, attr, value|
-        record.errors.add attr, options[:message] if record.send("#{attr}_processing_error")
+        if record.send("#{attr}_processing_error")
+          message = options[:message] || I18n.t('carrierwave.errors.processing', :default => 'failed to be processed.')
+          record.errors.add attr, message
+        end
       end
     end
 

data/lib/carrierwave/orm/datamapper.rb

@@ -19,6 +19,16 @@ module CarrierWave
       pre_hook = ::DataMapper.const_defined?(:Validate) ? :valid? : :save
       before pre_hook, "write_#{column}_identifier".to_sym
       after :destroy, "remove_#{column}!".to_sym
+
+      # FIXME: Hack to work around Datamapper not triggering callbacks
+      # for objects that are not dirty. By explicitly calling
+      # attribute_set we are marking the record as dirty.
+      class_eval <<-RUBY
+        def remove_image=(value)
+          _mounter(:#{column}).remove = value
+          attribute_set(:#{column}, '') if _mounter(:#{column}).remove?
+        end
+      RUBY
     end
 
   end # DataMapper

data/lib/carrierwave/processing/mini_magick.rb

@@ -257,7 +257,7 @@ module CarrierWave
       image = yield(image)
       image.write(current_path)
       ::MiniMagick::Image.from_file(current_path)
-    rescue ::MiniMagick::MiniMagickError => e
+    rescue ::MiniMagick::Error => e
       raise CarrierWave::ProcessingError.new("Failed to manipulate with MiniMagick, maybe it is not an image? Original Error: #{e}")
     end
 

data/lib/carrierwave/processing/rmagick.rb

@@ -87,8 +87,8 @@ module CarrierWave
         process :resize_to_fit => [width, height]
       end
 
-      def resize_to_fill(width, height)
-        process :resize_to_fill => [width, height]
+      def resize_to_fill(width, height, gravity=::Magick::CenterGravity)
+        process :resize_to_fill => [width, height, gravity]
       end
 
       def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
@@ -185,9 +185,9 @@ module CarrierWave
     #
     # [Magick::Image] additional manipulations to perform
     #
-    def resize_to_fill(width, height)
+    def resize_to_fill(width, height, gravity=::Magick::CenterGravity)
       manipulate! do |img|
-        img.crop_resized!(width, height)
+        img.crop_resized!(width, height, gravity)
         img = yield(img) if block_given?
         img
       end

data/lib/carrierwave/sanitized_file.rb

@@ -147,7 +147,7 @@ module CarrierWave
     #
     def read
       if is_path?
-        File.read(@file)
+        File.open(@file, "rb").read
       else
         @file.rewind if @file.respond_to?(:rewind)
         @file.read
@@ -199,7 +199,7 @@ module CarrierWave
         File.open(new_path, "wb") { |f| f.write(read) }
       end
       chmod!(new_path, permissions)
-      self.class.new(new_path)
+      self.class.new({:tempfile => new_path, :content_type => content_type})
     end
 
     ##

data/lib/carrierwave/storage/cloud_files.rb

@@ -15,12 +15,11 @@ module CarrierWave
     #       config.cloud_files_container = "my_container"
     #     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.
     #
-    # You can set the access policy for the uploaded files:
-    #
-    #     CarrierWave.configure do |config|
-    #       config.s3_access_policy = 'public-read'
-    #     end
+    #   config.cloud_files_cdn_host = "c000000.cdn.rackspacecloud.com"
     #
     #
     class CloudFiles < Abstract
@@ -73,13 +72,13 @@ module CarrierWave
         # [String] file's url
         #
         def url
-          cf_container.object(@path).public_url
+          if @uploader.cloud_files_cdn_host
+            "http://" + @uploader.cloud_files_cdn_host + "/" + @path
+          else
+            cf_container.object(@path).public_url
+          end
         end
 
-        #def metadata
-        #  s3_object.metadata
-        #end
-
         def content_type
           cf_container.object(@path).content_type
         end
@@ -140,7 +139,7 @@ module CarrierWave
       #
       # === Returns
       #
-      # [CarrierWave::Storage::RightS3::File] the stored file
+      # [CarrierWave::Storage::CloudFiles::File] the stored file
       #
       def store!(file)
         cloud_files_options = {'Content-Type' => file.content_type}
@@ -157,7 +156,7 @@ module CarrierWave
       #
       # === Returns
       #
-      # [CarrierWave::Storage::RightS3::File] the stored file
+      # [CarrierWave::Storage::CloudFiles::File] the stored file
       #
       def retrieve!(identifier)
         CarrierWave::Storage::CloudFiles::File.new(uploader, self, uploader.store_path(identifier))

data/lib/carrierwave/storage/grid_fs.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'mongo'
-require 'mongo/gridfs'
 
 module CarrierWave
   module Storage
@@ -12,8 +11,7 @@ module CarrierWave
 
       class File
 
-        def initialize(uploader, database, path)
-          @database = database
+        def initialize(uploader, path)
           @path = path
           @uploader = uploader
         end
@@ -31,15 +29,44 @@ module CarrierWave
         end
 
         def read
-          ::GridFS::GridStore.read(@database, @path)
+          grid.open(@path, 'r').data
+        end
+
+        def write(file)
+          grid.open(@uploader.store_path, 'w', :content_type => file.content_type) do |f| 
+            f.write(file.read)
+          end
         end
 
         def delete
-          ::GridFS::GridStore.unlink(@database, @path)
+          grid.delete(@path)
         end
 
         def content_type
-          ::GridFS::GridStore.open(@database, @path, 'r') { |f| return f.content_type }
+          grid.open(@path, 'r').content_type
+        end
+        
+        def file_length
+          grid.open(@path, 'r').file_length
+        end
+
+      protected
+
+        def database
+          @connection ||= begin
+            host = @uploader.grid_fs_host
+            port = @uploader.grid_fs_port
+            database = @uploader.grid_fs_database
+            username = @uploader.grid_fs_username
+            password = @uploader.grid_fs_password
+            db = Mongo::Connection.new(host, port).db(database)
+            db.authenticate(username, password) if username && password
+            db
+          end
+        end
+        
+        def grid
+          @grid ||= Mongo::GridFileSystem.new(database)
         end
 
       end
@@ -56,10 +83,9 @@ module CarrierWave
       # [CarrierWave::SanitizedFile] a sanitized file
       #
       def store!(file)
-        ::GridFS::GridStore.open(database, uploader.store_path, 'w', :content_type => file.content_type) do |f|
-          f.write file.read
-        end
-        CarrierWave::Storage::GridFS::File.new(uploader, database, uploader.store_path)
+        stored = CarrierWave::Storage::GridFS::File.new(uploader, uploader.store_path)
+        stored.write(file)
+        stored
       end
 
       ##
@@ -74,22 +100,7 @@ module CarrierWave
       # [CarrierWave::Storage::GridFS::File] a sanitized file
       #
       def retrieve!(identifier)
-        CarrierWave::Storage::GridFS::File.new(uploader, database, uploader.store_path(identifier))
-      end
-
-    private
-
-      def database
-        @connection ||= begin
-          host = uploader.grid_fs_host
-          port = uploader.grid_fs_port
-          database = uploader.grid_fs_database
-          username = uploader.grid_fs_username
-          password = uploader.grid_fs_password
-          db = Mongo::Connection.new(host, port).db(database)
-          db.authenticate(username, password) if username && password
-          db
-        end
+        CarrierWave::Storage::GridFS::File.new(uploader, uploader.store_path(identifier))
       end
 
     end # File

data/lib/carrierwave/storage/right_s3.rb

@@ -1,170 +1,3 @@
-# encoding: utf-8
-require 'right_aws'
 
-module CarrierWave
-  module Storage
+raise "The right_aws library is no longer supported. Please install the updated 'aws' library with support for Ruby 1.9 and euro buckets"
 
-    ##
-    # Uploads things to Amazon S3 webservices using the RightAWS libraries (right_aws gem). 
-    # In order for CarrierWave to connect to Amazon S3, you'll need to specify an access key id, secret key
-    # and bucket
-    #
-    #     CarrierWave.configure do |config|
-    #       config.s3_access_key_id = "xxxxxx"
-    #       config.s3_secret_access_key = "xxxxxx"
-    #       config.s3_bucket = "my_bucket_name"
-    #     end
-    #
-    # The RightAWS::S3Interface is used directly as opposed to the normal RightAWS::S3::Bucket et.al. classes.
-    # This gives much improved performance and avoids unnecessary requests.
-    #
-    # You can set the access policy for the uploaded files:
-    #
-    #     CarrierWave.configure do |config|
-    #       config.s3_access_policy = 'public-read'
-    #     end
-    #
-    # The default is 'public-read'. For more options see:
-    #
-    # http://docs.amazonwebservices.com/AmazonS3/latest/RESTAccessPolicy.html#RESTCannedAccessPolicies
-    #
-    # You can change the generated url to a cnamed domain by setting the cnamed config:
-    #
-    #     CarrierWave.configure do |config|
-    #       config.s3_cnamed = true
-    #       config.s3_bucket = 'bucketname.domain.tld'
-    #     end
-    #
-    # Now the resulting url will be
-    #     
-    #     http://bucketname.domain.tld/path/to/file
-    #
-    # instead of
-    #
-    #     http://bucketname.domain.tld.s3.amazonaws.com/path/to/file
-    #
-    class RightS3 < Abstract
-
-      class File
-
-        def initialize(uploader, base, path)
-          @uploader = uploader
-          @path = path
-          @base = base
-        end
-
-        ##
-        # Returns the current path of the file on S3
-        #
-        # === Returns
-        #
-        # [String] A path
-        #
-        def path
-          @path
-        end
-
-        ##
-        # Reads the contents of the file from S3
-        #
-        # === Returns
-        #
-        # [String] contents of the file
-        #
-        def read
-          result = connection.get(bucket, @path)
-          @headers = result[:headers]
-          result[:object]
-        end
-
-        ##
-        # Remove the file from Amazon S3
-        #
-        def delete
-          connection.delete(bucket, @path)
-        end
-
-        ##
-        # Returns the url on Amazon's S3 service
-        #
-        # === Returns
-        #
-        # [String] file's url
-        #
-        def url
-          if @uploader.s3_cnamed
-            ["http://", @uploader.s3_bucket, "/", @path].compact.join
-          else
-            ["http://s3.amazonaws.com/", @uploader.s3_bucket, "/", @path].compact.join
-          end
-        end
-
-        def content_type
-          headers["content-type"]
-        end
-
-        #def content_disposition
-        #  s3_object.content_disposition
-        #end
-
-        def store(file)
-          connection.put(bucket, @path, file.read,
-            'x-amz-acl' => @uploader.s3_access_policy,
-            'content-type' => file.content_type
-          )
-        end
-
-      private
-      
-        def headers
-          @headers ||= {}
-        end
-
-        def bucket
-          @uploader.s3_bucket
-        end
-
-        def connection
-          @base.connection
-        end
-
-      end
-
-      ##
-      # Store the file on S3
-      #
-      # === Parameters
-      #
-      # [file (CarrierWave::SanitizedFile)] the file to store
-      #
-      # === Returns
-      #
-      # [CarrierWave::Storage::RightS3::File] the stored file
-      #
-      def store!(file)
-        f = CarrierWave::Storage::RightS3::File.new(uploader, self, uploader.store_path)
-        f.store(file)
-        f
-      end
-
-      # Do something to retrieve the file
-      #
-      # @param [String] identifier uniquely identifies the file
-      #
-      # [identifier (String)] uniquely identifies the file
-      #
-      # === Returns
-      #
-      # [CarrierWave::Storage::RightS3::File] the stored file
-      #
-      def retrieve!(identifier)
-        CarrierWave::Storage::RightS3::File.new(uploader, self, uploader.store_path(identifier))
-      end
-
-      def connection
-        @connection ||= RightAws::S3Interface.new(uploader.s3_access_key_id, uploader.s3_secret_access_key)
-      end
-
-    end # RightS3
-  end # Storage
-end # CarrierWave