pire_loader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e69575b7173c853934208c31e7f8939fbf87484cd3b0ca449fd1c00ffda3d196
+  data.tar.gz: 94f13a68d718f6ed86096b6b672625e55d25f687c5d74d070d6af80c2515b4e7
+SHA512:
+  metadata.gz: d3be086dd43f1612a919e5acbc887a8d5802cfdc2cea5765e1cdae5319c7e9341e804f467d13fce96f84901bd7fa7958af73f849c72f7676d512fd1d726fda15
+  data.tar.gz: 33eff3ccee66ed7832bf709fbe66d87c78cb8dffbe8f6521ea54079ca1c006f24dd0c1b5f7fd6b00e8307b32eab04c1e9e4fb0b96794c7392f53c4c811693996

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    pire_loader (0.1.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.1)
+      activesupport (= 7.0.1)
+    activerecord (7.0.1)
+      activemodel (= 7.0.1)
+      activesupport (= 7.0.1)
+    activesupport (7.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    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.2)
+      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.3)
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  pire_loader!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mehmet Emin INAC
+
+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,39 @@
+# PireLoader
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pire_loader`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pire_loader'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pire_loader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pire_loader.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/pire_loader/loaders/singular.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+
+module PireLoader
+  module Loaders
+    class Singular
+      def self.preload(association)
+        new(association).preload
+      end
+
+      def initialize(association)
+        @association = association
+      end
+
+      def preload
+        owner_records.each do |record|
+          join_value = record[join_foreign_key]
+
+          record.association(reflection.name).target = associated_records[join_value]
+        end
+      end
+
+      private
+
+      attr_reader :association
+
+      delegate :reflection, to: :association, private: true
+      delegate :foreign_key, :join_foreign_key, to: :reflection, private: true
+
+      def associated_records
+        @associated_records ||= association.scope
+                                           .except(:limit)
+                                           .rewhere(foreign_key => join_values)
+                                           .to_a
+                                           .index_by(&foreign_key.to_sym)
+      end
+
+      def owner_records
+        @owner_records ||= association.owner.parent_relation.records
+      end
+
+      def join_values
+        owner_records.map { |record| record[join_foreign_key] }
+      end
+    end
+  end
+end

data/lib/pire_loader/patches/association.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PireLoader
+  module Patches
+    module Association
+      def lazy_load?
+        owner.lazy_load?(reflection.name)
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::Association.prepend(PireLoader::Patches::Association)

data/lib/pire_loader/patches/associations/singular_association.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PireLoader
+  module Patches
+    module Associations
+      module SingularAssociation
+        def find_target
+          return super unless lazy_load?
+
+          PireLoader::Loaders::Singular.preload(self) && target
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::SingularAssociation.prepend(PireLoader::Patches::Associations::SingularAssociation)

data/lib/pire_loader/patches/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PireLoader
+  module Patches
+    module Base
+      def self.prepended(base)
+        base.attr_accessor :parent_relation
+      end
+
+      def lazy_load?(association)
+        return unless parent_relation
+
+        parent_relation.lazy_load_values.include?(association)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.prepend(PireLoader::Patches::Base)

data/lib/pire_loader/patches/querying.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PireLoader
+  module Patches
+    module Querying
+      delegate :lazy_load, :lazy_load!, to: :all
+    end
+  end
+end
+
+ActiveRecord::Querying.prepend(PireLoader::Patches::Querying)

data/lib/pire_loader/patches/relation.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module PireLoader
+  module Patches
+    module Relation
+      #######################
+      # Lazy load interface #
+      #######################
+      def lazy_load(*args)
+        spawn.lazy_load!(*args)
+      end
+
+      def lazy_load!(*args) # :nodoc:
+        # args.compact_blank!
+        args.flatten!
+
+        self.lazy_load_values |= args
+        self
+      end
+
+      def lazy_load_values
+        @values.fetch(:lazy_load, [])
+      end
+
+      def lazy_load_values=(value)
+        assert_mutability!
+        @values[:lazy_load] = value
+      end
+      #######################
+      # Lazy load interface #
+      #######################
+
+      ###########################
+      # Parent relation methods #
+      ###########################
+      def parent_relation
+        @values.fetch(:parent_relation, nil)
+      end
+
+      def parent_relation=(value)
+        @values[:parent_relation] = value
+      end
+      ###########################
+      # Parent relation methods #
+      ###########################
+
+      ###########################
+      # After load methods      #
+      ###########################
+      def after_load_callback
+        @values.fetch(:after_load, nil)
+      end
+
+      def after_load(&blk)
+        @values[:after_load] = blk
+      end
+      ###########################
+      # After load methods      #
+      ###########################
+
+      ### Loading
+      def load(*)
+        super.tap do
+          inject_self
+          run_after_load
+        end
+      end
+
+      def inject_self
+        @records.each { |record| record.parent_relation = self } if lazy_load_values.present?
+      end
+
+      # This can also modify the @records if the callback
+      # returns a new collection!
+      def run_after_load
+        return unless after_load_callback
+
+        new_records = after_load_callback.call(@records)
+        @records = new_records.freeze if new_records.present?
+      end
+    end
+  end
+end
+
+ActiveRecord::Relation.prepend(PireLoader::Patches::Relation)

data/lib/pire_loader/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PireLoader
+  VERSION = "0.1.0"
+end

data/lib/pire_loader.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+require_relative "pire_loader/version"
+require_relative "pire_loader/loaders/singular"
+require_relative "pire_loader/patches/association"
+require_relative "pire_loader/patches/querying"
+require_relative "pire_loader/patches/relation"
+require_relative "pire_loader/patches/associations/singular_association"
+require_relative "pire_loader/patches/base"
+
+module PireLoader
+end

data/pire_loader.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/pire_loader/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pire_loader"
+  spec.version = PireLoader::VERSION
+  spec.authors = ["Mehmet Emin INAC"]
+  spec.email = ["mehmetemininac@gmail.com"]
+
+  spec.summary = "Lazy and Async preloading for ActiveRecord associations"
+  spec.homepage = "https://github.com/meinac/pire_loader"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activerecord"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: pire_loader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mehmet Emin INAC
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- mehmetemininac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pire_loader.rb
+- lib/pire_loader/loaders/singular.rb
+- lib/pire_loader/patches/association.rb
+- lib/pire_loader/patches/associations/singular_association.rb
+- lib/pire_loader/patches/base.rb
+- lib/pire_loader/patches/querying.rb
+- lib/pire_loader/patches/relation.rb
+- lib/pire_loader/version.rb
+- pire_loader.gemspec
+homepage: https://github.com/meinac/pire_loader
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/meinac/pire_loader
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Lazy and Async preloading for ActiveRecord associations
+test_files: []