meta-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc6f6c3dddfd1e683cae7147be60bd7ead57e46b097700fc1db4113d12f08965
-  data.tar.gz: 476caee521969debd84614433ab41be89fbe7d1e5b074f46a6c8df40ca2d2c43
+  metadata.gz: a3fc58de696caf4cf3abade846de9af53bb6491bda575b361461aa67f07d2fb9
+  data.tar.gz: 68d00c2d43086af73a10bbe6bfc103a5ee8611751b01ad2b9c811edf9197438a
 SHA512:
-  metadata.gz: 3e213a983004b7fed1d15c2e0b41c9746584d259af6f969c631669b7efbb63f5573ee67b61ca5cb95888738925ca525e2ae4045502a7998c57c96432c12e3fd7
-  data.tar.gz: b575cf5145a3693ceb14296178c25c1ab1f8bf23e2a7dac92e9cc131a82dd79649d101f066c716069a5cb99114c138842b7bde89734790f217095fd459bf8fb4
+  metadata.gz: 18cf46619c9f286fe01fbc3b941a6ca5a5e380740ad94e4d6827040cd9c6a014f6249eb13bc609a9f56fe2c15da6e044250f610b0eafdf6202aa9b6a16a0f15b
+  data.tar.gz: edc1532a86fe8776f061cfd1f550392ba280a4e693437b6d6260bfcfce8f0a33d7ae66e6f95250fb8530751307751a53857c0fd2a32a57ec9f8764bf6a9037da

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 更新日志
 
+## 0.0.5（2023 年 4 月 18 日）
+
+1. 调整了 `around` 钩子的执行顺序，它与 `before` 钩子共同定义顺序。
+2. 修复了若干 bug.
+
 ## 0.0.4（2023 年 4 月 18 日）
 
 1. `Application` 添加 `.around` 宏。

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    meta-api (0.0.4)
+    meta-api (0.0.5)
 
 GEM
   remote: https://gems.ruby-china.com/
@@ -63,4 +63,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.3.17
+   2.3.7

data/README.md

@@ -17,7 +17,7 @@ $ git clone https://github.com/yetrun/web-frame-example.git
 在 Gemfile 中添加：
 
 ```ruby
-gem 'meta-api', '~> 0.0.3' # Meta 框架处于快速开发阶段，引入时应尽量固定版本
+gem 'meta-api', '~> 0.0.5' # Meta 框架处于快速开发阶段，引入时应尽量固定版本
 ```
 
 然后在 Ruby 代码中引用：

data/config/locales/zh-CN.yml

@@ -1,6 +1,14 @@
 zh-CN:
   json_schema:
+    type_names:
+      basic: "基本类型"
+      array: "数组类型"
     errors:
-      required: '未提供'
-      format: '格式不正确'
-      allowable: '不在允许的值范围内'
+      required: "未提供"
+      format: "格式不正确"
+      allowable: "不在允许的值范围内"
+      type_convert:
+        basic: "类型转化失败，期望得到一个 `%{target_type}` 类型，但值 `%{value}` 无法转化"
+        array: "转化为数组类型时期望对象拥有 `to_a` 方法"
+        object: "类型转化失败，期望得到一个 `object` 类型，但值 `%{value}` 是一个%{real_type}"
+        unknown: "未知的目标类型 `%{target_type}`"

data/docs//346/225/231/347/250/213.md

@@ -147,14 +147,14 @@ end
 ```ruby
 class DemoApp < Meta::Application
   before { puts 1 }
-  before { puts 2 }
   around { |next_action|
-     puts 3
+     puts 2
      next_action.execute(self)
-     puts 5
+     puts 7
   }
+  before { puts 3 }
+  after { puts 5 }
   after { puts 6 }
-  after { puts 7 }
 
   get '/request' do
     puts 4
@@ -164,11 +164,10 @@ end
 
 所有钩子的执行顺序是：
 
-1. 首先执行 `before` 钩子，按照定义的顺序执行。
-2. 然后执行 `around` 钩子的前半部分，按照定义的顺序执行。
-3. 然后执行路由方法。
-4. 然后执行 `around` 钩子的后半部分，按照定义的顺序执行。
-5. 最后执行 `after` 钩子，按照定义的顺序执行。
+1. `before` 钩子和 `around` 钩子的前半部分，按照定义的顺序执行
+2. 然后执行路由方法。
+3. 然后执行 `after` 钩子，按照定义的顺序执行。
+4. 最后执行 `around` 钩子的后半部分，按照定义的逆序执行。
 
 ### 异常拦截
 

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

@@ -123,7 +123,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

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

@@ -28,11 +28,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/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_description.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_description.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.5"
   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.5
 platform: ruby
 authors:
 - yetrun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies: []
 description: 一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档
 email: