mongoid-activerecord-eagerloadable 0.0.1

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Articulate Global, Inc., Patrick Klingemann
+
+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,52 @@
+# Mongoid::Activerecord::Eagerloadable
+
+Belongs to relationships between Mongoid and ActiveRecord models. With
+eager loading.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-activerecord-eagerloadable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-activerecord-eagerloadable
+
+## Usage
+
+Consider the following Mongoid document:
+
+    class Pet
+      include Mongoid::Document
+      include Mongoid::ActiveRecord::EagerLoadable
+
+      belongs_to_active_record :person
+    end
+  
+And the following ActiveRecord class:
+
+    class Person < ActiveRecord::Base
+      attr_accessible :name
+    end
+
+The `belongs_to_active_record :person` statement enables the following
+to execute a single query against your mongodb instance and a single
+query against your ActiveRecord connection:
+
+    Pet.scoped.includes_active_record(:person).all.map(&:person)
+
+Also, the `person` method is added to each instance of `Pet` regardless
+of whether or not the `includes_active_record` method is invoked
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+desc 'Run Devise unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end

data/config/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: eager_loading_test
+      hosts:
+        - localhost:17017
+  options:
+    identity_map_enabled: true

data/lib/mongoid-activerecord-eagerloadable.rb

@@ -0,0 +1 @@
+require 'mongoid/active_record/eager_loadable.rb'

data/lib/mongoid/active_record/eager_loadable.rb

@@ -0,0 +1,44 @@
+require 'active_support/core_ext/module/delegation'
+require 'mongoid/active_record/eager_loadable/version'
+require 'mongoid/active_record/eager_loadable/eager'
+require 'mongoid/active_record/eager_loadable/relation_metadata'
+require 'mongoid/active_record/eager_loadable/criteria'
+
+module Mongoid
+  module ActiveRecord
+    module EagerLoadable
+
+      extend ActiveSupport::Concern
+
+      included do
+        Mongoid::Contextual::Mongo.send(:include, Eager)
+        Mongoid::Contextual::Memory.send(:include, Eager)
+        Mongoid::Criteria.send(:include, Criteria)
+
+        @active_record_relations = {}
+      end
+
+      module ClassMethods
+        # todo: put this in Accessors similar to mongoid
+        def active_record_getter(name, metadata)
+          re_define_method name do
+            record_id = self.send(metadata.foreign_key)
+            IdentityMap.get(metadata.relation_class, record_id) || metadata.relation_class.find(record_id)
+          end
+          self
+        end
+
+        def active_record_relate(name, metadata)
+          @active_record_relations[name] = metadata
+          active_record_getter(name, metadata)
+        end
+
+        def belongs_to_active_record(association_id)
+          metadata = RelationMetadata.new(association_id)
+          active_record_relate(association_id, metadata)
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid/active_record/eager_loadable/criteria.rb

@@ -0,0 +1,23 @@
+module Mongoid
+  module ActiveRecord
+    module EagerLoadable
+
+      module Criteria
+        extend ActiveSupport::Concern
+
+        def includes_active_record(*relations)
+          relations.each do |relation|
+            metadata = RelationMetadata.new(relation)
+            active_record_inclusions.push(metadata) unless active_record_inclusions.include?(metadata)
+          end
+          clone
+        end
+
+        def active_record_inclusions
+          @active_record_inclusions ||= []
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid/active_record/eager_loadable/eager.rb

@@ -0,0 +1,32 @@
+module Mongoid
+  module ActiveRecord
+    module EagerLoadable
+
+      module Eager
+        extend ActiveSupport::Concern
+
+        included do
+          alias_method :original_eager_load, :eager_load
+          alias_method :original_eager_loadable?, :eager_loadable?
+
+          def eager_load(docs)
+            load_active_record_inclusions(docs)
+            original_eager_load(docs)
+          end
+
+          def eager_loadable?(document = nil)
+            return false if criteria.inclusions.empty? && criteria.active_record_inclusions.empty?
+            document ? !inclusions_loaded?(document) : !eager_loaded
+          end
+        end
+
+        def load_active_record_inclusions(docs)
+          criteria.active_record_inclusions.each do |metadata|
+            metadata.eager_load(eager_loaded_ids(docs, metadata)) if !docs.empty?
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid/active_record/eager_loadable/relation_metadata.rb

@@ -0,0 +1,34 @@
+module Mongoid
+  module ActiveRecord
+    module EagerLoadable
+
+      class RelationMetadata
+        attr_reader :relation
+
+        def initialize(relation)
+          @relation = relation
+          relation_class.define_singleton_method(:collection_name) { table_name }
+        end
+
+        def eager_load(ids)
+          relation_class.where(id: ids.uniq).each do |record|
+            IdentityMap.set(record)
+          end
+        end
+
+        def relation_class
+          relation.to_s.classify.constantize
+        end
+
+        def foreign_key
+          "#{relation}_id"
+        end
+
+        def stores_foreign_key?
+          true
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid/active_record/eager_loadable/version.rb

@@ -0,0 +1,7 @@
+module Mongoid
+  module ActiveRecord
+    module EagerLoadable
+      VERSION = "0.0.1"
+    end
+  end
+end

data/mongoid-activerecord-eagerloadable.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/active_record/eager_loadable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-activerecord-eagerloadable"
+  spec.version       = Mongoid::ActiveRecord::EagerLoadable::VERSION
+  spec.authors       = ["pklingem"]
+  spec.email         = ["pklingemann@articulate.com"]
+  spec.description   = %q{Mongoid to ActiveRecord belongs to assocations with eager-loading}
+  spec.summary       = %q{A Mongoid::Document mixin for creating "belongs to" associations with ActiveRecord models with eager-loading}
+  spec.homepage      = "http://github.com/articulate/mongoid-activerecord-eagerloadable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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", "~> 3.1"
+  spec.add_dependency "activerecord", "~> 3.2"
+  spec.add_dependency "activesupport", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/test/eager_loadable_test.rb

@@ -0,0 +1,79 @@
+require 'active_record'
+require 'test/unit'
+require 'mongoid'
+require './lib/mongoid/active_record/eager_loadable.rb'
+
+ENV['MONGOID_ENV'] = 'test'
+Mongoid.load!('./config/mongoid.yml', :test)
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+require './test/support/models'
+require './test/support/active_record/sql_counter.rb'
+
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "../log/debug.log"))
+ActiveSupport::Notifications.subscribe('sql.active_record', ActiveRecord::SQLCounter.new)
+
+class EagerLoadableTest < ActiveRecord::TestCase
+  def setup
+    @jim      = Person.create!(name: 'Jim')
+    @bill     = Person.create!(name: 'Bill')
+    @bob      = Person.create!(name: 'Bob')
+    @joe      = Person.create!(name: 'Joe')
+    @jack     = Person.create!(name: 'Jack')
+
+    @fletch   = Pet.create!(name: 'Fletch', person_id: @jim.id)
+    @wilson   = Pet.create!(name: 'Wilson', person_id: @bill.id)
+    @mocha    = Pet.create!(name: 'Mocha', person_id: @bob.id)
+    @tanner   = Pet.create!(name: 'Tanner', person_id: @joe.id)
+    @freckles = Pet.create!(name: 'Freckles', person_id: @jack.id)
+  end
+
+  def teardown
+    Person.delete_all
+    Pet.delete_all
+  end
+
+  def test_respond_to_belongs_to_active_record
+    assert_respond_to Pet, :belongs_to_active_record
+  end
+
+  def test_respond_to_includes_active_record
+    assert_respond_to Pet.scoped, :includes_active_record
+  end
+
+  def test_mongoid_model_responds_to_association_method
+    assert_respond_to Pet.first, :person
+  end
+
+  def test_mongoid_model_without_includes_active_record_finds_associated_model_instance
+    assert_kind_of Person, Pet.first.person
+  end
+
+  def test_mongoid_model_with_includes_active_record_finds_associated_model_instance
+    assert_kind_of Person, Pet.scoped.includes_active_record(:person).first.person
+  end
+
+  def test_getter_method_returns_proper_associatied_object_without_eager_loading
+    assert_equal Pet.first.person, Person.find(Pet.first.person_id)
+  end
+
+  def test_getter_method_returns_proper_associatied_object_with_eager_loading
+    assert_equal Pet.scoped.includes_active_record(:person).first.person,
+                 Person.find(Pet.scoped.includes_active_record(:person).first.person_id)
+  end
+
+  def test_multiple_queries_execute_without_eager_loading
+    assert_queries(5) do
+      Pet.all.map(&:person)
+    end
+  end
+
+  def test_one_query_executes_with_eager_loading
+    assert_queries(1) do
+      Pet.scoped.includes_active_record(:person).map(&:person)
+    end
+  end
+end

data/test/support/active_record/sql_counter.rb

@@ -0,0 +1,42 @@
+module ActiveRecord
+  class SQLCounter
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+      def clear_log; self.log = []; self.log_all = []; end
+    end
+
+    self.clear_log
+
+    self.ignored_sql = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL, or better yet, use a different notification for the queries
+    # instead examining the SQL content.
+    oracle_ignored     = [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im]
+    mysql_ignored      = [/^SHOW TABLES/i, /^SHOW FULL FIELDS/]
+    postgresql_ignored = [/^\s*select\b.*\bfrom\b.*pg_namespace\b/im, /^\s*select\b.*\battname\b.*\bfrom\b.*\bpg_attribute\b/im, /^SHOW search_path/i]
+    sqlite3_ignored =    [/^\s*SELECT name\b.*\bFROM sqlite_master/im]
+
+    [oracle_ignored, mysql_ignored, postgresql_ignored, sqlite3_ignored].each do |db_ignored_sql|
+      ignored_sql.concat db_ignored_sql
+    end
+
+    attr_reader :ignore
+
+    def initialize(ignore = Regexp.union(self.class.ignored_sql))
+      @ignore = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name]
+
+      self.class.log_all << sql
+      self.class.log << sql unless ignore =~ sql
+    end
+  end
+end
+

data/test/support/models.rb

@@ -0,0 +1,3 @@
+load './test/support/schema.rb'
+require './test/support/models/person.rb'
+require './test/support/models/pet.rb'

data/test/support/models/person.rb

@@ -0,0 +1,3 @@
+class Person < ActiveRecord::Base
+  attr_accessible :name
+end

data/test/support/models/pet.rb

@@ -0,0 +1,6 @@
+class Pet
+  include Mongoid::Document
+  include Mongoid::ActiveRecord::EagerLoadable
+
+  belongs_to_active_record :person
+end

data/test/support/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define do
+  create_table :people, force: true do |t|
+    t.string :name
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-activerecord-eagerloadable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- pklingem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mongoid to ActiveRecord belongs to assocations with eager-loading
+email:
+- pklingemann@articulate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/mongoid.yml
+- lib/mongoid-activerecord-eagerloadable.rb
+- lib/mongoid/active_record/eager_loadable.rb
+- lib/mongoid/active_record/eager_loadable/criteria.rb
+- lib/mongoid/active_record/eager_loadable/eager.rb
+- lib/mongoid/active_record/eager_loadable/relation_metadata.rb
+- lib/mongoid/active_record/eager_loadable/version.rb
+- mongoid-activerecord-eagerloadable.gemspec
+- test/eager_loadable_test.rb
+- test/support/active_record/sql_counter.rb
+- test/support/models.rb
+- test/support/models/person.rb
+- test/support/models/pet.rb
+- test/support/schema.rb
+homepage: http://github.com/articulate/mongoid-activerecord-eagerloadable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Mongoid::Document mixin for creating "belongs to" associations with ActiveRecord
+  models with eager-loading
+test_files:
+- test/eager_loadable_test.rb
+- test/support/active_record/sql_counter.rb
+- test/support/models.rb
+- test/support/models/person.rb
+- test/support/models/pet.rb
+- test/support/schema.rb