serega 0.14.0 → 0.16.0

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

@@ -27,7 +27,7 @@ class Serega
           private
 
           def check_usage_with_other_params(opts, block)
-            raise SeregaError, "Option :value can not be used together with option :key" if opts.key?(:key)
+            raise SeregaError, "Option :value can not be used together with option :method" if opts.key?(:method)
             raise SeregaError, "Option :value can not be used together with option :const" if opts.key?(:const)
             raise SeregaError, "Option :value can not be used together with block" if block
           end

data/lib/serega/validations/check_attribute_params.rb

@@ -58,12 +58,12 @@ class Serega
         # - plugin :if (checks :if, :if_value, :unless, :unless_value options)
         # - plugin :preloads (checks :preload option)
         def check_opts
-          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys)
+          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys, :attribute)
 
           Attribute::CheckOptConst.call(opts, block)
           Attribute::CheckOptDelegate.call(opts, block)
           Attribute::CheckOptHide.call(opts)
-          Attribute::CheckOptKey.call(opts, block)
+          Attribute::CheckOptMethod.call(opts, block)
           Attribute::CheckOptMany.call(opts)
           Attribute::CheckOptSerializer.call(opts)
           Attribute::CheckOptValue.call(opts, block)

data/lib/serega/validations/check_initiate_params.rb

@@ -35,7 +35,7 @@ class Serega
         private
 
         def check_allowed_keys
-          Utils::CheckAllowedKeys.call(opts, serializer_class.config.initiate_keys)
+          Utils::CheckAllowedKeys.call(opts, serializer_class.config.initiate_keys, :initiate)
         end
 
         def check_modifiers

data/lib/serega/validations/check_serialize_params.rb

@@ -33,7 +33,7 @@ class Serega
         private
 
         def check_opts
-          Utils::CheckAllowedKeys.call(opts, serializer_class.config.serialize_keys)
+          Utils::CheckAllowedKeys.call(opts, serializer_class.config.serialize_keys, :serialize)
 
           Utils::CheckOptIsHash.call(opts, :context)
           Utils::CheckOptIsBool.call(opts, :many)

data/lib/serega/validations/utils/check_allowed_keys.rb

@@ -18,11 +18,13 @@ class Serega
         # @raise [Serega::SeregaError] error when any hash key is not allowed
         #
         # @return [void]
-        def self.call(opts, allowed_keys)
+        def self.call(opts, allowed_keys, parameter_name)
           opts.each_key do |key|
             next if allowed_keys.include?(key)
 
-            raise SeregaError, "Invalid option #{key.inspect}. Allowed options are: #{allowed_keys.map(&:inspect).join(", ")}"
+            raise SeregaError,
+              "Invalid #{parameter_name} option #{key.inspect}." \
+              " Allowed options are: #{allowed_keys.map(&:inspect).sort.join(", ")}"
           end
         end
       end

data/lib/serega.rb

@@ -32,8 +32,8 @@ require_relative "serega/validations/attribute/check_name"
 require_relative "serega/validations/attribute/check_opt_const"
 require_relative "serega/validations/attribute/check_opt_hide"
 require_relative "serega/validations/attribute/check_opt_delegate"
-require_relative "serega/validations/attribute/check_opt_key"
 require_relative "serega/validations/attribute/check_opt_many"
+require_relative "serega/validations/attribute/check_opt_method"
 require_relative "serega/validations/attribute/check_opt_serializer"
 require_relative "serega/validations/attribute/check_opt_value"
 require_relative "serega/validations/initiate/check_modifiers"
@@ -172,7 +172,20 @@ class Serega
       new(modifiers_opts).to_h(object, serialize_opts)
     end
 
-    # @see #call
+    #
+    # Serializes provided object to Hash
+    #
+    # @param object [Object] Serialized object
+    # @param opts [Hash, nil] Serializer modifiers and other instantiating options
+    # @option opts [Array, Hash, String, Symbol] :only The only attributes to serialize
+    # @option opts [Array, Hash, String, Symbol] :except Attributes to hide
+    # @option opts [Array, Hash, String, Symbol] :with Attributes (usually hidden) to serialize additionally
+    # @option opts [Boolean] :validate Validates provided modifiers (Default is true)
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
+    #
+    # @return [Hash] Serialization result
+    #
     def to_h(object, opts = nil)
       call(object, opts)
     end
@@ -283,8 +296,17 @@ class Serega
     def initialize(opts = nil)
       @opts = (opts.nil? || opts.empty?) ? FROZEN_EMPTY_HASH : parse_modifiers(opts)
       self.class::CheckInitiateParams.new(@opts).validate if opts&.fetch(:check_initiate_params) { config.check_initiate_params }
+
+      @plan = self.class::SeregaPlan.call(@opts)
     end
 
+    #
+    # Plan for serialization.
+    # This plan can be traversed to find serialized attributes and nested attributes.
+    #
+    # @return [Serega::SeregaPlan] Serialization plan
+    attr_reader :plan
+
     #
     # Serializes provided object to Hash
     #
@@ -338,15 +360,6 @@ class Serega
       config.from_json.call(json)
     end
 
-    #
-    # Plan for serialization.
-    # This plan can be traversed to find serialized attributes and nested attributes.
-    #
-    # @return [Array<Serega::SeregaPlanPoint>] plan
-    def plan
-      @plan ||= self.class::SeregaPlan.call(opts)
-    end
-
     private
 
     attr_reader :opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-10-14 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -58,7 +58,9 @@ files:
 - 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/camel_case/camel_case.rb
 - lib/serega/plugins/context_metadata/context_metadata.rb
+- lib/serega/plugins/depth_limit/depth_limit.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
@@ -74,9 +76,6 @@ files:
 - lib/serega/plugins/metadata/validations/check_opt_hide_nil.rb
 - lib/serega/plugins/metadata/validations/check_opts.rb
 - lib/serega/plugins/metadata/validations/check_path.rb
-- lib/serega/plugins/openapi/lib/modules/config.rb
-- lib/serega/plugins/openapi/lib/openapi_config.rb
-- lib/serega/plugins/openapi/openapi.rb
 - lib/serega/plugins/preloads/lib/format_user_preloads.rb
 - lib/serega/plugins/preloads/lib/modules/attribute.rb
 - lib/serega/plugins/preloads/lib/modules/attribute_normalizer.rb
@@ -102,8 +101,8 @@ files:
 - lib/serega/validations/attribute/check_opt_const.rb
 - lib/serega/validations/attribute/check_opt_delegate.rb
 - lib/serega/validations/attribute/check_opt_hide.rb
-- lib/serega/validations/attribute/check_opt_key.rb
 - lib/serega/validations/attribute/check_opt_many.rb
+- lib/serega/validations/attribute/check_opt_method.rb
 - lib/serega/validations/attribute/check_opt_serializer.rb
 - lib/serega/validations/attribute/check_opt_value.rb
 - lib/serega/validations/check_attribute_params.rb

data/lib/serega/plugins/openapi/lib/modules/config.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module OpenAPI
-      #
-      # Config class additional/patched instance methods
-      #
-      # @see Serega::SeregaConfig
-      #
-      module ConfigInstanceMethods
-        #
-        # Returns openapi plugin config
-        #
-        # @return [Serega::SeregaPlugins::OpenAPI::OpenAPIConfig] configuration for openapi plugin
-        #
-        def openapi
-          @openapi ||= OpenAPIConfig.new(self.class.serializer_class, opts.fetch(:openapi))
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/openapi/lib/openapi_config.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module OpenAPI
-      #
-      # OpenAPI plugin config
-      #
-      class OpenAPIConfig
-        attr_reader :serializer_class, :opts
-
-        def initialize(serializer_class, opts)
-          @serializer_class = serializer_class
-          @opts = opts
-        end
-
-        #
-        # Saves new properties
-        #
-        # @param new_properties [Hash] new properties
-        #
-        # @return [Hash] OpenAPI properties
-        #
-        def properties(new_properties = FROZEN_EMPTY_HASH)
-          properties = opts[:properties]
-          return properties if new_properties.empty?
-
-          new_properties = SeregaUtils::EnumDeepDup.call(new_properties)
-          symbolize_keys!(new_properties)
-
-          new_properties.each do |attribute_name, new_attribute_properties|
-            check_attribute_exists(attribute_name)
-            check_properties_is_a_hash(attribute_name, new_attribute_properties)
-
-            properties[attribute_name] = symbolize_keys!(new_attribute_properties)
-          end
-        end
-
-        #
-        # @return [#call] builder of `$ref` attribute
-        #
-        def ref_builder
-          opts[:ref_builder]
-        end
-
-        #
-        # Sets new $ref option builder
-        #
-        # @param builder [#call] Callable object that accepts serializer_class and constructs $ref option string
-        #
-        # @return Specified new builder
-        #
-        def ref_builder=(builder)
-          raise SeregaError, "ref_builder must respond to #call" unless builder.respond_to?(:call)
-          opts[:ref_builder] = builder
-        end
-
-        #
-        # @return [#call] builder of schema name
-        #
-        def schema_name_builder
-          opts[:schema_name_builder]
-        end
-
-        #
-        # Sets new schema_name_builder
-        #
-        # @param builder [#call] Callable object that accepts serializer_class and
-        #   constructs schema name to use in schemas list and in $ref option
-        #
-        # @return Specified new builder
-        #
-        def schema_name_builder=(builder)
-          raise SeregaError, "schema_name_builder must respond to #call" unless builder.respond_to?(:call)
-          opts[:schema_name_builder] = builder
-        end
-
-        private
-
-        def check_attribute_exists(attribute_name)
-          return if serializer_class.attributes.key?(attribute_name)
-
-          raise SeregaError, "No attribute with name :#{attribute_name}"
-        end
-
-        def check_properties_is_a_hash(attribute_name, new_attribute_properties)
-          return if new_attribute_properties.is_a?(Hash)
-
-          raise SeregaError, "Property #{attribute_name} value must be a Hash," \
-            " but #{new_attribute_properties.inspect} was provided"
-        end
-
-        def symbolize_keys!(opts)
-          opts.transform_keys! do |key|
-            key.to_sym
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/openapi/openapi.rb

@@ -1,245 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  #
-  # Utility class to build OpenAPI schemas
-  #
-  class OpenAPI
-    #
-    # Constructs OpenAPI schemas for multiple serializers
-    #
-    # @params serializers [Class<Serega>] Serializers tobuild schemas,
-    #   by default it is all serializers with :openapi plugin enabled
-    #
-    # @return [Hash] Schemas hash
-    #
-    def self.schemas(serializers = self.serializers)
-      serializers.each_with_object({}) do |serializer_class, schemas|
-        schema = serializer_class.openapi_schema
-        schema_name = serializer_class.openapi_schema_name
-        schemas[schema_name] = schema
-      end
-    end
-
-    #
-    # Returns list of serializers with :openapi plugin
-    #
-    def self.serializers
-      @serializers ||= []
-    end
-  end
-
-  module SeregaPlugins
-    #
-    # Plugin :openapi
-    #
-    # Helps to build OpenAPI schemas
-    #
-    # This schemas can be easielty used with "rswag" gem by adding them to "config.swagger_docs"
-    #   https://github.com/rswag/rswag#referenced-parameters-and-schema-definitions
-    #
-    # This plugin only adds type "object" or "array" for relationships and marks
-    # attributes as **required** if they have no :hide option set.
-    #
-    # OpenAPI properties will have no any "type" or other options specified by default,
-    # you should provide them in 'YourSerializer.openapi_properties' method.
-    # `openapi_properties` can be specified multiple time, in this case they wil be merged.
-    #
-    # After enabling this plugin attributes with :serializer option will have
-    # to have :many option set to construct "object" or "array" openapi type for relationships.
-    #
-    # OpenAPI `$ref` property will be added automatically for all relationships.
-    #
-    # Example constructing all serializers schemas:
-    #   `Serega::OpenAPI.schemas`
-    #
-    # Example constructing specific serializers schemas:
-    #   `Serega::OpenAPI.schemas(Serega::OpenAPI.serializers - [MyBaseSerializer])`
-    #
-    # Example constructing one serializer schema:
-    #   `SomeSerializer.openapi_schema`
-    #
-    # @example
-    #   class BaseSerializer < Serega
-    #     plugin :openapi
-    #   end
-    #
-    #   class UserSerializer < BaseSerializer
-    #     attribute :name
-    #
-    #     openapi_properties(
-    #       name: { type: :string }
-    #     )
-    #   end
-    #
-    #   class PostSerializer < BaseSerializer
-    #     attribute :text
-    #     attribute :user, serializer: UserSerializer, many: false
-    #     attribute :comments, serializer: PostSerializer, many: true, hide: true
-    #
-    #     openapi_properties(
-    #       text: { type: :string },
-    #       user: { type: 'object' }, # `$ref` option will be added automatically when constructing schema
-    #       comments: { type: 'array' } # `items` option with `$ref` will be added automatically when constructing schema
-    #     )
-    #   end
-    #
-    #   puts Serega::OpenAPI.schemas
-    #   =>
-    #   {
-    #     "PostSerializer" => {
-    #       type: "object",
-    #       properties: {
-    #         text: {type: "string"},
-    #         user: {:$ref => "#/components/schemas/UserSerializer"},
-    #         comments: {type: "array", items: {:$ref => "#/components/schemas/PostSerializer"}}
-    #       },
-    #       required: [:text, :comments],
-    #       additionalProperties: false
-    #     },
-    #     "UserSerializer" => {
-    #       type: "object",
-    #       properties: {
-    #         name: {type: "string"}
-    #       },
-    #       required: [:name],
-    #       additionalProperties: false
-    #     }
-    #   }
-    #
-    module OpenAPI
-      # Builder for schema name (used is schemas list). Returns serializer class name
-      DEFAULT_SCHEMA_NAME_BUILDER = ->(serializer_class) { serializer_class.name }
-
-      # Builder for $ref openapi property
-      DEFAULT_REF_BUILDER = ->(serializer_class) { "#/components/schemas/#{serializer_class.openapi_schema_name}" }
-
-      # @return [Symbol] Plugin name
-      def self.plugin_name
-        :openapi
-      end
-
-      # Checks requirements and loads additional plugins
-      #
-      # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
-      #
-      # @return [void]
-      #
-      def self.before_load_plugin(serializer_class, **opts)
-        unless serializer_class.plugin_used?(:explicit_many_option)
-          serializer_class.plugin :explicit_many_option
-        end
-      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 "./lib/modules/config"
-        require_relative "./lib/openapi_config"
-
-        serializer_class.extend(ClassMethods)
-        serializer_class::SeregaConfig.include(ConfigInstanceMethods)
-
-        config = serializer_class.config
-        config.opts[:openapi] = {properties: {}}
-        openapi_config = serializer_class.config.openapi
-        openapi_config.schema_name_builder = opts[:schema_name_builder] || DEFAULT_SCHEMA_NAME_BUILDER
-        openapi_config.ref_builder = opts[:ref_builder] || DEFAULT_REF_BUILDER
-      end
-
-      #
-      # 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
-      #
-      # @return [void]
-      #
-      def self.after_load_plugin(serializer_class, **opts)
-        Serega::OpenAPI.serializers << serializer_class unless serializer_class.equal?(Serega)
-      end
-
-      #
-      # Serega additional/patched class methods
-      #
-      # @see Serega
-      #
-      module ClassMethods
-        #
-        # OpenAPI schema for current serializer
-        #
-        def openapi_schema
-          properties = SeregaUtils::EnumDeepDup.call(openapi_properties)
-          required_properties = []
-
-          attributes.each do |attribute_name, attribute|
-            add_openapi_property(properties, attribute_name, attribute)
-            add_openapi_required_property(required_properties, attribute_name, attribute)
-          end
-
-          {
-            type: "object",
-            properties: properties,
-            required: required_properties,
-            additionalProperties: false
-          }
-        end
-
-        #
-        # Adds new OpenAPI properties and returns all properties
-        #
-        # @param props [Hash] Specifies new properties
-        #
-        # @return [Hash] Specified OpenAPI properties
-        #
-        def openapi_properties(props = FROZEN_EMPTY_HASH)
-          config.openapi.properties(props)
-        end
-
-        #
-        # Builds OpenAPI schema name using configured builder
-        #
-        # @return [String] OpenAPI schema name
-        #
-        def openapi_schema_name
-          config.openapi.schema_name_builder.call(self)
-        end
-
-        private
-
-        def inherited(subclass)
-          super
-          Serega::OpenAPI.serializers << subclass
-        end
-
-        def add_openapi_property(properties, attribute_name, attribute)
-          property = properties[attribute_name] ||= {}
-          return unless attribute.relation?
-
-          ref = attribute.serializer.config.openapi.ref_builder.call(attribute.serializer)
-
-          if attribute.many
-            property[:type] = "array"
-            property[:items] ||= {}
-            property[:items][:$ref] ||= ref
-          else
-            property[:$ref] ||= ref
-          end
-        end
-
-        def add_openapi_required_property(required_properties, attribute_name, attribute)
-          required_properties << attribute_name unless attribute.hide
-        end
-      end
-    end
-
-    register_plugin(OpenAPI.plugin_name, OpenAPI)
-  end
-end