meta-api 0.0.1 → 0.0.3

data/lib/meta/utils/kwargs/builder.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# 使用构建器构建关键字参数检查器。
+#
+# 在 Ruby 3 中，关键字参数有所变化。简单来说，关键字参数和 Hash 类型不再自动转化，并且一般情况下推荐使用关键字参数。
+# 但关键字参数还是有稍稍不足之处，比如在做一些复杂的关键字参数定义时。
+#
+# 这个文件编写了一个方法，帮助我们在运行时检查关键字参数。这样，我们就可以像下面这样笼统的方式定义参数，不必用明确的关
+# 键字参数名称。
+#
+#     def method_name(x, y, z, **kwargs); end
+#     def method_name(x, y, z, kwargs={}); end
+#
+# 构建器使用示例：
+#
+#     Meta::Utils::KeywordArgs::Builder.build do
+#       key :a, :b, :c
+#       key :d, normalizer: ->(value) { normalize_to_array(value) }
+#     end
+#
+
+module Meta
+  module Utils
+    class KeywordArgs
+      def initialize(arguments, permit_extras = false, final_consumer = nil)
+        @arguments = arguments
+        @permit_extras = permit_extras
+        @final_consumer = final_consumer
+      end
+
+      def check(args)
+        args = args.dup
+        final_args = {}
+
+        @arguments.each do |argument|
+          argument.consume(final_args, args)
+        end
+
+        # 做最终的修饰
+        @final_consumer.call(final_args, args) if @final_consumer
+
+        # 处理剩余字段
+        unless args.keys.empty?
+          if @permit_extras
+            final_args.merge!(args)
+          else
+            extras = args.keys
+            raise "不接受额外的关键字参数：#{extras.join(', ')}" unless extras.empty?
+          end
+        end
+
+        final_args
+      end
+
+      class Argument
+        DEFAULT_TRANSFORMER = ->(value) { value }
+
+        def initialize(name:, normalizer: DEFAULT_TRANSFORMER, alias_names: [])
+          @key_name = name
+          @consumer_names = [name] + alias_names
+          @normalizer = normalizer
+        end
+
+        def consume(final_args, args)
+          @consumer_names.each do |name|
+            return true if consume_name(final_args, args, name)
+          end
+          return false
+        end
+
+        def consume_name(final_args, args, consumer_name)
+          if args.key?(consumer_name)
+            value = @normalizer.call(args.delete(consumer_name))
+            final_args[@key_name] = value
+            true
+          else
+            false
+          end
+        end
+      end
+
+      class Builder
+        def initialize
+          @arguments = []
+          @permit_extras = false
+          @final_consumer = nil
+        end
+
+        def key(*names, **options)
+          names.each do |name|
+            @arguments << Argument.new(name: name, **options)
+          end
+        end
+
+        def permit_extras(value)
+          @permit_extras = value
+        end
+
+        def final_consumer(&block)
+          @final_consumer = block
+        end
+
+        def build
+          KeywordArgs.new(@arguments, @permit_extras, @final_consumer)
+        end
+
+        def self.build(&block)
+          builder = Builder.new
+          builder.instance_exec &block
+          builder.build
+        end
+      end
+    end
+  end
+end

data/lib/meta/utils/kwargs/check.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# 运行时检查关键字参数。（已过时，请使用 Builder）
+#
+# 在 Ruby 3 中，关键字参数有所变化。简单来说，关键字参数和 Hash 类型不再自动转化，并且一般情况下推荐使用关键字参数。
+# 但关键字参数还是有稍稍不足之处，比如在做一些复杂的关键字参数定义时。
+#
+# 这个文件编写了一个方法，帮助我们在运行时检查关键字参数。这样，我们就可以像下面这样笼统的方式定义参数，不必用明确的关
+# 键字参数名称。
+#
+#     def method_name(x, y, z, **kwargs); end
+#     def method_name(x, y, z, kwargs={}); end
+#
+# 使用示例：
+#
+#     # 返回 { x: 1, y: 2, z: 3 }
+#     Meta::Utils::KeywordArgs.check(args: { x: 1, y: 2 }, schema: [:x, :y, { z: 3 }])
+#
+#     # 返回 { x: 1, y: 2, z: 4 }
+#     Meta::Utils::KeywordArgs.check(args: { x: 1, y: 2, z: 4 }, schema: [:x, :y, { z: 3 }])
+#
+#     # Error: `x` is required
+#     Meta::Utils::KeywordArgs.check(args: { y: 2, z: 3 }, schema: [:x, :y, { z: 3 }])
+#
+#     # Error: `a` is not allowed
+#     Meta::Utils::KeywordArgs.check(args: { a: 1, y: 2, z: 3 }, schema: [:x, :y, { z: 3 }])
+
+module Meta
+  module Utils
+    class KeywordArgs
+      class << self
+        def check(args:, schema:)
+          schemas = build_schemas(schema)
+
+          # 不接受额外的关键字参数
+          extras = args.keys - schemas.keys
+          raise "不接受额外的关键字参数：#{extras.join(', ')}" unless extras.empty?
+
+          # 通过 schema 导出关键字参数
+          missing = []
+          result = schemas.map do |name, spec|
+            if args.include?(name)
+              [name, args[name]]
+            elsif spec.include?(:default)
+              [name, spec[:default]]
+            else
+              missing << name
+            end
+          end.to_h
+
+          # 检查以上导出过程中是否找到缺失的参数
+          if missing.empty?
+            result
+          else
+            raise "缺失必要的关键字参数：#{missing.join(', ')}"
+          end
+        end
+
+        private
+
+        def build_schemas(spec)
+          if spec.is_a?(Array)
+            build_schemas_from_array(spec)
+          elsif spec.is_a?(Hash)
+            build_schemas_from_hash(spec)
+          elsif spec.is_a?(Symbol)
+            build_schemas_from_symbol(spec)
+          else
+            raise "未知的参数类型：#{spec.class}"
+          end
+        end
+
+        def build_schemas_from_array(spec_array)
+          spec_array.inject({}) do |accumulated, val|
+            accumulated.merge!(build_schemas(val))
+          end
+        end
+
+        def build_schemas_from_hash(spec_hash)
+          spec_hash.transform_values do |val|
+            { default: val }
+          end
+        end
+
+        def build_schemas_from_symbol(spec_symbol)
+          { spec_symbol => {} }
+        end
+      end
+    end
+  end
+end

data/meta-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "meta-api"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.3"
   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.1
+  version: 0.0.3
 platform: ruby
 authors:
 - yetrun
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies: []
 description: 一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档
 email:
@@ -20,13 +20,16 @@ files:
 - ".autoenv.zsh"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - config/locales/zh-CN.yml
+- docs/Rails.md
 - docs/名称由来.md
+- docs/如何贡献.md
 - docs/教程.md
 - docs/索引.md
 - examples/lobster.rb
@@ -34,28 +37,77 @@ files:
 - examples/rack_app/config.ru
 - examples/rack_app/hello.rb
 - examples/rack_app/timing.rb
+- examples/rails_app/.gitattributes
+- examples/rails_app/.gitignore
+- examples/rails_app/.rspec
+- examples/rails_app/.ruby-version
+- examples/rails_app/Gemfile
+- examples/rails_app/Gemfile.lock
+- examples/rails_app/README.md
+- examples/rails_app/Rakefile
+- examples/rails_app/app/controllers/application_controller.rb
+- examples/rails_app/app/controllers/concerns/.keep
+- examples/rails_app/app/controllers/data_controller.rb
+- examples/rails_app/app/controllers/swagger_controller.rb
+- examples/rails_app/app/models/concerns/.keep
+- examples/rails_app/bin/rails
+- examples/rails_app/bin/rake
+- examples/rails_app/bin/setup
+- examples/rails_app/config.ru
+- examples/rails_app/config/application.rb
+- examples/rails_app/config/boot.rb
+- examples/rails_app/config/credentials.yml.enc
+- examples/rails_app/config/environment.rb
+- examples/rails_app/config/environments/development.rb
+- examples/rails_app/config/environments/production.rb
+- examples/rails_app/config/environments/test.rb
+- examples/rails_app/config/initializers/cors.rb
+- examples/rails_app/config/initializers/filter_parameter_logging.rb
+- examples/rails_app/config/initializers/inflections.rb
+- examples/rails_app/config/initializers/meta_rails_plugin.rb
+- examples/rails_app/config/locales/en.yml
+- examples/rails_app/config/puma.rb
+- examples/rails_app/config/routes.rb
+- examples/rails_app/lib/tasks/.keep
+- examples/rails_app/log/.keep
+- examples/rails_app/public/robots.txt
+- examples/rails_app/spec/data_controller_spec.rb
+- examples/rails_app/spec/rails_helper.rb
+- examples/rails_app/spec/spec_helper.rb
+- examples/rails_app/spec/swagger_controller_spec.rb
+- examples/rails_app/tmp/.keep
+- examples/rails_app/tmp/pids/.keep
 - lib/meta/api.rb
 - lib/meta/application.rb
 - lib/meta/application/application.rb
 - lib/meta/application/execution.rb
-- lib/meta/application/meta.rb
+- lib/meta/application/metadata.rb
+- lib/meta/application/parameters.rb
 - lib/meta/application/path_matching_mod.rb
 - lib/meta/application/route.rb
+- lib/meta/config.rb
 - lib/meta/entity.rb
 - lib/meta/errors.rb
+- lib/meta/json_schema.rb
 - lib/meta/json_schema/builders/array_schema_builder.rb
+- lib/meta/json_schema/builders/dynamic_schema_builder.rb
 - lib/meta/json_schema/builders/object_schema_builder.rb
+- lib/meta/json_schema/builders/ref_schema_builder.rb
 - lib/meta/json_schema/builders/schema_builder_tool.rb
 - lib/meta/json_schema/schemas.rb
 - lib/meta/json_schema/schemas/array_schema.rb
 - lib/meta/json_schema/schemas/base_schema.rb
+- lib/meta/json_schema/schemas/dynamic_schema.rb
 - lib/meta/json_schema/schemas/object_schema.rb
+- lib/meta/json_schema/schemas/properties.rb
+- lib/meta/json_schema/schemas/ref_schema.rb
 - lib/meta/json_schema/support/errors.rb
 - lib/meta/json_schema/support/presenters.rb
 - lib/meta/json_schema/support/schema_options.rb
 - lib/meta/json_schema/support/type_converter.rb
 - lib/meta/json_schema/support/validators.rb
 - lib/meta/load_i18n.rb
+- lib/meta/rails.rb
 - lib/meta/route_dsl/action_builder.rb
 - lib/meta/route_dsl/application_builder.rb
 - lib/meta/route_dsl/chain_builder.rb
@@ -65,6 +117,8 @@ files:
 - lib/meta/route_dsl/route_builder.rb
 - lib/meta/route_dsl/uniformed_params_builder.rb
 - lib/meta/swagger_doc.rb
+- lib/meta/utils/kwargs/builder.rb
+- lib/meta/utils/kwargs/check.rb
 - lib/meta/utils/path.rb
 - meta-api.gemspec
 homepage: https://github.com/yetrun/web-frame
@@ -74,7 +128,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
@@ -89,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: 一个 Web API 框架
 test_files: []