carrierwave 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,6 +1,11 @@
 = CarrierWave
 
-This plugin for Merb and Rails provides a simple and extremely flexible way to upload files.
+This plugin for Merb and Rails provides a simple and extremely flexible way to
+upload files.
+
+* RDoc Documentation {available at Rubyforge}[http://carrierwave.rubyforge.org/].
+* Source code {hosted at GitHub}[http://github.com/jnicklas/carrierwave]
+* Please {report any issues}[http://github.com/jnicklas/carrierwave/issues] on GitHub
 
 == Getting Started
 
@@ -34,7 +39,8 @@ this should give you a file in:
 
     app/uploaders/avatar_uploader.rb
 
-Check out this file for some hints on how you can customize your uploader. It should look something like this:
+Check out this file for some hints on how you can customize your uploader. It
+should look something like this:
 
     class AvatarUploader < CarrierWave::Uploader::Base
       storage :file
@@ -48,20 +54,23 @@ You can use your uploader class to store and retrieve files like this:
     
     uploader.retrieve_from_store!('my_file.png')
 
-CarrierWave gives you a +store+ for permanent storage, and a +cache+ for temporary storage. You can use different stores, at the moment a filesystem store and an Amazon S3 store are bundled.
+CarrierWave gives you a +store+ for permanent storage, and a +cache+ for
+temporary storage. You can use different stores, at the moment a filesystem
+store and an Amazon S3 store are bundled.
 
-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:
+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
 
-First require the relevant extension:
+If you are *not* using Merb or Rails you'll need to require the relevant ORM
+extension.
 
     require 'carrierwave/orm/activerecord'
     require 'carrierwave/orm/datamapper'
     require 'carrierwave/orm/sequel'
 
-You don't need to do this if you are using Merb or Rails.
-
 Open your model file, for ActiveRecord do something like:
 
     class User < ActiveRecord::Base
@@ -82,7 +91,8 @@ Or for Sequel
       mount_uploader :avatar, AvatarUploader
     end
 
-Now you can cache files by assigning them to the attribute, they will automatically be stored when the record is saved.
+Now you can cache files by assigning them to the attribute, they will
+automatically be stored when the record is saved.
 
     u = User.new
     u.avatar = params[:file]
@@ -93,7 +103,8 @@ Now you can cache files by assigning them to the attribute, they will automatica
 
 == Changing the storage directory
 
-In order to change where uploaded files are put, just override the +store_dir+ method:
+In order to change where uploaded files are put, just override the +store_dir+
+method:
 
     class MyUploader < CarrierWave::Uploader::Base
       def store_dir
@@ -105,7 +116,8 @@ This works for the file storage as well as Amazon S3.
 
 == Adding versions
 
-Often you'll want to add different versions of the same file. The classic example is image thumbnails. There is built in support for this:
+Often you'll want to add different versions of the same file. The classic
+example is image thumbnails. There is built in support for this:
 
     class MyUploader < CarrierWave::Uploader::Base
       include CarrierWave::RMagick
@@ -118,7 +130,9 @@ Often you'll want to add different versions of the same file. The classic exampl
       
     end
 
-When this uploader is used, an uploaded image would be scaled to be no larger than 800 by 800 pixels. A version called thumb is then created, which is scaled and cropped to exactly 200 by 200 pixels. The uploader could be used like this:
+When this uploader is used, an uploaded image would be scaled to be no larger
+than 800 by 800 pixels. A version called thumb is then created, which is scaled
+and cropped to exactly 200 by 200 pixels. The uploader could be used like this:
 
     uploader = AvatarUploader.new
     uploader.store!(my_file)                              # size: 1024x768
@@ -126,7 +140,8 @@ When this uploader is used, an uploaded image would be scaled to be no larger th
     uploader.url # => '/url/to/my_file.png'               # size: 800x600
     uploader.thumb.url # => '/url/to/thumb_my_file.png'   # size: 200x200
 
-One important thing to remember is that process is called *before* versions are created. This can cut down on processing cost.
+One important thing to remember is that process is called *before* versions are
+created. This can cut down on processing cost.
 
 It is possible to nest versions within versions:
 
@@ -141,10 +156,11 @@ It is possible to nest versions within versions:
 
 == Making uploads work across form redisplays
 
-Often you'll notice that uploaded files disappear when a validation
-fails. CarrierWave has a feature that makes it easy to remember the
-uploaded file even 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:
+Often you'll notice that uploaded files disappear when a validation fails.
+CarrierWave has a feature that makes it easy to remember the uploaded file even
+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| %>
       <p>
@@ -154,8 +170,8 @@ In Rails, this would look like this:
       </p>
     <% end %>
 
-It might be a good idea to show th user that a file has been uploaded,
-in the case of images, a small thumbnail would be a good indicator:
+It might be a good idea to show th 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| %>
       <p>
@@ -166,11 +182,17 @@ in the case of images, a small thumbnail would be a good indicator:
       </p>
     <% end %>
 
-NOTE: this feature currently requires write access to your filesystem. If write access is unavailable (e.g. Heroku) you will not be able to upload files. You can prevent CarrierWave from writing to the file system by setting `CarrierWave.config[:cache_to_cache_dir] = false`. This will however break redisplays of forms.
+NOTE: this feature currently requires write access to your filesystem. If write
+access is unavailable you will not be able to upload files. You can prevent
+CarrierWave from writing to the file system by setting
+`CarrierWave.config[:cache_to_cache_dir] = false`. This will however break
+redisplays of forms.
 
 == Providing a default path
 
-In many cases, especially when working with images, it might be a good idea to provide a default path, a fallback in case no file has been uploaded. You can do this easily by overriding the +default_path+ method in your uploader:
+In many cases, especially when working with images, it might be a good idea to
+provide a default path, a fallback in case no file has been uploaded. You can do
+this easily by overriding the +default_path+ method in your uploader:
 
     class MyUploader < CarrierWave::Uploader::Base
       def default_path
@@ -194,17 +216,24 @@ And then in your uploader, set the storage to :s3
       storage :s3
     end
 
-That's it! You can still use the +CarrierWave::Uploader#url+ method to return the url to the file on Amazon S3
+That's it! You can still use the +CarrierWave::Uploader#url+ method to return
+the url to the file on Amazon S3
 
 == Using RMagick
 
-If you're uploading images, you'll probably want to manipulate them in some way, you might want to create thumbnail images for example. CarrierWave comes with a small library to make manipulating images with RMagick easier, you'll need to include it in your Uploader:
+If you're uploading images, you'll probably want to manipulate them in some way,
+you might want to create thumbnail images for example. CarrierWave comes with a
+small library to make manipulating images with RMagick easier, you'll need to
+include it in your Uploader:
 
     class AvatarUploader < CarrierWave::Uploader::Base
       include CarrierWave::RMagick
     end
 
-The RMagick module gives you a few methods, like +CarrierWave::RMagick#crop_resized+ which manipulate the image file in some way. You can set a +process+ callback, which will call that method any time a file is uploaded.
+The RMagick module gives you a few methods, like
++CarrierWave::RMagick#crop_resized+ which manipulate the image file in some way.
+You can set a +process+ callback, which will call that method any time a file is
+uploaded.
 
     class AvatarUploader < CarrierWave::Uploader::Base
       include CarrierWave::RMagick
@@ -217,7 +246,8 @@ The RMagick module gives you a few methods, like +CarrierWave::RMagick#crop_resi
       end
     end
 
-Check out the manipulate! method, which makes it easy for you to write your own manipulation methods.
+Check out the manipulate! method, which makes it easy for you to write your own
+manipulation methods.
 
 == Using ImageScience
 
@@ -237,18 +267,41 @@ If you are using Paperclip, you can use the provided compatibility module:
       include CarrierWave::Compatibility::Paperclip
     end
 
-See the documentation for +Paperclip::Compatibility::Paperclip+ for more detaills.
+See the documentation for +Paperclip::Compatibility::Paperclip+ for more
+detaills.
 
 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 sensible compatibility mode. Patches for migrating from other solutions will be happily accepted.
+Unfortunately AttachmentFoo 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
+your translations file:
+
+    carrierwave:
+      errors:
+        integrity: 'Not an image.'
+        processing: 'Cannot resize image.'
+
+== Contributors
+
+These people have contributed their time and effort to CarrierWave:
+
+* Jonas Nicklas
+* Pavel Kunc
 
-== Documentation
+== License
 
-Full rdoc documentation is {available at Rubyforge}[http://carrierwave.rubyforge.org/].
+MIT-License, see the separate LICENSE file in the source distribution.
 
 == Read the source
 
-CarrierWave is still young, but most of it is pretty well documented. It is also extensively specced, and there are cucumber features for some common use cases. Just dig in and look at the source for more in-depth explanation of what things are doing.
+CarrierWave is still young, but most of it is pretty well documented. It is also
+extensively specced, and there are cucumber features for some common use cases.
+Just dig in and look at the source for more in-depth explanation of what things
+are doing.

data/Rakefile

@@ -3,13 +3,17 @@ require 'rake/gempackagetask'
 require 'rake/rdoctask'
 gem 'rdoc', '>=2.4.0'
 require 'rdoc'
-require 'sdoc'
+begin
+  require 'sdoc'
+rescue LoadError
+end
 
 require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
 require 'cucumber/rake/task'
 
 NAME = "carrierwave"
-GEM_VERSION = "0.3.0"
+GEM_VERSION = "0.3.1"
 AUTHOR = "Jonas Nicklas"
 EMAIL = "jonas.nicklas@gmail.com"
 HOMEPAGE = "http://www.example.com"
@@ -82,13 +86,18 @@ Spec::Rake::SpecTask.new('spec') do |t|
   t.spec_files = file_list
 end
 
+RCov::VerifyTask.new(:verify_coverage => "spec:rcov") do |t|
+  t.threshold = 95.64
+  t.index_html = 'doc/coverage/index.html'
+end
+
 namespace :spec do
   desc "Run all examples with RCov"
   Spec::Rake::SpecTask.new('rcov') do |t|
     t.spec_files = file_list
     t.rcov = true
     t.rcov_dir = "doc/coverage"
-    t.rcov_opts = ['--exclude', 'spec']
+    t.rcov_opts = ['--exclude', 'spec,features,lib/generators,gems/*']
   end
   
   desc "Generate an html report"
@@ -100,7 +109,7 @@ namespace :spec do
 
 end
 
-desc 'Default: run unit tests.'
-task :default => 'spec'
-
 task :superspec => [:spec, :features]
+
+desc 'Default: run unit tests and features.'
+task :default => 'superspec'

data/lib/carrierwave/compatibility/paperclip.rb

@@ -1,29 +1,3 @@
-# This file contains code taken from Paperclip
-# 
-# LICENSE
-# 
-# The MIT License
-# 
-# Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND 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.
-
 module CarrierWave
   module Compatibility
 
@@ -41,6 +15,34 @@ module CarrierWave
     #       end
     #     end
     #
+    # ---
+    #
+    # This file contains code taken from Paperclip
+    # 
+    # LICENSE
+    # 
+    # The MIT License
+    # 
+    # Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+    # 
+    # Permission is hereby granted, free of charge, to any person obtaining a copy
+    # of this software and associated documentation files (the "Software"), to deal
+    # in the Software without restriction, including without limitation the rights
+    # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    # copies of the Software, and to permit persons to whom the Software is
+    # furnished to do so, subject to the following conditions:
+    # 
+    # The above copyright notice and this permission notice shall be included in
+    # all copies or substantial portions of the Software.
+    # 
+    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    # FITNESS FOR A PARTICULAR PURPOSE AND 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.
+    #
     module Paperclip
 
       def store_path(for_file=filename)

data/lib/carrierwave/mount.rb

@@ -19,6 +19,9 @@ module CarrierWave
     #
     def uploaders
       @uploaders ||= {}
+      @uploaders = superclass.uploaders.merge(@uploaders)
+    rescue NoMethodError
+      @uploaders
     end
 
     ##
@@ -28,6 +31,9 @@ module CarrierWave
     #
     def uploader_options
       @uploader_options ||= {}
+      @uploader_options = superclass.uploader_options.merge(@uploader_options)
+    rescue NoMethodError
+      @uploader_options
     end
 
     ##
@@ -247,7 +253,7 @@ module CarrierWave
       def write_identifier
         if remove?
           record.write_uploader(serialization_column, '')
-        else
+        elsif not uploader.identifier.blank?
           record.write_uploader(serialization_column, uploader.identifier)
         end
       end

data/lib/carrierwave/orm/activerecord.rb

@@ -17,17 +17,9 @@ module CarrierWave
       validates_integrity_of column if uploader_options[column.to_sym][:validate_integrity]
       validates_processing_of column if uploader_options[column.to_sym][:validate_processing]
 
-      after_save do |record|
-        record.send("store_#{column}!")
-      end
-
-      before_save do |record|
-        record.send("write_#{column}_identifier")
-      end
-
-      after_destroy do |record|
-        record.send("remove_#{column}!")
-      end
+      after_save "store_#{column}!"
+      before_save "write_#{column}_identifier"
+      after_destroy "remove_#{column}!"
     end
 
     ##

data/lib/carrierwave/orm/datamapper.rb

@@ -14,17 +14,9 @@ module CarrierWave
       alias_method :read_uploader, :attribute_get
       alias_method :write_uploader, :attribute_set
 
-      after :save do
-        send("store_#{column}!")
-      end
-
-      before :save do
-        send("write_#{column}_identifier")
-      end
-
-      after :destroy do
-        send("remove_#{column}!")
-      end
+      after :save, "store_#{column}!".to_sym
+      before :save, "write_#{column}_identifier".to_sym
+      after :destroy, "remove_#{column}!".to_sym
     end
 
   end # DataMapper

data/lib/carrierwave/orm/sequel.rb

@@ -11,17 +11,9 @@ module CarrierWave
       alias_method :read_uploader, :[]
       alias_method :write_uploader, :[]=
 
-      after_save do
-        send("store_#{column}!")
-      end
-
-      before_save do
-        send("write_#{column}_identifier")
-      end
-
-      before_destroy do
-        send("remove_#{column}!")
-      end
+      after_save "store_#{column}!"
+      before_save "write_#{column}_identifier"
+      before_destroy "remove_#{column}!"
     end
 
     # Determine if we're using Sequel > 2.12
@@ -29,7 +21,7 @@ module CarrierWave
     # ==== Returns
     # Bool:: True if Sequel 2.12 or higher False otherwise
     def self.new_sequel?
-      !!(/^(2.12|3)/ =~ ::Sequel.version)
+      ::Sequel::Model.respond_to?(:plugin)
     end
 
   end # Sequel

data/lib/carrierwave/storage/abstract.rb

@@ -19,10 +19,10 @@ module CarrierWave
         uploader.filename
       end
       
-      def store!
+      def store!(file)
       end
       
-      def retrieve!
+      def retrieve!(identifier)
       end
       
     end # Abstract

data/lib/carrierwave/storage/s3.rb

@@ -87,8 +87,20 @@ module CarrierWave
           ["http://s3.amazonaws.com", bucket, @path].compact.join('/')
         end
 
+        def respond_to?(*args)
+          super || s3_object.respond_to?(*args)
+        end
+
       private
 
+        def method_missing(*args, &block)
+          s3_object.send(*args, &block)
+        end
+
+        def s3_object
+          @s3_object ||= AWS::S3::S3Object.find(@path, bucket)
+        end
+
         def bucket
           CarrierWave::Storage::S3.bucket
         end
@@ -141,7 +153,7 @@ module CarrierWave
       #
       def store!(file)
         AWS::S3::S3Object.store(::File.join(uploader.store_path), file.read, self.class.bucket, :access => self.class.access)
-        CarrierWave::Storage::S3::File.new(uploader.store_dir, uploader.filename)
+        CarrierWave::Storage::S3::File.new(uploader.store_path, uploader.filename)
       end
 
       # Do something to retrieve the file

data/lib/carrierwave/uploader/callbacks.rb

@@ -7,31 +7,31 @@ module CarrierWave
       end
 
       def with_callbacks(kind, *args)
-        self.class._before_callback(kind).each { |callback| self.send(callback, *args) }
+        self.class._before_callbacks_for(kind).each { |callback| self.send(callback, *args) }
         yield
-        self.class._after_callback(kind).each { |callback| self.send(callback, *args) }
+        self.class._after_callbacks_for(kind).each { |callback| self.send(callback, *args) }
       end
 
       module ClassMethods
         
-        def _before_callback(kind) #:nodoc:
+        def _before_callbacks_for(kind) #:nodoc:
           self._before_callbacks ||= {}
           self._before_callbacks[kind] ||= []
           self._before_callbacks[kind]
         end
 
-        def _after_callback(kind) #:nodoc:
+        def _after_callbacks_for(kind) #:nodoc:
           self._after_callbacks ||= {}
           self._after_callbacks[kind] ||= []
           self._after_callbacks[kind]
         end
 
         def before(kind, callback)
-          _before_callback(kind) << callback
+          _before_callbacks_for(kind) << callback
         end
 
         def after(kind, callback)
-          _after_callback(kind) << callback
+          _after_callbacks_for(kind) << callback
         end
       end # ClassMethods
 

data/spec/mount_spec.rb

@@ -34,6 +34,14 @@ describe CarrierWave::Mount do
       @instance.image.should be_an_instance_of(@uploader)
     end
     
+    it "should inherit uploaders to subclasses" do
+      @subclass = Class.new(@class)
+      @subclass_instance = @subclass.new
+      @subclass_instance.image_uploader.should be_an_instance_of(@uploader)
+      @subclass_instance.image = stub_file('test.jpg')
+      @subclass_instance.image.should be_an_instance_of(@uploader)
+    end
+    
     describe '#image_uploader' do
       it "should return the uploader" do
         @instance.image_uploader.should be_an_instance_of(@uploader)

data/spec/orm/activerecord_spec.rb

@@ -16,6 +16,7 @@ class TestMigration < ActiveRecord::Migration
     create_table :events, :force => true do |t|
       t.column :image, :string
       t.column :textfile, :string
+      t.column :foo, :string
     end
   end
 
@@ -156,6 +157,15 @@ describe CarrierWave::ActiveRecord do
         @event[:image].should == 'test.jpeg'
       end
       
+      it "should preserve the image when nothing is assigned" do
+        @event.image = stub_file('test.jpeg')
+        @event.save.should be_true
+        @event = @class.find(@event.id)
+        @event.foo = "bar"
+        @event.save.should be_true
+        @event[:image].should == 'test.jpeg'
+      end
+      
       it "should remove the image if remove_image? returns true" do
         @event.image = stub_file('test.jpeg')
         @event.save!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: carrierwave
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jonas Nicklas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-20 00:00:00 +02:00
+date: 2009-07-01 00:00:00 +02:00
 default_executable: 
 dependencies: []