fume-aloader 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e76d23af085408f974ed12200e21710eb7e41ed838f1e1f4906b28cda813967e
-  data.tar.gz: f8ca566f229ef016c0f25a47d4018ec2b82fbb2e9c3c04c1a760d297fcf22edc
+  metadata.gz: 3d205f2e1934bebb8d922c2d17a5126b4a46d1f25897edbc82be331b3010e255
+  data.tar.gz: 37a54264eb5998a64bff6f9e400be6d1d2bcade3b5cc281add1687cbf88f9f0e
 SHA512:
-  metadata.gz: 3cced0b48ce3022d0467db55bbc4f6b474546bf3990991d531a479d99914afaa568de687d608dc0f8deccc3cbea338eb0218d65656207b85e935e18f8dcc6f7a
-  data.tar.gz: d2897f943c2cbceb053a2580190faa83e42fab3700d07999bd1aa18f675238fd0c864ee97168a8686b7b48a3962ad9ba80865048be730fc5bf98af91eb12ba05
+  metadata.gz: 1b7192010a01bcc3cdc5ed17b91523d9f3b8135db14f6c7ef2a588bebf928eb83871115d89c548274dd999609f9cf59bd4c027250719c401b1b48ca82a2cdcfd
+  data.tar.gz: f4676daf7024f3b81eaa85599f1a2923de222027aefedac1cb9e499850eb87a09d6d7dd41afc0138577a8d2d054d19ae169e7bae909119792fecc851eb14a17b

data/lib/fume/aloader/association_loader.rb

@@ -1,3 +1,5 @@
+require_relative "relationship"
+
 module Fume::Aloader
   class AssociationLoader
     attr_accessor :klass
@@ -20,29 +22,32 @@ module Fume::Aloader
     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]
+      relationship = Relationship.build(klass, name)
+      cache_key = relationship.get_cache_key(record)
+      self.cached_values[name][cache_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
-        })
+      if self.cached_values.key?(name)
+        # prefer use cached value
+        association.target = find_cached_value(record, name)
+      elsif association.loaded?
+        ensure_attribute_aloader_inited(record, name)
       else
-        value = find_cached_value(record, name)
-        association.target = value
+        init_records_value(name)
+        association.target = find_cached_value(record, name)
+      end
+    end
+
+    def ensure_attribute_aloader_inited(record, name)
+      relationship = Relationship.build(klass, name)
+      return if relationship.loader_is_inited?(record)
+
+      options = active_preset.dig(:attributes, name) || {}
+      loaders = relationship.loaders_init(self.records, options[:preset])
+      (self.preload_values[name] || []).each do |args|
+        loaders.each { |it| it.preload_all(*args) }
       end
     end
 
@@ -51,59 +56,43 @@ module Fume::Aloader
       name = path.shift
 
       if path.size.zero?
-        fill_records_value(name, values)
+        cache_association_values(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)
+    def init_records_value(name)
+      values_list = build_association_values_scopes(name)
+      values_list.each do |values|
+        if self.preload_values.key?(name)
+          preload_values[name].each do |args|
+            values.al_preload_all(*args)
+          end
         end
-      end
 
-      fill_records_value(name, values)
+        cache_association_values(name, values)
+      end
     end
 
-    def fill_records_value(name, values)
-      association = klass.new.association(name)
-      reflection = association.reflection
+    def cache_association_values(name, values)
+      relationship = Relationship.build(klass, name)
 
-      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)
+      if self.cached_values.key?(name)
+        self.cached_values[name].update(relationship.build_cached_value(values))
       else
-        self.cached_values[name] = values.index_by { |it| it.send(reflection.join_primary_key) }
+        self.cached_values[name] = relationship.build_cached_value(values)
       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 ]
+    def build_association_values_scopes(name)
+      relationship = Relationship.build(klass, name)
+      values_scopes = relationship.build_values_scopes(records)
 
-      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
+      values_scopes.map do |values_scope|
+        apply_profile_attribute_includes(values_scope, name)
+      end
     end
 
     def apply_profile_attribute_includes(base, name)
@@ -114,10 +103,9 @@ module Fume::Aloader
         return base.al_to_scope(attr_preset_name)
       end
 
-      includes = find_attribute_includes(preset, name) || []
+      includes = find_attribute_includes(preset, name, base.klass) || []
       return base if includes.empty?
 
-
       except = (self.preload_values[name] || []).map(&:first)
       columns = simplify_includes_hash(convert_to_includes_hash(includes, [], except))
 
@@ -145,7 +133,7 @@ module Fume::Aloader
             result.update convert_to_includes_hash({ name => value }, [], except)
           end
         else
-          includes = find_attribute_includes(preset, root) || {}
+          includes = find_attribute_includes(preset, root, nil) || {}
           result.update convert_to_includes_hash({ root => includes }, [], except)
         end
       end
@@ -201,24 +189,18 @@ module Fume::Aloader
       end
     end
 
-    def find_attribute_includes(preset, name)
+    def find_attribute_includes(preset, name, association_klass)
       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)
+      association_klass ||= klass.new.association(name).reflection.klass
+      loader = association_klass.al_build([])
+      loader.active(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

data/lib/fume/aloader/railtie.rb

@@ -9,6 +9,11 @@ module Fume::Aloader
     initializer 'fume-aloader.configure_rails_initialization' do |app|
       ::ActiveRecord::Base.include(RecordAddons)
       ::ActiveRecord::Relation.prepend(RelationAddons)
+
+      # CollectionProxy is inhert from Relation, proxy back to Relation
+      ::ActiveRecord::Associations::CollectionProxy.class_eval do
+        delegate :al_to_scope, :aloader, to: :scope
+      end
     end
   end
 end

data/lib/fume/aloader/relation_addons.rb

@@ -1,6 +1,5 @@
 module Fume::Aloader
   module RelationAddons
-
     attr_accessor :aloader
 
     def load(*args, &block)
@@ -11,7 +10,7 @@ module Fume::Aloader
     end
 
     def spawn(*args)
-      result = super
+      result = already_in_scope? ? klass.all : clone
       result.aloader = nil
       result.al_init_loader
       result.aloader&.spawn_from(self.aloader) if self.aloader
@@ -47,9 +46,15 @@ module Fume::Aloader
     end
 
     def al_to_scope(preset = :default)
+      if self.is_a?(ActiveRecord::Associations::CollectionProxy)
+        scope.al_to_scope(preset)
+        return
+      end
+
       al_init_loader
       self.aloader.active(preset)
-      self.aloader.apply_profile_scope_includes(self)
+      result = self.aloader.apply_profile_scope_includes(self)
+      result
     end
   end
 end

data/lib/fume/aloader/relationship/base.rb

@@ -0,0 +1,30 @@
+module Fume::Aloader
+  module Relationship
+    class Base
+      attr_accessor :klass
+      attr_accessor :association
+      attr_accessor :reflection
+
+      def initialize(klass, association, reflection)
+        self.klass = klass
+        self.association = association
+        self.reflection = reflection
+      end
+
+      def build_values_scopes(records)
+        # 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 = values_scope.limit(nil).offset(0)
+        [ values_scope ]
+      end
+    end
+  end
+end

data/lib/fume/aloader/relationship/base_single.rb

@@ -0,0 +1,25 @@
+require_relative "base"
+
+module Fume::Aloader
+  module Relationship
+    class BaseSingle < Base
+      def loader_is_inited?(parent)
+        value = parent.send(reflection.name)
+        value.nil? || !!value.aloader
+      end
+
+      def loaders_init(parents, preset)
+        values = parents.map { |it| it.send(reflection.name) }.compact
+        return [] if !reflection.klass.respond_to?(:al_build)
+        loader = reflection.klass.al_build(values)
+
+        values.each do |value|
+          value.aloader = loader
+        end
+
+        loader.active(preset) if preset
+        [ loader ]
+      end
+    end
+  end
+end

data/lib/fume/aloader/relationship/belongs_to.rb

@@ -0,0 +1,15 @@
+require_relative "base_single"
+
+module Fume::Aloader
+  module Relationship
+    class BelongsTo < BaseSingle
+      def get_cache_key(record)
+        record.send(reflection.join_foreign_key)
+      end
+
+      def build_cached_value(values)
+        values.index_by(&:id)
+      end
+    end
+  end
+end

data/lib/fume/aloader/relationship/belongs_to_polymorphic.rb

@@ -0,0 +1,74 @@
+require_relative "base_single"
+
+module Fume::Aloader
+  module Relationship
+    class BelongsToPolymorphic < BaseSingle
+      def get_cache_key(record)
+        [ record.send(reflection.join_foreign_type), record.send(reflection.join_foreign_key) ]
+      end
+
+      def build_cached_value(values)
+        values.index_by { |it| [ it.class.to_s, it.id ] }
+      end
+
+      def build_values_scopes(records)
+        values_mapping = records.each_with_object({}).each do |record, hash|
+          type = record.read_attribute(reflection.join_foreign_type)
+          next if type.nil?
+
+          value = record.read_attribute(reflection.join_foreign_key)
+          if value
+            hash[type] ||= Set.new
+            hash[type] << value
+          end
+        end.compact
+
+        values_mapping.map do |type, values|
+          values = [ values.to_a ]
+
+          # HACK: 重写第一次取值，升级后可能会报错
+          # 不能使用子查询 select, 可能内存占用过多
+          value_transformation = ->(val) {
+            values.shift || val
+          }
+
+          association_scope = ActiveRecord::Associations::AssociationScope.new(value_transformation)
+
+          association = klass.new(reflection.join_foreign_type => type, reflection.join_foreign_key => -1).association(reflection.name)
+          values_scope = association.send(:target_scope).merge(association_scope.scope(association))
+          values_scope = values_scope.limit(nil).offset(0)
+          values_scope
+        end
+      end
+
+      def build_values_mapping(records)
+      end
+
+      def loaders_init(parents, preset)
+        values_mapping = parents.each_with_object({}).each do |parent, hash|
+          type = parent.read_attribute(reflection.join_foreign_type)
+          next if type.nil?
+
+          value = parent.send(reflection.name)
+          if value
+            hash[type] ||= Set.new
+            hash[type] << value
+          end
+        end.compact
+
+        values_mapping.each do |type, values|
+          loader_klass = type.constantize
+          next if !loader_klass.respond_to?(:al_build)
+          loader = loader_klass.al_build(values)
+
+          values.each do |value|
+            value.aloader = loader
+          end
+
+          loader.active(preset) if preset
+          loader
+        end
+      end
+    end
+  end
+end

data/lib/fume/aloader/relationship/has_and_belongs_to_many.rb

@@ -0,0 +1,8 @@
+# require_relative "base"
+
+# module Fume::Aloader
+#   module Relationship
+#     class HasAndBelongsToMany < Base
+#     end
+#   end
+# end

data/lib/fume/aloader/relationship/has_many.rb

@@ -0,0 +1,36 @@
+require_relative "base"
+
+module Fume::Aloader
+  module Relationship
+    class HasMany < Base
+      def get_cache_key(record)
+        record.send(reflection.join_foreign_key)
+      end
+
+      def build_cached_value(values)
+        values.each_with_object(Hash.new { [] }) do |it, result|
+          key = it.send(reflection.join_primary_key)
+          result[key] += [ it ]
+        end
+      end
+
+      def loader_is_inited?(parent)
+        values = parent.send(reflection.name)
+        values.nil? || values.empty? || !!values.first.aloader
+      end
+
+      def loaders_init(parents, preset)
+        values = parents.flat_map { |it| it.send(reflection.name) }.compact
+        return [] if !reflection.klass.respond_to?(:al_build)
+        loader = reflection.klass.al_build(values)
+
+        values.each do |value|
+          value.aloader = loader
+        end
+
+        loader.active(preset) if preset
+        [ loader ]
+      end
+    end
+  end
+end

data/lib/fume/aloader/relationship/has_one.rb

@@ -0,0 +1,15 @@
+require_relative "base_single"
+
+module Fume::Aloader
+  module Relationship
+    class HasOne < BaseSingle
+      def get_cache_key(record)
+        record.send(reflection.join_foreign_key)
+      end
+
+      def build_cached_value(values)
+        values.index_by { |it| it.send(reflection.join_primary_key) }
+      end
+    end
+  end
+end

data/lib/fume/aloader/relationship.rb

@@ -0,0 +1,29 @@
+require_relative "relationship/has_many"
+require_relative "relationship/belongs_to"
+require_relative "relationship/belongs_to_polymorphic"
+# require_relative "relationship/has_and_belongs_to_many"
+require_relative "relationship/has_one"
+
+module Fume::Aloader
+  module Relationship
+    def self.build(klass, name)
+      association = klass.new.association(name)
+      reflection = association.reflection
+
+      reflection_class = nil
+      if reflection.through_reflection?
+        raise "Not supported through reflection yet"
+      elsif reflection.collection?
+        reflection_class = HasMany
+      elsif reflection.has_one?
+        reflection_class = HasOne
+      elsif reflection.polymorphic?
+        reflection_class = BelongsToPolymorphic
+      else
+        reflection_class = BelongsTo
+      end
+
+      reflection_class.new(klass, association, reflection)
+    end
+  end
+end

data/lib/fume/aloader/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fume-aloader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - sunteya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -130,10 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
 - Gemfile
-- LICENSE
 - LICENSE.txt
 - README.md
 - config.ru
@@ -143,6 +154,14 @@ files:
 - lib/fume/aloader/railtie.rb
 - lib/fume/aloader/record_addons.rb
 - lib/fume/aloader/relation_addons.rb
+- lib/fume/aloader/relationship.rb
+- lib/fume/aloader/relationship/base.rb
+- lib/fume/aloader/relationship/base_single.rb
+- lib/fume/aloader/relationship/belongs_to.rb
+- lib/fume/aloader/relationship/belongs_to_polymorphic.rb
+- lib/fume/aloader/relationship/has_and_belongs_to_many.rb
+- lib/fume/aloader/relationship/has_many.rb
+- lib/fume/aloader/relationship/has_one.rb
 - lib/fume/aloader/version.rb
 homepage: https://github.com/sunteya/fume-aloader
 licenses:

data/.rubocop.yml

@@ -1,13 +0,0 @@
-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

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

data/LICENSE

@@ -1,21 +0,0 @@
-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.