mongoid-paperclip 0.0.2 → 0.0.3

data/README.md

@@ -3,7 +3,7 @@ Mongoid::Paperclip - Making Paperclip play nice with Mongoid ODM
 
 As the title suggests: `Mongoid::Paperclip` makes it easy to hook up [Paperclip](https://github.com/thoughtbot/paperclip) with [Mongoid](http://mongoid.org/).
 
-This is actually easier and faster to set up than when using Paperclip the ActiveRecord ORM.
+This is actually easier and faster to set up than when using Paperclip and the ActiveRecord ORM.
 This example assumes you are using **Ruby on Rails 3** and **Bundler**. However it doesn't require either.
 
 
@@ -16,42 +16,42 @@ Simply define the `mongoid-paperclip` gem inside your `Gemfile`. Additionally, y
 
     gem "mongoid-paperclip", :require => "mongoid_paperclip"
     gem "aws-s3",            :require => "aws/s3"
-    
+
 Next let's assume we have a User model and we want to allow our users to upload an avatar.
 
-**Rails.root/app/models/user.rb - include the Mongoid::Paperclip and invoke the class method**
+**Rails.root/app/models/user.rb - include the Mongoid::Paperclip module and invoke the provided class method**
 
     class User
       include Mongoid::Document
       include Mongoid::Paperclip
-      
-      has_attached_file :avatar
+
+      has_mongoid_attached_file :avatar
     end
 
 
 That's it
 --------
 
-That's all you have to do. Users can now upload avatars. Unlike ActiveRecord, Mongoid doesn't use migrations, so we don't need to define the Paperclip columns in a separate file. Invoking the `has_attached_file` method will automatically define the necessary `:avatar` fields for you in the background.
+That's all you have to do. Users can now upload avatars. Unlike ActiveRecord, Mongoid doesn't use migrations, so we don't need to define the Paperclip columns in a separate file. Invoking the `has_mongoid_attached_file` method will automatically define the necessary `:avatar` fields for you in the background.
 
 
 A more complex example
 ----------------------
 
-Just like Paperclip, Mongoid::Paperclip takes a second argument (hash of options) for the `has_attached_file` method, so you can do more complex things such as in the following example.
+Just like Paperclip, Mongoid::Paperclip takes a second argument (hash of options) for the `has_mongoid_attached_file` method, so you can do more complex things such as in the following example.
 
     class User
       include Mongoid::Document
       embeds_many :pictures
     end
-    
+
     class Picture
       include Mongoid::Document
       include Mongoid::Paperclip
-      
+
       embedded_in :user, :inverse_of => :pictures
-      
-      has_attached_file :attachment,
+
+      has_mongoid_attached_file :attachment,
         :path           => ':attachment/:id/:style.:extension',
         :storage        => :s3,
         :url            => ':s3_alias_url',
@@ -65,7 +65,7 @@ Just like Paperclip, Mongoid::Paperclip takes a second argument (hash of options
         },
         :convert_options => { :all => '-background white -flatten +matte' }
     end
-    
+
     @user.pictures.each do |picture|
       <%= picture.attachment.url %>
     end

data/lib/mongoid_paperclip.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 begin
   require "paperclip"
 rescue LoadError
@@ -39,15 +41,15 @@ end
 #    include Mongoid::Document
 #    include Mongoid::Paperclip
 #
-#    has_attached_file :avatar
+#    has_mongoid_attached_file :avatar
 #  end
 #
 # The above example is all you need to do. This will load the Paperclip library into the User model
-# and add the "has_attached_file" class method. Provide this method with the same values as you would
+# and add the "has_mongoid_attached_file" class method. Provide this method with the same values as you would
 # when using "vanilla Paperclip". The first parameter is a symbol [:field] and the second parameter is a hash of options [options = {}].
 #
 # Unlike Paperclip for ActiveRecord, since MongoDB does not use "schema" or "migrations", Mongoid::Paperclip automatically adds the neccesary "fields"
-# to your Model (MongoDB collection) when you invoke the "#has_attached_file" method. When you invoke "has_attached_file :avatar" it will
+# to your Model (MongoDB collection) when you invoke the "#has_mongoid_attached_file" method. When you invoke "has_mongoid_attached_file :avatar" it will
 # automatially add the following fields:
 #
 #  field :avatar_file_name,    :type => String
@@ -67,20 +69,37 @@ module Mongoid
     module ClassMethods
 
       ##
-      # Adds Mongoid::Paperclip's "#has_attached_file" class method to the model
+      # Adds Mongoid::Paperclip's "#has_mongoid_attached_file" class method to the model
       # which includes Paperclip and Paperclip::Glue in to the model. Additionally
       # it'll also add the required fields for Paperclip since MongoDB is schemaless and doesn't
       # have migrations.
-      def has_attached_file(field, options = {})
+      def has_mongoid_attached_file(field, options = {})
+
+        ##
+        # Include Paperclip and Paperclip::Glue for compatibility
         include ::Paperclip
         include ::Paperclip::Glue
+
+        ##
+        # Invoke Paperclip's #has_attached_file method and passes in the
+        # arguments specified by the user that invoked Mongoid::Paperclip#has_mongoid_attached_file
         has_attached_file(field, options)
+
+        ##
+        # Define the necessary collection fields in Mongoid for Paperclip
         field(:"#{field}_file_name",    :type => String)
         field(:"#{field}_content_type", :type => String)
         field(:"#{field}_file_size",    :type => Integer)
         field(:"#{field}_updated_at",   :type => DateTime)
       end
+
+      ##
+      # This method is deprecated
+      def has_attached_file(field, options = {})
+        raise "Mongoid::Paperclip#has_attached_file is deprecated, " +
+              "Use 'has_mongoid_attached_file' instead"
+      end
     end
 
   end
-end
+end

data/mongoid-paperclip.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |gem|
 
   gem.name        = 'mongoid-paperclip'
-  gem.version     = '0.0.2'
+  gem.version     = '0.0.3'
   gem.platform    = Gem::Platform::RUBY
   gem.authors     = 'Michael van Rooijen'
   gem.email       = 'meskyanichi@gmail.com'
@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.files         = %x[git ls-files].split("\n")
   gem.test_files    = %x[git ls-files -- {spec}/*].split("\n")
   gem.require_path  = 'lib'
-  
+
   gem.add_dependency 'paperclip', ['~> 2.3.6']
 
-end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid-paperclip
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-11 00:00:00 +01:00
+date: 2011-02-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 6
         version: 2.3.6
   type: :runtime
   version_requirements: *id001
@@ -59,21 +51,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Mongoid::Paperclip enables you to use Paperclip with the Mongoid ODM for MongoDB.