mongoid 7.2.0.rc1 → 7.3.0

data/spec/mongoid/attributes/projector_data/fields.yml

@@ -0,0 +1,93 @@
+- name: simple inclusion - integer
+  projection:
+    foo: 1
+  
+  queries: &field-inclusion-expectations
+    - query: foo
+      allowed: true
+    - query: bar
+      allowed: false
+
+- name: simple inclusion - boolean
+  projection:
+    foo: true
+  
+  queries: &field-inclusion-expectations
+    - query: foo
+      allowed: true
+    - query: bar
+      allowed: false
+
+- name: positive integer - inclusion
+  projection:
+    foo: 2
+  
+  queries: *field-inclusion-expectations
+
+- name: simple exclusion - integer
+  projection:
+    foo: 0
+  
+  queries: &field-exclusion-expectations
+    - query: foo
+      allowed: false
+    - query: bar
+      allowed: true
+
+- name: simple exclusion - boolean
+  projection:
+    foo: false
+  
+  queries: &field-exclusion-expectations
+    - query: foo
+      allowed: false
+    - query: bar
+      allowed: true
+
+- name: negative integer - exclusion
+  projection:
+    foo: -2
+  
+  queries: *field-exclusion-expectations
+
+- name: field inclusion with _id exclusion
+  projection:
+    foo: 1
+    _id: 0
+  
+  queries: &field-inclusion-with-id-exclusion-expectations
+    - query: foo
+      allowed: true
+      
+    - query: bar
+      allowed: false
+      
+    - query: _id
+      allowed: false
+
+- name: _id exclusion with field inclusion
+  projection:
+    _id: 0
+    foo: 1
+  
+  queries: *field-inclusion-with-id-exclusion-expectations
+
+- name: id inclusion
+  projection:
+    _id: 1
+  
+  queries:
+    - query: _id
+      allowed: true
+    - query: foo
+      allowed: false
+
+- name: id exclusion
+  projection:
+    _id: false
+  
+  queries:
+    - query: _id
+      allowed: false
+    - query: foo
+      allowed: true

data/spec/mongoid/attributes/projector_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Mongoid::Attributes::Projector do
+  Dir[File.join(File.dirname(__FILE__), 'projector_data', '*.yml')].sort.each do |path|
+    context File.basename(path) do
+      specs = YAML.load(File.read(path))
+
+      specs.each do |spec|
+        context spec['name'] do
+
+          if spec['pending']
+            pending spec['pending'].to_s
+          end
+
+          let(:projection) do
+            spec['projection']
+          end
+
+          let(:projector) do
+            Mongoid::Attributes::Projector.new(projection)
+          end
+
+          spec.fetch('queries').each do |query_spec|
+            context query_spec.fetch('query').inspect do
+              let(:query) { query_spec['query'] }
+
+              context 'attribute_or_path_allowed?' do
+                it "is #{query_spec.fetch('allowed')}" do
+                  projector.attribute_or_path_allowed?(query).should be query_spec['allowed']
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/mongoid/attributes_spec.rb

@@ -96,6 +96,49 @@ describe Mongoid::Attributes do
             it "does not raise an error" do
               expect(from_db.map).to eq(map)
             end
+
+            context 'when only one of the hash fields is projected' do
+
+              let(:map) do
+                { 'dates' => { 'y' => { '2016' => 'Berlin', '2017' => 'Munich' } } }
+              end
+
+              let(:expected) do
+                { 'dates' => { 'y' => {
+                  '2016' => 'Berlin',
+                } } }
+              end
+
+              it 'retrieves only the projected fields' do
+                expect(from_db.map).to eq(expected)
+              end
+            end
+
+            context 'when several of the hash fields is projected' do
+
+              let(:map) do
+                { 'dates' => { 'y' => {
+                  '2016' => 'Berlin',
+                  '2017' => 'Munich',
+                  '2018' => 'Krakow',
+                } } }
+              end
+
+              let(:expected) do
+                { 'dates' => { 'y' => {
+                  '2016' => 'Berlin',
+                  '2018' => 'Krakow',
+                } } }
+              end
+
+              let(:from_db) do
+                Person.only('map.dates.y.2016', 'map.dates.y.2018').first
+              end
+
+              it 'retrieves only the projected fields' do
+                expect(from_db.map).to eq(expected)
+              end
+            end
           end
         end
 
@@ -245,6 +288,91 @@ describe Mongoid::Attributes do
         end
       end
 
+      context "when the field was not explicitly defined" do
+
+        context "when excluding with only and the field was not excluded" do
+
+          let(:from_db) do
+            Person.only(:_id).first
+          end
+
+          it "raises an error" do
+            expect {
+              from_db[:undefined_field]
+            }.to raise_error(ActiveModel::MissingAttributeError)
+          end
+        end
+
+        context "when excluding with without and the field was excluded" do
+
+          let(:from_db) do
+            Person.without(:title).first
+          end
+
+          it "raises an error" do
+            expect {
+              from_db[:title]
+            }.to raise_error(ActiveModel::MissingAttributeError)
+          end
+        end
+
+        context "when excluding with without and the field was not excluded" do
+
+          let(:from_db) do
+            Person.without(:title).first
+          end
+
+          it "returns nil" do
+            from_db[:undefined_field].should be nil
+          end
+        end
+      end
+
+      context 'when projecting with #only' do
+        let!(:person) do
+          Person.create(title: 'sir', name: { first_name: 'Jose', language: { name: 'es' } })
+        end
+
+        context 'when projecting an embedded association' do
+          let(:from_db) do
+            Person.only(:name).first
+          end
+
+          context 'when retrieving a field of the association using the dot notation' do
+
+            it 'retrieves the field' do
+              expect(from_db['name.first_name']).to eq 'Jose'
+            end
+          end
+
+          context 'when retrieving a field of a nested association using the dot notation' do
+            it 'retrieves the field' do
+              expect(from_db['name.language.name']).to eq 'es'
+            end
+          end
+        end
+
+        context 'when projecting a sub-association of an embedded association' do
+          let(:from_db) do
+            Person.only('name.language').first
+          end
+
+          context 'when retrieving a field under the projected sub-association' do
+            it 'retrieves the field' do
+              expect(from_db['name.language.name']).to eq 'es'
+            end
+          end
+
+          context 'when retrieving a non-projected field' do
+            it 'raises MissingAttributeError' do
+              expect do
+                from_db['name.first_name']
+              end.to raise_error(ActiveModel::MissingAttributeError)
+            end
+          end
+        end
+      end
+
       context "when the attribute does not exist" do
 
         before do
@@ -329,6 +457,67 @@ describe Mongoid::Attributes do
         expect(terms).to eq(true)
       end
     end
+
+    context 'when the field is not explicitly defined' do
+      let(:bar) { Bar.new }
+
+      before do
+        bar['missing_field'] = 42
+      end
+
+      it 'writes the value into attributes' do
+        bar.attributes.should == {'_id' => bar.id, 'missing_field' => 42}
+      end
+
+      it 'makes the attribute accessible via []' do
+        bar['missing_field'].should == 42
+      end
+
+      context 'when writing fields on a document with projection' do
+
+        let!(:person) do
+          Person.create(title: "sir")
+        end
+
+        context "when excluding with only and the field was not excluded" do
+
+          let(:from_db) do
+            Person.only(:_id).first
+          end
+
+          it "raises an error" do
+            expect {
+              from_db[:undefined_field] = 'x'
+            }.to raise_error(ActiveModel::MissingAttributeError)
+          end
+        end
+
+        context "when excluding with without and the field was excluded" do
+
+          let(:from_db) do
+            Person.without(:title).first
+          end
+
+          it "raises an error" do
+            expect {
+              from_db[:title] = 'x'
+            }.to raise_error(ActiveModel::MissingAttributeError)
+          end
+        end
+
+        context "when excluding with without and the field was not excluded" do
+
+          let(:from_db) do
+            Person.without(:title).first
+          end
+
+          it "writes the value" do
+            from_db[:undefined_field] = 'x'
+            from_db[:undefined_field].should == 'x'
+          end
+        end
+      end
+    end
   end
 
   describe "#_id" do
@@ -893,6 +1082,50 @@ describe Mongoid::Attributes do
         expect(person.age_before_type_cast).to eq("old")
       end
     end
+
+    context 'when reading fields on a document with projection' do
+
+      let!(:person) do
+        Person.create(title: "sir")
+      end
+
+      context "when excluding with only and the field was not excluded" do
+
+        let(:from_db) do
+          Person.only(:_id).first
+        end
+
+        it "raises an error" do
+          expect {
+            from_db.read_attribute(:undefined_field)
+          }.to raise_error(ActiveModel::MissingAttributeError)
+        end
+      end
+
+      context "when excluding with without and the field was excluded" do
+
+        let(:from_db) do
+          Person.without(:title).first
+        end
+
+        it "raises an error" do
+          expect {
+            from_db.read_attribute(:title)
+          }.to raise_error(ActiveModel::MissingAttributeError)
+        end
+      end
+
+      context "when excluding with without and the field was not excluded" do
+
+        let(:from_db) do
+          Person.without(:title).first
+        end
+
+        it "returns nil" do
+          from_db.read_attribute(:undefined_field).should be nil
+        end
+      end
+    end
   end
 
   describe "#attribute_present?" do
@@ -1398,6 +1631,51 @@ describe Mongoid::Attributes do
         expect(dictionary.description).to eq('foo')
       end
     end
+
+    context 'when writing fields on a document with projection' do
+
+      let!(:person) do
+        Person.create(title: "sir")
+      end
+
+      context "when excluding with only and the field was not excluded" do
+
+        let(:from_db) do
+          Person.only(:_id).first
+        end
+
+        it "raises an error" do
+          expect {
+            from_db.write_attribute(:undefined_field, 'x')
+          }.to raise_error(ActiveModel::MissingAttributeError)
+        end
+      end
+
+      context "when excluding with without and the field was excluded" do
+
+        let(:from_db) do
+          Person.without(:title).first
+        end
+
+        it "raises an error" do
+          expect {
+            from_db.write_attribute(:title, 'x')
+          }.to raise_error(ActiveModel::MissingAttributeError)
+        end
+      end
+
+      context "when excluding with without and the field was not excluded" do
+
+        let(:from_db) do
+          Person.without(:title).first
+        end
+
+        it "writes the value" do
+          from_db.write_attribute(:undefined_field, 'x')
+          from_db.read_attribute(:undefined_field).should == 'x'
+        end
+      end
+    end
   end
 
   describe "#typed_value_for" do
@@ -1651,6 +1929,61 @@ describe Mongoid::Attributes do
     end
   end
 
+  describe '#unalias_attribute' do
+    let(:shirt) { Shirt.new }
+    let(:id) { '1234' }
+
+    context 'when creating object' do
+      let(:shirt) { Shirt.new(id: id) }
+
+      it 'id and _id are not the same' do
+        expect(shirt.id).to eq(id)
+        expect(shirt._id).not_to eq(id)
+      end
+    end
+
+    context 'update' do
+      before do
+        shirt.update(id: id)
+      end
+
+      it 'updates id but not_id' do
+        expect(shirt.id).to eq(id)
+        expect(shirt._id).not_to eq(id)
+      end
+    end
+
+    context 'id=' do
+      before do
+        shirt.id = id
+      end
+
+      it 'sets id and not _id' do
+        expect(shirt.id).to eq(id)
+        expect(shirt._id).not_to eq(id)
+      end
+    end
+
+    context 'id?' do
+      context 'with null id' do
+        it 'returns false' do
+          expect(shirt.id?).to be false
+          expect(shirt._id?).to be true
+        end
+      end
+
+      context 'with id' do
+        before do
+          shirt.id = id
+        end
+
+        it 'returns true' do
+          expect(shirt.id?).to be true
+        end
+      end
+    end
+  end
+
   describe "#alias_attribute" do
 
     let(:product) do