serega 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11821b5953500ef9f895ad8c96e97951734615363f3147c623b70519b6199a5
-  data.tar.gz: 8b03241a9def2e5a8777a75e61062f8b81544e497a1a1e490e085d52f14a326c
+  metadata.gz: d780c3d344370b36d9e6db64dfdfa08878bfe32885469610ac2314638c878d87
+  data.tar.gz: d282c6466f7b7205a7b524999b85a3e928d79c00ee11445abd26582e0146842c
 SHA512:
-  metadata.gz: eb5cb48e74c0e9c8307c6ceb6c47b918eb46ef3c160de90d0eb976239bbc036f1d3fb78219abd5567977f348e3e03d7e492e29140e6d85223fcf14289d794d89
-  data.tar.gz: acb7623ea317aab640aae70d0a5dfa0c436b706529741b36b15d938ab6af7523576f72ab4633b591b61dcdc38df768818eab3811005c248c3a00d2872cdccc46
+  metadata.gz: e2a161487df001b0074d1864770a7dfecd77ef788e187de6e460cd3d2856162cba8777eb807a65a8d4d49471bb50380fc49ffd17f36c16eb52a2ab8b84ed7991
+  data.tar.gz: 4a672090d0893ef8d3945b2528fc9861d245833ec4b21074b73481ab7acbf8fa5207c786cad8496bf022070f3341339522bbf4970c7a554cfa543f002f51f504

data/README.md

@@ -888,91 +888,14 @@ Look at [select serialized fields](#selecting-fields) for `:hide` usage examples
  end
 ```
 
-### Plugin :openapi
-
-Helps to build OpenAPI schemas
-
-This schemas can be easily used with [rswag](https://github.com/rswag/rswag#referenced-parameters-and-schema-definitions)"
-gem by adding them to "config.swagger_docs"
-
-Schemas properties will have no any "type" or other limits specified by default,
-you should provide them as new attribute `:openapi` option.
-
-This plugin adds type "object" or "array" only for relationships and marks
-attributes as **required** if they have no `:hide` option set
-(manually or automatically).
-
-After enabling this plugin attributes with :serializer option will have
-to have `:many` option set to construct "object" or "array" openapi
-property type.
-
-- constructing all serializers schemas:
-  `Serega::OpenAPI.schemas`
-- constructing specific serializers schemas:
-  `Serega::OpenAPI.schemas(Serega::OpenAPI.serializers - [MyBaseSerializer])`
-- constructing one serializer schema:
-  `SomeSerializer.openapi_schema`
-
-```ruby
-  class BaseSerializer < Serega
-    plugin :openapi
-  end
-
-  class UserSerializer < BaseSerializer
-    attribute :name, openapi: { type: "string" }
-
-    openapi_properties(
-      name: { type: :string }
-    )
-  end
-
-  class PostSerializer < BaseSerializer
-    attribute :text, openapi: { type: "string" }
-    attribute :user, serializer: UserSerializer, many: false
-    attribute :comments, serializer: PostSerializer, many: true, hide: true
-
-    openapi_properties(
-      text: { type: :string },
-      user: { type: 'object' }, # `$ref` added automatically
-      comments: { type: 'array' } # `items` option with `$ref` added automatically
-    )
-  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
-  #   }
-  # }
-```
-
 ### Plugin :explicit_many_option
 
 Plugin requires to add :many option when adding relationships
 (relationships are attributes with :serializer option specified)
 
-Adding this plugin makes clearer to find if relationship returns array or single
+Adding this plugin makes it clearer to find if relationship returns array or single
 object
 
-Also plugin `:openapi` load this plugin automatically as it need to know if
-relationship is array
-
 ```ruby
   class BaseSerializer < Serega
     plugin :explicit_many_option

data/VERSION

@@ -1 +1 @@
-0.14.0
+0.15.0

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

@@ -8,10 +8,7 @@ class Serega
     # Plugin requires to add :many option when adding relationships
     # (relationships are attributes with :serializer option specified)
     #
-    # Adding this plugin makes clearer to find if relationship returns array or single object
-    #
-    # Also some plugins like :openapi load this plugin automatically as they need to know if
-    # relationship is array
+    # Adding this plugin makes it clearer to find if relationship returns array or single object
     #
     # @example
     #   class BaseSerializer < Serega

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.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -74,9 +74,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

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