ree_lib 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be5ae7ea8b9a8508ae04cc0caf741b87bc67b974c0a14d6cfbabef16607e1c81
-  data.tar.gz: fc7feb07cf62419e03262e4910fa9d02ac8c1b0eed9f60f76a4282f61357985f
+  metadata.gz: ff525a1db86ff974abe2f0095d70921fa49e324b808723042b1671140b372809
+  data.tar.gz: 899723f369a42828b8dc094cdcaf96c10d78704e23f95b9500ed76d453858f3b
 SHA512:
-  metadata.gz: ff19ea51129ec5d6f3fdace442c2264fc8af6071e9e92f769916c3faea5da8aa9e59c04bcb94f6e063f0b363407d2c8b64ba7ce8136c750831b0ae60337d356d
-  data.tar.gz: 777a59bf5a429a99d9f0c3e749d79a8af0223a08a1028cbae5d74d759fa6519bc12b48c36dc016373337e51d1f1427aca116acb0ccc26aaeac1a762891d28cd7
+  metadata.gz: 8a8630ad6fbb14f70ffef61be34708befd543be814a29fb81afda8a9020b8b46222e4aca37662e8504dbab8d43d408e9850168acc50595962245c93a4b377155
+  data.tar.gz: 1eb4b5d094c9b5aabf5882f5c055594348ea7a818920a1e55e87f48765e66dd0e2718a6643d7d4ba65f70ded911dd2a5575ad401497a5c69765f0700f34804cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ree_lib (1.0.0)
+    ree_lib (1.0.3)
       binding_of_caller (~> 1.0.0)
       i18n (~> 1.12.0)
       loofah (~> 2.18.0)
@@ -36,11 +36,11 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     msgpack (1.5.3)
-    nokogiri (1.13.7-x86_64-darwin)
+    nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.7-x86_64-linux)
+    nokogiri (1.13.8-x86_64-linux)
       racc (~> 1.4)
-    oj (3.13.17)
+    oj (3.13.19)
     pg (1.4.1)
     public_suffix (4.0.7)
     racc (1.6.0)

data/lib/ree_lib/packages/ree_enum/Package.schema.json

@@ -10,6 +10,9 @@
     {
       "name": "ree_mapper"
     },
+    {
+      "name": "ree_swagger"
+    },
     {
       "name": "ree_validator"
     }

data/lib/ree_lib/packages/ree_enum/package/ree_enum/dsl.rb

@@ -1,3 +1,5 @@
+package_require 'ree_swagger/functions/register_type'
+
 module ReeEnum
   module DSL
     def self.included(base)
@@ -22,80 +24,102 @@ module ReeEnum
         Ree.container.compile(dsl.package, name)
       end
 
-      def register_as_mapper_type
-        mapper_factory = ReeMapper.get_mapper_factory(
-          Object.const_get(self.name.split('::').first)
-        )
+      def type_for_mapper
+        @type_for_mapper ||= begin
+          klass = Class.new(ReeMapper::AbstractType) do
+            def initialize(enum)
+              @enum = enum
+            end
 
-        klass = Class.new(ReeMapper::AbstractType) do
-          def initialize(enum)
-            @enum = enum
-          end
+            contract(
+              ReeEnum::Value,
+              Kwargs[
+                role: Nilor[Symbol, ArrayOf[Symbol]]
+              ] => String
+            )
+            def serialize(value, role: nil)
+              value.to_s
+            end
 
-          contract(
-            ReeEnum::Value,
-            Kwargs[
-              role: Nilor[Symbol, ArrayOf[Symbol]]
-            ] => String
-          )
-          def serialize(value, role: nil)
-            value.to_s
-          end
+            contract(
+              Any,
+              Kwargs[
+                role: Nilor[Symbol, ArrayOf[Symbol]]
+              ] => ReeEnum::Value
+            ).throws(ReeMapper::CoercionError)
+            def cast(value, role: nil)
+              if value.is_a?(String)
+                enum_val = @enum.values.all.detect { |v| v.to_s == value }
 
-          contract(
-            Any,
-            Kwargs[
-              role: Nilor[Symbol, ArrayOf[Symbol]]
-            ] => ReeEnum::Value
-          ).throws(ReeMapper::CoercionError)
-          def cast(value, role: nil)
-            if value.is_a?(String)
-              enum_val = @enum.values.all.detect { |v| v.to_s == value }
-
-              if !enum_val
-                raise ReeMapper::CoercionError, "should be one of #{@enum.values.all.map(&:to_s).inspect}"
-              end
+                if !enum_val
+                  raise ReeMapper::CoercionError, "should be one of #{@enum.values.all.map(&:to_s).inspect}"
+                end
 
-              enum_val
-            elsif value.is_a?(Integer)
-              enum_val = @enum.values.all.detect { |v| v.to_i == value }
+                enum_val
+              elsif value.is_a?(Integer)
+                enum_val = @enum.values.all.detect { |v| v.to_i == value }
 
-              if !enum_val
+                if !enum_val
+                  raise ReeMapper::CoercionError, "should be one of #{@enum.values.all.map(&:to_s).inspect}"
+                end
+
+                enum_val
+              else
                 raise ReeMapper::CoercionError, "should be one of #{@enum.values.all.map(&:to_s).inspect}"
               end
+            end
 
-              enum_val
-            else
-              raise ReeMapper::CoercionError, "should be one of #{@enum.values.all.map(&:to_s).inspect}"
+            contract(
+              ReeEnum::Value,
+              Kwargs[
+                role: Nilor[Symbol, ArrayOf[Symbol]]
+              ] => Integer
+            )
+            def db_dump(value, role: nil)
+              value.to_i
             end
-          end
 
-          contract(
-            ReeEnum::Value,
-            Kwargs[
-              role: Nilor[Symbol, ArrayOf[Symbol]]
-            ] => Integer
-          )
-          def db_dump(value, role: nil)
-            value.to_i
+            contract(
+              Integer,
+              Kwargs[
+                role: Nilor[Symbol, ArrayOf[Symbol]]
+              ] => ReeEnum::Value
+            ).throws(ReeMapper::TypeError)
+            def db_load(value, role: nil)
+              cast(value, role: role)
+            end
           end
 
-          contract(
-            Integer,
-            Kwargs[
-              role: Nilor[Symbol, ArrayOf[Symbol]]
-            ] => ReeEnum::Value
-          ).throws(ReeMapper::TypeError)
-          def db_load(value, role: nil)
-            cast(value, role: role)
-          end
+          klass.new(self)
         end
+      end
 
-        mapper_factory.register(
-          self.enum_name,
-          ReeMapper::Mapper.build(
-            mapper_factory.strategies, klass.new(self)
+      def register_as_swagger_type
+        swagger_type_registrator = ReeSwagger::RegisterType.new
+
+        [:casters, :serializers].each do |kind|
+          swagger_type_registrator.call(
+            kind,
+            type_for_mapper.class,
+            ->(*) {
+              {
+                type: 'string',
+                enum: values.all.map(&:to_s)
+              }
+            }
           )
+        end
+      end
+
+      def register_as_mapper_type
+        register_as_swagger_type
+
+        mapper_factory = ReeMapper.get_mapper_factory(
+          Object.const_get(self.name.split('::').first)
+        )
+
+        mapper_factory.register_type(
+          self.enum_name, type_for_mapper
         )
       end
     end

data/lib/ree_lib/packages/ree_enum/package/ree_enum.rb

@@ -5,6 +5,7 @@ module ReeEnum
 
   package do
     depends_on :ree_mapper
+    depends_on :ree_swagger
     depends_on :ree_validator
   end
 end

data/lib/ree_lib/packages/ree_json/package/ree_json.rb

@@ -6,5 +6,4 @@ module ReeJson
   package do
     depends_on :ree_hash
   end
-
 end

data/lib/ree_lib/packages/ree_logger/package/ree_logger/multi_logger.rb

@@ -83,7 +83,7 @@ class ReeLogger::MultiLogger < Logger
   end
 
   contract(String, Hash, Nilor[Exception], Bool => nil)
-  def unknown(message, parameters = {}, exception  =nil, log_args = true)
+  def unknown(message, parameters = {}, exception = nil, log_args = true)
     log(:unknown, message, parameters, exception, true)
   end
 

data/lib/ree_lib/packages/ree_mapper/package/ree_mapper/mapper_factory.rb

@@ -11,6 +11,14 @@ class ReeMapper::MapperFactory
     string: ReeMapper::StringKeyHashOutput
   }.freeze
 
+  contract(Symbol, Any => Class).throws(ArgumentError)
+  def self.register_type(name, object_type)
+    register(
+      name,
+      ReeMapper::Mapper.build(strategies, object_type)
+    )
+  end
+
   contract(Symbol, Any => Class).throws(ArgumentError)
   def self.register(name, type)
     raise ArgumentError, "name of mapper type should not include `?`" if name.to_s.end_with?('?')

data/lib/ree_lib/packages/ree_swagger/Package.schema.json

@@ -10,6 +10,9 @@
     {
       "name": "ree_dto"
     },
+    {
+      "name": "ree_enum"
+    },
     {
       "name": "ree_hash"
     },

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/beans/type_definitions_repo.rb

@@ -9,40 +9,40 @@ class ReeSwagger::TypeDefinitionsRepo
   def build
     {
       serializers: {
-        'ReeMapper::Integer' => ->(*) {
+        ReeMapper::Integer => ->(*) {
           { type: 'integer' }
         },
-        'ReeMapper::String' => ->(*) {
+        ReeMapper::String => ->(*) {
           { type: 'string' }
         },
-        'ReeMapper::Bool' => ->(*) {
+        ReeMapper::Bool => ->(*) {
           { type: 'boolean' }
         },
-        'ReeMapper::Float' => ->(*) {
+        ReeMapper::Float => ->(*) {
           {
             type: 'number',
             format: 'float'
           }
         },
-        'ReeMapper::Array' => ->(type, build_serializer_schema) {
+        ReeMapper::Array => ->(type, build_serializer_schema) {
           {
             type: 'array',
             items: build_serializer_schema.(type.of.type)
           }
         },
-        'ReeMapper::DateTime' => ->(*) {
+        ReeMapper::DateTime => ->(*) {
           {
             type: 'string',
             format: 'date-time'
           }
         },
-        'ReeMapper::Date' => ->(*) {
+        ReeMapper::Date => ->(*) {
           {
             type: 'string',
             format: 'date'
           }
         },
-        'ReeMapper::Time' => ->(*) {
+        ReeMapper::Time => ->(*) {
           {
             type: 'string',
             format: 'date-time'
@@ -50,40 +50,40 @@ class ReeSwagger::TypeDefinitionsRepo
         }
       },
       casters: {
-        'ReeMapper::Integer' => ->(*) {
+        ReeMapper::Integer => ->(*) {
           { type: 'integer' }
         },
-        'ReeMapper::String' => ->(*) {
+        ReeMapper::String => ->(*) {
           { type: 'string' }
         },
-        'ReeMapper::Bool' => ->(*) {
+        ReeMapper::Bool => ->(*) {
           { type: 'boolean' }
         },
-        'ReeMapper::Float' => ->(*) {
+        ReeMapper::Float => ->(*) {
           {
             type: 'number',
             format: 'float'
           }
         },
-        'ReeMapper::Array' => ->(type, build_caster_schema) {
+        ReeMapper::Array => ->(type, build_caster_schema) {
           {
             type: 'array',
             items: build_caster_schema.(type.of.type)
           }
         },
-        'ReeMapper::DateTime' => ->(*) {
+        ReeMapper::DateTime => ->(*) {
           {
             type: 'string',
             format: 'date-time'
           }
         },
-        'ReeMapper::Date' => ->(*) {
+        ReeMapper::Date => ->(*) {
           {
             type: 'string',
             format: 'date'
           }
         },
-        'ReeMapper::Time' => ->(*) {
+        ReeMapper::Time => ->(*) {
           {
             type: 'string',
             format: 'date-time'

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/endpoint_dto.rb

@@ -1,5 +1,8 @@
 class ReeSwagger::EndpointDto
   include ReeDto::EntityDSL
+  include Ree::LinkDSL
+
+  link 'ree_swagger/dto/error_dto', -> { ErrorDto }
 
   properties(
     method: Or[:get, :post, :put, :patch, :delete],
@@ -8,6 +11,7 @@ class ReeSwagger::EndpointDto
     serializer: Nilor[ReeMapper::Mapper],
     description: Nilor[String],
     response_status: Integer,
-    response_description: Nilor[String]
+    response_description: Nilor[String],
+    errors: ArrayOf[ErrorDto]
   )
 end

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/error_dto.rb

@@ -0,0 +1,9 @@
+
+  class ReeSwagger::ErrorDto
+    include ReeDto::EntityDSL
+
+    properties(
+      status: Integer,
+      description: String,
+    )
+  end

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_endpoint_schema.rb

@@ -88,6 +88,17 @@ class ReeSwagger::BuildEndpointSchema
       endpoint.response_status => response_schema
     }
 
+    endpoint.errors.each do |error|
+      if responses.key?(error.status)
+        responses[error.status][:description] += "\n- #{error.description}"
+        next
+      end
+
+      responses[error.status] = {
+        description: "- #{error.description}",
+      }
+    end
+
     method_schema = {
       responses: responses
     }

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/get_caster_definition.rb

@@ -10,7 +10,7 @@ class ReeSwagger::GetCasterDefinition
   contract(Any, Proc => Nilor[Hash])
   def call(type, schema_builder)
     type_definitions_repo
-      .dig(:casters, type.class.name)
+      .dig(:casters, type.class)
       &.(type, schema_builder)
   end
 end

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/get_serializer_definition.rb

@@ -10,7 +10,7 @@ class ReeSwagger::GetSerializerDefinition
   contract(Any, Proc => Nilor[Hash])
   def call(type, build_serializer_schema)
     type_definitions_repo
-      .dig(:serializers, type.class.name)
+      .dig(:serializers, type.class)
       &.(type, build_serializer_schema)
   end
 end

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/register_type.rb

@@ -12,7 +12,7 @@ class ReeSwagger::RegisterType
   contract(Or[:casters, :serializers], Any, Proc => nil)
   def call(kind, type, definition)
     SEMAPHORE.synchronize do
-      type_definitions_repo[kind][type.name] = definition
+      type_definitions_repo[kind][type] = definition
     end
 
     nil

data/lib/ree_lib/packages/ree_swagger/package/ree_swagger.rb

@@ -5,5 +5,6 @@ module ReeSwagger
     depends_on :ree_mapper
     depends_on :ree_dto
     depends_on :ree_hash
+    depends_on :ree_enum
   end
 end

data/lib/ree_lib/packages/ree_swagger/spec/functions/build_endpoint_schema_spec.rb

@@ -3,6 +3,14 @@ RSpec.describe :build_endpoint_schema do
   link :build_mapper_factory, from: :ree_mapper
   link :build_mapper_strategy, from: :ree_mapper
 
+  before :all do
+    Ree.enable_irb_mode
+  end
+
+  after :all do
+    Ree.disable_irb_mode
+  end
+
   let(:mapper_factory) {
     strategies = [
       build_mapper_strategy(method: :serialize, output: :symbol_key_hash),
@@ -15,6 +23,27 @@ RSpec.describe :build_endpoint_schema do
   }
 
   it {
+    module ReeSwaggerTest
+      include Ree::PackageDSL
+
+      package
+
+      class Locales
+        include ReeEnum::DSL
+
+        enum :locales
+
+        val :en, 0
+        val :ru, 1
+      end
+    end
+
+    mapper_factory.register_type(
+      :locales, ReeSwaggerTest::Locales.type_for_mapper
+    )
+
+    ReeSwaggerTest::Locales.register_as_swagger_type
+
     serializer = mapper_factory.call.use(:serialize) do
       integer :id
     end
@@ -28,6 +57,7 @@ RSpec.describe :build_endpoint_schema do
       integer :id
       string :name
       tag    :tag
+      locales :locale
     end
 
     schema = build_endpoint_schema(ReeSwagger::EndpointDto.new(
@@ -36,7 +66,21 @@ RSpec.describe :build_endpoint_schema do
       caster:          caster,
       serializer:      serializer,
       response_status: 200,
-      description:     nil
+      description:     nil,
+      errors:          [
+        ReeSwagger::ErrorDto.new(
+          status: 400,
+          description: "1st 400 error"
+        ),
+        ReeSwagger::ErrorDto.new(
+          status: 400,
+          description: "2nd 400 error"
+        ),
+        ReeSwagger::ErrorDto.new(
+          status: 401,
+          description: "401 error"
+        )
+      ]
     ))
 
     expect(schema).to eq(ReeSwagger::PathDto.new(
@@ -64,6 +108,10 @@ RSpec.describe :build_endpoint_schema do
                         name: { type: 'string' },
                         value: { type: 'string' }
                       }
+                    },
+                    locale: {
+                      type: 'string',
+                      enum: ['en', 'ru']
                     }
                   }
                 }
@@ -83,6 +131,13 @@ RSpec.describe :build_endpoint_schema do
                   }
                 }
               }
+            },
+            400 => {
+              description: "- 1st 400 error\n- 2nd 400 error",
+
+            },
+            401 => {
+              description: "- 401 error",
             }
           }
         }
@@ -109,7 +164,8 @@ RSpec.describe :build_endpoint_schema do
       caster:          caster,
       serializer:      nil,
       response_status: 200,
-      description:     nil
+      description:     nil,
+      errors:          []
     ))
 
     expect(schema).to eq(ReeSwagger::PathDto.new(
@@ -167,7 +223,8 @@ RSpec.describe :build_endpoint_schema do
         caster:          nil,
         serializer:      nil,
         response_status: 200,
-        description:     nil
+        description:     nil,
+        errors:          []
       ))
     }.to raise_error(
       ReeSwagger::BuildEndpointSchema::MissingCasterError,
@@ -187,7 +244,8 @@ RSpec.describe :build_endpoint_schema do
         caster:          caster,
         serializer:      nil,
         response_status: 200,
-        description:     nil
+        description:     nil,
+        errors:          []
       ))
     }.to raise_error(
       ReeSwagger::BuildEndpointSchema::MissingCasterError,

data/lib/ree_lib/packages/ree_swagger/spec/functions/build_schema_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe :build_schema do
         caster:          nil,
         serializer:      nil,
         response_status: 200,
-        description:     nil
+        description:     nil,
+        errors:          []
       )]
     )
 

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.0.0"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Ruslan Gatiyatov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-23 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ree
@@ -1120,6 +1120,7 @@ files:
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/beans/type_definitions_repo.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/endpoint_dto.rb
+- lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/error_dto.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/dto/path_dto.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_endpoint_schema.rb
 - lib/ree_lib/packages/ree_swagger/package/ree_swagger/functions/build_parameters.rb