serega 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54cf18301cae5fd9b8351603916e033bd31c3f5e36728b815e1ab4008f032023
-  data.tar.gz: bf35bd1f1f98439e47b493dcf99aa31ce4d0cd6ccf0bda9d3c9bfb82a8a064f0
+  metadata.gz: 9b4a68e91572d22cf24e20a79cc788f647eb63e16582f0e33497eec459692de1
+  data.tar.gz: 8d3a55c8fd783b00c55cb08ed8f62c0f47cb79573ccbdc9f65c6710489d0dd0f
 SHA512:
-  metadata.gz: b97a1bd42e8abcf3f8f7069388bb7ddc0e4e2328b1d5f945597fae19b852526ace0dc1d2c033e806d6537a00e35467d59d68ac9c42e5dc2a324b79e4ee93ffce
-  data.tar.gz: 9bdea1cf52a44c74137b2af216babc771fc454f165224539a58f3f2a010f4f798af7e6b8e978cdff38e83281d720fda450ea3a51372f7a2b84e2acfde2a5651c
+  metadata.gz: 67cb15aafd0dd90dd301a2ae79643c93204c52c26752649f96e904d2e1fe75d37709c91474c891eb73d1ee913002c214fc2c0288a613f82ad082ee385b149338
+  data.tar.gz: c421133bba5f4be2227a266bf6eb6fa6013f0320741f4e842575823d3a6d9e93bf37e8029b9fa801b2bcede964679c19fe794a1f7f0dceb10909c98251db588b

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.11.2

data/lib/serega/plugins/batch/batch.rb

@@ -79,8 +79,15 @@ class Serega
       # @return [void]
       #
       def self.load_plugin(serializer_class, **_opts)
+        require_relative "./lib/batch_config"
         require_relative "./lib/loader"
         require_relative "./lib/loaders"
+        require_relative "./lib/modules/attribute"
+        require_relative "./lib/modules/attribute_normalizer"
+        require_relative "./lib/modules/check_attribute_params"
+        require_relative "./lib/modules/config"
+        require_relative "./lib/modules/object_serializer"
+        require_relative "./lib/modules/plan_point"
         require_relative "./lib/validations/check_batch_opt_key"
         require_relative "./lib/validations/check_batch_opt_loader"
         require_relative "./lib/validations/check_opt_batch"
@@ -133,97 +140,7 @@ class Serega
         config.attribute_keys << :batch
         config.opts[:batch] = {loaders: {}, default_key: nil, auto_hide: false}
         config.batch.auto_hide = opts[:auto_hide] if opts.key?(:auto_hide)
-      end
-
-      #
-      # Batch loader config
-      #
-      class BatchConfig
-        attr_reader :opts
-
-        def initialize(opts)
-          @opts = opts
-        end
-
-        #
-        # Defines batch loader
-        #
-        # @param loader_name [Symbol] Batch loader name, that is used when defining attribute with batch loader.
-        # @param block [Proc] Block that can accept 3 parameters - keys, context, plan_point
-        #   and returns hash where ids are keys and values are batch loaded objects/
-        #
-        # @return [void]
-        #
-        def define(loader_name, &block)
-          unless block
-            raise SeregaError, "Block must be given to #define method"
-          end
-
-          params = block.parameters
-          if params.count > 3 || !params.all? { |param| (param[0] == :req) || (param[0] == :opt) }
-            raise SeregaError, "Block can have maximum 3 regular parameters"
-          end
-
-          loaders[loader_name] = block
-        end
-
-        # Shows defined loaders
-        # @return [Hash] defined loaders
-        def loaders
-          opts[:loaders]
-        end
-
-        #
-        # Finds previously defined batch loader by name
-        #
-        # @param loader_name [Symbol]
-        #
-        # @return [Proc] batch loader block
-        def fetch_loader(loader_name)
-          loaders[loader_name] || (raise SeregaError, "Batch loader with name `#{loader_name.inspect}` was not defined. Define example: config.batch.define(:#{loader_name}) { |keys, ctx, points| ... }")
-        end
-
-        # Shows option to auto hide attributes with :batch specified
-        # @return [Boolean, nil] option value
-        def auto_hide
-          opts[:auto_hide]
-        end
-
-        # @param value [Boolean] New :auto_hide option value
-        # @return [Boolean] New option value
-        def auto_hide=(value)
-          raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
-          opts[:auto_hide] = value
-        end
-
-        # Shows default key for :batch option
-        # @return [Symbol, nil] default key for :batch option
-        def default_key
-          opts[:default_key]
-        end
-
-        # @param value [Symbol] New :default_key option value
-        # @return [Boolean] New option value
-        def default_key=(value)
-          raise SeregaError, "Must be a Symbol, #{value.inspect} provided" unless value.is_a?(Symbol)
-          opts[:default_key] = value
-        end
-      end
-
-      #
-      # Config class additional/patched instance methods
-      #
-      # @see Serega::SeregaConfig
-      #
-      module ConfigInstanceMethods
-        #
-        # Returns all batch loaders registered for current serializer
-        #
-        # @return [Serega::SeregaPlugins::Batch::BatchConfig] configuration for batch loaded attributes
-        #
-        def batch
-          @batch ||= BatchConfig.new(opts.fetch(:batch))
-        end
+        config.batch.default_key = opts[:default_key] if opts.key?(:default_key)
       end
 
       #
@@ -247,138 +164,6 @@ class Serega
         end
       end
 
-      #
-      # Serega::SeregaValidations::CheckAttributeParams additional/patched class methods
-      #
-      # @see Serega::SeregaValidations::CheckAttributeParams
-      #
-      module CheckAttributeParamsInstanceMethods
-        private
-
-        def check_opts
-          super
-
-          CheckOptBatch.call(opts, block, self.class.serializer_class)
-        end
-      end
-
-      #
-      # Serega::SeregaAttribute additional/patched class methods
-      #
-      # @see Serega::SeregaAttribute
-      #
-      module AttributeInstanceMethods
-        #
-        # @return [nil, Hash] :batch option
-        #
-        attr_reader :batch
-
-        private
-
-        def set_normalized_vars(normalizer)
-          super
-          @batch = normalizer.batch
-        end
-      end
-
-      #
-      # SeregaAttributeNormalizer additional/patched instance methods
-      #
-      # @see SeregaAttributeNormalizer::AttributeInstanceMethods
-      #
-      module AttributeNormalizerInstanceMethods
-        #
-        # Returns normalized attribute :batch option with prepared :key and
-        # :default options. Option :loader will be prepared at serialization
-        # time as loaders are usually defined after attributes.
-        #
-        # @return [Hash] attribute :batch normalized options
-        #
-        def batch
-          return @batch if instance_variable_defined?(:@batch)
-
-          @batch = prepare_batch
-        end
-
-        private
-
-        #
-        # Patch for original `prepare_hide` method
-        #
-        # Marks attribute hidden if auto_hide option was set and attribute has batch loader
-        #
-        def prepare_hide
-          res = super
-          return res unless res.nil?
-
-          if batch
-            self.class.serializer_class.config.batch.auto_hide || nil
-          end
-        end
-
-        def prepare_batch
-          batch = init_opts[:batch]
-          return unless batch
-
-          # take loader
-          loader = batch[:loader]
-
-          # take key
-          key = batch[:key] || self.class.serializer_class.config.batch.default_key
-          proc_key =
-            if key.is_a?(Symbol)
-              proc do |object|
-                handle_no_method_error { object.public_send(key) }
-              end
-            else
-              key
-            end
-
-          # take default value
-          default = batch.fetch(:default) { many ? FROZEN_EMPTY_ARRAY : nil }
-
-          {loader: loader, key: proc_key, default: default}
-        end
-
-        def handle_no_method_error
-          yield
-        rescue NoMethodError => error
-          raise error, "NoMethodError when serializing '#{name}' attribute in #{self.class.serializer_class}\n\n#{error.message}", error.backtrace
-        end
-      end
-
-      #
-      # Serega::SeregaPlanPoint additional/patched class methods
-      #
-      # @see SeregaAttribute
-      #
-      module PlanPointInstanceMethods
-        #
-        # Returns attribute :batch option with prepared loader
-        # @return [Hash] attribute :batch option
-        #
-        attr_reader :batch
-
-        private
-
-        def set_normalized_vars
-          super
-          @batch = prepare_batch
-        end
-
-        def prepare_batch
-          batch = attribute.batch
-          if batch
-            loader = batch[:loader]
-            if loader.is_a?(Symbol)
-              batch_config = attribute.class.serializer_class.config.batch
-              batch[:loader] = batch_config.fetch_loader(loader)
-            end
-          end
-          batch
-        end
-      end
-
       #
       # Serega additional/patched instance methods
       #
@@ -397,28 +182,6 @@ class Serega
           result
         end
       end
-
-      #
-      # SeregaObjectSerializer additional/patched class methods
-      #
-      # @see Serega::SeregaObjectSerializer
-      #
-      module SeregaObjectSerializerInstanceMethods
-        private
-
-        def attach_value(object, point, container)
-          batch = point.batch
-          return super unless batch
-
-          remember_key_for_batch_loading(batch, object, point, container)
-        end
-
-        def remember_key_for_batch_loading(batch, object, point, container)
-          key = batch[:key].call(object, context)
-          opts[:batch_loaders].get(point, self).remember(key, container)
-          container[point.name] = nil # Reserve attribute place in resulted hash. We will set correct value later
-        end
-      end
     end
 
     register_plugin(Batch.plugin_name, Batch)

data/lib/serega/plugins/batch/lib/batch_config.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # Batch plugin config
+      #
+      class BatchConfig
+        attr_reader :opts
+
+        def initialize(opts)
+          @opts = opts
+        end
+
+        #
+        # Defines batch loader
+        #
+        # @param loader_name [Symbol] Batch loader name, that is used when defining attribute with batch loader.
+        # @param block [Proc] Block that can accept 3 parameters - keys, context, plan_point
+        #   and returns hash where ids are keys and values are batch loaded objects/
+        #
+        # @return [void]
+        #
+        def define(loader_name, &block)
+          unless block
+            raise SeregaError, "Block must be given to #define method"
+          end
+
+          params = block.parameters
+          if params.count > 3 || !params.all? { |param| (param[0] == :req) || (param[0] == :opt) }
+            raise SeregaError, "Block can have maximum 3 regular parameters"
+          end
+
+          loaders[loader_name] = block
+        end
+
+        # Shows defined loaders
+        # @return [Hash] defined loaders
+        def loaders
+          opts[:loaders]
+        end
+
+        #
+        # Finds previously defined batch loader by name
+        #
+        # @param loader_name [Symbol]
+        #
+        # @return [Proc] batch loader block
+        def fetch_loader(loader_name)
+          loaders[loader_name] || (raise SeregaError, "Batch loader with name `#{loader_name.inspect}` was not defined. Define example: config.batch.define(:#{loader_name}) { |keys, ctx, points| ... }")
+        end
+
+        # Shows option to auto hide attributes with :batch specified
+        # @return [Boolean, nil] option value
+        def auto_hide
+          opts[:auto_hide]
+        end
+
+        # @param value [Boolean] New :auto_hide option value
+        # @return [Boolean] New option value
+        def auto_hide=(value)
+          raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
+          opts[:auto_hide] = value
+        end
+
+        # Shows default key for :batch option
+        # @return [Symbol, nil] default key for :batch option
+        def default_key
+          opts[:default_key]
+        end
+
+        # @param value [Symbol] New :default_key option value
+        # @return [Boolean] New option value
+        def default_key=(value)
+          raise SeregaError, "Must be a Symbol, #{value.inspect} provided" unless value.is_a?(Symbol)
+          opts[:default_key] = value
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/batch/lib/modules/attribute.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # Serega::SeregaAttribute additional/patched class methods
+      #
+      # @see Serega::SeregaAttribute
+      #
+      module AttributeInstanceMethods
+        #
+        # @return [nil, Hash] :batch option
+        #
+        attr_reader :batch
+
+        private
+
+        def set_normalized_vars(normalizer)
+          super
+          @batch = normalizer.batch
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/batch/lib/modules/attribute_normalizer.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # SeregaAttributeNormalizer additional/patched instance methods
+      #
+      # @see SeregaAttributeNormalizer::AttributeInstanceMethods
+      #
+      module AttributeNormalizerInstanceMethods
+        #
+        # Returns normalized attribute :batch option with prepared :key and
+        # :default options. Option :loader will be prepared at serialization
+        # time as loaders are usually defined after attributes.
+        #
+        # @return [Hash] attribute :batch normalized options
+        #
+        def batch
+          return @batch if instance_variable_defined?(:@batch)
+
+          @batch = prepare_batch
+        end
+
+        private
+
+        #
+        # Patch for original `prepare_hide` method
+        #
+        # Marks attribute hidden if auto_hide option was set and attribute has batch loader
+        #
+        def prepare_hide
+          res = super
+          return res unless res.nil?
+
+          if batch
+            self.class.serializer_class.config.batch.auto_hide || nil
+          end
+        end
+
+        def prepare_batch
+          batch = init_opts[:batch]
+          return unless batch
+
+          # take loader
+          loader = batch[:loader]
+
+          # take key
+          key = batch[:key] || self.class.serializer_class.config.batch.default_key
+          proc_key =
+            if key.is_a?(Symbol)
+              proc do |object|
+                handle_no_method_error { object.public_send(key) }
+              end
+            else
+              key
+            end
+
+          # take default value
+          default = batch.fetch(:default) { many ? FROZEN_EMPTY_ARRAY : nil }
+
+          {loader: loader, key: proc_key, default: default}
+        end
+
+        def handle_no_method_error
+          yield
+        rescue NoMethodError => error
+          raise error, "NoMethodError when serializing '#{name}' attribute in #{self.class.serializer_class}\n\n#{error.message}", error.backtrace
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/batch/lib/modules/check_attribute_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # Serega::SeregaValidations::CheckAttributeParams additional/patched class methods
+      #
+      # @see Serega::SeregaValidations::CheckAttributeParams
+      #
+      module CheckAttributeParamsInstanceMethods
+        private
+
+        def check_opts
+          super
+
+          CheckOptBatch.call(opts, block, self.class.serializer_class)
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/batch/lib/modules/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # Config class additional/patched instance methods
+      #
+      # @see Serega::SeregaConfig
+      #
+      module ConfigInstanceMethods
+        #
+        # Returns all batch loaders registered for current serializer
+        #
+        # @return [Serega::SeregaPlugins::Batch::BatchConfig] configuration for batch loaded attributes
+        #
+        def batch
+          @batch ||= BatchConfig.new(opts.fetch(:batch))
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/batch/lib/modules/object_serializer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # SeregaObjectSerializer additional/patched class methods
+      #
+      # @see Serega::SeregaObjectSerializer
+      #
+      module SeregaObjectSerializerInstanceMethods
+        private
+
+        def attach_value(object, point, container)
+          batch = point.batch
+          return super unless batch
+
+          remember_key_for_batch_loading(batch, object, point, container)
+        end
+
+        def remember_key_for_batch_loading(batch, object, point, container)
+          key = batch[:key].call(object, context)
+          batch_loader(point).remember(key, container)
+          container[point.name] = nil # Reserve attribute place in resulted hash. We will set correct value later
+        end
+
+        def batch_loader(point)
+          batch_loaders = opts[:batch_loaders]
+          raise_batch_plugin_for_serializer_not_defined(point) unless batch_loaders
+          batch_loaders.get(point, self)
+        end
+
+        def raise_batch_plugin_for_serializer_not_defined(point)
+          root_plan = point.plan
+          root_plan = plan.parent_plan_point.plan while root_plan.parent_plan_point
+          current_serializer = root_plan.serializer_class
+          nested_serializer = self.class.serializer_class
+
+          raise SeregaError,
+            "Plugin :batch must be added to current serializer (#{current_serializer})" \
+            " to load attributes with :batch option in nested serializer (#{nested_serializer})"
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/batch/lib/modules/plan_point.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # Serega::SeregaPlanPoint additional/patched class methods
+      #
+      # @see SeregaAttribute
+      #
+      module PlanPointInstanceMethods
+        #
+        # Returns attribute :batch option with prepared loader
+        # @return [Hash] attribute :batch option
+        #
+        attr_reader :batch
+
+        private
+
+        def set_normalized_vars
+          super
+          @batch = prepare_batch
+        end
+
+        def prepare_batch
+          batch = attribute.batch
+          if batch
+            loader = batch[:loader]
+            if loader.is_a?(Symbol)
+              batch_config = attribute.class.serializer_class.config.batch
+              batch[:loader] = batch_config.fetch_loader(loader)
+            end
+          end
+          batch
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -43,8 +43,15 @@ files:
 - lib/serega/plugins/activerecord_preloads/activerecord_preloads.rb
 - lib/serega/plugins/activerecord_preloads/lib/preloader.rb
 - lib/serega/plugins/batch/batch.rb
+- lib/serega/plugins/batch/lib/batch_config.rb
 - lib/serega/plugins/batch/lib/loader.rb
 - lib/serega/plugins/batch/lib/loaders.rb
+- lib/serega/plugins/batch/lib/modules/attribute.rb
+- lib/serega/plugins/batch/lib/modules/attribute_normalizer.rb
+- lib/serega/plugins/batch/lib/modules/check_attribute_params.rb
+- lib/serega/plugins/batch/lib/modules/config.rb
+- lib/serega/plugins/batch/lib/modules/object_serializer.rb
+- lib/serega/plugins/batch/lib/modules/plan_point.rb
 - lib/serega/plugins/batch/lib/plugins_extensions/activerecord_preloads.rb
 - lib/serega/plugins/batch/lib/plugins_extensions/formatters.rb
 - lib/serega/plugins/batch/lib/plugins_extensions/preloads.rb