serega 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85e79f7011bb7c55c60c9b39e425faf9137fb4b2f2889332a2e75f1fea1268a7
-  data.tar.gz: 5358001a693ec3f6c40383cc12c8f44b37764bf5f1b9143bddba338756948e91
+  metadata.gz: 3a8bc4f49c84bd623535d3134b77e01cd002b4a3fe6bea9b2dbc998e80911e53
+  data.tar.gz: e06e06c478dc605afa417e0a97289b2930b7ce084e3d57f07d1b3f94f7ff7717
 SHA512:
-  metadata.gz: 66e705d78a97def601c4f3ad79b20a5599cd0b7885b26decea38437428ea18a9ac1d65a55d20042d2c79046343ec36c25ede2795ac1a697dd510976876a91eff
-  data.tar.gz: 2cb126604c9d0a8eb5679a85daa29bcd830996bca4820d8fadfec5847f78af74602cc1dc2693143cd86fa0160b0f6c61248fcf87a41d1e97ec5e732772962989
+  metadata.gz: 6b699d5ae9ed68da0147be26cd1f64ef5e26a99ce22b260889a7a831af8765f3fc02c02ce4c879672c719b4ad8e7c40aaf5903e3183bf770061e8cf54bcd37fc
+  data.tar.gz: a82645b1ac1b2c68fea64c49235d78b926608de0e035d7042cb37ab5836fe6885742d63b4317cceb91889d9b87a54af9f4b2e6de1455cbfee9f886f79396bdcf

data/README.md

@@ -301,7 +301,7 @@ fields_as_string = 'first_name,enemy'
 UserSerializer.new(only: fields).to_h(bruce)
 UserSerializer.to_h(bruce, only: fields)
 UserSerializer.to_h(bruce, only: fields_as_string)
-# => raises Serega::AttributeNotExist, "Attribute 'enemy' not exists"
+# => raises Serega::AttributeNotExist
 
 # With no existing attribute and disabled validation
 fields = %i[first_name enemy]
@@ -1074,7 +1074,10 @@ a single object.
 
 - The `Serega::SeregaError` is a base error raised by this gem.
 - The `Serega::AttributeNotExist` error is raised when validating attributes in
-  `:only, :except, :with` modifiers
+  `:only, :except, :with` modifiers. This error contains additional methods:
+
+   - `#serializer` - shows current serializer
+   - `#attributes` - lists not existing attributes
 
 ## Release
 

data/VERSION

@@ -1 +1 @@
-0.19.0
+0.20.0

data/lib/serega/config.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "forwardable"
-
 class Serega
   #
   # Stores serialization config

data/lib/serega/errors.rb

@@ -11,5 +11,13 @@ class Serega
   # @example
   #   Serega.new(only: 'FOO')
   #   # => Attribute 'FOO' not exists (Serega::AttributeNotExist)
-  class AttributeNotExist < SeregaError; end
+  class AttributeNotExist < SeregaError
+    attr_reader :serializer, :attributes
+
+    def initialize(message = nil, serializer = nil, attributes = nil)
+      super(message)
+      @serializer = serializer
+      @attributes = attributes
+    end
+  end
 end

data/lib/serega/object_serializer.rb

@@ -38,8 +38,8 @@ class Serega
 
       private
 
-      def serialize_array(object)
-        object.map { |obj| serialize_object(obj) }
+      def serialize_array(objects)
+        objects.map { |object| serialize_object(object) }
       end
 
       # Patched in:
@@ -79,11 +79,16 @@ class Serega
       end
 
       def relation_value(value, point)
-        child_plan = point.child_plan
-        child_serializer = point.child_object_serializer
-        child_many = point.many
-        serializer = child_serializer.new(context: context, plan: child_plan, many: child_many, **opts)
-        serializer.serialize(value)
+        child_serializer(point).serialize(value)
+      end
+
+      def child_serializer(point)
+        point.child_object_serializer.new(
+          context: context,
+          plan: point.child_plan,
+          many: point.many,
+          **opts
+        )
       end
 
       def array?(object, many)

data/lib/serega/plan_point.rb

@@ -9,8 +9,6 @@ class Serega
     # SeregaPlanPoint instance methods
     #
     module InstanceMethods
-      extend Forwardable
-
       # Link to current plan this point belongs to
       # @return [SeregaAttribute] Current plan
       attr_reader :plan
@@ -27,20 +25,6 @@ class Serega
       # @return [Hash] Attributes to serialize
       attr_reader :modifiers
 
-      # @!method name
-      #   Attribute `name`
-      #   @see SeregaAttribute::AttributeInstanceMethods#name
-      # @!method value
-      #   Attribute `value` block
-      #   @see SeregaAttribute::AttributeInstanceMethods#value
-      # @!method many
-      #   Attribute `many` option
-      #   @see SeregaAttribute::AttributeInstanceMethods#many
-      # @!method serializer
-      #   Attribute `serializer` option
-      #   @see SeregaAttribute::AttributeInstanceMethods#serializer
-      def_delegators :@attribute, :name, :value, :many, :serializer
-
       #
       # Initializes plan point
       #
@@ -60,6 +44,30 @@ class Serega
         set_normalized_vars
       end
 
+      # Attribute `value`
+      # @see SeregaAttribute::AttributeInstanceMethods#value
+      def value(obj, ctx)
+        attribute.value(obj, ctx)
+      end
+
+      # Attribute `name`
+      # @see SeregaAttribute::AttributeInstanceMethods#value
+      def name
+        attribute.name
+      end
+
+      # Attribute `many` option
+      # @see SeregaAttribute::AttributeInstanceMethods#many
+      def many
+        attribute.many
+      end
+
+      # Attribute `serializer` option
+      # @see SeregaAttribute::AttributeInstanceMethods#serializer
+      def serializer
+        attribute.serializer
+      end
+
       #
       # @return [SeregaObjectSerializer] object serializer for child plan
       #

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

@@ -54,17 +54,21 @@ class Serega
       # Checks requirements to load plugin
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] plugins options
+      # @param opts [Hash] plugin options
       #
       # @return [void]
       #
-      def self.before_load_plugin(serializer_class, **_opts)
+      def self.before_load_plugin(serializer_class, **opts)
+        opts.each_key do |key|
+          raise SeregaError, "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. No options are allowed"
+        end
+
         unless serializer_class.plugin_used?(:preloads)
-          raise SeregaError, "Please load `plugin :preloads` first"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded after the :preloads plugin. Please load the :preloads plugin first"
         end
 
         if serializer_class.plugin_used?(:batch)
-          raise SeregaError, "Plugin `activerecord_preloads` must be loaded before `batch`"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded before the :batch plugin"
         end
       end
 
@@ -72,7 +76,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -25,11 +25,30 @@ class Serega
         :batch
       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)
+        allowed_keys = %i[auto_hide id_method]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :auto_hide [Boolean] - Marks attribute as hidden when it has :batch loader specified\n" \
+            "  - :id_method [Symbol, #call] - Specified the default method to use to find object identifier"
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -60,7 +79,7 @@ class Serega
       # Runs callbacks after plugin was attached
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/camel_case/camel_case.rb

@@ -48,11 +48,29 @@ class Serega
         :camel_case
       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)
+        allowed_keys = %i[transform]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :transform [#call] - Custom transformation"
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -66,7 +84,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -30,13 +30,22 @@ class Serega
       # Checks requirements and loads additional plugins
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #
       def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[context_metadata_key]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :context_metadata_key [Symbol] - The key name that must be used to add metadata. Default is :meta."
+        end
+
         unless serializer_class.plugin_used?(:root)
-          raise SeregaError, "Please load :root plugin first so we can wrap serialization response into top-level hash to add metadata there"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded after the :root plugin. Please load the :root plugin first"
         end
       end
 
@@ -44,7 +53,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -58,7 +67,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/depth_limit/depth_limit.rb

@@ -41,11 +41,29 @@ class Serega
         :depth_limit
       end
 
+      # Checks requirements
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param opts [Hash] Plugin options
+      #
+      # @return [void]
+      #
+      def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[limit]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :limit [Integer] - Maximum serialization depth."
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -58,7 +76,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/explicit_many_option/explicit_many_option.rb

@@ -35,7 +35,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -51,13 +51,22 @@ class Serega
       # Checks requirements and loads additional plugins
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #
       def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[formatters]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :formatters [Hash<Symbol, #call>] - Formatters (names and according callable values)"
+        end
+
         if serializer_class.plugin_used?(:batch)
-          raise SeregaError, "Plugin `formatters` must be loaded before `batch`"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded before the :batch plugin"
         end
       end
 
@@ -65,7 +74,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -79,7 +88,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -51,7 +51,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -72,7 +72,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -65,7 +65,7 @@ class Serega
           def normalize_block(value, const, block)
             return proc { const } if const
 
-            callable = (value || block)
+            callable = value || block
             params_count = SeregaUtils::ParamsCount.call(callable, max_count: 2)
 
             case params_count

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

@@ -46,13 +46,13 @@ class Serega
       # Checks requirements and loads additional plugins
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] loaded plugins opts
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
       def self.before_load_plugin(serializer_class, **_opts)
         unless serializer_class.plugin_used?(:root)
-          raise SeregaError, "Please load :root plugin first so we can wrap serialization response into top-level hash to add metadata there"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded after the :root plugin. Please load the :root plugin first"
         end
       end
 
@@ -60,7 +60,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -87,7 +87,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] loaded plugins opts
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -51,7 +51,7 @@ class Serega
             opts.fetch(method_name)
           end
 
-          define_method("#{method_name}=") do |value|
+          define_method(:"#{method_name}=") do |value|
             raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
             opts[method_name] = value
           end

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

@@ -70,11 +70,31 @@ class Serega
         :preloads
       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)
+        allowed_keys = DEFAULT_CONFIG.keys
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :auto_preload_attributes_with_delegate [Boolean] - Automatically adds `preload: <delegate_to>` option to attributes with :delegate option specified\n" \
+            "  - :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
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -104,7 +124,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -29,7 +29,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -42,7 +42,7 @@ class Serega
       # Runs callbacks after plugin was attached
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] loaded plugins opts
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

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

@@ -60,11 +60,31 @@ class Serega
         :root
       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)
+        allowed_keys = %i[root root_one root_many]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :root [String, Symbol, nil] Specifies common root keyword used when serializing one or multiple objects\n" \
+            "  - :root_one [String, Symbol, nil] Specifies root keyword used when serializing one object\n" \
+            "  - :root_many [String, Symbol, nil] Specifies root keyword used when serializing multiple objects" \
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -78,7 +98,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -102,9 +122,9 @@ class Serega
         #
         # Configures response root key
         #
-        # @param root [String, Symbol, nil] Specifies common root when serializing one or multiple objects
-        # @param one [String, Symbol, nil] Specifies root when serializing one object
-        # @param many [String, Symbol, nil] Specifies root when serializing multiple objects
+        # @param root [String, Symbol, nil] Specifies common root keyword used when serializing one or multiple objects
+        # @param one [String, Symbol, nil] Specifies root keyword used when serializing one object
+        # @param many [String, Symbol, nil] Specifies root keyword used when serializing multiple objects
         #
         # @return [Hash] Configured root names
         #

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

@@ -12,7 +12,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/validations/initiate/check_modifiers.rb

@@ -27,7 +27,7 @@ class Serega
           validate(serializer_class, with) if with
           validate(serializer_class, except) if except
 
-          raise_errors if any_error?
+          raise_errors(serializer_class) if any_error?
         end
 
         private
@@ -66,12 +66,19 @@ class Serega
         end
 
         def save_error(name)
-          full_attribute_name = [*parents_names, name].join(".")
-          error_attributes << full_attribute_name
+          error_attributes << build_full_attribute_name(*parents_names, name)
         end
 
-        def raise_errors
-          raise Serega::AttributeNotExist, "Not existing attributes: #{error_attributes.join(", ")}"
+        def build_full_attribute_name(*names)
+          head, *nested = *names
+          result = head.to_s # names are symbols, we need not frozen string
+          nested.each { |nested_name| result << "(" << nested_name.to_s }
+          nested.each { result << ")" }
+          result
+        end
+
+        def raise_errors(serializer_class)
+          raise Serega::AttributeNotExist.new("Not existing attributes: #{error_attributes.join(", ")}", serializer_class, error_attributes)
         end
 
         def any_error?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-17 00:00:00.000000000 Z
+date: 2023-12-28 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: JSON Serializer