fume-aloader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e76d23af085408f974ed12200e21710eb7e41ed838f1e1f4906b28cda813967e
+  data.tar.gz: f8ca566f229ef016c0f25a47d4018ec2b82fbb2e9c3c04c1a760d297fcf22edc
+SHA512:
+  metadata.gz: 3cced0b48ce3022d0467db55bbc4f6b474546bf3990991d531a479d99914afaa568de687d608dc0f8deccc3cbea338eb0218d65656207b85e935e18f8dcc6f7a
+  data.tar.gz: d2897f943c2cbceb053a2580190faa83e42fab3700d07999bd1aa18f675238fd0c864ee97168a8686b7b48a3962ad9ba80865048be730fc5bf98af91eb12ba05

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/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fume-aloader.gemspec
+gemspec
+
+gem "pry"
+
+# gem "rubocop", "~> 1.21"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 sunteya
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 sunteya
+
+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,31 @@
+# Fume::Aloader
+
+[fume-aloader](https://github.com/sunteya/fume-aloader) is a configurable eager loading plugin for rails
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add fume-aloader
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fume-aloader
+
+## Usage
+
+TODO: Please read spec code.
+
+## 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]/fume-aloader.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/fume/aloader/association_loader.rb

@@ -0,0 +1,235 @@
+module Fume::Aloader
+  class AssociationLoader
+    attr_accessor :klass
+    attr_accessor :records
+    attr_accessor :presets
+    attr_accessor :profile
+
+    attr_accessor :cached_values
+    attr_accessor :preload_values
+
+    def initialize(records, klass = nil, &block)
+      self.profile = :default
+      self.presets = {}
+      self.klass = klass || records.klass
+
+      self.cached_values = {}
+      self.preload_values = {}
+      self.records = records
+      instance_exec(&block) if block
+    end
+
+    def find_cached_value(record, name)
+      association = record.association(name)
+      reflection = association.reflection
+
+      key = reflection.collection? ? record.send(:id) : record.send(reflection.join_foreign_key)
+
+      unless self.cached_values.key?(name)
+        init_records_value(name)
+      end
+
+      self.cached_values[name][key]
+    end
+
+    def load(record, name)
+      association = record.association(name)
+      if association.loaded? && !self.cached_values.key?(name)
+        init_records_value(name, ->(scope) {
+          values = self.records.flat_map(&name.to_sym).compact
+          scope.send(:load_records, values)
+          scope.al_init_records
+        })
+      else
+        value = find_cached_value(record, name)
+        association.target = value
+      end
+    end
+
+    def preload_all(*path, values)
+      path = [ path ].flatten
+      name = path.shift
+
+      if path.size.zero?
+        fill_records_value(name, values)
+      else
+        self.preload_values[name] ||= []
+        self.preload_values[name] << [ path, values ]
+      end
+    end
+
+    def init_records_value(name, callback = nil)
+      association = klass.new.association(name)
+      values = build_association_values_scope(name, association)
+      callback&.(values)
+
+      if self.preload_values.key?(name)
+        preload_values[name].each do |args|
+          values.al_preload_all(*args)
+        end
+      end
+
+      fill_records_value(name, values)
+    end
+
+    def fill_records_value(name, values)
+      association = klass.new.association(name)
+      reflection = association.reflection
+
+      if reflection.collection?
+        self.cached_values[name] = values.each_with_object(Hash.new { [] }) do |it, result|
+          key = it.send(reflection.join_primary_key)
+          result[key] += [ it ]
+        end
+      elsif reflection.belongs_to?
+        self.cached_values[name] = values.index_by(&:id)
+      else
+        self.cached_values[name] = values.index_by { |it| it.send(reflection.join_primary_key) }
+      end
+    end
+
+    def build_association_values_scope(name, association)
+      reflection = association.reflection
+
+      # HACK: 重写第一次取值，升级后可能会报错
+      # 不能使用子查询 select, 可能内存占用过多
+      hack_values = [ records.map { |item| item.read_attribute(reflection.join_foreign_key) }.uniq ]
+
+      value_transformation = ->(val) {
+        hack_values.shift || val
+      }
+
+      association_scope = ActiveRecord::Associations::AssociationScope.new(value_transformation)
+      values_scope = association.send(:target_scope).merge(association_scope.scope(association))
+      values_scope = apply_profile_attribute_includes(values_scope, name)
+      values_scope = values_scope.limit(nil).offset(0)
+      values_scope
+    end
+
+    def apply_profile_attribute_includes(base, name)
+      preset = self.active_preset
+      attribute = preset.dig(:attributes, name) || {}
+
+      if (attr_preset_name = attribute[:preset])
+        return base.al_to_scope(attr_preset_name)
+      end
+
+      includes = find_attribute_includes(preset, name) || []
+      return base if includes.empty?
+
+
+      except = (self.preload_values[name] || []).map(&:first)
+      columns = simplify_includes_hash(convert_to_includes_hash(includes, [], except))
+
+      if columns.any?
+        base = base.includes(columns).references(columns)
+      else
+        base
+      end
+    end
+
+    def build_profile_scope_includes
+      preset = self.active_preset
+      except = self.cached_values.keys.map { |it| [ it] }.to_set
+      self.preload_values.each do |name, items|
+        items.each do |item|
+          except << ([ name ] + item.first)
+        end
+      end
+
+      result = {}
+      roots = [ preset[:scope_includes] || [] ].flatten
+      roots.each do |root|
+        if root.is_a?(Hash)
+          root.each do |(name, value)|
+            result.update convert_to_includes_hash({ name => value }, [], except)
+          end
+        else
+          includes = find_attribute_includes(preset, root) || {}
+          result.update convert_to_includes_hash({ root => includes }, [], except)
+        end
+      end
+
+      simplify_includes_hash(result)
+    end
+
+    def simplify_includes_hash(includes)
+      array = []
+      hash = {}
+
+      includes.each do |(key, value)|
+        if value.empty?
+          array << key
+        else
+          hash[key] = simplify_includes_hash(value)
+        end
+      end
+
+      hash.empty? ? array : array + [ hash ]
+    end
+
+    def convert_to_includes_hash(item, prefix = [], except = [])
+      case item
+      when Hash
+        item.each_with_object({}) do |(name, value), result|
+          path = prefix + [ name ]
+          if !except.include?(path)
+            result[name] = convert_to_includes_hash(value, path, except)
+          end
+        end
+      when Array
+        item.each_with_object({}) do |name, result|
+          path = prefix + [ name ]
+
+          if !except.include?(path)
+            result[name] = convert_to_includes_hash({}, path, except)
+          end
+        end
+      else
+        path = prefix + [ item ]
+        except.include?(path) ? {} : { item => Hash.new }
+      end
+    end
+
+    def apply_profile_scope_includes(base)
+      names = build_profile_scope_includes
+
+      if names.any?
+        base.includes(*names).references(*names)
+      else
+        base
+      end
+    end
+
+    def find_attribute_includes(preset, name)
+      attribute = preset.dig(:attributes, name) || {}
+
+      attr_preset_name = attribute[:preset]
+      return attribute[:scope_includes] || [] if attr_preset_name.nil?
+
+      loader = build_attribute_aloader(name, attr_preset_name)
+      loader.build_profile_scope_includes
+    end
+
+    def build_attribute_aloader(name, profile)
+      association = klass.new.association(name)
+      reflection = association.reflection
+      loader = reflection.klass.al_build([])
+      loader.active(profile)
+      loader
+    end
+
+    def active(name)
+      self.profile = name
+    end
+
+    def active_preset
+      self.presets[self.profile] || {}
+    end
+
+    def spawn_from(parent)
+      self.preload_values = parent.preload_values.dup
+      self.profile = parent.profile
+    end
+  end
+end

data/lib/fume/aloader/dsl.rb

@@ -0,0 +1,40 @@
+module Fume::Aloader
+  class DSL
+    attr_accessor :config
+
+    def initialize(&block)
+      self.config = {}
+      instance_exec &block if block
+    end
+
+    def preset(name, &block)
+      name = name.to_sym
+      dsl = self.class.new(&block)
+      self.config[:presets] ||= {}
+      self.config[:presets][name] = { scope_includes: [] }.merge(dsl.config)
+    end
+
+    def scope_includes(columns)
+      self.config[:scope_includes] = columns
+    end
+
+    def attribute(name, options = {}, &block)
+      self.config[:attributes] ||= {}
+      self.config[:attributes][name] = options
+
+      if block
+        dsl = self.class.new(&block)
+        self.config[:attributes][name][:scope_includes] = dsl.config[:scope_includes]
+      end
+    end
+
+    def apply_config(loader)
+      loader.presets = self.config[:presets] || {}
+      loader.presets[nil] = {
+        scope_includes: self.config[:scope_includes] || [],
+        attributes: self.config[:attributes] || {}
+      }
+      loader
+    end
+  end
+end

data/lib/fume/aloader/railtie.rb

@@ -0,0 +1,14 @@
+require "rails/railtie"
+require_relative "relation_addons"
+require_relative "record_addons"
+
+require_relative "association_loader"
+
+module Fume::Aloader
+  class Railtie < ::Rails::Railtie
+    initializer 'fume-aloader.configure_rails_initialization' do |app|
+      ::ActiveRecord::Base.include(RecordAddons)
+      ::ActiveRecord::Relation.prepend(RelationAddons)
+    end
+  end
+end

data/lib/fume/aloader/record_addons.rb

@@ -0,0 +1,32 @@
+require "active_support/concern"
+require_relative "dsl"
+
+module Fume::Aloader
+  module RecordAddons
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :aloader
+    end
+
+    def al_load(*path)
+      path = [ path ].flatten
+      name = path.shift
+      self.aloader.load(self, name)
+
+      if path.any?
+        value = self.send(name)
+        value&.al_load(*path)
+      end
+    end
+
+    module ClassMethods
+      def aloader_init(&block)
+        define_singleton_method :al_build do |records|
+          dsl = DSL.new(&block)
+          dsl.apply_config(AssociationLoader.new(records, self))
+        end
+      end
+    end
+  end
+end

data/lib/fume/aloader/relation_addons.rb

@@ -0,0 +1,55 @@
+module Fume::Aloader
+  module RelationAddons
+
+    attr_accessor :aloader
+
+    def load(*args, &block)
+      return super if loaded?
+      result = super
+      al_init_records
+      result
+    end
+
+    def spawn(*args)
+      result = super
+      result.aloader = nil
+      result.al_init_loader
+      result.aloader&.spawn_from(self.aloader) if self.aloader
+      result
+    end
+
+    def al_init_records
+      al_init_loader
+
+      if self.aloader
+        @records.each do |record|
+          record.aloader = self.aloader
+        end
+      end
+    end
+
+    def al_init_loader
+      return if self.aloader
+      return unless klass.respond_to?(:al_build)
+
+      self.aloader = klass.al_build(self)
+    end
+
+    def al_load(*args)
+      records.each { |it| it.al_load(*args) }
+      self
+    end
+
+    def al_preload_all(*args)
+      al_init_loader
+      self.aloader.preload_all(*args)
+      self
+    end
+
+    def al_to_scope(preset = :default)
+      al_init_loader
+      self.aloader.active(preset)
+      self.aloader.apply_profile_scope_includes(self)
+    end
+  end
+end

data/lib/fume/aloader/version.rb

@@ -0,0 +1,5 @@
+module Fume
+  module Aloader
+    VERSION = "0.1.0"
+  end
+end

data/lib/fume/aloader.rb

@@ -0,0 +1,15 @@
+require_relative "aloader/version"
+require_relative "aloader/railtie"
+require_relative "aloader/dsl"
+require_relative "aloader/association_loader"
+
+module Fume
+  module Aloader
+    def self.dsl(*args, &block)
+      dsl = DSL.new(&block)
+      loader = AssociationLoader.new(*args)
+      dsl.apply_config(loader)
+      loader
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: fume-aloader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sunteya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec-do_action
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+description: 
+email:
+- sunteya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- config.ru
+- lib/fume/aloader.rb
+- lib/fume/aloader/association_loader.rb
+- lib/fume/aloader/dsl.rb
+- lib/fume/aloader/railtie.rb
+- lib/fume/aloader/record_addons.rb
+- lib/fume/aloader/relation_addons.rb
+- lib/fume/aloader/version.rb
+homepage: https://github.com/sunteya/fume-aloader
+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.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: a configurable eager loading plugin for rails
+test_files: []