includes_many 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1fd0e7ff99ce84e15556ab818ba5403422c8350
+  data.tar.gz: 951126e5d7da338b31b2f40cbb5b7c3e8b5e00d6
+SHA512:
+  metadata.gz: 8a67bc7ad024b1b0fe1de2248fbf7c56640fa614cbedd325f19992048960adf340fe7f2b5f172ee67eb7beedb5126204b043c6baad04e6e12ee37de74679f7d3
+  data.tar.gz: 2c44ecf767a95989e8ca36820d51cfa6ef20cc1e2fff953caf28d493cd763eae60ca21ded30f82980b470c04319d9b5b9c3c266c2ea63b41541314bca2e30c17

data/.gitignore

@@ -0,0 +1,24 @@
+*.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
+spec/internal/db/*.sqlite3
+spec/internal/log/*log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+gemfile:
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/rails_4_2.gemfile
+

data/Appraisals

@@ -0,0 +1,18 @@
+appraise 'rails_3_2' do
+  gem 'rails',  '~> 3.2.0'
+end
+
+appraise 'rails_4_0' do
+  gem 'rails', '~> 4.0.2'
+end
+
+appraise 'rails_4_1' do
+  gem 'rails', '~> 4.1.0.beta1'
+end
+
+appraise 'rails_4_2' do
+  gem 'rails', github: 'rails/rails',    branch: 'master'
+  gem 'arel',  github: 'rails/arel',     branch: 'master'
+  gem 'rack',  github: 'rack/rack',      branch: 'master'
+  gem 'i18n',  github: 'svenfuchs/i18n', branch: 'master'
+end

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in includes_many.gemspec
+gemspec
+
+group :development do
+  # tools
+  gem 'debugger', github: 'razum2um/debugger'
+  gem 'pry-debugger'
+  gem 'pry-stack_explorer'
+  # rspec --format fuubar
+  gem 'fuubar', github: 'thekompanee/fuubar'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vlad Bokov
+
+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,66 @@
+# IncludesMany
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+
+This implements [rails/rails#16277](https://github.com/rails/rails/pull/16277) as a Gem.
+Tested with Rails 3.2.19, 4.0.8, 4.1.4 :)
+
+Sad, but ActiveRecord is hard to extend :( I used monkeypatch,
+but it's protected by [`safe_monkeypatch`](https://github.com/razum2um/safe_monkeypatch)
+It will loudly complain at startup time if it's incompatible. Feel free to open an issue if such.
+
+Use it and upgrade without fear!
+
+## Usage
+
+Use `includes_many` in your AR-model:
+
+    includes_many :siblings_and_children, :class_name => 'Comment',
+       :foreign_key => :parent_id, :primary_key => proc { |c| [c.parent_id, c.id] }
+
+And do eager loading:
+
+    comments = Comment.where(body: 'something').includes(:siblings_and_children)
+    comments.map(&:siblings_and_children) # ...
+
+This would issue only 2 SQL queries just as expected.
+
+Normally, without this gem you would write an instance method `siblings_and_children`
+and calling a method would end up with an N+1 problem.
+
+## Installation
+
+Add my public key:
+
+    gem cert --add <(curl -Ls https://raw.github.com/razum2um/include_many/master/certs/razum2um.pem)
+
+    $ gem install include_many                 # without key
+    $ gem install include_many -P HighSecurity # secure, with key added
+
+Add this line to your application's Gemfile:
+
+    gem 'includes_many'
+
+## Contributing
+
+To test under different Rails version use [`appraisal`](https://github.com/thoughtbot/appraisal)
+To experiment inside a console:
+
+    appraisal rails_3_2 rake c # etc..
+
+1. Fork it ( https://github.com/razum2um/includes_many/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
+
+## Acknoledgements
+
+Thanks for [@pat](https://github.com/pat) for `combustion` and multi-rails testing practices.
+
+[Gem Version]: https://rubygems.org/gems/includes_many
+[Build Status]: https://travis-ci.org/razum2um/includes_many
+
+[GV img]: https://badge.fury.io/rb/includes_many.png
+[BS img]: https://travis-ci.org/razum2um/includes_many.png

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format progress"
+end
+
+desc 'pry console for gem'
+task :c do
+  require 'pry'
+  require 'includes_many'
+  ARGV.clear
+  Pry.start
+end
+
+task :default => [:spec]
+

data/certs/razum2um.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApib2tv
+di52bGFkMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMTQwNTIwMjAyOTAyWhcNMTUwNTIwMjAyOTAyWjBBMRMwEQYDVQQDDApi
+b2tvdi52bGFkMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCibrb/aiZX3kWo
+Fmzo3gvGBFS9N18Q5rp9UTJRc4KxZQOay2WcgLjy1oU61r2Urjz3VDT4sg/yw3N3
+YXIPqSTRl+OPIaafe45TVpF4mtMSsc1Gm/O3Sfoz6URiMd9iDtc2sTpaMgatL4pV
+EExER9emjrmElRFknJD65E3gVDX7KXvrZYYAScJR33DADIGUgpuyHm29S7G/4WAy
+ol6XfmPx+x5rM49QytGSNCQDYQ3SMMCo9wKkEm3Zcx0O4qhO8INevl/mvkAWLhOA
++0qldtuUx9wbBQ0D0wVR8LTafqWrIUHQjWXqrhWBqXhYeR3jj5aehBhpPFclHuKU
+5GeILZrFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBSiidH2CEJmkza+NBBJNLcnzQX57TAfBgNVHREEGDAWgRRib2tvdi52bGFkQGdt
+YWlsLmNvbTAfBgNVHRIEGDAWgRRib2tvdi52bGFkQGdtYWlsLmNvbTANBgkqhkiG
+9w0BAQUFAAOCAQEAVEyF63kQT9HKm3YIw1WzLvuOMvEUThzBomMMsTp9CGXWvem6
+wZdMhxykwk1lga0OwsCn+wr1tWZ/cNeWqGSY00vTfLWdriK60xuRW7zT1Z5tmxbD
+dq2ULdhII/qCFQlzDB/+IptO1rJLzfxTckoArmeYtkBV6LaVd7wpaRZnw0Apm93e
+ph03YddPDbB34xTivvu4d6BBbKGxj/YN+1NLD9rMi6FspgcA4P1UlmKqyCluTbZj
+vzKbYclpJ7gENr/xiTjGqA/Md3zJMzmsFrzUXt4RVmo5SaCyZjC6gFfhSr+PODc7
+ZaSbckvH/+m4boAsg0JkGGFcS3j5fgNmdwgA1A==
+-----END CERTIFICATE-----

data/gemfiles/.gitignore

@@ -0,0 +1 @@
+*.gemfile.lock

data/gemfiles/rails_3_2.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+group :development do
+  gem "debugger", :github => "razum2um/debugger"
+  gem "pry-debugger"
+  gem "pry-stack_explorer"
+  gem "fuubar", :github => "thekompanee/fuubar"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.2"
+
+group :development do
+  gem "debugger", :github => "razum2um/debugger"
+  gem "pry-debugger"
+  gem "pry-stack_explorer"
+  gem "fuubar", :github => "thekompanee/fuubar"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0.beta1"
+
+group :development do
+  gem "debugger", :github => "razum2um/debugger"
+  gem "pry-debugger"
+  gem "pry-stack_explorer"
+  gem "fuubar", :github => "thekompanee/fuubar"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", :github => "rails/rails", :branch => "master"
+gem "arel", :github => "rails/arel", :branch => "master"
+gem "rack", :github => "rack/rack", :branch => "master"
+gem "i18n", :github => "svenfuchs/i18n", :branch => "master"
+
+group :development do
+  gem "debugger", :github => "razum2um/debugger"
+  gem "pry-debugger"
+  gem "pry-stack_explorer"
+  gem "fuubar", :github => "thekompanee/fuubar"
+end
+
+gemspec :path => "../"

data/includes_many.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'includes_many/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "includes_many"
+  spec.version       = IncludesMany::VERSION
+  spec.authors       = ["Vlad Bokov"]
+  spec.email         = ["razum2um@mail.ru"]
+  spec.summary       = %q{ActiveRecord has_many + includes(:relation) on steroids}
+  spec.description   = %q{ActiveRecord has_many + includes(:relation) on steroids}
+  spec.homepage      = "https://github.com/razum2um/include_many"
+  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 "activerecord", ">= 3.2", "< 4.2"
+  spec.add_dependency "safe_monkeypatch", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "appraisal"
+end

data/lib/includes_many.rb

@@ -0,0 +1,19 @@
+require "includes_many/version"
+require "safe_monkeypatch"
+require "active_record"
+
+major, minor, _ = Gem::Version.new(ActiveRecord::VERSION::STRING).segments
+require "includes_many/active_record#{major}#{minor}"
+
+module IncludesMany
+end
+
+module ActiveRecord
+  module Associations
+    module ClassMethods
+      module_eval do
+        alias includes_many has_many
+      end
+    end
+  end
+end

data/lib/includes_many/active_record32.rb

@@ -0,0 +1,4 @@
+require 'includes_many/active_record32/association_scope'
+require 'includes_many/active_record32/has_many'
+require 'includes_many/active_record32/join_association'
+

data/lib/includes_many/active_record32/association_scope.rb

@@ -0,0 +1,93 @@
+module ActiveRecord
+  module Associations
+    class AssociationScope
+      safe_monkeypatch :add_constraints, md5: '9c737355ac54b790c3e6b9c5feb37513'
+
+      def add_constraints(scope)
+        tables = construct_tables
+
+        chain.each_with_index do |reflection, i|
+          table, foreign_table = tables.shift, tables.first
+
+          if reflection.source_macro == :has_and_belongs_to_many
+            join_table = tables.shift
+
+            scope = scope.joins(join(
+              join_table,
+              table[reflection.association_primary_key].
+                eq(join_table[reflection.association_foreign_key])
+            ))
+
+            table, foreign_table = join_table, tables.first
+          end
+
+          if reflection.source_macro == :belongs_to
+            if reflection.options[:polymorphic]
+              key = reflection.association_primary_key(klass)
+            else
+              key = reflection.association_primary_key
+            end
+
+            foreign_key = reflection.foreign_key
+          else
+            key         = reflection.foreign_key
+            foreign_key = reflection.active_record_primary_key
+          end
+
+          conditions = self.conditions[i]
+
+          # PATCH here
+          if key.respond_to?(:call)
+            key = key.call(owner)
+          end
+          # end PATCH
+
+          if reflection == chain.last
+            # PATCH here
+            fk_arel = if foreign_key.respond_to?(:call)
+              fk = foreign_key.call(owner)
+              if fk.respond_to?(:each)
+                table[key].in(fk.compact)
+              else
+                table[key].eq(fk)
+              end
+            else
+              table[key].eq(owner[foreign_key])
+            end
+            scope = scope.where(fk_arel)
+            # end PATCH
+
+            if reflection.type
+              scope = scope.where(table[reflection.type].eq(owner.class.base_class.name))
+            end
+
+            conditions.each do |condition|
+              if options[:through] && condition.is_a?(Hash)
+                condition = disambiguate_condition(table, condition)
+              end
+
+              scope = scope.where(interpolate(condition))
+            end
+          else
+            constraint = table[key].eq(foreign_table[foreign_key])
+
+            if reflection.type
+              type = chain[i + 1].klass.base_class.name
+              constraint = constraint.and(table[reflection.type].eq(type))
+            end
+
+            scope = scope.joins(join(foreign_table, constraint))
+
+            unless conditions.empty?
+              scope = scope.where(sanitize(conditions, table))
+            end
+          end
+        end
+
+        scope
+      end
+    end
+  end
+end
+
+

data/lib/includes_many/active_record32/has_many.rb

@@ -0,0 +1,43 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasMany
+        safe_monkeypatch :association_key_name, md5: 'c4a2d2c69f85b007bf546989d601b94a'
+
+        # method is fully rewritten
+        def association_key_name
+          fk = reflection.foreign_key
+          if fk.respond_to?(:call)
+            fk.call(owners.first)
+          else
+            fk
+          end
+        end
+
+        safe_monkeypatch :owners_by_key, md5: '33eab3037fd994d4a7106a68a05f169d'
+
+        # method is fully rewritten
+        def owners_by_key
+          @owners_by_key ||= begin
+            res = Hash.new { |h,k| h[k] = Set.new }
+            owners.each do |owner|
+              key = if owner_key_name.respond_to?(:call)
+                owner_key_name.call(owner)
+              else
+                owner[owner_key_name]
+              end
+
+              if key.respond_to?(:each)
+                key.each { |k| res[k && k.to_s] << owner }
+              else
+                res[key && key.to_s] << owner
+              end
+            end
+            res
+          end
+        end
+      end
+    end
+  end
+end
+