serega 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a8bc4f49c84bd623535d3134b77e01cd002b4a3fe6bea9b2dbc998e80911e53
-  data.tar.gz: e06e06c478dc605afa417e0a97289b2930b7ce084e3d57f07d1b3f94f7ff7717
+  metadata.gz: 9ea0f19662815497e76a3ace9b247e90268f7c44a3cf917b97a186887043fc7b
+  data.tar.gz: fb13ebbaa26603c0eda053e78634aaecf1a8d040c73b5824892b03c2b0d2a70d
 SHA512:
-  metadata.gz: 6b699d5ae9ed68da0147be26cd1f64ef5e26a99ce22b260889a7a831af8765f3fc02c02ce4c879672c719b4ad8e7c40aaf5903e3183bf770061e8cf54bcd37fc
-  data.tar.gz: a82645b1ac1b2c68fea64c49235d78b926608de0e035d7042cb37ab5836fe6885742d63b4317cceb91889d9b87a54af9f4b2e6de1455cbfee9f886f79396bdcf
+  metadata.gz: a5847251f29dfd44a7da2cd9b5a99411aa430323d1d57e7706e176cc234f96ff7575298c5909c753aa4f3a2895d41a48c3c6a5b67a95e0bdac935f38c5c6f15d
+  data.tar.gz: 4fdf12f075816ea3ba155ace47b6f5e6c7b3b0bcd000179e43e4edf356e63b19360de227b6112b4fe98e310975da4afebc3d5c86476deadc749c4197330ddfd0

data/README.md

@@ -549,6 +549,9 @@ UserSerializer.to_h(user)
 # => preloads {users_stats: {}, albums: { downloads: {} }}
 ```
 
+For testing purposes preloading can be done manually with
+`#preload_association_to(obj)` instance method
+
 ### Plugin :batch
 
 Helps to omit N+1.

data/VERSION

@@ -1 +1 @@
-0.20.0
+0.21.0

data/lib/serega/object_serializer.rb

@@ -70,6 +70,7 @@ class Serega
 
       # Patched in:
       # - plugin :if (conditionally skips attaching)
+      # - plugin :batch :if extension (removes prepared key)
       def attach_final_value(final_value, point, container)
         container[point.name] = final_value
       end

data/lib/serega/plugins/activerecord_preloads/activerecord_preloads.rb

@@ -90,6 +90,22 @@ class Serega
       # Overrides Serega class instance methods
       #
       module InstanceMethods
+        #
+        # Preloads associations to object
+        #
+        # @param object [Object] Any object
+        # @return provided object
+        #
+        def preload_associations_to(object)
+          return object if object.nil? || (object.is_a?(Array) && object.empty?)
+
+          preloads = preloads() # `preloads()` method comes from :preloads plugin
+          return object if preloads.empty?
+
+          Preloader.preload(object, preloads)
+          object
+        end
+
         private
 
         #
@@ -97,18 +113,9 @@ class Serega
         # Preloads associations to object before serialization
         #
         def serialize(object, _opts)
-          object = add_preloads(object)
+          preload_associations_to(object)
           super
         end
-
-        def add_preloads(obj)
-          return obj if obj.nil? || (obj.is_a?(Array) && obj.empty?)
-
-          preloads = preloads() # `preloads()` method comes from :preloads plugin
-          return obj if preloads.empty?
-
-          Preloader.preload(obj, preloads)
-        end
       end
     end
 

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

@@ -105,6 +105,11 @@ class Serega
           serializer_class::SeregaAttribute.include(PluginsExtensions::Formatters::SeregaAttributeInstanceMethods)
         end
 
+        if serializer_class.plugin_used?(:if)
+          require_relative "lib/plugins_extensions/if"
+          serializer_class::SeregaObjectSerializer.include(PluginsExtensions::If::ObjectSerializerInstanceMethods123)
+        end
+
         if serializer_class.plugin_used?(:preloads)
           require_relative "lib/plugins_extensions/preloads"
           serializer_class::SeregaAttributeNormalizer.include(PluginsExtensions::Preloads::AttributeNormalizerInstanceMethods)

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Batch
+      #
+      # Extensions (mini-plugins) that are enabled when :batch plugin used with other plugins
+      #
+      module PluginsExtensions
+        #
+        # Extension that is used when :if plugin is loaded
+        #
+        module If
+          #
+          # SeregaObjectSerializer additional/patched class methods
+          #
+          # @see Serega::SeregaObjectSerializer
+          #
+          module ObjectSerializerInstanceMethods123
+            private
+
+            # Removes key added by `batch` plugin at the start of serialization to preserve attributes ordering
+            def attach_final_value(value, point, container)
+              container.delete(point.name) if super == SeregaPlugins::If::KEY_SKIPPED
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/serega/plugins/if/if.rb

@@ -42,11 +42,27 @@ class Serega
     #  end
     #
     module If
+      # This value must be returned to identify that serialization key was skipped
+      KEY_SKIPPED = :_key_skipped_with_serega_if_plugin
+
       # @return [Symbol] Plugin name
       def self.plugin_name
         :if
       end
 
+      # Checks requirements to load plugin
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param opts [Hash] plugin options
+      #
+      # @return [void]
+      #
+      def self.before_load_plugin(serializer_class, **opts)
+        if serializer_class.plugin_used?(:batch)
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded before the :batch plugin"
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
@@ -194,12 +210,13 @@ class Serega
         private
 
         def serialize_point(object, point, _container)
-          return unless point.satisfy_if_conditions?(object, context)
+          return KEY_SKIPPED unless point.satisfy_if_conditions?(object, context)
           super
         end
 
         def attach_final_value(value, point, _container)
-          return unless point.satisfy_if_value_conditions?(value, context)
+          return KEY_SKIPPED unless point.satisfy_if_value_conditions?(value, context)
+
           super
         end
       end

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

@@ -88,6 +88,10 @@ class Serega
             "  - :auto_preload_attributes_with_serializer [Boolean] - Automatically adds `preload: <attribute_name>` option to attributes with :serializer option specified\n" \
             "  - :auto_hide_attributes_with_preload [Boolean] - Automatically adds `hide: true` option to attributes with :preload option (specified manually or added automatically)"
         end
+
+        if serializer_class.plugin_used?(:batch)
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded before the :batch plugin"
+        end
       end
 
       #

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "stringio"
-
 class Serega
   module SeregaPlugins
     #
@@ -25,6 +23,14 @@ class Serega
       # Modifiers parser
       #
       class ParseStringModifiers
+        COMMA = ","
+        COMMA_CODEPOINT = COMMA.ord
+        LPAREN = "("
+        LPAREN_CODEPOINT = LPAREN.ord
+        RPAREN = ")"
+        RPAREN_CODEPOINT = RPAREN.ord
+        private_constant :COMMA, :LPAREN, :RPAREN, :COMMA_CODEPOINT, :LPAREN_CODEPOINT, :RPAREN_CODEPOINT
+
         class << self
           #
           # Parses string modifiers
@@ -40,45 +46,52 @@ class Serega
           #   parse("user,comments") => { user: {}, comments: {} }
           #   parse("user(comments(text))") => { user: { comments: { text: {} } } }
           def parse(fields)
-            res = {}
-            attribute = +""
-            char = +""
-            path_stack = nil
-            fields = StringIO.new(fields)
+            result = {}
+            attribute_storage = result
+            path_stack = (fields.include?(LPAREN) || fields.include?(RPAREN)) ? [] : nil
 
-            while fields.read(1, char)
-              case char
-              when ","
-                add_attribute(res, path_stack, attribute, FROZEN_EMPTY_HASH)
-              when ")"
-                add_attribute(res, path_stack, attribute, FROZEN_EMPTY_HASH)
-                path_stack&.pop
-              when "("
-                name = add_attribute(res, path_stack, attribute, {})
-                (path_stack ||= []).push(name) if name
-              else
-                attribute.insert(-1, char)
+            start_index = 0
+            end_index = 0
+            fields.each_codepoint do |codepoint|
+              case codepoint
+              when COMMA_CODEPOINT
+                attribute = extract_attribute(fields, start_index, end_index)
+                add_attribute(attribute_storage, attribute, FROZEN_EMPTY_HASH) if attribute
+                start_index = end_index + 1
+              when LPAREN_CODEPOINT
+                attribute = extract_attribute(fields, start_index, end_index)
+                if attribute
+                  attribute_storage = add_attribute(attribute_storage, attribute, {})
+                  path_stack.push(attribute)
+                end
+                start_index = end_index + 1
+              when RPAREN_CODEPOINT
+                attribute = extract_attribute(fields, start_index, end_index)
+                add_attribute(attribute_storage, attribute, FROZEN_EMPTY_HASH) if attribute
+                path_stack.pop
+                attribute_storage = dig?(result, path_stack)
+                start_index = end_index + 1
               end
+
+              end_index += 1
             end
 
-            add_attribute(res, path_stack, attribute, FROZEN_EMPTY_HASH)
+            attribute = extract_attribute(fields, start_index, end_index)
+            add_attribute(attribute_storage, attribute, FROZEN_EMPTY_HASH) if attribute
 
-            res
+            result
           end
 
           private
 
-          def add_attribute(res, path_stack, attribute, nested_attributes = FROZEN_EMPTY_HASH)
+          def extract_attribute(fields, start_index, end_index)
+            attribute = fields[start_index, end_index - start_index]
             attribute.strip!
-            return if attribute.empty?
-
-            name = attribute.to_sym
-            attribute.clear
-
-            current_attrs = dig?(res, path_stack)
-            current_attrs[name] = nested_attributes
+            attribute.empty? ? nil : attribute.to_sym
+          end
 
-            name
+          def add_attribute(storage, attribute, nested_attributes = FROZEN_EMPTY_HASH)
+            storage[attribute] = nested_attributes
           end
 
           def dig?(hash, path)

data/lib/serega.rb

@@ -167,6 +167,7 @@ class Serega
         modifiers_opts = FROZEN_EMPTY_HASH
         serialize_opts = nil
       else
+        opts.transform_keys!(&:to_sym)
         serialize_opts = opts.except(*initiate_keys)
         modifiers_opts = opts.slice(*initiate_keys)
       end
@@ -296,7 +297,14 @@ class Serega
     # @option opts [Boolean] :validate Validates provided modifiers (Default is true)
     #
     def initialize(opts = nil)
-      @opts = (opts.nil? || opts.empty?) ? FROZEN_EMPTY_HASH : parse_modifiers(opts)
+      @opts =
+        if opts.nil? || opts.empty?
+          FROZEN_EMPTY_HASH
+        else
+          opts.transform_keys!(&:to_sym)
+          parse_modifiers(opts)
+        end
+
       self.class::CheckInitiateParams.new(@opts).validate if opts&.fetch(:check_initiate_params) { config.check_initiate_params }
 
       @plan = self.class::SeregaPlan.call(@opts)
@@ -320,10 +328,10 @@ class Serega
     # @return [Hash] Serialization result
     #
     def call(object, opts = nil)
-      self.class::CheckSerializeParams.new(opts).validate if opts&.any?
-      opts ||= {}
-      opts[:context] ||= {}
+      opts = opts ? opts.transform_keys!(&:to_sym) : {}
+      self.class::CheckSerializeParams.new(opts).validate unless opts.empty?
 
+      opts[:context] ||= {}
       serialize(object, opts)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -54,6 +54,7 @@ files:
 - 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/if.rb
 - lib/serega/plugins/batch/lib/plugins_extensions/preloads.rb
 - lib/serega/plugins/batch/lib/validations/check_batch_opt_id_method.rb
 - lib/serega/plugins/batch/lib/validations/check_batch_opt_loader.rb
@@ -140,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: JSON Serializer