meta-api 0.0.4 → 0.0.6

data/examples/rails_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /home/run/workspace/personal/web-frame
   specs:
-    meta-api (0.0.3)
+    meta-api (0.0.4)
 
 GEM
   remote: https://gems.ruby-china.com/

data/lib/meta/application/execution.rb

@@ -100,22 +100,36 @@ module Meta
         end
 
         new_hash = entity_schema.filter(hash, **options, execution: self, stage: :render, validation: ::Meta.config.render_validation, type_conversion: ::Meta.config.render_type_conversion)
+        response.content_type = 'application/json' if response.content_type.nil?
         response.body = [JSON.generate(new_hash)]
       else
         # 渲染多键值结点
-        new_hash = renders.map do |key, render_content|
+        errors = {}
+        final_value = {}
+        renders.each do |key, render_content|
           raise Errors::RenderingError, "渲染的键名 `#{key}` 不存在，请检查实体定义以确认是否有拼写错误" unless entity_schema.properties.key?(key)
           schema = entity_schema.properties[key].schema(:render)
-
-          filtered = schema.filter(render_content[:value], **render_content[:options], execution: self, stage: :render)
-          [key, filtered]
+          final_value[key] = schema.filter(render_content[:value], **render_content[:options], execution: self, stage: :render)
+        rescue JsonSchema::ValidationErrors => e
+          # 错误信息再度绑定 key
+          errors.merge! e.errors.transform_keys! { |k| k.empty? ? key : "#{key}.#{k}" }
         end.to_h
-        response.body = [JSON.generate(new_hash)]
+
+        if errors.empty?
+          response.content_type = 'application/json' if response.content_type.nil?
+          response.body = [JSON.generate(final_value)]
+        else
+          raise Errors::RenderingInvalid.new(errors)
+        end
       end
     rescue JsonSchema::ValidationErrors => e
       raise Errors::RenderingInvalid.new(e.errors)
     end
 
+    def abort_execution!
+      raise Abort
+    end
+
     private
 
     def parse_raw_params
@@ -123,7 +137,7 @@ module Meta
       if request_body.empty?
         json = {}
       elsif !request.content_type.start_with?('application/json')
-        raise Errors::UnsupportedContentType, "只接受 Content-Type 为 application/json 的请求参数"
+        raise Errors::UnsupportedContentType, "只接受 Content-Type 为 application/json 的请求参数，当前格式：#{request.content_type}"
       else
         json = JSON.parse(request_body)
       end
@@ -134,22 +148,18 @@ module Meta
     end
 
     def parse_request_body_for_replacing
-      begin
-        request_body_schema.filter(params(:raw), stage: :param)
-      rescue JsonSchema::ValidationErrors => e
-        raise Errors::ParameterInvalid.new(e.errors)
-      end
+      request_body_schema.filter(params(:raw), stage: :param)
+    rescue JsonSchema::ValidationErrors => e
+      raise Errors::ParameterInvalid.new(e.errors)
     end
 
     def parse_request_body_for_updating
-      begin
-        request_body_schema.filter(params(:raw), stage: :param, discard_missing: true)
-      rescue JsonSchema::ValidationErrors => e
-        raise Errors::ParameterInvalid.new(e.errors)
-      end
+      request_body_schema.filter(params(:raw), stage: :param, discard_missing: true)
+    rescue JsonSchema::ValidationErrors => e
+      raise Errors::ParameterInvalid.new(e.errors)
     end
 
-    class Abort < StandardError
+    class Abort < Exception
     end
 
     # 使得能够处理 Execution 的类作为 Rack 中间件
@@ -162,7 +172,6 @@ module Meta
         execute(execution, request.path)
 
         response = execution.response
-        response.content_type = 'application/json' unless response.no_content?
         response.to_a
       end
     end

data/lib/meta/application/metadata.rb

@@ -51,7 +51,7 @@ module Meta
         }.compact
       end unless responses.empty?
 
-      operation_object
+      operation_object.compact
     end
 
     def self.new(meta = {})

data/lib/meta/application/parameters.rb

@@ -11,15 +11,23 @@ module Meta
     end
 
     def filter(request)
-      parameters.map do |name, options|
+      errors = {}
+      final_value = {}
+
+      parameters.each do |name, options|
         schema = options[:schema]
         value = if options[:in] == 'header'
-          schema.filter(request.get_header('HTTP_' + name.to_s.upcase.gsub('-', '_')))
-        else
-          schema.filter(request.params[name.to_s])
-        end
-        [name, value]
-      end.to_h
+                  schema.filter(request.get_header('HTTP_' + name.to_s.upcase.gsub('-', '_')))
+                else
+                  schema.filter(request.params[name.to_s])
+                end
+        final_value[name] = value
+      rescue JsonSchema::ValidationError => e
+        errors[name] = e.message
+      end
+      raise Errors::ParameterInvalid.new(errors) unless errors.empty?
+
+      final_value
     end
 
     def to_swagger_doc
@@ -28,11 +36,11 @@ module Meta
         {
           name: name,
           in: options[:in],
-          required: property_options[:required] || nil,
+          required: property_options.key?(:required) ? property_options[:required] : false,
           description: property_options[:description] || '',
           schema: {
             type: property_options[:type]
-          }
+          }.compact
         }.compact
       end unless parameters.empty?
     end

data/lib/meta/application/route.rb

@@ -20,16 +20,14 @@ module Meta
     def execute(execution, remaining_path)
       path_matching.merge_path_params(remaining_path, execution.request)
 
-      begin
-        execution.parse_parameters(@meta[:parameters]) if @meta[:parameters]
-        execution.parse_request_body(@meta[:request_body]) if @meta[:request_body]
+      execution.parse_parameters(@meta[:parameters]) if @meta[:parameters]
+      execution.parse_request_body(@meta[:request_body]) if @meta[:request_body]
 
-        action.execute(execution) if action
+      action.execute(execution) if action
 
-        render_entity(execution) if @meta[:responses]
-      rescue Execution::Abort
-        execution
-      end
+      render_entity(execution) if @meta[:responses]
+    rescue Execution::Abort
+      nil
     end
 
     def match?(execution, remaining_path)

data/lib/meta/errors.rb

@@ -13,7 +13,7 @@ module Meta
     end
 
     class RenderingInvalid < JsonSchema::ValidationErrors
-      def initialize(errors)
+      def initialize(errors = {})
         super(errors, "渲染实体异常：#{errors}")
       end
     end

data/lib/meta/json_schema/builders/schema_builder_tool.rb

@@ -34,7 +34,7 @@ module Meta
         private
 
         def apply_array_schema?(options, block)
-          options[:type] == 'array' && (options[:items] || options[:ref] || options[:dynamic_ref] || block)
+          options[:type] == 'array'
         end
 
         def apply_object_schema?(options, block)

data/lib/meta/json_schema/schemas/base_schema.rb

@@ -23,6 +23,8 @@ module Meta
 
       def initialize(options = {})
         options = OPTIONS_CHECKER.check(options)
+        raise '不允许 BaseSchema 直接接受 array 类型，必须通过继承使用 ArraySchema' if options[:type] == 'array' && self.class == BaseSchema
+
         @options = SchemaOptions.normalize(options)
       end
 

data/lib/meta/json_schema/support/type_converter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bigdecimal'
+
 module Meta
   module JsonSchema
     class ObjectWrapper
@@ -29,7 +31,7 @@ module Meta
       @definity_types = {
         'boolean' => [TrueClass, FalseClass],
         'integer' => [Integer],
-        'number' => [Integer, Float],
+        'number' => [Integer, Float, BigDecimal],
         'string' => [String],
         'array' => [Array],
         'object' => [Hash, ObjectWrapper]
@@ -39,7 +41,7 @@ module Meta
       @boolean_converters = {
         [String] => lambda do |value|
           unless %w[true True TRUE false False FALSE].include?(value)
-            raise TypeConvertError, "类型转化失败，期望得到一个 `boolean` 类型，但值 `#{value}` 无法转化"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.basic', target_type: 'boolean', value: value)
           end
 
           value.downcase == 'true'
@@ -50,14 +52,14 @@ module Meta
         [String] => lambda do |value|
           # 允许的格式：+34、-34、34、34.0 等
           unless value =~ /^[+-]?\d+(\.0+)?$/
-            raise TypeConvertError, "类型转化失败，期望得到一个 `integer` 类型，但值 `#{value}` 无法转化"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.basic', target_type: 'integer', value: value)
           end
 
           value.to_i
         end,
-        [Float] => lambda do |value|
+        [Float, BigDecimal] => lambda do |value|
           unless value.to_i == value
-            raise TypeConvertError, "类型转化失败，期望得到一个 `integer` 类型，但值 `#{value}` 无法转化"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.basic', target_type: 'integer', value: value)
           end
 
           value.to_i
@@ -67,7 +69,7 @@ module Meta
       @number_converters = {
         [String] => lambda do |value|
           unless value =~ /^[+-]?\d+(\.\d+)?$/
-            raise TypeConvertError, "类型转化失败，期望得到一个 `number` 类型，但值 `#{value}` 无法转化"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.basic', target_type: 'number', value: value)
           end
 
           float = value.to_f
@@ -84,7 +86,7 @@ module Meta
       @array_converters = {
         [Object] => lambda do |value|
           unless value.respond_to?(:to_a)
-            raise TypeConvertError, "转化为数组类型时期望对象拥有 `to_a` 方法"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.array')
           end
 
           value.to_a
@@ -94,9 +96,9 @@ module Meta
       @object_converters = {
         [Object] => lambda do |value|
           if [TrueClass, FalseClass, Integer, Float, String].any? { |ruby_type| value.is_a?(ruby_type) }
-            raise TypeConvertError, "类型转化失败，期望得到一个 `object` 类型，但值 `#{value}` 是一个基本类型"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.object', value: value, real_type: I18n.t(:'json_schema.type_names.basic'))
           elsif value.is_a?(Array)
-            raise TypeConvertError, "类型转化失败，期望得到一个 `object` 类型，但值 `#{value}` 是一个 `array` 类型"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.object', value: value, real_type: I18n.t(:'json_schema.type_names.array'))
           end
 
           ObjectWrapper.new(value)
@@ -106,7 +108,7 @@ module Meta
       class << self
         def convert_value(value, target_type)
           return nil if value.nil?
-          raise JsonSchema::TypeConvertError, "未知的目标类型 `#{target_type}`" unless @definity_types.keys.include?(target_type)
+          raise JsonSchema::TypeConvertError, I18n.t(:'json_schema.errors.type_convert.unknown') unless @definity_types.keys.include?(target_type)
           return value if match_definity_types?(value, target_type)
 
           convert_to_definity_type(value, target_type)
@@ -126,7 +128,7 @@ module Meta
                 return converter.call(value)
               end
             end
-            raise TypeConvertError, "类型转化失败，期望得到一个 `#{target_type}` 类型，但值 `#{value}` 无法转化"
+            raise TypeConvertError, I18n.t(:'json_schema.errors.type_convert.basic', target_type: target_type, value: value)
           end
       end
     end

data/lib/meta/route_dsl/application_builder.rb

@@ -10,7 +10,7 @@ module Meta
 
       def initialize(prefix = nil, &block)
         @mod_prefix = prefix
-        @callbacks = { before: [], after: [], around: [] }
+        @callbacks = []
         @error_guards = []
         @meta_builder = MetaBuilder.new
         @mod_builders = []
@@ -19,7 +19,7 @@ module Meta
         instance_exec &block if block_given?
       end
 
-      def build(parent_path: '', meta: {}, callbacks: {})
+      def build(parent_path: '', meta: {}, callbacks: [])
         # 合并 meta 时不仅仅是覆盖，比如 parameters 参数需要合并
         meta2 = (meta || {}).merge(@meta_builder.build)
         if meta[:parameters] && meta2[:parameters]
@@ -27,11 +27,10 @@ module Meta
         end
 
         # 构建子模块
-        callbacks = { # 合并父级传递过来的 callbacks
-          before: (callbacks[:before] || []) + @callbacks[:before],
-          around: (callbacks[:around] || []) + @callbacks[:around],
-          after: @callbacks[:after] + (callbacks[:after] || []),
-        }
+        # 合并父级传递过来的 callbacks，将 before 和 around 放在前面，after 放在后面
+        parent_before = callbacks.filter { |cb| cb[:lifecycle] == :before || cb[:lifecycle] == :around }
+        parent_after = callbacks.filter { |cb| cb[:lifecycle] == :after }
+        callbacks = parent_before + @callbacks + parent_after
         mods = @mod_builders.map { |builder| builder.build(parent_path: Utils::Path.join(parent_path, @mod_prefix), meta: meta2, callbacks: callbacks) }
 
         Application.new(
@@ -66,15 +65,24 @@ module Meta
 
       # 定义模块内的公共逻辑
       def before(&block)
-        @callbacks[:before] << block
+        @callbacks << {
+          lifecycle: :before,
+          proc: block
+        }
       end
 
       def after(&block)
-        @callbacks[:after] << block
+        @callbacks << {
+          lifecycle: :after,
+          proc: block
+        }
       end
 
       def around(&block)
-        @callbacks[:around] << block
+        @callbacks << {
+          lifecycle: :around,
+          proc: block
+        }
       end
 
       def rescue_error(error_class, &block)

data/lib/meta/route_dsl/around_action_builder.rb

@@ -1,26 +1,53 @@
 # frozen_string_literal: true
 
+# 洋葱圈模型的构建器。
+#
+# 因为应用的底层仅使用洋葱圈模型，所以在 DSL 层面，我们需要将 before、after、around 等序列和当前 action 共同构建洋葱圈模型。
+# 在这个类中，仅仅列出了 before、around、after 三个方法。
+# 因此第一步，当前执行的 action 会用 before 逻辑代替。
+# 其次，有必要声明 before、after、around 的执行顺序。before 和 after 的顺序关系容易理解，重点是要关注 around 的执行顺序。
+# around 的前半部分与 before 的关系：按照声明的顺序执行。
+# around 与 after 的关系：after 序列会在之前执行，然后是 around 序列的后半部分。
+
 require_relative '../application/linked_action'
 
 module Meta
   module RouteDSL
     class AroundActionBuilder
       def initialize
-        @around = []
+        @before = []
+        @after = []
       end
 
       def around(&block)
-        @around << block
+        @before << block
+      end
+
+      def before(&block)
+        @before << Proc.new do |next_action|
+          self.instance_exec(&block)
+          next_action.execute(self) if next_action
+        end
+      end
+
+      def after(&block)
+        # 在洋葱圈模型中，先声明的 after 逻辑会在最后执行，因此为了保证 after 逻辑的执行顺序
+        @after.unshift(Proc.new do |next_action|
+          next_action.execute(self) if next_action
+          self.instance_exec(&block)
+        end)
       end
 
       def build
         # 从后向前构建
-        @around.reverse.reduce(nil) do |following, p|
+        (@before + @after).reverse.reduce(nil) do |following, p|
           LinkedAction.new(p, following)
         end
       end
 
       # 使用 before、after、around 系列和当前 action 共同构建洋葱圈模型。
+      # Note: 该方法可能被废弃!
+      #
       # 构建成功后，执行顺序是：
       #
       # - before 序列

data/lib/meta/route_dsl/route_builder.rb

@@ -47,10 +47,16 @@ module Meta
         end
 
         # 构建洋葱圈模型的 LinkedAction
-        action = AroundActionBuilder.build(
-          action: @action_builder&.build,
-          **callbacks
-        )
+        # 合并父级传递过来的 callbacks，将 before 和 around 放在前面，after 放在后面
+        parent_before = callbacks.filter { |cb| cb[:lifecycle] == :before || cb[:lifecycle] == :around }
+        parent_after = callbacks.filter { |cb| cb[:lifecycle] == :after }
+        callbacks = parent_before + [{ lifecycle: :before, proc: @action_builder&.build }] + parent_after
+        # 使用 AroundActionBuilder 构建洋葱圈模型
+        around_action_builder = AroundActionBuilder.new
+        callbacks.each do |cb|
+          around_action_builder.send(cb[:lifecycle], &cb[:proc]) if cb[:proc]
+        end
+        action = around_action_builder.build
 
         Route.new(
           path: @path,

data/meta-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "meta-api"
-  spec.version       = "0.0.4"
+  spec.version       = "0.0.6"
   spec.authors       = ["yetrun"]
   spec.email         = ["yetrun@foxmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meta-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - yetrun
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies: []
 description: 一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档
 email:
@@ -130,7 +130,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/yetrun/web-frame
   source_code_uri: https://github.com/yetrun/web-frame.git
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: 一个 Web API 框架
 test_files: []