active_record_association_query_economizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a37d4e68d13db2c12393514216621e56fa2bde304f7efdafb041c980b8990dad
+  data.tar.gz: 3195f945400f046a5a6bced0d4fb6db840e89b7d4bd8125a485004b13f382eb6
+SHA512:
+  metadata.gz: c9cb87a348df517cbf6d3c8a621568f73c9d278abc2b9c65783795de44a604f28307d9a16d280b2ae12bfc9c3249d002dc9288e1e89a73e2c598896924e23b77
+  data.tar.gz: 1f4bf6b4b3dd73f0656945f2cbe52e37c34125420a74a01ef505bba1b08a55316691b33cebce47952a9bb64ec3e8ed4eb23513a32439b46bb7b5842114118379

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/gemfiles/*.lock
+/gemfiles/.bundle

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.4
+before_install: gem install bundler -v 1.13.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 toru.yagi
+
+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,57 @@
+# ActiveRecordAssociationQueryEconomizer
+
+Enables to define preloading conditions in the arguments of `has_many`.
+
+Condition is defined as an array of symbolized method name or Proc object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_association_query_economizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_association_query_economizer
+
+## Usage
+
+```
+class SampleObject < ActiveRecord::Base
+  has_many :sample_associations, preload_if: [:one_condition?, :another_condition?]
+
+  def one_condition?
+    true
+  end
+
+  def another_condition?
+    false
+  end
+end
+```
+
+(Proc)
+
+```
+class SampleObject < ActiveRecord::Base
+  has_many :sample_associations, preload_if: -> (record) {
+    true
+  }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record_association_query_economizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ["test"]
+  t.pattern = "test/**/*_test.rb"
+  t.ruby_opts = ['-w']
+end
+
+task :default => :test
+
+pwd = File.expand_path('../', __FILE__)
+
+gemfiles = %w(
+  activerecord-42
+  activerecord-50
+  activerecord-51
+)
+
+namespace :test do
+  gemfiles.each do |gemfile|
+    desc "Run Tests by #{gemfile}.gemfile"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='#{pwd}/gemfiles/#{gemfile}.gemfile' bundle install --path #{pwd}/.bundle"
+      sh "BUNDLE_GEMFILE='#{pwd}/gemfiles/#{gemfile}.gemfile' bundle exec rake -t test"
+    end
+  end
+
+  desc "Run All Tests"
+  task :all do
+    gemfiles.each do |gemfile|
+      Rake::Task["test:#{gemfile}"].invoke
+    end
+  end
+end

data/active_record_association_query_economizer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_association_query_economizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_association_query_economizer"
+  spec.version       = ActiveRecordAssociationQueryEconomizer::VERSION
+  spec.authors       = ["toru.yagi"]
+
+  spec.summary       = %q{Optimize queries of ActiveRecord preload functions.}
+  spec.homepage      = "https://github.com/negito6"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 3'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.2', '<= 5.1.1'
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_association_query_economizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/activerecord-42.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord-50.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord-51.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+gemspec :path => "../"

data/lib/active_record_association_query_economizer.rb

@@ -0,0 +1,11 @@
+require "active_record_association_query_economizer/version"
+
+activerecord_version = ActiveRecord.version
+case activerecord_version
+when Gem::Requirement.create(['>= 4.2', '< 5'])
+  require 'active_record_association_query_economizer/rails4-2/associations'
+when Gem::Requirement.create(['>= 5.0', '<= 5.1.1'])
+  require 'active_record_association_query_economizer/rails5/associations'
+else
+  puts "active_record_association_query_economizer doesn't yet do anything on ActiveRecord #{activerecord_version}"
+end

data/lib/active_record_association_query_economizer/rails4-2/associations.rb

@@ -0,0 +1,60 @@
+require 'active_record/associations/builder/association'
+require 'active_record/associations/preloader/association'
+
+module ActiveRecord
+  module Associations
+    module Builder
+      class Association #:nodoc:
+        self.valid_options += [:preload_if]
+      end
+    end
+    class Preloader
+      class Association #:nodoc:
+        def preload_filters
+          [options[:preload_if]].flatten.compact
+        end
+
+        def owners_filtered
+          # owners_by_key is: {1=>[#<SourceModel ...>, 2=>[#<SourceModel ...>], ...}
+          owners_by_key.select do |key, records|
+            preload_filters.each do |filter|
+              case filter
+              when Proc
+                records.select!(&filter)
+              when Symbol
+                records.select! { |record| record.send(filter) }
+              end
+            end
+            records.present?
+          end
+        end
+
+        remove_method :associated_records_by_owner
+        def associated_records_by_owner(preloader)
+          owners_map = owners_filtered
+          owner_keys = owners_map.keys.compact
+
+          # Each record may have multiple owners, and vice-versa
+          records_by_owner = owners.each_with_object({}) do |owner,h|
+            h[owner] = []
+          end
+
+          if owner_keys.any?
+            # Some databases impose a limit on the number of ids in a list (in Oracle it's 1000)
+            # Make several smaller queries if necessary or make one query if the adapter supports it
+            sliced  = owner_keys.each_slice(klass.connection.in_clause_length || owner_keys.size)
+
+            records = load_slices sliced
+            records.each do |record, owner_key|
+              owners_map[owner_key].each do |owner|
+                records_by_owner[owner] << record
+              end
+            end
+          end
+
+          records_by_owner
+        end
+      end
+    end
+  end
+end

data/lib/active_record_association_query_economizer/rails5/associations.rb

@@ -0,0 +1,47 @@
+require 'active_record/associations/builder/association'
+require 'active_record/associations/preloader/association'
+
+module ActiveRecord
+  module Associations
+    module Builder
+      class Association #:nodoc:
+        VALID_OPTIONS += [:preload_if]
+      end
+    end
+
+    class Preloader
+      class Association #:nodoc:
+        def preload_filters
+          [options[:preload_if]].flatten.compact
+        end
+
+        def owners_filtered
+          unless defined?(@owners_filtered)
+            @owners_filtered = owners.dup
+            preload_filters.each do |filter|
+              case filter
+              when Proc
+                @owners_filtered.select!(&filter)
+              when Symbol
+                @owners_filtered.select! { |record| record.send(filter) }
+              end
+            end
+          end
+          @owners_filtered
+        end
+
+        remove_method :owner_keys
+        def owner_keys
+          unless defined?(@owner_keys)
+            @owner_keys = owners_filtered.map do |owner|
+              owner[owner_key_name]
+            end
+            @owner_keys.uniq!
+            @owner_keys.compact!
+          end
+          @owner_keys
+        end
+      end
+    end
+  end
+end

data/lib/active_record_association_query_economizer/version.rb

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: active_record_association_query_economizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- toru.yagi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_association_query_economizer.gemspec
+- bin/console
+- bin/setup
+- gemfiles/activerecord-42.gemfile
+- gemfiles/activerecord-50.gemfile
+- gemfiles/activerecord-51.gemfile
+- lib/active_record_association_query_economizer.rb
+- lib/active_record_association_query_economizer/rails4-2/associations.rb
+- lib/active_record_association_query_economizer/rails5/associations.rb
+- lib/active_record_association_query_economizer/version.rb
+homepage: https://github.com/negito6
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Optimize queries of ActiveRecord preload functions.
+test_files: []