serega 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52535c7fab3897f65aec4e156ab5681e8595b4519df1e79a777688cee486a480
-  data.tar.gz: 16adbd9f036b0e23928049df873966f264db1004d2c4c1bc9e28422d687efd12
+  metadata.gz: d780c3d344370b36d9e6db64dfdfa08878bfe32885469610ac2314638c878d87
+  data.tar.gz: d282c6466f7b7205a7b524999b85a3e928d79c00ee11445abd26582e0146842c
 SHA512:
-  metadata.gz: 93a6aaefdf954556e31bd604ead1e376d5ffbb74225251e635bf5133af53da26f47e924f1f88349fa4656e228ddca573347d9f8fa15cc30bc6052f7e5dfec3bd
-  data.tar.gz: c84135d04c79aae1ccd03a3f3ac7dbed53dbf75165575afbb61ad6e32a558318cac2a8311c31b76df90fb74823facdf4677821d8f7ae8284f04782d33b04ad41
+  metadata.gz: e2a161487df001b0074d1864770a7dfecd77ef788e187de6e460cd3d2856162cba8777eb807a65a8d4d49471bb50380fc49ffd17f36c16eb52a2ab8b84ed7991
+  data.tar.gz: 4a672090d0893ef8d3945b2528fc9861d245833ec4b21074b73481ab7acbf8fa5207c786cad8496bf022070f3341339522bbf4970c7a554cfa543f002f51f504

data/README.md

@@ -888,6 +888,30 @@ Look at [select serialized fields](#selecting-fields) for `:hide` usage examples
  end
 ```
 
+### Plugin :explicit_many_option
+
+Plugin requires to add :many option when adding relationships
+(relationships are attributes with :serializer option specified)
+
+Adding this plugin makes it clearer to find if relationship returns array or single
+object
+
+```ruby
+  class BaseSerializer < Serega
+    plugin :explicit_many_option
+  end
+
+  class UserSerializer < BaseSerializer
+    attribute :name
+  end
+
+  class PostSerializer < BaseSerializer
+    attribute :text
+    attribute :user, serializer: UserSerializer, many: false
+    attribute :comments, serializer: PostSerializer, many: true
+  end
+```
+
 ## Errors
 
 - `Serega::SeregaError` is a base error raised by this gem.

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.15.0

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    #
+    # Plugin :explicit_many_option
+    #
+    # Plugin requires to add :many option when adding relationships
+    # (relationships are attributes with :serializer option specified)
+    #
+    # Adding this plugin makes it clearer to find if relationship returns array or single object
+    #
+    # @example
+    #   class BaseSerializer < Serega
+    #     plugin :explicit_many_option
+    #   end
+    #
+    #   class UserSerializer < BaseSerializer
+    #     attribute :name
+    #   end
+    #
+    #   class PostSerializer < BaseSerializer
+    #     attribute :text
+    #     attribute :user, serializer: UserSerializer, many: false
+    #     attribute :comments, serializer: PostSerializer, many: true
+    #   end
+    #
+    module ExplicitManyOption
+      # @return [Symbol] Plugin name
+      def self.plugin_name
+        :explicit_many_option
+      end
+
+      #
+      # Applies plugin code to specific serializer
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param _opts [Hash] Loaded plugins options
+      #
+      # @return [void]
+      #
+      def self.load_plugin(serializer_class, **_opts)
+        require_relative "./validations/check_opt_many"
+
+        serializer_class::CheckAttributeParams.include(CheckAttributeParamsInstanceMethods)
+      end
+
+      #
+      # Serega::SeregaValidations::CheckAttributeParams additional/patched class methods
+      #
+      # @see Serega::SeregaValidations::CheckAttributeParams
+      #
+      module CheckAttributeParamsInstanceMethods
+        private
+
+        def check_opts
+          super
+
+          CheckOptMany.call(opts)
+        end
+      end
+    end
+
+    register_plugin(ExplicitManyOption.plugin_name, ExplicitManyOption)
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module ExplicitManyOption
+      #
+      # Validator for attribute :many option
+      #
+      class CheckOptMany
+        class << self
+          #
+          # Checks attribute :many option must be provided with relations
+          #
+          # @param opts [Hash] Attribute options
+          #
+          # @raise [SeregaError] Attribute validation error
+          #
+          # @return [void]
+          #
+          def call(opts)
+            serializer = opts[:serializer]
+            return unless serializer
+
+            many_option_exists = opts.key?(:many)
+            return if many_option_exists
+
+            raise SeregaError,
+              "Attribute option :many [Boolean] must be provided" \
+              " for attributes with :serializer option"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,11 +11,11 @@ class Serega
         attr_reader :opts
 
         #
-        # Initializes context_metadata config object
+        # Initializes PreloadsConfig object
         #
         # @param opts [Hash] options
         #
-        # @return [Serega::SeregaPlugins::Metadata::MetadataConfig]
+        # @return [Serega::SeregaPlugins::Preloads::PreloadsConfig]
         #
         def initialize(opts)
           @opts = opts

data/lib/serega/validations/attribute/check_opt_many.rb

@@ -7,17 +7,34 @@ class Serega
       # Attribute `:many` option validator
       #
       class CheckOptMany
-        #
-        # Checks attribute :many option
-        #
-        # @param opts [Hash] Attribute options
-        #
-        # @raise [SeregaError] SeregaError that option has invalid value
-        #
-        # @return [void]
-        #
-        def self.call(opts)
-          Utils::CheckOptIsBool.call(opts, :many)
+        class << self
+          #
+          # Checks attribute :many option
+          #
+          # @param opts [Hash] Attribute options
+          #
+          # @raise [SeregaError] SeregaError that option has invalid value
+          #
+          # @return [void]
+          #
+          def call(opts)
+            return unless opts.key?(:many)
+
+            check_many_option_makes_sence(opts)
+            Utils::CheckOptIsBool.call(opts, :many)
+          end
+
+          private
+
+          def check_many_option_makes_sence(opts)
+            return if many_option_makes_sence?(opts)
+
+            raise SeregaError, "Option :many can be provided only together with :serializer or :batch option"
+          end
+
+          def many_option_makes_sence?(opts)
+            opts[:serializer] || opts[:batch]
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Andrey Glushkov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -59,6 +59,8 @@ files:
 - 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/explicit_many_option/explicit_many_option.rb
+- lib/serega/plugins/explicit_many_option/validations/check_opt_many.rb
 - lib/serega/plugins/formatters/formatters.rb
 - lib/serega/plugins/if/if.rb
 - lib/serega/plugins/if/validations/check_opt_if.rb
@@ -117,7 +119,7 @@ metadata:
   source_code_uri: https://github.com/aglushkov/serega
   documentation_uri: https://www.rubydoc.info/gems/serega
   changelog_uri: https://github.com/aglushkov/serega/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: JSON Serializer
 test_files: []