includes_many 0.1.0

data/lib/includes_many/active_record42/has_many.rb

@@ -0,0 +1,34 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasMany
+        safe_monkeypatch :owners_by_key, md5: '70b0628dd3c79928ee0bcff75052894a'
+
+        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 do |k|
+                  k = k.to_s if key_conversion_required?
+                  res[k] << owner
+                end
+              else
+                key = key.to_s if key_conversion_required?
+                res[key] << owner
+              end
+            end
+            res
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/includes_many/active_record42/join_association.rb

@@ -0,0 +1,30 @@
+module ActiveRecord
+  class NonScalarPrimaryKeyError < ActiveRecordError
+    def initialize(reflection)
+      super("Can not join association #{reflection.name.inspect}, because :primary_key is a callable. Use Relation#includes or specify a join column name")
+    end
+  end
+
+  module Associations
+    class JoinDependency
+      class JoinAssociation
+        safe_monkeypatch :initialize, md5: '2332c88140aa9e9efa96975fd48e6958'
+
+        def initialize(reflection, children)
+
+          # PATCH here
+          if reflection.options[:primary_key].respond_to?(:call)
+            raise NonScalarPrimaryKeyError.new(reflection)
+          end
+          # end PATCH
+
+          super(reflection.klass, children)
+
+          @reflection      = reflection
+          @tables          = nil
+        end
+      end
+    end
+  end
+end
+

data/lib/includes_many/version.rb

@@ -0,0 +1,3 @@
+module IncludesMany
+  VERSION = "0.1.0"
+end

data/spec/includes_many_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+class SQLCounter
+  attr_accessor :log, :ignore
+
+  def initialize
+    @log = []
+    @ignore = [/^PRAGMA (?!(table_info))/,
+               /^SELECT currval/, /^SELECT CAST/,
+               /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/,
+               /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/,
+               /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/,
+               /^BEGIN/, /^COMMIT/]
+  end
+
+  def call(name, start, finish, message_id, values)
+    sql = values[:sql]
+    return if 'CACHE' == values[:name] || ignore.any? { |x| x =~ sql }
+    @log << sql
+  end
+end
+
+RSpec.describe IncludesMany do
+  describe 'self_siblings_and_children' do
+    let(:parent) { Comment.create! :body => 'some comment' }
+    let(:child1) { Comment.create! :body => 'child1', :parent => parent }
+    let(:child2) { Comment.create! :body => 'child2', :parent => parent }
+    let(:child3) { Comment.create! :body => 'child3', :parent => parent }
+    let(:subchild11) { Comment.create! :body => 'subchild11', :parent => child1 }
+    let(:subchild12) { Comment.create! :body => 'subchild12', :parent => child1 }
+    let(:subchild21) { Comment.create! :body => 'subchild21', :parent => child2 }
+    let(:subchild31) { Comment.create! :body => 'subchild31', :parent => child3 }
+
+    let(:subscriber) { SQLCounter.new }
+
+    before do
+      Comment.find_each(&:destroy)
+      subchild11
+      subchild12
+      subchild21
+      subchild31
+      ActiveSupport::Notifications.subscribe('sql.active_record', subscriber)
+    end
+
+    it 'works', :focus do
+      x = child1.self_siblings_and_children.to_a
+      expect(x.map(&:body).sort).to eq ["child1", "child2", "child3", "subchild11", "subchild12"]
+      # expect(child2.self_siblings_and_children.map(&:body).sort).to eq ["child1", "child2", "child3", "subchild21"]
+      # expect(child3.self_siblings_and_children.map(&:body).sort).to eq ["child1", "child2", "child3", "subchild31"]
+    end
+
+    it 'executes N+1 if not used includes' do
+      expect {
+        childs = Comment.where("body like 'child%'").order('body ASC')
+        expect(childs.map(&:self_siblings_and_children).map(&:size).flatten).to eq [5, 4, 4]
+      }.to change { subscriber.log.size } .from(0).to(4)
+    end
+
+    it 'includes relation' do
+      expect {
+        childs = Comment.where("body like 'child%'").order('body ASC').includes(:self_siblings_and_children)
+        expect(childs.map(&:self_siblings_and_children).map(&:size).flatten).to eq [5, 4, 4]
+      }.to change { subscriber.log.size } .from(0).to(2)
+
+      expect(subscriber.log.first).to match Regexp.new( #Regexp.escape(
+        %q{SELECT "comments".* FROM "comments"\s+WHERE \(body like 'child%'\)\s+ORDER BY body ASC}
+      )
+
+      expect(subscriber.log.last).to match Regexp.new( #Regexp.escape(
+        %q{SELECT "comments".* FROM "comments"\s+WHERE "comments"."parent_id" IN}
+      )
+    end
+
+    it 'denies join on includes_many' do
+      expect {
+        Comment.where("body like 'child%'").order('body ASC').joins(:self_siblings_and_children).to_a
+      }.to raise_error(
+        ActiveRecord::NonScalarPrimaryKeyError,
+        /Can not join association :self_siblings_and_children, because :primary_key is a callable/
+      )
+    end
+  end
+end

data/spec/internal/app/models/comment.rb

@@ -0,0 +1,12 @@
+class Comment < ::ActiveRecord::Base
+  belongs_to :parent, :class_name => 'Comment', :foreign_key => :parent_id
+  has_many :children, :class_name => 'Comment', :foreign_key => :parent_id
+  has_many :self_siblings, :class_name => 'Comment',
+     :foreign_key => :parent_id, :primary_key => :parent_id
+
+  includes_many :self_or_children, :class_name => 'Comment',
+     :foreign_key => proc { parent_id && :parent_id or :id }, :primary_key => :id
+
+  includes_many :self_siblings_and_children, :class_name => 'Comment',
+     :foreign_key => :parent_id, :primary_key => proc { |c| [c.parent_id, c.id] }
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,9 @@
+development: &development
+  adapter: sqlite3
+  database: db/includes_many.sqlite3
+
+production:
+  <<: *development
+
+test:
+  <<: *development

data/spec/internal/db/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  create_table(:comments, :force => true) do |t|
+    t.string :body
+    t.integer :parent_id
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+require 'combustion'
+require 'pry-debugger'
+
+Combustion.initialize! :active_record
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: includes_many
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vlad Bokov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: safe_monkeypatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: sqlite3
+  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: rspec
+  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: rake
+  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: combustion
+  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: appraisal
+  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'
+description: ActiveRecord has_many + includes(:relation) on steroids
+email:
+- razum2um@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/razum2um.pem
+- gemfiles/.gitignore
+- gemfiles/rails_3_2.gemfile
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_2.gemfile
+- includes_many.gemspec
+- lib/includes_many.rb
+- lib/includes_many/active_record32.rb
+- lib/includes_many/active_record32/association_scope.rb
+- lib/includes_many/active_record32/has_many.rb
+- lib/includes_many/active_record32/join_association.rb
+- lib/includes_many/active_record40.rb
+- lib/includes_many/active_record40/association_scope.rb
+- lib/includes_many/active_record40/has_many.rb
+- lib/includes_many/active_record40/join_association.rb
+- lib/includes_many/active_record41.rb
+- lib/includes_many/active_record41/association_scope.rb
+- lib/includes_many/active_record41/has_many.rb
+- lib/includes_many/active_record41/join_association.rb
+- lib/includes_many/active_record42.rb
+- lib/includes_many/active_record42/association_scope.rb
+- lib/includes_many/active_record42/has_many.rb
+- lib/includes_many/active_record42/join_association.rb
+- lib/includes_many/version.rb
+- spec/includes_many_spec.rb
+- spec/internal/app/models/comment.rb
+- spec/internal/config/database.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitkeep
+- spec/spec_helper.rb
+homepage: https://github.com/razum2um/include_many
+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: ActiveRecord has_many + includes(:relation) on steroids
+test_files:
+- spec/includes_many_spec.rb
+- spec/internal/app/models/comment.rb
+- spec/internal/config/database.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitkeep
+- spec/spec_helper.rb