active_record_custom_preloader 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebc260ca02c7f72a2c65f2cb594735d982482108
+  data.tar.gz: 473f45b86356872c382adfde7fa35f7229e5ec38
+SHA512:
+  metadata.gz: 38dd285e78ce11f4d9648db79b56b95c196916bf7b5c7412d1e81ff6eb7c0bd2ad5f888a215be3e96b54e35afae1258f0bc626eb0452bacf00ea06f0a7b96a75
+  data.tar.gz: f4b515d22b3a83e74a57e55ac6ceaf7acc0212e09f27856f3c8c90df9a48c073444deb5e48526e49dfd80fed81ae75c3035c95dac9ed8e3ea06d5c24b6f326c3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at senid231@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Denis Talakevich
+
+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,65 @@
+# ActiveRecordCustomPreloader
+
+custom preloader for ActiveRecord model
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_custom_preloader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_custom_preloader
+
+## Usage
+
+```ruby
+class Person < ActiveRecord::Base
+  add_custom_loader :_stats, class_name: 'StatsPreloader'
+end
+
+class StatsPreloader < ActiveRecordCustomerPreloader::Preloader
+  def preload(records)
+    ids = records.map(&:id)
+    values = CustomApi.fetch_stats_for(ids)
+    records.each do |record|
+      value = OpenStruct.new(values[record.id])
+      record._set_custom_preloaded_value(name, value)
+    end
+  end
+end
+
+people = Person.all.preload(:_stats)
+people.first._stats # will return value that was preloaded earlier
+
+person = Person.find(1)
+person._stats # will preload and return value
+person._stats # will return value that was preloaded earlier
+person.clear_custom_preloaded_value(:_stats) # will clear preloaded value for _stats
+person._stats # will preload again and return value
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/senid231/active_record_custom_preloader. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecordCustomPreloader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_record_custom_preloader/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/active_record_custom_preloader.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record_custom_preloader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_custom_preloader'
+  spec.version       = ActiveRecordCustomPreloader::VERSION
+  spec.authors       = ['Denis Talakevich']
+  spec.email         = ['senid231@gmail.com']
+
+  spec.summary       = %q{Custom preloader for ActiveRecord.}
+  spec.description   = %q{Custom preloader for ActiveRecord.}
+  spec.homepage      = 'https://github.com/senid231/active_record_custom_preloader'
+  spec.license       = 'MIT'
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'activesupport'
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_custom_preloader"
+
+# 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(__FILE__)

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/lib/active_record_custom_preloader/associations_preloader.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'active_record'
+
+module ActiveRecordCustomPreloader
+  class AssociationsPreloader < ::ActiveRecord::Associations::Preloader
+    private
+
+    def preloaders_on(association, records, scope)
+      if association.is_a?(PreloadWithOptions)
+        preloaders_for_one(association, records, scope)
+        return
+      end
+
+      klass = records.first.class
+      if klass.respond_to?(:has_custom_loader?) && klass.has_custom_loader?(association)
+        association = PreloadWithOptions.new(association)
+        preloaders_for_one(association, records, scope)
+        return
+      end
+
+      super
+    end
+
+    def preloaders_for_one(association, records, scope)
+      if records.size > 0 && association.is_a?(PreloadWithOptions)
+        association.loader_for(records.first.class).preload(records)
+        return
+      end
+
+      super
+    end
+  end
+end

data/lib/active_record_custom_preloader/model_patch.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+
+module ActiveRecordCustomPreloader
+  module ModelPatch
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_custom_loaders, instance_writer: false
+      class_attribute :_default_custom_loader_class, instance_accessor: false
+      self._custom_loaders = {}
+      self._default_custom_loader_class = 'ActiveRecordCustomerPreloader::Preloader'.freeze
+
+      # clear custom preloaded values on model instance reload
+      def reload(*)
+        clear_custom_preloaded_values
+        super
+      end
+    end
+
+    class_methods do
+      # add custom preloader for ActiveRecord model
+      # name <Symbol> name of loader [required]
+      # args <Hash> options that will be propagated to preloader (except :skip_methods and :class_name)
+      #   args[:skip_methods] <Boolean> will not create method "#{name}" for instance if true (default false)
+      #   args[:class_name] <String> class name of preloader (default 'ActiveRecord::CustomerPreloader::Preloader')
+      #
+      def add_custom_loader(name, args = {})
+        skip_methods = args.delete(:skip_methods)
+        class_name = args.delete(:class_name) || _default_custom_loader_class
+        self._custom_loaders = _custom_loaders.merge(name.to_sym => {
+            class_name: class_name,
+            args: args
+        })
+
+        define_method(name) do
+          _custom_preloaded_value(name)
+        end unless skip_methods
+      end
+
+      # find custom loader by name
+      # returns instance of custom loader
+      def custom_loader_for(name, options = {})
+        opts = _custom_loaders[name]
+        raise Error, "custom preloader #{name.inspect} does not exist" if opts.nil?
+        klass = opts[:class_name].safe_constantize
+        raise Error, "custom preloader klass #{opts[:class_name]} can't be found" if klass.nil?
+        klass.new self, name, opts[:args].merge(options)
+      end
+
+      # check if class has custom loader for name
+      def has_custom_loader?(name)
+        _custom_loaders.key?(name)
+      end
+    end
+
+    ## Instance Methods
+
+    # clear custom preloaded values
+    def clear_custom_preloaded_values
+      @_custom_preloaded_values = nil
+    end
+
+    # clear particular custom preloaded value
+    def clear_custom_preloaded_value(name)
+      raise Error, "custom preloader #{name.inspect} does not exist" unless _custom_loaders.key?(name)
+      _custom_preloaded_values.delete(name)
+    end
+
+    def has_custom_preloaded_value?(name)
+      _custom_preloaded_values.key?(name)
+    end
+
+    # sets custom preloaded value for name
+    def _set_custom_preloaded_value(name, value)
+      _custom_preloaded_values[name] = value
+    end
+
+    # returns Hash that stores cached custom preloaded values
+    def _custom_preloaded_values
+      @_custom_preloaded_values ||= {}
+    end
+
+    # fetch if necessary and return custom preloaded value for name
+    def _custom_preloaded_value(name)
+      raise ArgumentError, "custom preloader #{name.inspect} does not exist" unless _custom_loaders.key?(name)
+      _load_custom_preloaded_value(name) unless has_custom_preloaded_value?(name)
+      _custom_preloaded_values[name]
+    end
+
+    def _load_custom_preloaded_value(name, options = {})
+      self.class.custom_loader_for(name, options).preload([self])
+    end
+  end
+end

data/lib/active_record_custom_preloader/preload_with_options.rb

@@ -0,0 +1,13 @@
+module ActiveRecordCustomPreloader
+  class PreloadWithOptions
+    attr_reader :name, :options
+    def initialize(name, options = {})
+      @name = name
+      @options = options
+    end
+
+    def loader_for(klass)
+      klass.custom_loader_for(name, options)
+    end
+  end
+end

data/lib/active_record_custom_preloader/preloader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveRecordCustomPreloader
+  class Preloader
+    attr_reader :klass, :name, :args
+
+    def initialize(klass, name, args)
+      @klass = klass
+      @name = name
+      @args = args
+    end
+
+    # override this method in a subclass to provide customized preloading behavior
+    def preload(records)
+      values = args.fetch(:values).call(records)
+      records.each do |record|
+        value = values[record.id]
+        record._set_custom_preloaded_value(name, value)
+      end
+    end
+
+  end
+end

data/lib/active_record_custom_preloader/railtie.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require 'active_record_custom_preloader'
+
+ActiveRecord::Base.include ActiveRecordCustomPreloader::ModelPatch
+ActiveRecord::Relation.include ActiveRecordCustomPreloader::RelationPatch

data/lib/active_record_custom_preloader/relation_patch.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+
+module ActiveRecordCustomPreloader
+  module RelationPatch
+    extend ActiveSupport::Concern
+
+    included do
+      private
+
+      def build_preloader
+        ActiveRecordCustomPreloader::AssociationsPreloader.new
+      end
+    end
+  end
+end

data/lib/active_record_custom_preloader/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordCustomPreloader
+  VERSION = '0.2.2'
+end

data/lib/active_record_custom_preloader.rb

@@ -0,0 +1,12 @@
+require 'active_record_custom_preloader/version'
+require 'active_record_custom_preloader/preloader'
+require 'active_record_custom_preloader/preload_with_options'
+require 'active_record_custom_preloader/associations_preloader'
+require 'active_record_custom_preloader/model_patch'
+require 'active_record_custom_preloader/relation_patch'
+
+module ActiveRecordCustomPreloader
+  class Error < StandardError
+  end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: active_record_custom_preloader
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-09 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Custom preloader for ActiveRecord.
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_custom_preloader.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_custom_preloader.rb
+- lib/active_record_custom_preloader/associations_preloader.rb
+- lib/active_record_custom_preloader/model_patch.rb
+- lib/active_record_custom_preloader/preload_with_options.rb
+- lib/active_record_custom_preloader/preloader.rb
+- lib/active_record_custom_preloader/railtie.rb
+- lib/active_record_custom_preloader/relation_patch.rb
+- lib/active_record_custom_preloader/version.rb
+homepage: https://github.com/senid231/active_record_custom_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Custom preloader for ActiveRecord.
+test_files: []