mongoid-paperclip 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+mongoid-paperclip-*.gem

data/README.md

@@ -0,0 +1,73 @@
+Mongoid::Paperclip - Making Paperclip play nice with Mongoid ORM
+================================================================
+
+As the title suggests, using this gem you will be able to use [Paperclip](https://github.com/thoughtbot/paperclip) with [Mongoid](http://mongoid.org/).
+
+This is actually **easier** and **faster** to set up than when using the ActiveRecord ORM.
+
+This example assumes you are using **Ruby on Rails 3** and **Bundler**. However it doesn't require either.
+
+
+Setting it up in a few seconds
+------------------------------
+
+First require the **Paperclip** gem as you normally would, followed by the **Mongoid::Paperclip** extension. Additionally if you are working with Amazon S3 you will want to add the AWS::S3 gem to your Gemfile as well.
+
+**Rails.root/Gemfile**
+
+    gem "paperclip"
+    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**
+
+    class User
+      include Mongoid::Document
+      include Mongoid::Paperclip
+      
+      has_attached_file :avatar
+    end
+
+
+And there you go!
+-----------------
+
+As you can see you use it in practically the same as when you use vanilla Paperclip. However, since we're using Mongoid and not ActiveRecord, we do not have a schema or any migrations. So with **Mongoid::Paperclip** when you invoke the `has_attached_file :avatar` it will create the necessary Mongoid **fields** for the specified attribute (`:avatar` in this case).
+
+
+A more complex example
+----------------------
+
+Just like vanilla 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.
+
+    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,
+        :path           => ':attachment/:id/:style.:extension',
+        :storage        => :s3,
+        :url            => ':s3_alias_url',
+        :s3_host_alias  => 'something.cloudfront.net',
+        :s3_credentials => File.join(Rails.root, 'config', 's3.yml'),
+        :styles => {
+          :original => ['1920x1680>', :jpg],
+          :small    => ['100x100#',   :jpg],
+          :medium   => ['250x250',    :jpg],
+          :large    => ['500x500>',   :jpg]
+        },
+        :convert_options => { :all => '-background white -flatten +matte' }
+    end
+
+Quite a lot of people have been looking for a solution to use [Paperclip](https://github.com/thoughtbot/paperclip) with [Mongoid](http://mongoid.org/) so I hope this helps!
+
+© Copyright [Michael van Rooijen](http://michaelvanrooijen.com/)

data/lib/mongoid_paperclip.rb

@@ -0,0 +1,79 @@
+##
+# The logger is set to the Active Record logger by Paperclip itself.
+# Because of this, we set the logger to false as "default" so that it doesn't raise
+# an "uninitialized constant" exception.
+#
+# You can manually change loggers by adding for example an initializer and configuring the logger, like so:
+#
+#   Paperclip.options[:log] = MyLogger.log
+#
+Paperclip.options[:log] = false
+
+##
+# If Ruby on Rails is defined and the logger method exists, the Paperclip logger
+# will be set to the Rails logger by default. You may overwrite the logger by re-defining the
+# logger in for example an initializer file, like so:
+#
+#  Paperclip.options[:log] = MyLogger.log
+#
+if defined?(Rails)
+  if Rails.respond_to?(:logger)
+    Paperclip.options[:log] = Rails.logger
+  end
+end
+
+##
+# The Mongoid::Paperclip extension
+# Makes Paperclip play nice with the Mongoid ORM
+#
+# Example:
+#
+#  class User
+#    include Mongoid::Document
+#    include Mongoid::Paperclip
+#
+#    has_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
+# 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
+# automatially add the following fields:
+#
+#  field :avatar_file_name,    :type => String
+#  field :avatar_content_type, :type => String
+#  field :avatar_file_size,    :type => Integer
+#  field :avatar_updated_at,   :type => DateTime
+#
+module Mongoid
+  module Paperclip
+
+    ##
+    # Extends the model with the defined Class methods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      ##
+      # Adds Mongoid::Paperclip's "#has_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 = {})
+        include ::Paperclip
+        include ::Paperclip::Glue
+        has_attached_file(field, options)
+        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
+    end
+
+  end
+end

data/mongoid_paperclip.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+
+  gem.name        = 'mongoid-paperclip'
+  gem.version     = '0.0.1'
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = 'Michael van Rooijen'
+  gem.email       = 'meskyanichi@gmail.com'
+  gem.homepage    = 'https://github.com/meskyanichi/mongoid-paperclip'
+  gem.summary     = 'Mongoid::Paperclip enables you to use Paperclip with the Mongoid ORM for MongoDB.'
+  gem.description = 'Mongoid::Paperclip enables you to use Paperclip with the Mongoid ORM for MongoDB.'
+
+  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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid-paperclip
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 6
+        version: 2.3.6
+  type: :runtime
+  version_requirements: *id001
+description: Mongoid::Paperclip enables you to use Paperclip with the Mongoid ORM for MongoDB.
+email: meskyanichi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.md
+- lib/mongoid_paperclip.rb
+- mongoid_paperclip.gemspec
+has_rdoc: true
+homepage: https://github.com/meskyanichi/mongoid-paperclip
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+signing_key: 
+specification_version: 3
+summary: Mongoid::Paperclip enables you to use Paperclip with the Mongoid ORM for MongoDB.
+test_files: []
+