mongoid_monkey 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 214e7694779c183b25d31b4a3acd022b6d197883
-  data.tar.gz: ba65a452be5ef5778673fb790872ad7e879e368e
+  metadata.gz: 118a2a99faa547a7a3336586d933db15563d8069
+  data.tar.gz: 97f311b750030497fd6c1a63da61d369bbcfbdb1
 SHA512:
-  metadata.gz: 9c3906fb7a21840e4e1688bc1f9f9bcbfa608d3083533d52b87cb8caf31783dfe6aea1ae462b85c6908cb9d9b05ec35cd5e04e6d83e2e0750dbcb2f231d96c1b
-  data.tar.gz: 9c0dc36cb5537f059791b16d43ba2dd5fb3337d3597e3dfc4600c469d3717166a6761a5d8a335731dae3e6810340aad0e7a1b51bea69136af6a78bbab17d1864
+  metadata.gz: 0a3e0791c5012535b304f706f4484c781c2230d6b9ceabde4d39100de8512aef245c02063be791cb8e52734516be7cd50221bd6037dd223b38942ec922c147cd
+  data.tar.gz: b84df91ff37ffbea35e9dc2d559ec7a5cd0aa20d063caf5d583011a6e33c0e9fc307201eec53bba9fe0e3667653448bd3d32bb493c44168bc2f8950137019b6a

data/README.md

@@ -25,13 +25,18 @@ Installing this gem will apply all monkey patches for the Mongoid version you ar
 If you would only like some of the patches, please copy and paste the code to your app directly
 (e.g. `/config/initializers` if using Rails.)
 
+`●` = This gem adds support
+`×` = This gem does not yet support (PRs welcome!)
+`○` = Already supported natively
+
 | File | Description | 3 | 4 | 5 |
 | --- | --- | --- | --- | --- |
-| `atomic.rb` | Backport syntax change of atomic query methods. | ● | | |
+| `atomic.rb` | Backport syntax change of atomic query methods. | ● | ○ | ○ |
 | `big_decimal.rb` | Fixes buggy BigDecimal behavior. | ● | ● | ● |
-| `db_commands.rb` | Use MongoDB 3.0+ command syntax; required for WiredTiger. | ● | ● | |
-| `instrument.rb` | Backport instrumentation change to Moped 1. | ● | | |
-| `reorder.rb` | Backport `Criteria#reorder` method. | ● | | |
+| `db_commands.rb` | Use MongoDB 3.0+ command syntax; required for WiredTiger. | ● | ● | ○ |
+| `instrument.rb` | Backport instrumentation change to Moped 1. | ● | ○ | ○ |
+| `reorder.rb` | Backport `Criteria#reorder` method from Mongoid 4. | ● | ○ | ○ |
+| `only_pluck_localized.rb` | Backport [PR #4299](https://github.com/mongodb/mongoid/pull/4299) from Mongoid 6 which fixes `#only`, `#without`, and `#pluck` with localized fields. | ● | × | × |
 
 ### License
 

data/lib/mongoid_monkey.rb

@@ -5,3 +5,4 @@ require 'patches/big_decimal'
 require 'patches/db_commands'
 require 'patches/instrument'
 require 'patches/reorder'
+require 'patches/only_pluck_localized'

data/lib/patches/only_pluck_localized.rb

@@ -0,0 +1,74 @@
+# Backport of https://github.com/mongodb/mongoid/pull/4299 Mongoid 6 to Mongoid 3.
+
+if Mongoid::VERSION =~ /\A3\./
+
+  module Origin
+    class Options < Smash
+
+      def store(key, value, localize = true)
+        super(key, evolve(value, localize))
+      end
+      alias :[]= :store
+
+      private
+
+      def evolve(value, localize = true)
+        case value
+          when Hash
+            evolve_hash(value, localize)
+          else
+            value
+        end
+      end
+
+      def evolve_hash(value, localize = true)
+        value.inject({}) do |hash, (field, _value)|
+          name, serializer = storage_pair(field)
+          name = normalized_key(name, serializer) if localize
+          hash[name] = _value
+          hash
+        end
+      end
+    end
+  end
+
+  module Origin
+    module Optional
+
+      def only(*args)
+        args = args.flatten
+        puts args.inspect
+        option(*args) do |options|
+          options.store(
+              :fields,
+              args.inject({}){ |sub, field| sub.tap { sub[field] = 1 }},
+              false
+          )
+        end
+      end
+
+      def without(*args)
+        args = args.flatten
+        option(*args) do |options|
+          options.store(
+              :fields,
+              args.inject({}){ |sub, field| sub.tap { sub[field] = 0 }},
+              false
+          )
+        end
+      end
+    end
+  end
+
+  module Mongoid
+    module Contextual
+      class Mongo
+
+        def pluck(field)
+          normalized = klass.database_field_name(field)
+          query.dup.select(normalized => 1).map{ |doc| doc[normalized.partition('.').first] }.compact
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module MongoidMonkey
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/spec/unit/only_pluck_localized.rb

@@ -0,0 +1,326 @@
+require "spec_helper"
+
+if defined?(Moped) && Moped::VERSION =~ /\A3\./
+
+  describe Mongoid::Criteria do
+
+    describe "#only" do
+
+      let!(:band) do
+        Band.create(name: "Depeche Mode", likes: 3, views: 10)
+      end
+
+      context "when not using inheritance" do
+
+        context "when passing splat args" do
+
+          let(:criteria) do
+            Band.only(:_id)
+          end
+
+          it "limits the returned fields" do
+            criteria.first.name.should be_nil
+          end
+
+          it "does not add _type to the fields" do
+            criteria.options[:fields]["_type"].should be_nil
+          end
+        end
+
+        context "when not including id" do
+
+          let(:criteria) do
+            Band.only(:name)
+          end
+
+          it "responds to id anyway" do
+            expect {
+              criteria.first.id
+            }.to_not raise_error
+          end
+        end
+
+        context "when passing an array" do
+
+          let(:criteria) do
+            Band.only([ :name, :likes ])
+          end
+
+          it "includes the limited fields" do
+            criteria.first.name.should_not be_nil
+          end
+
+          it "excludes the non included fields" do
+            criteria.first.active.should be_nil
+          end
+
+          it "does not add _type to the fields" do
+            criteria.options[:fields]["_type"].should be_nil
+          end
+        end
+
+        context "when instantiating a class of another type inside the iteration" do
+
+          let(:criteria) do
+            Band.only(:name)
+          end
+
+          it "only limits the fields on the correct model" do
+            criteria.each do |band|
+              Person.new.age.should eq(100)
+            end
+          end
+        end
+
+        context "when instantiating a document not in the result set" do
+
+          let(:criteria) do
+            Band.only(:name)
+          end
+
+          it "only limits the fields on the correct criteria" do
+            criteria.each do |band|
+              Band.new.active.should be_true
+            end
+          end
+        end
+
+        context "when nesting a criteria within a criteria" do
+
+          let(:criteria) do
+            Band.only(:name)
+          end
+
+          it "only limits the fields on the correct criteria" do
+            criteria.each do |band|
+              Band.all.each do |b|
+                b.active.should be_true
+              end
+            end
+          end
+        end
+      end
+
+      context "when using inheritance" do
+
+        let(:criteria) do
+          Doctor.only(:_id)
+        end
+
+        it "adds _type to the fields" do
+          criteria.options[:fields]["_type"].should eq(1)
+        end
+      end
+
+      context "when limiting to embedded documents" do
+
+        context "when the embedded documents are aliased" do
+
+          let(:criteria) do
+            Person.only(:phones)
+          end
+
+          it "properly uses the database field name" do
+            criteria.options.should eq(fields: { "mobile_phones" => 1 })
+          end
+        end
+      end
+
+      context 'when the field is localized' do
+
+        before do
+          I18n.locale = :en
+          d = Dictionary.create(description: 'english-text')
+          I18n.locale = :de
+          d.description = 'deutsch-text'
+          d.save
+        end
+
+        after do
+          I18n.locale = :en
+        end
+
+        context 'when entire field is included' do
+
+          let(:dictionary) do
+            Dictionary.only(:description).first
+          end
+
+          it 'loads all translations' do
+            expect(dictionary.description_translations.keys).to include('de', 'en')
+          end
+
+          it 'returns the field value for the current locale' do
+            I18n.locale = :en
+            expect(dictionary.description).to eq('english-text')
+            I18n.locale = :de
+            expect(dictionary.description).to eq('deutsch-text')
+          end
+        end
+
+        context 'when a specific locale is included' do
+
+          let(:dictionary) do
+            Dictionary.only(:'description.de').first
+          end
+
+          it 'loads translations only for the included locale' do
+            expect(dictionary.description_translations.keys).to include('de')
+            expect(dictionary.description_translations.keys).to_not include('en')
+          end
+
+          it 'returns the field value for the included locale' do
+            I18n.locale = :en
+            expect(dictionary.description).to be_nil
+            I18n.locale = :de
+            expect(dictionary.description).to eq('deutsch-text')
+          end
+        end
+
+        context 'when entire field is excluded' do
+
+          let(:dictionary) do
+            Dictionary.without(:description).first
+          end
+
+          it 'does not load all translations' do
+            expect(dictionary.description_translations.keys).to_not include('de', 'en')
+          end
+
+          it 'raises an ActiveModel::MissingAttributeError when attempting to access the field' do
+            expect{dictionary.description}.to raise_error ActiveModel::MissingAttributeError
+          end
+        end
+
+        context 'when a specific locale is excluded' do
+
+          let(:dictionary) do
+            Dictionary.without(:'description.de').first
+          end
+
+          it 'does not load excluded translations' do
+            expect(dictionary.description_translations.keys).to_not include('de')
+            expect(dictionary.description_translations.keys).to include('en')
+          end
+
+          it 'returns nil for excluded translations' do
+            I18n.locale = :en
+            expect(dictionary.description).to eq('english-text')
+            I18n.locale = :de
+            expect(dictionary.description).to be_nil
+          end
+        end
+      end
+    end
+
+    describe "#pluck" do
+
+      let!(:depeche) do
+        Band.create(name: "Depeche Mode", likes: 3)
+      end
+
+      let!(:tool) do
+        Band.create(name: "Tool", likes: 3)
+      end
+
+      let!(:photek) do
+        Band.create(name: "Photek", likes: 1)
+      end
+
+      context "when the criteria matches" do
+
+        context "when there are no duplicate values" do
+
+          let(:criteria) do
+            Band.where(:name.exists => true)
+          end
+
+          let!(:plucked) do
+            criteria.pluck(:name)
+          end
+
+          it "returns the values" do
+            plucked.should eq([ "Depeche Mode", "Tool", "Photek" ])
+          end
+
+          context "when subsequently executing the criteria without a pluck" do
+
+            it "does not limit the fields" do
+              expect(criteria.first.likes).to eq(3)
+            end
+          end
+        end
+
+        context "when there are duplicate values" do
+
+          let(:plucked) do
+            Band.where(:name.exists => true).pluck(:likes)
+          end
+
+          it "returns the duplicates" do
+            plucked.should eq([ 3, 3, 1 ])
+          end
+        end
+      end
+
+      context "when the criteria does not match" do
+
+        let(:plucked) do
+          Band.where(name: "New Order").pluck(:_id)
+        end
+
+        it "returns an empty array" do
+          plucked.should be_empty
+        end
+      end
+
+      context "when plucking an aliased field" do
+
+        let(:plucked) do
+          Band.all.pluck(:id)
+        end
+
+        it "returns the field values" do
+          plucked.should eq([ depeche.id, tool.id, photek.id ])
+        end
+      end
+
+      context 'when plucking a localized field' do
+
+        before do
+          I18n.locale = :en
+          d = Dictionary.create(description: 'english-text')
+          I18n.locale = :de
+          d.description = 'deutsch-text'
+          d.save
+        end
+
+        after do
+          I18n.locale = :en
+        end
+
+        context 'when plucking the entire field' do
+
+          let(:plucked) do
+            Dictionary.all.pluck(:description)
+          end
+
+          it 'returns all translations' do
+            expect(plucked.first).to eq({'en' => 'english-text', 'de' => 'deutsch-text'})
+          end
+        end
+
+        context 'when plucking a specific locale' do
+
+          let(:plucked) do
+            Dictionary.all.pluck(:'description.de')
+          end
+
+          it 'returns the specific translations' do
+            expect(plucked.first).to eq({'de' => 'deutsch-text'})
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_monkey
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - johnnyshields
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,6 +67,7 @@ files:
 - lib/patches/big_decimal.rb
 - lib/patches/db_commands.rb
 - lib/patches/instrument.rb
+- lib/patches/only_pluck_localized.rb
 - lib/patches/reorder.rb
 - lib/version.rb
 - spec/app/models/account.rb
@@ -110,6 +111,7 @@ files:
 - spec/unit/db_commands/moped_database_spec.rb
 - spec/unit/db_commands/moped_indexes_spec.rb
 - spec/unit/instrument_spec.rb
+- spec/unit/only_pluck_localized.rb
 - spec/unit/reorder_spec.rb
 homepage: https://github.com/johnnyshields/mongoid_monkey
 licenses:
@@ -131,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Monkey patches for Mongoid
@@ -177,5 +179,5 @@ test_files:
 - spec/unit/db_commands/moped_database_spec.rb
 - spec/unit/db_commands/moped_indexes_spec.rb
 - spec/unit/instrument_spec.rb
+- spec/unit/only_pluck_localized.rb
 - spec/unit/reorder_spec.rb
-has_rdoc: