serega 0.4.0 → 0.5.0

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      class CheckOptBatch
+        class << self
+          def call(opts, block)
+            return unless opts.key?(:batch)
+
+            SeregaValidations::Utils::CheckOptIsHash.call(opts, :batch)
+
+            batch = opts[:batch]
+            SeregaValidations::Utils::CheckAllowedKeys.call(batch, %i[key loader default])
+
+            check_batch_opt_key(batch[:key])
+            check_batch_opt_loader(batch[:loader])
+
+            check_usage_with_other_params(opts, block)
+          end
+
+          private
+
+          def check_batch_opt_key(key)
+            raise SeregaError, "Option :key must present inside :batch option" unless key
+
+            CheckBatchOptKey.call(key)
+          end
+
+          def check_batch_opt_loader(loader)
+            raise SeregaError, "Option :loader must present inside :batch option" unless loader
+
+            CheckBatchOptLoader.call(loader)
+          end
+
+          def check_usage_with_other_params(opts, block)
+            raise SeregaError, "Option :batch can not be used together with option :key" if opts.key?(:key)
+            raise SeregaError, "Option :batch can not be used together with option :value" if opts.key?(:value)
+            raise SeregaError, "Option :batch can not be used together with option :const" if opts.key?(:const)
+            raise SeregaError, "Option :batch can not be used together with option :delegate" if opts.key?(:delegate)
+            raise SeregaError, "Option :batch can not be used together with block" if block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/context_metadata/context_metadata.rb

@@ -15,7 +15,7 @@ class Serega
 
       def self.load_plugin(serializer_class, **_opts)
         serializer_class::SeregaConfig.include(ConfigInstanceMethods)
-        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
+        serializer_class::SeregaSerializer.include(SeregaSerializerInstanceMethods)
         serializer_class::CheckSerializeParams.include(CheckSerializeParamsInstanceMethods)
       end
 
@@ -44,7 +44,7 @@ class Serega
 
       module ConfigInstanceMethods
         def context_metadata
-          ContextMetadataConfig.new(opts.fetch(:context_metadata))
+          @context_metadata ||= ContextMetadataConfig.new(opts.fetch(:context_metadata))
         end
       end
 
@@ -57,8 +57,8 @@ class Serega
         end
       end
 
-      module SeregaConvertInstanceMethods
-        def to_h
+      module SeregaSerializerInstanceMethods
+        def serialize(object)
           super.tap do |hash|
             add_context_metadata(hash)
           end

data/lib/serega/plugins/formatters/formatters.rb

@@ -7,6 +7,12 @@ class Serega
         :formatters
       end
 
+      def self.before_load_plugin(serializer_class, **opts)
+        if serializer_class.plugin_used?(:batch)
+          raise SeregaError, "Plugin `formatters` must be loaded before `batch`"
+        end
+      end
+
       def self.load_plugin(serializer_class, **_opts)
         serializer_class::SeregaConfig.include(ConfigInstanceMethods)
         serializer_class::SeregaAttribute.include(AttributeInstanceMethods)
@@ -35,21 +41,32 @@ class Serega
 
       module ConfigInstanceMethods
         def formatters
-          FormattersConfig.new(opts.fetch(:formatters))
+          @formatters ||= FormattersConfig.new(opts.fetch(:formatters))
         end
       end
 
       module AttributeInstanceMethods
-        def value_block
-          return @value_block if instance_variable_defined?(:@value_block)
+        def formatter
+          return @formatter if instance_variable_defined?(:@formatter)
+
+          @formatter = formatter_resolved
+        end
 
-          original_block = super
+        def formatter_resolved
           formatter = opts[:format]
-          return original_block unless formatter
+          return unless formatter
 
-          new_value_block = formatted_block(formatter, original_block)
+          formatter = self.class.serializer_class.config.formatters.opts.fetch(formatter) if formatter.is_a?(Symbol)
+          formatter
+        end
+
+        def value_block
+          return @value_block if instance_variable_defined?(:@value_block)
+          return @value_block = super unless formatter
+
+          new_value_block = formatted_block(formatter, super)
 
-          # Detect formatted :const value in advance
+          # Format :const value in advance
           if opts.key?(:const)
             const_value = new_value_block.call
             new_value_block = proc { const_value }
@@ -63,12 +80,7 @@ class Serega
         def formatted_block(formatter, original_block)
           proc do |object, context|
             value = original_block.call(object, context)
-
-            if formatter.is_a?(Symbol)
-              self.class.serializer_class.config.formatters.opts.fetch(formatter).call(value)
-            else
-              formatter.call(value)
-            end
+            formatter.call(value)
           end
         end
       end

data/lib/serega/plugins/hide_nil/hide_nil.rb

@@ -23,7 +23,7 @@ class Serega
       def self.load_plugin(serializer_class, **_opts)
         serializer_class::SeregaAttribute.include(AttributeMethods)
         serializer_class::CheckAttributeParams.include(CheckAttributeParamsInstanceMethods)
-        serializer_class::SeregaConvertItem.extend(SeregaConvertItemClassMethods)
+        serializer_class::SeregaObjectSerializer.include(SeregaObjectSerializerInstanceMethods)
       end
 
       def self.after_load_plugin(serializer_class, **opts)
@@ -66,11 +66,11 @@ class Serega
         end
       end
 
-      module SeregaConvertItemClassMethods
+      module SeregaObjectSerializerInstanceMethods
         private
 
-        def attach_value(value, *args)
-          super unless value.nil?
+        def attach_final_value(final_value, *)
+          super unless final_value.nil?
         end
       end
     end

data/lib/serega/plugins/metadata/metadata.rb

@@ -20,7 +20,7 @@ class Serega
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
         serializer_class::SeregaConfig.include(ConfigInstanceMethods)
-        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
+        serializer_class::SeregaSerializer.include(SeregaSerializerInstanceMethods)
 
         require_relative "./meta_attribute"
         require_relative "./validations/check_block"
@@ -52,7 +52,7 @@ class Serega
 
       module ConfigInstanceMethods
         def metadata
-          MetadataConfig.new(opts.fetch(:metadata))
+          @metadata ||= MetadataConfig.new(opts.fetch(:metadata))
         end
       end
 
@@ -104,26 +104,26 @@ class Serega
         end
       end
 
-      module SeregaConvertInstanceMethods
-        def to_h
-          hash = super
-          add_metadata(hash)
-          hash
+      module SeregaSerializerInstanceMethods
+        def serialize(object)
+          super.tap do |hash|
+            add_metadata(object, hash)
+          end
         end
 
         private
 
-        def add_metadata(hash)
+        def add_metadata(object, hash)
           self.class.serializer_class.meta_attributes.each_value do |meta_attribute|
-            metadata = meta_attribute_value(meta_attribute)
+            metadata = meta_attribute_value(object, meta_attribute)
             next unless metadata
 
             deep_merge_metadata(hash, metadata)
           end
         end
 
-        def meta_attribute_value(meta_attribute)
-          value = meta_attribute.value(object, opts[:context])
+        def meta_attribute_value(object, meta_attribute)
+          value = meta_attribute.value(object, context)
           return if meta_attribute.hide?(value)
 
           # Example:

data/lib/serega/plugins/preloads/lib/preloads_constructor.rb

@@ -16,6 +16,8 @@ class Serega
           # @return [Hash]
           #
           def call(map)
+            return FROZEN_EMPTY_HASH unless map
+
             preloads = {}
             append_many(preloads, map)
             preloads
@@ -24,17 +26,17 @@ class Serega
           private
 
           def append_many(preloads, map)
-            map.each do |attribute, nested_map|
-              current_preloads = attribute.preloads
+            map.each do |point|
+              current_preloads = point.attribute.preloads
               next unless current_preloads
 
-              has_nested = nested_map.any?
+              has_nested = point.has_nested_points?
               current_preloads = SeregaUtils::EnumDeepDup.call(current_preloads) if has_nested
               append_current(preloads, current_preloads)
               next unless has_nested
 
-              nested_preloads = nested(preloads, attribute.preloads_path)
-              append_many(nested_preloads, nested_map)
+              nested_preloads = nested(preloads, point.preloads_path)
+              append_many(nested_preloads, point.nested_points)
             end
           end
 
@@ -49,7 +51,7 @@ class Serega
           end
 
           def nested(preloads, path)
-            !path || path.empty? ? preloads : preloads.dig(*path)
+            (!path || path.empty?) ? preloads : preloads.dig(*path)
           end
         end
 

data/lib/serega/plugins/preloads/preloads.rb

@@ -29,6 +29,7 @@ class Serega
         serializer_class.include(InstanceMethods)
         serializer_class::SeregaAttribute.include(AttributeMethods)
         serializer_class::SeregaConfig.include(ConfigInstanceMethods)
+        serializer_class::SeregaMapPoint.include(MapPointMethods)
 
         serializer_class::CheckAttributeParams.include(CheckAttributeParamsInstanceMethods)
 
@@ -85,7 +86,7 @@ class Serega
 
       module ConfigInstanceMethods
         def preloads
-          PreloadsConfig.new(opts.fetch(:preloads))
+          @preloads ||= PreloadsConfig.new(opts.fetch(:preloads))
         end
       end
 
@@ -142,6 +143,16 @@ class Serega
         end
       end
 
+      module MapPointMethods
+        def preloads
+          @preloads ||= PreloadsConstructor.call(nested_points)
+        end
+
+        def preloads_path
+          attribute.preloads_path
+        end
+      end
+
       module CheckAttributeParamsInstanceMethods
         private
 

data/lib/serega/plugins/presenter/presenter.rb

@@ -35,7 +35,7 @@ class Serega
       #
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::SeregaConvertItem.extend(SeregaConvertItemClassMethods)
+        serializer_class::SeregaSerializer.include(SeregaSerializerInstanceMethods)
       end
 
       #
@@ -94,13 +94,14 @@ class Serega
         end
       end
 
-      # Includes methods to override SeregaConvertItem class
-      module SeregaConvertItemClassMethods
+      # Includes methods to override SeregaSerializer class
+      module SeregaSerializerInstanceMethods
         #
         # Replaces serialized object with Presenter.new(object)
         #
-        def call(object, *)
-          object = serializer_class::Presenter.new(object)
+        def serialize(object)
+          presenter_class = points.first.class.serializer_class::Presenter
+          object = presenter_class.new(object)
           super
         end
       end

data/lib/serega/plugins/root/root.rb

@@ -12,8 +12,8 @@ class Serega
 
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::SeregaConfig.include(SeregaConfigInstanceMethods)
-        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
+        serializer_class::SeregaConfig.include(ConfigInstanceMethods)
+        serializer_class::SeregaSerializer.include(SerializerInstanceMethods)
       end
 
       def self.after_load_plugin(serializer_class, **opts)
@@ -70,9 +70,9 @@ class Serega
         end
       end
 
-      module SeregaConfigInstanceMethods
+      module ConfigInstanceMethods
         def root
-          RootConfig.new(opts.fetch(:root))
+          @root ||= RootConfig.new(opts.fetch(:root))
         end
 
         def root=(value)
@@ -81,21 +81,21 @@ class Serega
         end
       end
 
-      module SeregaConvertInstanceMethods
-        def to_h
-          hash = super
-          root = build_root(opts)
-          hash = {root => hash} if root
-          hash
+      module SerializerInstanceMethods
+        def serialize(_object)
+          result = super
+          root = build_root(result, opts)
+          result = {root => result} if root
+          result
         end
 
         private
 
-        def build_root(opts)
+        def build_root(result, opts)
           return opts[:root] if opts.key?(:root)
 
           root = self.class.serializer_class.config.root
-          many? ? root.many : root.one
+          result.is_a?(Array) ? root.many : root.one
         end
       end
     end

data/lib/serega/plugins/string_modifiers/parse_string_modifiers.rb

@@ -53,7 +53,7 @@ class Serega
           name = attribute.to_sym
           attribute.clear
 
-          current_attrs = !path_stack || path_stack.empty? ? res : res.dig(*path_stack)
+          current_attrs = (!path_stack || path_stack.empty?) ? res : res.dig(*path_stack)
           current_attrs[name] = nested_attributes
 
           name

data/lib/serega/serializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Serega
+  class SeregaSerializer
+    module SeregaSerializerInstanceMethods
+      # @param context [Hash] Serialization context
+      # @param many [TrueClass|FalseClass] is object is enumerable
+      # @param points [Array<MapPoint>] Serialization points (attributes)
+      # @param opts [Hash] Any custom options
+      def initialize(context:, points:, many: nil, **opts)
+        @context = context
+        @points = points
+        @many = many
+        @opts = opts
+      end
+
+      # @param object [Object] Serialized object
+      def serialize(object)
+        self.class.serializer_class::SeregaObjectSerializer
+          .new(context: context, points: points, many: many, **opts)
+          .serialize(object)
+      end
+
+      private
+
+      attr_reader :context, :points, :many, :opts
+    end
+
+    extend Serega::SeregaHelpers::SerializerClassHelper
+    include SeregaSerializerInstanceMethods
+  end
+end

data/lib/serega.rb

@@ -37,8 +37,9 @@ require_relative "serega/validations/check_initiate_params"
 require_relative "serega/validations/check_serialize_params"
 
 require_relative "serega/config"
-require_relative "serega/convert"
-require_relative "serega/convert_item"
+require_relative "serega/object_serializer"
+require_relative "serega/serializer"
+require_relative "serega/map_point"
 require_relative "serega/map"
 require_relative "serega/plugins"
 
@@ -79,13 +80,17 @@ class Serega
       map_class.serializer_class = subclass
       subclass.const_set(:SeregaMap, map_class)
 
-      convert_class = Class.new(self::SeregaConvert)
-      convert_class.serializer_class = subclass
-      subclass.const_set(:SeregaConvert, convert_class)
+      map_point_class = Class.new(self::SeregaMapPoint)
+      map_point_class.serializer_class = subclass
+      subclass.const_set(:SeregaMapPoint, map_point_class)
 
-      convert_item_class = Class.new(self::SeregaConvertItem)
-      convert_item_class.serializer_class = subclass
-      subclass.const_set(:SeregaConvertItem, convert_item_class)
+      serega_serializer_class = Class.new(self::SeregaSerializer)
+      serega_serializer_class.serializer_class = subclass
+      subclass.const_set(:SeregaSerializer, serega_serializer_class)
+
+      object_serializer_class = Class.new(self::SeregaObjectSerializer)
+      object_serializer_class.serializer_class = subclass
+      subclass.const_set(:SeregaObjectSerializer, object_serializer_class)
 
       check_attribute_params_class = Class.new(self::CheckAttributeParams)
       check_attribute_params_class.serializer_class = subclass
@@ -208,7 +213,7 @@ class Serega
     # @param with [Array, Hash, String, Symbol] Attributes (usually hidden) to serialize additionally
     #
     def initialize(opts = FROZEN_EMPTY_HASH)
-      @opts = opts == FROZEN_EMPTY_HASH ? opts : prepare_modifiers(opts)
+      @opts = (opts == FROZEN_EMPTY_HASH) ? opts : prepare_modifiers(opts)
       self.class::CheckInitiateParams.new(@opts).validate if opts.fetch(:check_initiate_params) { config.check_initiate_params }
     end
 
@@ -224,7 +229,7 @@ class Serega
       self.class::CheckSerializeParams.new(opts).validate
       opts[:context] ||= {}
 
-      self.class::SeregaConvert.call(object, **opts, map: map)
+      self.class::SeregaSerializer.new(points: map, **opts).serialize(object)
     end
 
     # @see #call

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -21,21 +21,27 @@ files:
 - lib/serega.rb
 - lib/serega/attribute.rb
 - lib/serega/config.rb
-- lib/serega/convert.rb
-- lib/serega/convert_item.rb
 - lib/serega/errors.rb
 - lib/serega/helpers/serializer_class_helper.rb
 - lib/serega/json/adapter.rb
 - lib/serega/json/json.rb
 - lib/serega/json/oj.rb
 - lib/serega/map.rb
+- lib/serega/map_point.rb
+- lib/serega/object_serializer.rb
 - lib/serega/plugins.rb
 - 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/loader.rb
+- lib/serega/plugins/batch/lib/loaders.rb
+- lib/serega/plugins/batch/lib/plugins_extensions.rb
+- lib/serega/plugins/batch/lib/validations/check_batch_opt_key.rb
+- lib/serega/plugins/batch/lib/validations/check_batch_opt_loader.rb
+- lib/serega/plugins/batch/lib/validations/check_opt_batch.rb
 - lib/serega/plugins/context_metadata/context_metadata.rb
 - lib/serega/plugins/formatters/formatters.rb
 - lib/serega/plugins/hide_nil/hide_nil.rb
-- lib/serega/plugins/lazy/lazy.rb
 - lib/serega/plugins/metadata/meta_attribute.rb
 - lib/serega/plugins/metadata/metadata.rb
 - lib/serega/plugins/metadata/validations/check_block.rb
@@ -54,6 +60,7 @@ files:
 - lib/serega/plugins/root/root.rb
 - lib/serega/plugins/string_modifiers/parse_string_modifiers.rb
 - lib/serega/plugins/string_modifiers/string_modifiers.rb
+- lib/serega/serializer.rb
 - lib/serega/utils/enum_deep_dup.rb
 - lib/serega/utils/to_hash.rb
 - lib/serega/validations/attribute/check_block.rb

data/lib/serega/convert.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  class SeregaConvert
-    module SeregaConvertClassMethods
-      def call(object, **opts)
-        new(object, **opts).to_h
-      end
-    end
-
-    module SeregaConvertInstanceMethods
-      attr_reader :object, :opts
-
-      def initialize(object, **opts)
-        @object = object
-        @opts = opts
-      end
-
-      def to_h
-        many? ? many(object) : one(object) || {}
-      end
-
-      private
-
-      def many(objects)
-        objects.map { |obj| one(obj) }
-      end
-
-      def one(object)
-        self.class.serializer_class::SeregaConvertItem.call(object, opts[:context], opts[:map])
-      end
-
-      def many?
-        many = opts[:many]
-        return many unless many.nil?
-
-        object.is_a?(Enumerable)
-      end
-    end
-
-    extend Serega::SeregaHelpers::SerializerClassHelper
-    extend SeregaConvertClassMethods
-    include SeregaConvertInstanceMethods
-  end
-end

data/lib/serega/convert_item.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  class SeregaConvertItem
-    module SeregaConvertItemClassMethods
-      def call(object, context, map)
-        return unless object
-
-        map.each_with_object({}) do |(attribute, nested_attributes), hash|
-          value = attribute.value(object, context)
-          attach_value(value, hash, attribute, nested_attributes, context)
-        end
-      end
-
-      private
-
-      def attach_value(value, hash, attribute, nested_attributes, context)
-        hash[attribute.name] =
-          if nested_attributes.empty?
-            attribute.relation? ? FROZEN_EMPTY_HASH : value
-          elsif many?(attribute, value)
-            value.map { |val| call(val, context, nested_attributes) }
-          else
-            call(value, context, nested_attributes)
-          end
-      end
-
-      def many?(attribute, object)
-        is_many = attribute.many
-        is_many.nil? ? object.is_a?(Enumerable) : is_many
-      end
-    end
-
-    extend Serega::SeregaHelpers::SerializerClassHelper
-    extend SeregaConvertItemClassMethods
-  end
-end

data/lib/serega/plugins/lazy/lazy.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Lazy
-      def self.plugin_name
-        :lazy
-      end
-
-      def self.before_load_plugin(serializer_class, **opts)
-      end
-
-      def self.load_plugin(serializer_class, **_opts)
-        serializer_class.extend(ClassMethods)
-        serializer_class.include(InstanceMethods)
-      end
-
-      def self.after_load_plugin(serializer_class, **_opts)
-        serializer_class.config.attribute_keys << :lazy
-      end
-    end
-
-    module ClassMethods
-      def lazy(key:, buffer:, resolver:)
-        @lazy[key] = { buffer: buffer, resolver: resolver }
-      end
-    end
-
-    module InstanceMethods
-      def initialize(*args, **kwargs)
-        super
-        @lazy = {}
-      end
-
-      def to_h(*args, **kwargs)
-        result = super
-        lazy.each_key do |key, |
-          buffer = lazy.delete(key) # { val => [paths], val2 => [paths2] }
-          buffer_values = self.class.lazy[key][:resolver].(buffer.keys)
-
-          buffer_values.each do |key, resolved_value|
-            paths = buffer[key]
-            paths.each do |path|
-              result.dig(path[0, -2])
-              replace(result, buffer_values)
-        end
-
-      end
-    end
-
-    register_plugin(Metadata.plugin_name, Metadata)
-  end
-end