mongoid_embed_finder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecbb38b95a0203aecd5993d79c10dbb28ee06f5c
+  data.tar.gz: 7fbf881de4a588a8676920cfb6625fc9e2699b10
+SHA512:
+  metadata.gz: 6db36b453e52cb4b3343db6b3e19ac60e032eee512ef5c8811ca8b5a8af618e320d5e9b7454d3ee00b04471eac8f5c1aa6bb861bb1751ed5cc8b7adb0d03e98c
+  data.tar.gz: beeaf658226886300e6b0f0ef5b6dd69f5634db2435fa4509cbcf842f92f09e8cd5f8092f948698f23d7a577ec05902d21ad4f71b9b5d813dcb1eb03d553925d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2013 Artur Hebda
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Artur Hebda
+
+MIT License
+
+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,60 @@
+# MongoidEmbedFinder
+
+This simple gem lets you find embedded documents easily. It does not instantiate parent record with a whole bunch of embedded documents. Instead it instantiates found embedded documents first and then sets parent association.
+
+At the moment it allows you to find only one embedded document and assumes relation `embeds_many`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_embed_finder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_embed_finder
+
+## Usage
+
+Let's say that you have defined two classes as follows:
+
+    class Door
+      include Mongoid::Document
+      embedded_in :car
+    end
+    
+    class Car
+      include Mongoid::Document
+      embeds_many :doors
+    end
+
+Now you can easily retrieve instances of `Door` class using `finder`:
+
+    finder = MongoidEmbedFinder::Runner.new(Door, :car)
+    # first argument is embedded class
+    # second is name of the association to the parent
+
+If you have `door_id` at your hands:
+
+    finder.first(id: door_id)
+    # => instance of Door class or nil in case not found
+
+If you have `door_id` and `car_id` as well, you can narrow scope of cars:
+
+    finder.first(id: door_id, parent: { id: car_id })
+    # => instance of Door class or nil in case not found
+
+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`.
+
+## Contributing
+
+1. Fork it ( https://github.comgrowthrepublic/mongoid_embed_finder/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/mongoid_embed_finder/nested_builder.rb

@@ -0,0 +1,28 @@
+module MongoidEmbedFinder
+  class NestedBuilder
+    def initialize(nested_attrs, relations)
+      @nested_attrs = nested_attrs
+      @relations = relations
+    end
+
+    def build_child
+      return nil if children_attributes.empty?
+
+      @relations.child_class.new(children_attributes.first).tap do |child|
+        child.public_send(@relations.parent.setter, build_parent)
+      end
+    end
+
+    def build_parent
+      @relations.parent_class.new(parent_attributes)
+    end
+
+    def children_attributes
+      @children_attributes ||= @nested_attrs.fetch(@relations.children.key)
+    end
+
+    def parent_attributes
+      @parent_attributes ||= @nested_attrs.except(@relations.children.key)
+    end
+  end
+end

data/lib/mongoid_embed_finder/projectors/base.rb

@@ -0,0 +1,13 @@
+module MongoidEmbedFinder
+  module Projectors
+    class Base < Struct.new(:relation, :criteria)
+      def projection
+        { relation.key => { operator => criteria.selector }}
+      end
+
+      def operator
+        raise NotImplementedError, "operator needs to be overriden"
+      end
+    end
+  end
+end

data/lib/mongoid_embed_finder/projectors/single.rb

@@ -0,0 +1,11 @@
+require "mongoid_embed_finder/projectors/base"
+
+module MongoidEmbedFinder
+  module Projectors
+    class Single < Base
+      def operator
+        "$elemMatch"
+      end
+    end
+  end
+end

data/lib/mongoid_embed_finder/relation_discovery.rb

@@ -0,0 +1,29 @@
+require "ostruct"
+require "active_support/inflector"
+
+module MongoidEmbedFinder
+  class RelationDiscovery < Struct.new(:child_class, :relation_name)
+    def relations
+      @relations ||= OpenStruct.new(
+        child_class:  child_class,
+        parent_class: parent_class,
+        children:     find_children_relation,
+        parent:       find_parent_relation)
+    end
+
+    private
+
+    def find_parent_relation
+      @parent_relation ||= child_class.relations.fetch(relation_name.to_s)
+    end
+
+    def parent_class
+      @parent_class ||= find_parent_relation.class_name.constantize
+    end
+
+    def find_children_relation
+      @children_relation ||= parent_class.relations.values
+        .find { |v| v.class_name == child_class.name }
+    end
+  end
+end

data/lib/mongoid_embed_finder/runner.rb

@@ -0,0 +1,53 @@
+require "mongoid_embed_finder/projectors/base"
+require "mongoid_embed_finder/projectors/single"
+require "mongoid_embed_finder/nested_builder"
+require "mongoid_embed_finder/relation_discovery"
+
+module MongoidEmbedFinder
+  class Runner
+    def initialize(child_class, parent_relation_name)
+      @relation_discovery = RelationDiscovery.new(
+        child_class, parent_relation_name)
+    end
+
+    def first(parent: {}, **attrs)
+      nested_attrs = find_first(attrs, parent: parent)
+      return nil unless nested_attrs
+      build_child_with_parent(nested_attrs)
+    end
+
+    private
+
+    def find_first(attrs = {}, parent: {})
+      scope_parent(parent)
+      project(attrs, with: Projectors::Single)
+      execute_query.first
+    end
+
+    def scope_parent(attrs = {})
+      @parent_criteria ||= relations.parent_class.criteria
+      @parent_criteria.selector.merge!(attrs)
+    end
+
+    def project(attrs = {}, with: Projectors::Base)
+      child_criteria  = relations.child_class.criteria.where(attrs)
+      @projector = with.new(relations.children, child_criteria)
+      scope_parent(@projector.projection)
+    end
+
+    def execute_query
+      relations.parent_class.collection
+        .find(@parent_criteria.selector)
+        .select(@projector.projection)
+    end
+
+    def build_child_with_parent(nested_attrs)
+      builder = NestedBuilder.new(nested_attrs, relations)
+      builder.build_child
+    end
+
+    def relations
+      @relation_discovery.relations
+    end
+  end
+end

data/lib/mongoid_embed_finder/version.rb

@@ -0,0 +1,3 @@
+module MongoidEmbedFinder
+  VERSION = "0.0.1"
+end

data/lib/mongoid_embed_finder.rb

@@ -0,0 +1,9 @@
+require "mongoid_embed_finder/version"
+require "mongoid_embed_finder/projector"
+require "mongoid_embed_finder/single_projector"
+require "mongoid_embed_finder/relation_discovery"
+require "mongoid_embed_finder/hierarchy_builder"
+require "mongoid_embed_finder/runner"
+
+module MongoidEmbedFinder
+end

data/mongoid_embed_finder.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_embed_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_embed_finder"
+  spec.version       = MongoidEmbedFinder::VERSION
+  spec.authors       = ["Artur Hebda"]
+  spec.email         = ["arturhebda@gmail.com"]
+  spec.summary       = %[Find mongoid embedded documents easily.]
+  spec.description   = %[
+    This simple gem lets you find embedded documents easily. It does not instantiate
+    parent record with a whole bunch of embedded documents. Instead it instantiates
+    found embedded documents first and then sets parent association.
+  ]
+  spec.homepage      = "https://github.com/growthrepublic/mongoid_embed_finder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mongoid", "~> 4.0.0.beta1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0.0.rc1"
+  spec.add_development_dependency "rspec-its", "~> 1.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0.0.rc1"
+end

data/spec/mongoid_embed_finder/nested_builder_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require "mongoid_embed_finder/nested_builder"
+
+describe MongoidEmbedFinder::NestedBuilder do
+  let(:relations) do
+    double(
+      parent_class: Car,
+      child_class: Door,
+      children: double(key: "doors"),
+      parent: double(key: "car", setter: "car=")
+    )
+  end
+
+  context "parent with children" do
+    let(:nested_attrs) do
+      {
+        "_id" => "parent_id",
+        "name" => "Car Name",
+        "doors" => 2.times.map do |n|
+          {
+            "_id" => "child_id_#{n}",
+            "name" => "Child Name #{n}",
+          }
+        end
+      }
+    end
+
+    describe "#build_child" do
+      subject { described_class.new(nested_attrs, relations).build_child }
+
+      its(:_id) { should eq "child_id_0" }
+      its(:name) { should eq "Child Name 0" }
+      its('car._id') { should eq "parent_id" }
+      its('car.name') { should eq "Car Name" }
+    end
+
+    describe "#build_parent" do
+      subject { described_class.new(nested_attrs, relations).build_parent }
+
+      its(:_id) { should eq "parent_id" }
+      its(:name) { should eq "Car Name" }
+      its(:doors) { should be_empty }
+    end
+  end
+
+  context "parent without children" do
+    let(:nested_attrs) do
+      {
+        "_id" => "parent_id",
+        "name" => "Car Name",
+        "doors" => []
+      }
+    end
+
+    describe "#build_child" do
+      subject { described_class.new(nested_attrs, relations).build_child }
+      it { should be_nil }
+    end
+
+    describe "#build_parent" do
+      subject { described_class.new(nested_attrs, relations).build_parent }
+
+      its(:_id) { should eq "parent_id" }
+      its(:name) { should eq "Car Name" }
+      its(:doors) { should be_empty }
+    end
+  end
+end

data/spec/mongoid_embed_finder/projector_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+require "mongoid_embed_finder/projector"
+
+describe MongoidEmbedFinder::Projector do
+  describe "#to_projection" do
+    let(:relation) { double(key: "children") }
+    let(:criteria) { double(selector: { "name" => "Child Name 0" }) }
+
+    subject { described_class.new(relation, criteria) }
+
+    it "needs to be implemented in derived classes" do
+      expect { subject.to_projection }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/mongoid_embed_finder/projectors/base_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+require "mongoid_embed_finder/projectors/base"
+
+describe MongoidEmbedFinder::Projectors::Base do
+  describe "#projection" do
+    let(:relation) { double(key: "children") }
+    let(:criteria) { double(selector: { "name" => "Child Name 0" }) }
+
+    subject { described_class.new(relation, criteria) }
+
+    it "relies on methods to be implemented" do
+      expect { subject.projection }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/mongoid_embed_finder/projectors/single_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+require "mongoid_embed_finder/projectors/single"
+
+describe MongoidEmbedFinder::Projectors::Single do
+  describe "#projection" do
+    let(:relation) { double(key: "children") }
+    let(:criteria) { double(selector: { "name" => "Child Name 0" }) }
+
+    subject { described_class.new(relation, criteria) }
+
+    its(:projection) { should eq(relation.key => { "$elemMatch" => criteria.selector }) }
+  end
+end

data/spec/mongoid_embed_finder/relation_discovery_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+require "mongoid_embed_finder/relation_discovery"
+
+describe MongoidEmbedFinder::RelationDiscovery do
+  describe "#relations" do
+    subject { described_class.new(Child, :parent).relations }
+
+    its(:child_class)  { should eq Child }
+    its(:parent_class) { should eq Parent }
+
+    its('children.key')        { should eq "children" }
+    its('children.class_name') { should eq "Child" }
+
+    its('parent.setter') { should eq "parent=" }
+  end
+end

data/spec/mongoid_embed_finder/runner_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+require "mongoid_embed_finder/runner"
+
+describe MongoidEmbedFinder::Runner do
+  subject { described_class.new(Door, :car) }
+
+  describe "#first" do
+    let!(:cars) do
+      2.times.map do |n|
+        Car.create(name: "Parent Name #{n}").tap do |car|
+          2.times.map do |n|
+            car.doors << Door.new(name: "Child Name #{n}")
+          end
+        end
+      end
+    end
+
+    context "by child_id and parent_id" do
+      it "returns the child" do
+        door = 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]
+      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]
+      end
+    end
+
+    context "child does not exist" do
+      let(:wrong_id) { "5369f2d8417274e9d8000000" }
+
+      it "returns nil" do
+        expect(subject.first(id: wrong_id)).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift(File.join(__dir__, "..", "lib"))
+
+require "mongoid"
+require "rspec/its"
+
+# These environment variables can be set if wanting to test against a database
+# that is not on the local machine.
+ENV["MONGOID_SPEC_HOST"] ||= "localhost"
+ENV["MONGOID_SPEC_PORT"] ||= "27017"
+
+# These are used when creating any connection in the test suite.
+HOST = ENV["MONGOID_SPEC_HOST"]
+PORT = ENV["MONGOID_SPEC_PORT"].to_i
+
+def database_id
+  "mongoid_test"
+end
+
+CONFIG = {
+  sessions: {
+    default: {
+      database: database_id,
+      hosts: [ "#{HOST}:#{PORT}" ]
+    }
+  }
+}
+
+# Set the database that the spec suite connects to.
+Mongoid.configure do |config|
+  config.load_configuration(CONFIG)
+end
+
+class Door
+  include Mongoid::Document
+  field :name, type: String
+  embedded_in :car
+end unless defined?(Door)
+
+class Car
+  include Mongoid::Document
+  field :name, type: String
+  embeds_many :doors
+end unless defined?(Car)
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+
+  # Drop all collections and clear the identity map before each spec.
+  config.before(:each) do
+    Mongoid.purge!
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_embed_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artur Hebda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+description: "\n    This simple gem lets you find embedded documents easily. It does
+  not instantiate\n    parent record with a whole bunch of embedded documents. Instead
+  it instantiates\n    found embedded documents first and then sets parent association.\n
+  \ "
+email:
+- arturhebda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_embed_finder.rb
+- lib/mongoid_embed_finder/nested_builder.rb
+- lib/mongoid_embed_finder/projectors/base.rb
+- lib/mongoid_embed_finder/projectors/single.rb
+- lib/mongoid_embed_finder/relation_discovery.rb
+- lib/mongoid_embed_finder/runner.rb
+- lib/mongoid_embed_finder/version.rb
+- mongoid_embed_finder.gemspec
+- spec/mongoid_embed_finder/nested_builder_spec.rb
+- spec/mongoid_embed_finder/projector_spec.rb
+- spec/mongoid_embed_finder/projectors/base_spec.rb
+- spec/mongoid_embed_finder/projectors/single_spec.rb
+- spec/mongoid_embed_finder/relation_discovery_spec.rb
+- spec/mongoid_embed_finder/runner_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/growthrepublic/mongoid_embed_finder
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Find mongoid embedded documents easily.
+test_files:
+- spec/mongoid_embed_finder/nested_builder_spec.rb
+- spec/mongoid_embed_finder/projector_spec.rb
+- spec/mongoid_embed_finder/projectors/base_spec.rb
+- spec/mongoid_embed_finder/projectors/single_spec.rb
+- spec/mongoid_embed_finder/relation_discovery_spec.rb
+- spec/mongoid_embed_finder/runner_spec.rb
+- spec/spec_helper.rb
+has_rdoc: