serega 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a8bc4f49c84bd623535d3134b77e01cd002b4a3fe6bea9b2dbc998e80911e53
-  data.tar.gz: e06e06c478dc605afa417e0a97289b2930b7ce084e3d57f07d1b3f94f7ff7717
+  metadata.gz: 11094f59dcd5d1d918604998ac267dbd13297bf0f70a9f3da5fd5ba74eb76b06
+  data.tar.gz: 97d1a419769b73937afde735e24210690e2f7702943d60db5be4252301e07255
 SHA512:
-  metadata.gz: 6b699d5ae9ed68da0147be26cd1f64ef5e26a99ce22b260889a7a831af8765f3fc02c02ce4c879672c719b4ad8e7c40aaf5903e3183bf770061e8cf54bcd37fc
-  data.tar.gz: a82645b1ac1b2c68fea64c49235d78b926608de0e035d7042cb37ab5836fe6885742d63b4317cceb91889d9b87a54af9f4b2e6de1455cbfee9f886f79396bdcf
+  metadata.gz: f9e3bfb207894f09c9c88658bad62e2a28e8b4d44648a74f807d332862b0cd7bdc67870f0d06786de0eb64537fd1a824c5d4f375406b71d18410b63c5a8c5320
+  data.tar.gz: 1171f2aabb7ce1c63a9e2f95f5413e9d80a882326ada4fac561b527c8a1adcc263ff19d6224eb070f0ebb333254ff48c9c7f56861ff6418732848cde3ffbc5b5

data/VERSION

@@ -1 +1 @@
-0.20.0
+0.20.1

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/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
 
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.1
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-02-25 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