mongoload 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43f6d35204451fe83d744d022348bfa75bf44b4d
+  data.tar.gz: 0643e2e4a61dedc69853f13e243c48569a738828
+SHA512:
+  metadata.gz: 21d8fda99c4ff3fbb6f7d4b822610364d3fcc1cf7cf62149a8c5709e89c84880809eab6d2ab4e4d2484578d1ad0ff58c26183b3e4a28a6f1c2368dc430e5c877
+  data.tar.gz: 1ffff4324c1417821d7189191e06835a72228d692870e4bf321c57c6f43a131b8b23505255636cf1623e467939afe2dd1620afbb6a267ffeca94aa036bf83226

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle
+/Gemfile.lock
+/gemfiles/*.lock
+/html/
+/pkg/
+/vendor/cache/*.gem
+.byebug_history
+/log/*
+!/log/.keep

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: mongoload Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--backtrace

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+services: mongodb
+rvm:
+  - "2.1.10"
+  - "2.2.4"
+  - "2.3.0"
+gemfile:
+  - gemfiles/mongoid_50.gemfile
+  - gemfiles/mongoid_51.gemfile
+  - gemfiles/mongoid_master.gemfile
+matrix:
+  exclude:
+    - rvm: "2.1.10"
+      gemfile: gemfiles/mongoid_master.gemfile

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.0.1 / 2016-04-06
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Kaloku Sang<karloku@loku.it>
+
+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,33 @@
+# Mongoload
+
+[![Build Status](https://travis-ci.org/karloku/mongoload.svg?branch=master)](https://travis-ci.org/karloku/mongoload)
+
+Mongoload is a gem to perform eager loading automatically for Mongoid, inspired by [Goldiloader](https://github.com/salsify/goldiloader).
+
+## Usage
+
+Just install Mongoload. It will automatically eager load your reference relation the first time you access it.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoload'
+
+Or install it yourself as:
+
+    $ gem install mongoload
+
+## TODO
+
+* option to perform eager loading when calling following methods on an many/many_to_many relation:
+  + size
+  + first
+  + last
++ option to disable eager loading on specific relation
+
+## Copyright
+
+Copyright (c) 2016 Kaloku Sang
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task doc: :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task test: :spec
+task default: :spec

data/gemfiles/mongoid_50.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gem 'mongoid', '~> 5.0.0'
+
+gemspec path: '../'

data/gemfiles/mongoid_51.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gem 'mongoid', '~> 5.1.0'
+
+gemspec path: '../'

data/gemfiles/mongoid_master.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gem 'mongoid', github: 'mongodb/mongoid', branch: 'master'
+
+gemspec path: '../'

data/lib/mongoload.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'mongoid'
+require 'mongoload/version'
+require 'mongoload/auto_include_context'
+require 'mongoload/relation_loader'
+require 'mongoload/patches/mongoid_contextual_mongo_patch'
+require 'mongoload/patches/mongoid_document_patch'
+require 'mongoload/patches/mongoid_relations_accessors_patch'
+require 'mongoload/patches/mongoid_relations_targets_enumerable_patch'

data/lib/mongoload/auto_include_context.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Mongoload
+  class AutoIncludeContext
+    attr_reader :docs
+
+    def initialize
+      @docs = []
+    end
+
+    def register_docs(docs)
+      Array.wrap(docs).each do |model|
+        model.auto_include_context = self
+        self.docs << model
+      end
+      self
+    end
+
+    def self.register_docs(docs)
+      auto_include_context = new
+      auto_include_context.register_docs(docs)
+    end
+  end
+end

data/lib/mongoload/patches/mongoid_contextual_mongo_patch.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Mongoload
+  module MongoContextWithAutoInclude
+    def documents_for_iteration
+      results = super
+      if results.is_a?(Mongo::Collection::View)
+        require 'byebug'
+        begin
+          results.to_a
+        rescue SystemStackError
+          byebug
+        end
+        results = results.map { |doc| Mongoid::Factory.from_db(klass, doc, criteria.options[:fields]) }
+      end
+      results.tap do |documents|
+        Mongoload::AutoIncludeContext.register_docs(documents.to_a)
+      end
+    end
+  end
+end
+
+Mongoid::Contextual::Mongo.prepend Mongoload::MongoContextWithAutoInclude

data/lib/mongoload/patches/mongoid_document_patch.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Mongoload
+  module AutoIncludableModel
+    extend ActiveSupport::Concern
+
+    included do
+      attr_writer :auto_include_context
+    end
+
+    def initialize_copy(other)
+      super
+      @auto_include_context = nil
+    end
+
+    def auto_include_context
+      @auto_include_context ||= Mongoload::AutoIncludeContext.new.register_docs(self)
+    end
+
+    def reload(*)
+      @auto_include_context = nil
+      super
+    end
+  end
+end
+
+Mongoid::Document.include Mongoload::AutoIncludableModel

data/lib/mongoload/patches/mongoid_relations_accessors_patch.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Mongoload
+  module MongoRelationsAccessorsWithAutoInclude
+    private
+
+    def get_relation(name, metadata, object, reload=false)
+      # has_one and belongs_to will return the value immediately
+      # while other relation are lazy
+      if [Mongoid::Relations::Referenced::In, Mongoid::Relations::Referenced::One].include?(metadata.relation)
+        Mongoload::RelationLoader.load(self, metadata) if !object.is_a?(metadata.klass) && ivar(name) == false
+      end
+
+      result = super
+      result.tap do |relation|
+        if relation.class == Mongoid::Relations::Targets::Enumerable
+          relation.target.define_singleton_method :relation_metadata do
+            relation.relation_metadata
+          end
+
+          relation.target.define_singleton_method :base do
+            relation.base
+          end
+        end
+      end
+    end
+  end
+end
+
+Mongoid::Document.prepend Mongoload::MongoRelationsAccessorsWithAutoInclude

data/lib/mongoload/patches/mongoid_relations_targets_enumerable_patch.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Mongoload
+  module MongoRelationsEnumerableWithAutoInclude
+    private
+
+    def unloaded_documents
+      if Mongoload::RelationLoader.load(base, relation_metadata)
+        base.ivar(relation_metadata.name)
+      else
+        super
+      end
+    rescue NotImplementedError
+      super
+    end
+  end
+end
+
+Mongoid::Relations::Targets::Enumerable.prepend Mongoload::MongoRelationsEnumerableWithAutoInclude

data/lib/mongoload/relation_loader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module Mongoload
+  module RelationLoader
+    module_function
+
+    def load(doc, metadata)
+      docs = doc.auto_include_context.docs.select do |d|
+        auto_include?(d, metadata)
+      end
+      eager_load(metadata, docs)
+      docs.include?(doc)
+    end
+
+    def eager_load(metadata, docs)
+      metadata.relation.eager_load_klass.new([metadata], docs).run
+    end
+
+    def auto_include?(doc, metadata)
+      relation?(doc, metadata) && !loaded?(doc, metadata)
+    end
+
+    def relation?(doc, metadata)
+      doc.relations.values.include?(metadata)
+    end
+
+    def loaded?(doc, metadata)
+      if [Mongoid::Relations::Referenced::In, Mongoid::Relations::Referenced::One].include?(metadata.relation)
+        doc.ivar(metadata.name) != false
+      else
+        doc.public_send(metadata.name)._loaded?
+      end
+    end
+  end
+end

data/lib/mongoload/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Mongoload
+  # mongoload version
+  VERSION = '0.0.1'
+end

data/mongoload.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoload/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'mongoload'
+  gem.version       = Mongoload::VERSION
+  gem.summary       = 'Perform eager loading automatically for Mongoid'
+  gem.description   = 'Automatic Mongoid eager loading'
+  gem.license       = 'MIT'
+  gem.authors       = ['Kaloku Sang']
+  gem.email         = 'karloku@gmail.com'
+  gem.homepage      = 'https://github.com/karloku/mongoload'
+
+  gem.required_ruby_version = '>= 2.1.0'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files    = Dir.glob('spec/**/*')
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'mongoid', ['>= 5.0.0']
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 11.0'
+  gem.add_development_dependency 'rdoc', '~> 4.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'database_cleaner', '~> 1.5.3'
+  gem.add_development_dependency 'byebug'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/spec/db/models.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+class User
+  include Mongoid::Document
+  has_one :device
+  has_many :posts
+
+  field :username
+end
+
+class Device
+  include Mongoid::Document
+  belongs_to :user
+
+  field :uuid
+end
+
+class Post
+  include Mongoid::Document
+  belongs_to :user
+  has_and_belongs_to_many :tags
+
+  field :title
+end
+
+class Tag
+  include Mongoid::Document
+  has_and_belongs_to_many :posts
+
+  field :name
+end

data/spec/db/mongoid.yml

@@ -0,0 +1,10 @@
+test:
+  clients:
+    default:
+      database: oyster_rails_test
+      hosts:
+        - localhost:27017
+      options:
+        read:
+          mode: :primary
+        max_pool_size: 1

data/spec/mongoload/mongoload_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Mongoload do
+  let(:user1) do
+    User.create!(username: 'Adam').tap { |u| u.create_device(uuid: '111') }
+  end
+  let(:user2) do
+    User.create!(username: 'Betty').tap { |u| u.create_device(uuid: '222') }
+  end
+  let(:user3) do
+    User.create!(username: 'Cathy').tap { |u| u.create_device(uuid: '333') }
+  end
+
+  let(:tag1) { Tag.create!(name: 'tag1') }
+  let(:tag2) { Tag.create!(name: 'tag2') }
+  let(:tag3) { Tag.create!(name: 'tag3') }
+  let(:tag4) { Tag.create!(name: 'tag4') }
+
+  let(:post1) do
+    Post.create!(title: 'post1', user: user1).tap do |p|
+      p.tags << [tag1, tag2]
+    end
+  end
+
+  let(:post2) do
+    Post.create!(title: 'post2', user: user1).tap do |p|
+      p.tags << [tag2, tag3]
+    end
+  end
+
+  let(:post3) do
+    Post.create!(title: 'post3', user: user2).tap do |p|
+      p.tags << [tag1, tag3]
+    end
+  end
+
+  let(:post4) do
+    Post.create!(title: 'post4', user: user2).tap do |p|
+      p.tags << [tag2, tag4]
+    end
+  end
+
+  let(:post5) do
+    Post.create!(title: 'post5', user: user3).tap do |p|
+      p.tags << [tag1, tag4]
+    end
+  end
+
+  let(:post6) do
+    Post.create!(title: 'post6', user: user3).tap do |p|
+      p.tags << [tag2, tag4]
+    end
+  end
+
+  describe 'has_one relation' do
+    before { user1 && user2 && user3 }
+
+    it 'should eager load' do
+      users = User.all.to_a
+      users.each do |user|
+        expect(user.ivar(:device)).to be false
+      end
+
+      users.first.device
+      users.each do |user|
+        expect(user.ivar(:device)).to be_truthy
+      end
+    end
+  end
+
+  describe 'has_many relation' do
+    before { post1 && post2 && post3 && post4 && post5 && post6 }
+
+    it 'should eager load' do
+      users = User.all.to_a
+      users.each do |user|
+        expect(user.posts._loaded?).to be false
+      end
+
+      users.first.posts.to_a
+      users.each do |user|
+        expect(user.posts._loaded?).to be true
+      end
+    end
+  end
+
+  describe 'belongs_to' do
+    context 'inverse of has_one' do
+      before { user1 && user2 && user3 }
+
+      it 'should eager load' do
+        devices = Device.all.to_a
+        devices.each do |device|
+          expect(device.ivar(:user)).to be false
+        end
+
+        devices.first.user
+        devices.each do |device|
+          expect(device.ivar(:user)).to be_truthy
+        end
+      end
+    end
+
+    context 'inverse of has_many' do
+      before { post1 && post2 && post3 && post4 && post5 && post6 }
+
+      it 'should eager load' do
+        posts = Post.all.to_a
+        posts.each do |post|
+          expect(post.ivar(:user)).to be false
+        end
+
+        posts.first.user
+        posts.each do |post|
+          expect(post.ivar(:user)).to be_truthy
+        end
+      end
+    end
+  end
+
+  describe 'has_and_belongs_to_many' do
+    before { post1 && post2 && post3 && post4 && post5 && post6 }
+
+    it 'should eager load' do
+      posts = Post.all.to_a
+      posts.each do |post|
+        expect(post.tags._loaded?).to be false
+      end
+
+      posts.first.tags.to_a
+      posts.each do |post|
+        expect(post.tags._loaded?).to be true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'rspec'
+require 'database_cleaner'
+require 'mongoload'
+
+# initialize model definitions
+ENV['MONGOID_ENV'] = 'test'
+Mongoid.load!(File.join(File.dirname(__FILE__), 'db', 'mongoid.yml'))
+require_relative 'db/models'
+Mongo::Logger.logger = Logger.new('log/test.log')
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: mongoload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kaloku Sang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Automatic Mongoid eager loading
+email: karloku@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/mongoid_50.gemfile
+- gemfiles/mongoid_51.gemfile
+- gemfiles/mongoid_master.gemfile
+- lib/mongoload.rb
+- lib/mongoload/auto_include_context.rb
+- lib/mongoload/patches/mongoid_contextual_mongo_patch.rb
+- lib/mongoload/patches/mongoid_document_patch.rb
+- lib/mongoload/patches/mongoid_relations_accessors_patch.rb
+- lib/mongoload/patches/mongoid_relations_targets_enumerable_patch.rb
+- lib/mongoload/relation_loader.rb
+- lib/mongoload/version.rb
+- log/.keep
+- mongoload.gemspec
+- spec/db/models.rb
+- spec/db/mongoid.yml
+- spec/mongoload/auto_include_context_spec.rb
+- spec/mongoload/mongoload_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/karloku/mongoload
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Perform eager loading automatically for Mongoid
+test_files:
+- spec/db/models.rb
+- spec/db/mongoid.yml
+- spec/mongoload/auto_include_context_spec.rb
+- spec/mongoload/mongoload_spec.rb
+- spec/spec_helper.rb