smart_preloader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b818838fe062bbaf5c32f1ebdeb2144e345c778155e4913f7954402c729588f
+  data.tar.gz: a065007b057efb7dbe3f8ee862cf7c89b4defdf2d73e2b3a8ebbaf85a9234b69
+SHA512:
+  metadata.gz: 73cceb0acb5496af9545ef59a409c78a7b62c5509b2c309334d46d8929162d2f2dc118af7fc7364925a63ecebc8a6876bb6bf9130353aaa611a11cc130ce30cf
+  data.tar.gz: a52c72d6c2773d5ed1ce93f80e57a3b31ff588d0449d98d4c903b957b2d7039df7aa956b51d5f5cdbc26b4cbc272dd5c888ec822b14521d230a8334c7872b833

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in smart_preloader.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    smart_preloader (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  smart_preloader!
+
+BUNDLED WITH
+   2.2.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Serg Tyatin
+
+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,88 @@
+# SmartPreloader
+
+Smart preloader allows to:
+- Preload polymorphic associations
+- Filter records for preloading
+- Preload composite key associations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_preloader'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install smart_preloader
+
+## Usage
+
+### Preload polymorphic associations
+```ruby
+class Comment < ApplicationRecord
+  belongs_to :owner, polymorphic: true # User or Post
+end
+```
+
+To preload use the same syntax as for Rails eager load with one extra layer for polymorphic association
+Use class constants to specify corresponding preloads
+```ruby
+comments = Comment.all
+ActiveRecord::SmartPreloader.(comments, owner: [
+  User => :account,
+  Post => :votes
+])
+```
+Class name in preload tree considered as a filter for a records
+
+### Filter records for preloading
+It allows filter records at ruby level for further preloading
+```ruby
+comments = Comment.all
+ActiveRecord::SmartPreloader.(comments, ->(comment) { comment.rated? } => :author)
+```
+The code filters `rated?` comments and preloads `Comment#author` association 
+
+### Preload composite key associations
+Models could be referenced not by single id but by composite/multi key, like [:category_id, :author_id]
+
+```ruby
+class AuthorRating < ApplicationRecord
+  belongs_to :author
+  belongs_to :category
+end
+class Post < ApplicationRecord
+  belongs_to :category
+  belongs_to :author
+  has_one :author_rating,
+          ->(post) { where(category_id: post.category_id) },
+          class_name: 'AuthorRating', foreign_key: :author_id, primary_key: :author_id
+end
+```
+
+To preload post's author rating in the category:
+```ruby
+ActiveRecord::SmartPreloader.(posts, ActiveRecord::CompositeKey.new(:author_rating, [:author_id, :category_id]))
+```
+
+and it could be put in tree as usual:
+```ruby
+ActiveRecord::SmartPreloader.(comments, post: [
+  ActiveRecord::CompositeKey.new(:author_rating, [:author_id, :category_id]) => :voters
+])
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/2rba/smart_preloader.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/active_record/composite_key.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module ActiveRecord
+  class CompositeKey
+    attr_reader :association, :key
+
+    def initialize(association, key)
+      @association = association
+      @key = key
+    end
+  end
+end

data/lib/active_record/composite_key_preloader.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  # Modified ActiveRecord::Associations::Preloader::Association
+  class CompositeKeyPreloader
+    # The CompositeKeyPreloader does the same as default rails preloader ( ActiveRecord::Associations::Preloader )
+    # The difference: CompositeKeyPreloader allows to reference another table by multiple columns
+    #
+    # @param [Array<ActiveModel>] records Collection of active record models
+    # @param [Symbol] association ActiveRecord model association name to preload
+    # @param [Array<Symbol>] composite_key Array of primary_keys, defines how association should be loaded.
+    #   Default Rails implementation does not allow to specify composite key (multi-column key)
+    def self.call(records, association, composite_key)
+      records_for_preload = records.reject { |record| record.association(association).loaded? }
+      return if records_for_preload.blank?
+
+      assoc = records.first.association(association)
+      new(assoc.klass, records, assoc.reflection, composite_key).run
+    end
+
+    def initialize(klass, owners, reflection, composite_key)
+      @klass         = klass
+      @owners        = owners
+      @reflection    = reflection
+      @preloaded_records = []
+      @composite_key = composite_key
+    end
+
+    def run
+      records = load_records
+
+      owners.each do |owner|
+        owner_key = @composite_key.map { |key_name| owner[key_name] }
+        associate_records_to_owner(owner, records[owner_key] || [])
+      end
+    end
+
+    protected
+
+    attr_reader :owners, :reflection, :klass
+
+    private
+
+    def associate_records_to_owner(owner, records)
+      association = owner.association(reflection.name)
+      association.loaded!
+      raise 'no tested yet' if reflection.collection?
+
+      association.target = records.first unless records.empty?
+    end
+
+    def owner_keys
+      @owner_keys ||= owners_by_key.keys
+    end
+
+    def owners_by_key
+      unless defined?(@owners_by_key)
+        @owners_by_key = owners.each_with_object({}) do |owner, h|
+          key = @composite_key.map { |key_name| owner[key_name] }
+          h[key] = owner if key
+        end
+      end
+      @owners_by_key
+    end
+
+    def load_records
+      return {} if owner_keys.empty?
+
+      # 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
+      slices = owner_keys.each_slice(klass.connection.in_clause_length || owner_keys.size)
+      @preloaded_records = slices.flat_map do |slice|
+        records_for(slice)
+      end
+      @preloaded_records.group_by do |record|
+        @composite_key.map { |key_name| record[key_name] }
+      end
+    end
+
+    def records_for(ids)
+      composed_id_rows = ids.map { |multiple_ids| "ROW(#{multiple_ids.map(&:to_i).join(',')})" }.join(', ')
+      klass.scope_for_association.where("(#{@composite_key.join(', ')}) IN (#{composed_id_rows})")
+    end
+  end
+end

data/lib/active_record/smart_preloader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class SmartPreloader
+    VERSION = '0.1.0'
+
+    def self.call(records, association)
+      case association
+      when Hash
+        association.each do |key, value|
+          preloaded_records = call(records, key)
+          call(preloaded_records, value)
+        end
+      when Array
+        association.each do |key|
+          call(records, key)
+        end
+      when Symbol, String
+        ActiveRecord::Associations::Preloader.new.preload(records, association)
+        records.flat_map(&association.to_sym.to_proc).compact
+      when CompositeKey
+        ActiveRecord::CompositeKeyPreloader.(records, association.association, association.key)
+        records.flat_map(&association.association.to_sym.to_proc).compact
+      when Proc
+        records.select(&association)
+      else
+        if association.instance_of?(Class) && association.ancestors.include?(ApplicationRecord)
+          return records.grep(association)
+        end
+
+        raise ArgumentError, "#{association.inspect} was not recognized for preload"
+      end
+    end
+
+    def initialize(preloads)
+      @preloads = preloads
+    end
+
+    def call(records)
+      self.class.call(records, @preloads)
+    end
+  end
+end

data/smart_preloader.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_record/smart_preloader"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_preloader"
+  spec.version       = ActiveRecord::SmartPreloader::VERSION
+  spec.authors       = ["Serg Tyatin"]
+  spec.email         = ["700@2rba.com"]
+
+  spec.summary       = "Allows to preload associations in a smart way"
+  spec.description   = "Allows to preload ActiveRecord associations in a smart way"
+  spec.homepage      = "https://github.com/2rba/smart_preloader"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: smart_preloader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serg Tyatin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-31 00:00:00.000000000 Z
+dependencies: []
+description: Allows to preload ActiveRecord associations in a smart way
+email:
+- 700@2rba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record/composite_key.rb
+- lib/active_record/composite_key_preloader.rb
+- lib/active_record/smart_preloader.rb
+- smart_preloader.gemspec
+homepage: https://github.com/2rba/smart_preloader
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Allows to preload associations in a smart way
+test_files: []