mongoid-eager-loading 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/.rvmrc.example

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use mongoid-eager-loading

data/.watchr

@@ -0,0 +1,24 @@
+# vim:set filetype=ruby:
+def run(cmd)
+  puts cmd
+  system cmd
+end
+
+def spec(file)
+  if File.exists?(file)
+    run("rspec #{file}")
+  else
+    puts("Spec: #{file} does not exist.")
+  end
+end
+
+watch("spec/.*/*_spec\.rb") do |match|
+  puts(match[0])
+  spec(match[0])
+end
+
+watch("lib/(.*/.*)\.rb") do |match|
+  puts(match[1])
+  spec("spec/#{match[1]}_spec.rb")
+end
+

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in mongoid-eager-loading.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    mongoid-eager-loading (0.1.0)
+      mongoid (~> 2.0.0.beta.18)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.1)
+    bson (1.1.1)
+    bson_ext (1.1.1)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.1)
+    mocha (0.9.9)
+      rake
+    mongo (1.0.9)
+      bson (>= 1.0.5)
+    mongoid (2.0.0.beta.19)
+      activemodel (~> 3.0)
+      mongo (= 1.0.9)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    tzinfo (0.3.23)
+    watchr (0.7)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  bundler (>= 1.0.0)
+  mocha
+  mongoid (~> 2.0.0.beta.18)
+  mongoid-eager-loading!
+  rspec (~> 2.0.0)
+  watchr

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Huang (flyerhzm@gmail.com)
+
+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,35 @@
+mongoid-eager-loading
+=====================
+
+mongoid-eager-loading adds the eager loading feature for mongoid.
+
+Originally it is my [pull request][0] for mongoid, but it is not accepted yet, so I created this gem to get the eager loading benefits easily for my projects.
+
+Usage
+-----
+
+define it in your Gemfile
+
+    gem "mongoid-eager-loading"
+
+include the module after Mongoid::Document
+
+    class User
+      include Mongoid::Document
+      include Mongoid::EagerLoading
+    end
+
+then you can use the eager loading like
+
+    Post.includes(:user)
+    Post.includes(:user, :comment)
+
+Author
+------
+Richard Huang :: flyerhzm@gmail.com :: @flyerhzm
+
+Copyright
+---------
+Copyright (c) 2010 Richard Huang. See LICENSE for details.
+
+[0]: https://github.com/mongoid/mongoid/pull/391

data/Rakefile

@@ -0,0 +1,45 @@
+require 'bundler'
+Bundler.setup
+
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+task :build do
+  system "gem build mongoid-eager-loading.gemspec"
+end
+
+task :install => :build do
+  system "sudo gem install mongoid-eager-loading-#{Mongoid::EagerLoading::VERSION}.gem"
+end
+
+task :release => :build do
+  puts "Tagging #{Mongoid::EagerLoading::VERSION}..."
+  system "git tag -a #{Mongoid::EagerLoading::VERSION} -m 'Tagging #{Mongoid::EagerLoading::VERSION}'"
+  puts "Pushing to Github..."
+  system "git push --tags"
+  puts "Pushing to rubygems.org..."
+  system "gem push mongoid-eager-loading-#{Mongoid::EagerLoading::VERSION}.gem"
+end
+
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "mongoid-eager-loading #{Mongoid::EagerLoading::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+task :default => :spec
+

data/lib/mongoid-eager-loading.rb

@@ -0,0 +1,8 @@
+require 'mongoid-eager-loading/mongoid/criterion/eager_loading'
+require 'mongoid-eager-loading/mongoid/criteria'
+require 'mongoid-eager-loading/mongoid/finders'
+
+module Mongoid
+  module EagerLoading
+  end
+end

data/lib/mongoid-eager-loading/mongoid/criteria.rb

@@ -0,0 +1,18 @@
+Mongoid::Criteria.class_eval do
+  include Mongoid::Criterion::EagerLoading
+
+  alias_method :origin_each, :each
+
+  def each(&block)
+    if @eager_loadings
+      # if eager loadings are used, preload the associations.
+      docs = []
+      context.iterate { |doc| docs << doc }
+      preload(docs)
+      docs.each(&block)
+      self
+    else
+      origin_each(&block)
+    end
+  end
+end

data/lib/mongoid-eager-loading/mongoid/criterion/eager_loading.rb

@@ -0,0 +1,116 @@
+module Mongoid
+  module Criterion
+    module EagerLoading
+      # EagerLoading criterion are used when eager loading the associations.
+      #
+      # Example:
+      #
+      # <tt>criteria.includes(:user)</tt>
+      #
+      # <tt>criteria.includes(:user, :post)</tt>
+      #
+      # Returns: <tt>self</tt>
+      attr_accessor :eager_loadings, :id_document_map, :id_associations_map
+
+      def includes(*options)
+        @eager_loadings = options
+        self
+      end
+
+      def preload(documents)
+        document_class = documents.first.class
+        @eager_loadings.each do |eager_loading|
+          setup_associations(documents, association_reflection(document_class, eager_loading))
+        end
+      end
+      
+      private
+        def ignore_includes
+          @eager_loadings = nil
+        end
+
+        def association_reflection(document_class, eager_loading)
+          document_class.reflect_on_association(eager_loading)
+        end
+
+        def setup_associations(documents, reflection)
+          if reflection.association == Mongoid::Associations::ReferencesOne
+            setup_associations_with_ids(documents, reflection, true)
+          elsif reflection.association == Mongoid::Associations::ReferencesMany
+            setup_associations_with_ids(documents, reflection, false)
+          elsif reflection.association == Mongoid::Associations::ReferencesManyAsArray
+            setup_associations_with_foreign_keys(documents, reflection, false)
+          elsif reflection.association == Mongoid::Associations::ReferencedIn
+            setup_associations_with_foreign_keys(documents, reflection, true)
+          end
+        end
+
+        def setup_associations_with_ids(documents, reflection, one=true)
+          ids = []
+          documents.each do |document|
+            id_document_map[document.id] = document
+            ids << document.id if document.id
+          end
+
+          association_class = reflection.name.singularize.camelize.constantize
+          ignore_includes
+          eager_associations = association_class.where(reflection.foreign_key.to_sym.in => ids).to_a
+          eager_associations.each do |eager_association|
+            add_id_association(eager_association.send(reflection.foreign_key), eager_association)
+          end
+
+          id_document_map.each do |id, document|
+            document.send("#{reflection.name}=", one ? id_associations_map[id].first : id_associations_map[id])
+          end
+        end
+
+        def setup_associations_with_foreign_keys(documents, reflection, one)
+          ids = []
+          foreign_key_name = reflection.foreign_key
+          documents.each do |document|
+            foreign_key_value = document.send(foreign_key_name)
+            if one
+              id_document_map[foreign_key_value] = document
+              ids << foreign_key_value if foreign_key_value
+            elsif foreign_key_value
+              foreign_key_value.each do |fkv|
+                id_document_map[fkv] = document
+                ids << fkv if fkv
+              end
+            end
+          end
+
+          association_class = reflection.name.singularize.camelize.constantize
+          ignore_includes
+          eager_associations = association_class.find(ids).to_a
+          eager_associations.each do |eager_association|
+            add_id_association(eager_association.id, eager_association)
+          end
+
+          id_document_map.each do |id, document|
+            foreign_key_value = document.send(foreign_key_name)
+            associations = \
+              if one
+                id_associations_map[foreign_key_value].first
+              else
+                foreign_key_value.collect { |fkv| id_associations_map[fkv] }.flatten.uniq
+              end
+            document.send("#{reflection.name}=", associations)
+          end
+        end
+
+        def id_document_map
+          @id_doccument_map ||= {}
+        end
+
+        def id_associations_map
+          @id_associations_map ||= {}
+        end
+
+        def add_id_association(id, association)
+          id_associations_map[id] ||= []
+          id_associations_map[id] << association
+        end
+    end
+  end
+end

data/lib/mongoid-eager-loading/mongoid/finders.rb

@@ -0,0 +1,5 @@
+Mongoid::Finders.class_eval do
+  def includes(*args)
+    criteria.send(:includes, *args)
+  end
+end

data/lib/mongoid-eager-loading/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module EagerLoading
+    VERSION = "0.1.0"
+  end
+end

data/mongoid-eager-loading.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/mongoid-eager-loading/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid-eager-loading"
+  s.version     = Mongoid::EagerLoading::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Richard Huang"]
+  s.email       = ["flyerhzm@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/mongoid-eager-loading"
+  s.summary     = "eager loading for mongoid"
+  s.description = "eager loading for mongoid"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "mongoid-eager-loading"
+
+  s.add_dependency "mongoid", "~> 2.0.0.beta.18"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.0.0"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "watchr"
+  s.add_development_dependency "bson_ext"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/config/mongoid.yml

@@ -0,0 +1,21 @@
+defaults: &defaults
+  host: localhost
+  slaves:
+    # - host: localhost
+      # port: 27018
+    # - host: localhost
+      # port: 27019
+  allow_dynamic_fields: false
+  include_root_in_json: true
+  parameterize_keys: false
+  persist_in_safe_mode: false
+  raise_not_found_error: false
+  reconnect_time: 5
+  autocreate_indexes: false
+  persist_types: false
+  option_no_exist: false
+  skip_version_check: false
+
+test:
+  <<: *defaults
+  database: mongoid_config_test

data/spec/models/account.rb

@@ -0,0 +1,10 @@
+class Account
+  include Mongoid::Document
+  referenced_in :creator, :class_name => "User", :foreign_key => :creator_id
+  referenced_in :person
+  field :number
+  field :balance
+  field :nickname
+  
+  attr_accessible :nickname
+end

data/spec/models/address.rb

@@ -0,0 +1,52 @@
+class Address
+  include Mongoid::Document
+
+  attr_accessor :mode
+
+  field :address_type
+  field :number, :type => Integer
+  field :street
+  field :city
+  field :state
+  field :post_code
+  field :parent_title
+  field :services, :type => Array
+  field :latlng, :type => Array
+  key :street
+  embeds_many :locations
+
+  embedded_in :addressable, :inverse_of => :addresses do
+    def extension
+      "Testing"
+    end
+    def doctor?
+      title == "Dr"
+    end
+  end
+
+  named_scope :rodeo, where(:street => "Rodeo Dr") do
+    def mansion?
+      all? { |address| address.street == "Rodeo Dr" }
+    end
+  end
+
+  validates_presence_of :street, :on => :update
+
+  def set_parent=(set = false)
+    self.parent_title = addressable.title if set
+  end
+
+  class << self
+    def california
+      where(:state => "CA")
+    end
+
+    def homes
+      where(:address_type => "Home")
+    end
+
+    def streets
+      all.map(&:street)
+    end
+  end
+end