glebtv-mongoid-paperclip 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGM0YjAxZjY2ODU1ODFkYjAxZmU0ZWIyYTkwOWUxMWNhNjhmOWQ4Ng==
+  data.tar.gz: !binary |-
+    ODM4NjBiYjk2NDMwYjYzZDgyZDViNzc5NTA1MWJiMzFkNWUyOGRiMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDQ3NjQzMjU3NmM3YzBjNzdjMjM1Mjg3OTg4YzhhNjgzNDkyODlhNjZkZmVi
+    YzFiMTk2MTdjNjM1YmU2MTZhMWJiZDQ2NjBkY2FmMzI0NTI5OTU2ODhjYTY1
+    NWRiOGE3ZWJmN2Y3MWMwZTU2ZTAwODU2NGQ5ZDlmYTQ2MDdhYmY=
+  data.tar.gz: !binary |-
+    ZGMwMmE0ZTA0NDMwNjMyY2EyNDZkZGMyMmU2NWE5MDI0YzJmMThiNDNkNzk1
+    Y2RlOGVkNzlmYTdmMjUwODlkMmMxODc0ZjNkM2M3MDU4YjY2OTYzOGY5MzUx
+    NDI3OWVmYzc1NmRmOTdmNjkwYTNiYzA4ODU3MmNjNjVjNzFkN2I=

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+mongoid-paperclip-*.gem
+.*swp
+.*swo

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid-paperclip

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_rating.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    glebtv-mongoid-paperclip (0.1.0)
+      paperclip (>= 2.3.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    builder (3.1.4)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.2)
+      climate_control (>= 0.0.3, < 1.0)
+    i18n (0.6.5)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    paperclip (3.5.1)
+      activemodel (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      cocaine (~> 0.5.0)
+      mime-types
+    rake (10.1.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  glebtv-mongoid-paperclip!
+  rake

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Michael van Rooijen
+
+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.
+

data/README.md

@@ -0,0 +1,103 @@
+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 and the ActiveRecord ORM.
+This example assumes you are using **Ruby on Rails 3** and **Bundler**. However it doesn't require either.
+
+
+Setting it up
+-------------
+
+Simply define the `mongoid-paperclip` gem inside your `Gemfile`. Additionally, you can define the `aws-sdk` gem if you want to upload your files to Amazon S3. *You do not need to explicitly define the `paperclip` gem itself, since this is handled by `mongoid-paperclip`.*
+
+**Rails.root/Gemfile - Just define the following:**
+
+    gem "mongoid-paperclip", :require => "mongoid_paperclip"
+    gem 'aws-sdk', '~> 1.3.4'
+
+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 module and invoke the provided class method**
+
+    class User
+      include Mongoid::Document
+      include Mongoid::Paperclip
+
+      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_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_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_mongoid_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
+
+    @user.pictures.each do |picture|
+      <%= picture.attachment.url %>
+    end
+
+Note on embedded documents: if you plan to save or update the parent document, you MUST add cascade_callbacks: true to your
+embeds_XXX statement.  Otherwise, your data will be updated but the paperclip functions will not run to copy/update your file.
+
+In the above example:
+
+```ruby
+    class User
+    ...
+    embeds_many :pictures, :cascade_callbacks => true
+    accepts_nested_attributes_for :pictures, ...
+    attr_accepted :pictures_attributes, ...
+    ...
+    end
+
+    @user.update_attributes({ ... :pictures => [...] })
+```
+
+
+There you go
+------------
+
+Quite a lot of people have been looking for a solution to use Paperclip with Mongoid so I hope this helps!
+
+If you need more information on either [Mongoid](http://mongoid.org/) or [Paperclip](https://github.com/thoughtbot/paperclip) I suggest checking our their official documentation and website.
+
+
+License
+-------
+
+Mongoid::Paperclip is released under the MIT license. See LICENSE for more information.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/glebtv-mongoid-paperclip.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-paperclip/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'glebtv-mongoid-paperclip'
+  gem.version     = Mongoid::Paperclip::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ['GlebTV', 'Michael van Rooijen']
+  gem.email       = 'meskyanichi@gmail.com'
+  gem.homepage    = 'https://github.com/glebtv/mongoid-paperclip'
+  gem.summary     = 'Fork of Mongoid::Paperclip'
+  gem.description = 'Mongoid::Paperclip enables you to use Paperclip with the Mongoid ODM for MongoDB.'
+
+  gem.files         = %x[git ls-files].split("\n")
+  gem.test_files    = %x[git ls-files -- {spec}/*].split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'paperclip', ['>= 2.3.6']
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+end
+

data/lib/glebtv-mongoid-paperclip.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+
+require "mongoid-paperclip/version"
+
+begin
+  require "paperclip"
+rescue LoadError
+  puts "Mongoid::Paperclip requires that you install the Paperclip gem."
+  exit
+end
+
+##
+# the id of mongoid is not integer, correct the id_partitioin.
+Paperclip.interpolates :id_partition do |attachment, style|
+  attachment.instance.id.to_s.scan(/.{4}/).join("/")
+end
+
+##
+# mongoid criteria uses a different syntax.
+module Paperclip
+  module Helpers
+    def each_instance_with_attachment(klass, name)
+      class_for(klass).unscoped.where("#{name}_file_name".to_sym.ne => nil).each do |instance|
+        yield(instance)
+      end
+    end
+  end
+end
+
+##
+# The Mongoid::Paperclip extension
+# Makes Paperclip play nice with the Mongoid ODM
+#
+# Example:
+#
+#  class User
+#    include Mongoid::Document
+#    include Mongoid::Paperclip
+#
+#    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_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_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
+#  field :avatar_content_type, :type => String
+#  field :avatar_file_size,    :type => Integer
+#  field :avatar_updated_at,   :type => DateTime
+#  field :avatar_fingerprint,  :type => String
+#
+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_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_mongoid_attached_file(field, options = {})
+
+        ##
+        # Include Paperclip and Paperclip::Glue for compatibility
+        unless self.ancestors.include?(::Paperclip)
+          include ::Paperclip
+          include ::Paperclip::Glue
+        end
+
+        ##
+        # 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)
+        field(:"#{field}_fingerprint",  :type => String)
+      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

data/lib/mongoid-paperclip/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Paperclip
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: glebtv-mongoid-paperclip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GlebTV
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mongoid::Paperclip enables you to use Paperclip with the Mongoid ODM
+  for MongoDB.
+email: meskyanichi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- glebtv-mongoid-paperclip.gemspec
+- lib/glebtv-mongoid-paperclip.rb
+- lib/mongoid-paperclip/version.rb
+homepage: https://github.com/glebtv/mongoid-paperclip
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Fork of Mongoid::Paperclip
+test_files: []