mongoid-paperclip 0.0.8 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ab6e33f7deca617d928cc8ed4d1faf9c5dd50fbeff677a27bd6cba978c8d332
+  data.tar.gz: ef2b218581e0bc51f271b8b3fb15d10b21521b63e8c848c07a62f344024e735b
+SHA512:
+  metadata.gz: e0b4c8f32487dcfc459bea442d8308f80b3d793eab6a3fb9fa25eb4e4fef68cd11a8a61bd56fde001762a54fc510f2e3a763c72c1c193030b58955d205fe0545
+  data.tar.gz: ce9af4d226b37e5fe657a36d9c53939ee6d9ca3473b238e6f60ab05266deff6483cee58b9da1cadff142c8e0a630149b45cf9b5713b7a034f871dc5626d89ede

data/.gitignore

@@ -2,3 +2,5 @@
 mongoid-paperclip-*.gem
 .*swp
 .*swo
+.ruby-version
+/spec/public

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Use the gemspec for all dependencies.
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    mongoid-paperclip (0.1.0)
+      kt-paperclip
+      mongoid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    bson (4.13.0)
+    climate_control (0.2.0)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    kt-paperclip (7.0.1)
+      activemodel (>= 4.2.0)
+      activesupport (>= 4.2.0)
+      marcel (~> 1.0.1)
+      mime-types
+      terrapin (~> 0.6.0)
+    marcel (1.0.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
+    mongo (2.17.0)
+      bson (>= 4.8.2, < 5.0.0)
+    mongoid (7.3.3)
+      activemodel (>= 5.1, < 6.2)
+      mongo (>= 2.10.5, < 3.0.0)
+      ruby2_keywords (~> 0.0.5)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    ruby2_keywords (0.0.5)
+    terrapin (0.6.0)
+      climate_control (>= 0.0.3, < 1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  mongoid-paperclip!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.2.31

data/README.md

@@ -1,74 +1,71 @@
-Mongoid::Paperclip - Making Paperclip play nice with Mongoid ODM
-================================================================
+# Mongoid::Paperclip
 
-As the title suggests: `Mongoid::Paperclip` makes it easy to hook up [Paperclip](https://github.com/thoughtbot/paperclip) with [Mongoid](http://mongoid.org/).
+Integrate [kt-paperclip](https://github.com/kreeti/kt-paperclip) into [Mongoid](http://mongoid.org/).
+(Kt-paperclip is a maintained fork of the original [Paperclip](https://github.com/thoughtbot/paperclip) that is now deprecated)
 
 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
 
-Setting it up
--------------
+**Gemfile**
 
-Simply define the `mongoid-paperclip` gem inside your `Gemfile`. Additionally, you can define the `aws-s3` 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-s3",            :require => "aws/s3"
+```rb
+gem "mongoid-paperclip"
+```
 
 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
+```rb
+class User
+  include Mongoid::Document
+  include Mongoid::Paperclip
 
+  has_mongoid_attached_file :avatar
+end
+```
 
-That's it
---------
+## 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.
+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 `has_mongoid_attached_file` will automatically define the necessary `:avatar` fields for you.
 
 
-A more complex example
-----------------------
+## 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
+```rb
+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.
@@ -76,28 +73,44 @@ embeds_XXX statement.  Otherwise, your data will be updated but the paperclip fu
 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 => [...] })
+class User
+  embeds_many :pictures, :cascade_callbacks => true
+  accepts_nested_attributes_for :pictures, ...
+  attr_accepted :pictures_attributes, ...
+end
+
+@user.update_attributes({ ... :pictures => [...] })
 ```
 
+## Optional fingerprinting
 
-There you go
-------------
+Paperclip will skip calculating the fingerprint of a file when the `{file}_fingerprint` field is missing from the model. This can be desirable if attaching large files to a model. To disable adding the fingerprint field pass the `disable_fingerprint` option as in this example:
 
-Quite a lot of people have been looking for a solution to use Paperclip with Mongoid so I hope this helps!
+```rb
+class User
+  include Mongoid::Document
+  include Mongoid::Paperclip
 
-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.
+  has_mongoid_attached_file :usage_report, disable_fingerprint: true
+end
+```
 
+## Testing
 
-License
--------
+If you want to help develop this plugin, clone the repo and bundle to get all dependencies.
 
-Mongoid::Paperclip is released under the MIT license. See LICENSE for more information.
+Then to run the tests:
 
+```
+rspec
+```
+
+## 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 [kt-paperclip](https://github.com/kreeti/kt-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,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/mongoid-paperclip.rb

@@ -0,0 +1 @@
+require 'mongoid_paperclip'

data/lib/mongoid_paperclip.rb

@@ -1,16 +1,28 @@
-# encoding: utf-8
-
-begin
-  require "paperclip"
-rescue LoadError
-  puts "Mongoid::Paperclip requires that you install the Paperclip gem."
-  exit
-end
+require 'paperclip'
 
 ##
 # 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("/")
+  case id = attachment.instance.id
+  when Integer
+    ("%09d".freeze % id).scan(/\d{3}/).join("/".freeze)
+  when String
+    id.scan(/.{4}/).join("/".freeze)
+  else
+    nil
+  end
+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
 
 ##
@@ -38,6 +50,7 @@ end
 #  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
@@ -50,12 +63,33 @@ module Mongoid
 
     module ClassMethods
 
+      ##
+      # Adds after_commit
+      def after_commit(*args, &block)
+        options = args.pop if args.last.is_a? Hash
+        if options
+          case options[:on]
+          when :create
+            after_create(*args, &block)
+          when :update
+            after_update(*args, &block)
+          when :destroy
+            after_destroy(*args, &block)
+          else
+            after_save(*args, &block)
+          end
+        else
+          after_save(*args, &block)
+        end
+      end
+
       ##
       # 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 = {})
+        disable_fingerprint = options.delete(:disable_fingerprint)
 
         ##
         # Include Paperclip and Paperclip::Glue for compatibility
@@ -63,7 +97,7 @@ module Mongoid
           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
@@ -75,6 +109,7 @@ module Mongoid
         field(:"#{field}_content_type", :type => String)
         field(:"#{field}_file_size",    :type => Integer)
         field(:"#{field}_updated_at",   :type => DateTime)
+        field(:"#{field}_fingerprint",  :type => String) unless disable_fingerprint
       end
 
       ##

data/mongoid-paperclip.gemspec

@@ -1,21 +1,22 @@
-# encoding: utf-8
-
 Gem::Specification.new do |gem|
-
   gem.name        = 'mongoid-paperclip'
-  gem.version     = '0.0.8'
+  gem.version     = '0.1.0'
   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 ODM for MongoDB.'
-  gem.description = 'Mongoid::Paperclip enables you to use Paperclip with the Mongoid ODM for MongoDB.'
+  gem.authors     = ['Michael van Rooijen', 'Joost Baaij']
+  gem.email       = ['michael@vanrooijen.io', 'joost@spacebabies.nl']
+  gem.homepage    = 'https://github.com/mrrooijen/mongoid-paperclip'
+  gem.summary     = 'Paperclip compatibility for Mongoid ODM for MongoDB.'
+  gem.description = 'Enables you to use Paperclip with the Mongoid ODM for MongoDB.'
+  gem.license     = 'MIT'
 
-  gem.files         = %x[git ls-files].split("\n")
-  gem.test_files    = %x[git ls-files -- {spec}/*].split("\n")
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
   gem.require_path  = 'lib'
 
-  gem.add_dependency 'paperclip', ['>= 2.3.6']
+  gem.add_dependency 'kt-paperclip'
+  gem.add_dependency 'mongoid'
 
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 end
-

data/spec/config/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  clients:
+    default:
+      database: mongoid-paperclip
+      hosts:
+        - localhost:27017

data/spec/mongoid-paperclip_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe Mongoid::Paperclip, type: :unit do
+  describe "avatar" do
+    let(:user) { User.create }
+
+    before do
+      user.update avatar: File.new('spec/support/avatar.png', 'rb')
+    end
+
+    it "stores file_name" do
+      expect(user.avatar_file_name).to eq("avatar.png")
+    end
+
+    it "stores content_type" do
+      expect(user.avatar_content_type).to eq("image/png")
+    end
+
+    it "stores file_size" do
+      expect(user.avatar_file_size).to eq(357)
+    end
+
+    it "stores updated_at" do
+      expect(user.avatar_updated_at).to be_present
+    end
+
+    it "stores fingerprint" do
+      expect(user.avatar_fingerprint).to eq("2584a801e588b3fcf4aa074efff77e30")
+    end
+  end
+
+  describe "multiple attachments" do
+    let(:user) { MultipleAttachments.create }
+
+    it "works" do
+      user.update avatar: File.new('spec/support/avatar.png', 'rb'), icon: File.new('spec/support/avatar.png', 'rb')
+      expect(user.avatar_file_name).to eq("avatar.png")
+      expect(user.icon_file_name).to eq("avatar.png")
+    end
+  end
+
+  describe "disable fingerprint" do
+    let(:user) { NoFingerprint.create }
+
+    before do
+      user.update avatar: File.new('spec/support/avatar.png', 'rb')
+    end
+
+    it "does not store a fingerprint" do
+      expect(user.attributes).to_not include('fingerprint')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+require 'rspec'
+require 'mongoid'
+require 'mongoid-paperclip'
+
+ENV['MONGOID_ENV'] = 'test'
+Mongoid.load!('./spec/config/mongoid.yml')
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Mongoid.purge!
+  end
+end
+
+# Mock Rails itself so Paperclip can write the attachments to a directory.
+class Rails
+  def self.root
+    File.expand_path(File.dirname(__FILE__))
+  end
+end
+
+class User
+  include Mongoid::Document
+  include Mongoid::Paperclip
+
+  has_mongoid_attached_file :avatar
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
+end
+
+class MultipleAttachments
+  include Mongoid::Document
+  include Mongoid::Paperclip
+
+  has_mongoid_attached_file :avatar
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
+
+  has_mongoid_attached_file :icon
+  validates_attachment_content_type :icon, content_type: /\Aimage\/.*\Z/
+end
+
+class NoFingerprint
+  include Mongoid::Document
+  include Mongoid::Paperclip
+
+  has_mongoid_attached_file :avatar, disable_fingerprint: true
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
+end

metadata

@@ -1,68 +1,129 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-paperclip
 version: !ruby/object:Gem::Version
-  version: 0.0.8
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael van Rooijen
-autorequire: 
+- Joost Baaij
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: paperclip
+  name: kt-paperclip
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.6
-description: Mongoid::Paperclip enables you to use Paperclip with the Mongoid ODM
-  for MongoDB.
-email: meskyanichi@gmail.com
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Enables you to use Paperclip with the Mongoid ODM for MongoDB.
+email:
+- michael@vanrooijen.io
+- joost@spacebabies.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
+- lib/mongoid-paperclip.rb
 - lib/mongoid_paperclip.rb
 - mongoid-paperclip.gemspec
-homepage: https://github.com/meskyanichi/mongoid-paperclip
-licenses: []
-post_install_message: 
+- spec/config/mongoid.yml
+- spec/mongoid-paperclip_spec.rb
+- spec/spec_helper.rb
+- spec/support/avatar.png
+homepage: https://github.com/mrrooijen/mongoid-paperclip
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
-summary: Mongoid::Paperclip enables you to use Paperclip with the Mongoid ODM for
-  MongoDB.
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Paperclip compatibility for Mongoid ODM for MongoDB.
 test_files: []
-has_rdoc: