mongoid_embed_finder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70d886a2e30dc89447b1e95b6b2dc1384ef80e9a
-  data.tar.gz: 69221aca597bfe5f984551a0dec804b72895ddd4
+  metadata.gz: a4b0eab4a0e78f65604f3782019c1f8a96c2366d
+  data.tar.gz: bda098c893739bf97833edd34afff02f1f98f804
 SHA512:
-  metadata.gz: 12b5c6df2b73f7781571f55cc55c07fd80293856732af0e771b15519387c17bb821b35e4c05e7c599f1f9b465db88d3d9ebfe2dcb7fbb8921613b629672eae23
-  data.tar.gz: b687bdd8a2631c16c134f8f0ed14d533d70a25c87e5c0ce83e6fb06c02c61fc876d7c639714da209a30b4f7d5b54749cbebc7e2c01a1df4922753872bd097ffd
+  metadata.gz: a30f6b29f97ee61c425509401d150be9a66925b985c8bc1a4eb8a2646b50810c1ffa3695fe0b0736d5cb3d15c16f0a81c4af9c8adfdd050d7e905873cb52a42a
+  data.tar.gz: 4ad9f506675098f170a4eb290075518635c40be55af464c98c702168ee5b512bae392d91a5eba639285e7bb29e30664524424ae84989c0d644528606a27c7d30

data/README.md

@@ -28,10 +28,11 @@ Let's say that you have defined two classes as follows:
       include Mongoid::Document
       embedded_in :car
     end
-    
+
     class Car
       include Mongoid::Document
       embeds_many :doors
+      field :name, type: String
     end
 
 Now you can easily retrieve instances of `Door` class using `finder`:
@@ -53,6 +54,16 @@ If you have `door_id` and `car_id` as well, you can narrow scope of cars:
 In general you can basically pass any set of child's and parent's attributes.
 Latter group should be passed under `parent` key. Those attributes are passed down to `Mongoid::Criteria`.
 
+### Warning!
+
+If your embedded object has other referenced entities they will not be loaded.
+
+By default no parent's attributes are set except its primary key. It is deliberate to limit
+amount of returned data.
+To retrieve parent's attributes list them under `parent.include_fields` as follows:
+
+    finder.first(id: door_id, parent: { id: car_id, include_fields: [:name] })
+
 ## Contributing
 
 1. Fork it ( https://github.com/growthrepublic/mongoid_embed_finder/fork )

data/lib/mongoid_embed_finder/projectors/base.rb

@@ -5,14 +5,23 @@ module MongoidEmbedFinder
         { relation.key => { operator => query.child_criteria.selector }}
       end
 
-      def project
+      def project(fields = [])
+        projection_with_fields = projection.merge(include_fields(fields))
         query.scope_parent(projection)
-        query.execute.select(projection)
+        query.execute.select(projection_with_fields)
       end
 
       def operator
         raise NotImplementedError, "operator needs to be overriden"
       end
+
+      private
+
+      def include_fields(fields)
+        fields.inject({}) do
+          |acc, name| acc.merge(name => 1)
+        end
+      end
     end
   end
 end

data/lib/mongoid_embed_finder/runner.rb

@@ -20,7 +20,8 @@ module MongoidEmbedFinder
 
     def find_first(attrs = {}, parent: {})
       query = build_nested_query(attrs, parent: parent)
-      project_query(query, Projectors::Single).first
+      project_query(query, Projectors::Single,
+        parent_fields: parent.fetch(:include_fields, [])).first
     end
 
     def build_nested_query(attrs = {}, parent: {})
@@ -28,13 +29,13 @@ module MongoidEmbedFinder
       child_criteria  = relations.child_class.criteria
 
       NestedQuery.new(parent_criteria, child_criteria).tap do |query|
-        query.scope_parent(parent)
+        query.scope_parent(parent.except(:include_fields))
         query.scope_child(attrs)
       end
     end
 
-    def project_query(query, projector_class)
-      projector_class.new(query, relations.children).project
+    def project_query(query, projector_class, parent_fields: [])
+      projector_class.new(query, relations.children).project(parent_fields)
     end
 
     def build_child_with_parent(nested_attrs)

data/lib/mongoid_embed_finder/version.rb

@@ -1,3 +1,3 @@
 module MongoidEmbedFinder
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/mongoid_embed_finder/projectors/single_spec.rb

@@ -19,19 +19,38 @@ describe MongoidEmbedFinder::Projectors::Single do
   end
 
   describe "#project" do
-    it "extend parent's criteria" do
-      subject.project
-      expect(query).to have_received(:scope_parent).with(subject.projection)
-    end
+    context "without fields to include" do
+      it "extend parent's criteria" do
+        subject.project
+        expect(query).to have_received(:scope_parent).with(subject.projection)
+      end
+
+      it "projects query" do
+        subject.project
+        expect(query).to have_received(:execute)
+        expect(query.execute).to have_received(:select).with(subject.projection)
+      end
 
-    it "projects query" do
-      subject.project
-      expect(query).to have_received(:execute)
-      expect(query.execute).to have_received(:select).with(subject.projection)
+      it "returns projection result" do
+        expect(subject.project).to eq projection_result
+      end
     end
 
-    it "returns projection result" do
-      expect(subject.project).to eq projection_result
+    context "with fields to include" do
+      it "extend parent's criteria" do
+        subject.project
+        expect(query).to have_received(:scope_parent).with(subject.projection)
+      end
+
+      it "projects query with parent's fields" do
+        subject.project([:name])
+        expect(query).to have_received(:execute)
+        expect(query.execute).to have_received(:select).with(subject.projection.merge(name: 1))
+      end
+
+      it "returns projection result" do
+        expect(subject.project).to eq projection_result
+      end
     end
   end
 end

data/spec/mongoid_embed_finder/runner_spec.rb

@@ -17,18 +17,58 @@ describe MongoidEmbedFinder::Runner do
 
     context "by child_id and parent_id" do
       it "returns the child" do
-        door = subject.first(
+        result = subject.first(
           id: cars[1].doors[1].id.to_s,
           parent: { id: cars[1].id.to_s })
 
-        expect(door).to eq cars[1].doors[1]
+        expect(result).to eq cars[1].doors[1]
+      end
+
+      context "not listed parent's attributes" do
+        it "sets only id" do
+          result = subject.first(
+            id: cars[1].doors[1].id.to_s,
+            parent: { id: cars[1].id.to_s })
+
+          expect(result.car.id).to eq cars[1].id
+          expect(result.car.name).to be_nil
+        end
+      end
+
+      context "listed parent's attributes" do
+        it "sets listed attributes" do
+          result = subject.first(
+            id: cars[1].doors[1].id.to_s,
+            parent: { id: cars[1].id.to_s, include_fields: [:name] })
+
+          expect(result.car.id).to eq cars[1].id
+          expect(result.car.name).to eq cars[1].name
+        end
       end
     end
 
     context "no parent attributes" do
       it "returns the child" do
-        door = subject.first(id: cars[1].doors[1].id.to_s)
-        expect(door).to eq cars[1].doors[1]
+        result = subject.first(id: cars[1].doors[1].id.to_s)
+        expect(result).to eq cars[1].doors[1]
+      end
+
+      context "not listed parent's attributes" do
+        it "sets only id" do
+          result = subject.first(id: cars[1].doors[1].id.to_s)
+          expect(result.car.id).to eq cars[1].id
+          expect(result.car.name).to be_nil
+        end
+      end
+
+      context "listed parent's attributes" do
+        it "sets listed attributes" do
+          result = subject.first(id: cars[1].doors[1].id.to_s,
+            parent: { include_fields: [:name] })
+
+          expect(result.car.id).to eq cars[1].id
+          expect(result.car.name).to eq cars[1].name
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_embed_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Artur Hebda