meta-api 0.1.1 → 0.2.0

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Meta
+  module Utils
+    class Kwargs
+      class ArgumentConsumer
+        DEFAULT_TRANSFORMER = ->(value) { value }
+
+        def initialize(name:, normalizer: DEFAULT_TRANSFORMER, validator: nil, default: nil, alias_names: [])
+          @key_name = name
+          @consumer_names = [name] + alias_names
+          @default_proc = -> { default.dup } if default
+          @normalizer = normalizer
+          @validator = validator
+        end
+
+        def consume(final_args, args)
+          @consumer_names.each do |name|
+            return if consume_name(final_args, args, name)
+          end
+
+          if @default_proc
+            default_value = @default_proc.call
+            final_args[@key_name] = @normalizer.call(default_value)
+          end
+        end
+
+        def consume_name(final_args, args, consumer_name)
+          if args.key?(consumer_name)
+            value = @normalizer.call(args.delete(consumer_name))
+            @validator.call(value) if @validator
+            final_args[@key_name] = value
+            true
+          else
+            false
+          end
+        end
+      end
+
+      class ProcConsumer
+        def initialize(&blk)
+          @block = blk
+        end
+
+        def consume(final_args, args)
+          @block.call(final_args, args) if @block
+        end
+      end
+
+      class CompositeConsumer
+        def initialize(*consumers)
+          @consumers = consumers
+        end
+
+        def consume(final_args, args)
+          @consumers.each do |consumer|
+            consumer.consume(final_args, args)
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Meta
+  module Utils
+    class Kwargs
+      module ExtrasConsumers
+        Ignore = ProcConsumer.new
+        Merged = ProcConsumer.new do |final_args, args|
+          final_args.merge!(args)
+        end
+        RaiseError = ProcConsumer.new do |final_args, args|
+          extras_keys = args.keys
+          raise ArgumentError, "不接受额外的关键字参数：#{extras_keys.join(', ')}" unless extras_keys.empty?
+        end
+
+        def self.resolve_handle_extras(sym)
+          return nil if sym.nil?
+
+          case sym
+          when :ignore
+            ExtrasConsumers::Ignore
+          when :merged
+            ExtrasConsumers::Merged
+          when :raise_error
+            ExtrasConsumers::RaiseError
+          else
+            raise ArgumentError, "handle_extras 只接受 :ignore, :merged, :raise_error 三种值，当前传递：#{sym}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Meta
+  module Utils
+    class Kwargs
+      module Helpers
+        class << self
+          # 将 options 内的值修正为固定值，该方法会原地修改 options 选项。
+          # 如果 options 中的缺失相应的值，则使用 fixed_values 中的值补充；如果 options 中的值不等于 fixed_values 中对应的值，则抛出异常。
+          # 示例：
+          # （1）fix!({}, { a: 1, b: 2 }) # => { a: 1, b: 2 }
+          # （2）fix!({ a: 1 }, { a: 2 }) # raise error
+          def fix!(options, fixed_values)
+            fixed_values.each do |key, value|
+              if options.include?(key)
+                if options[key] != value
+                  raise ArgumentError, "关键字参数 #{key} 的值不正确，必须为 #{value}"
+                end
+              else
+                options[key] = value
+              end
+            end
+            options
+          end
+
+          def merge_defaults!(options, defaults)
+            defaults.each do |key, value|
+              options[key] = value unless options[key]
+            end
+            options
+          end
+        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.1.1"
+  spec.version       = "0.2.0"
   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.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - yetrun
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-01 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_to_struct
@@ -81,10 +81,14 @@ files:
 - lib//meta/route_dsl/parameters_builder.rb
 - lib//meta/route_dsl/route_builder.rb
 - lib//meta/route_dsl/uniformed_params_builder.rb
+- lib//meta/scope/base.rb
+- lib//meta/scope/utils.rb
 - lib//meta/swagger_doc.rb
 - lib//meta/utils/kwargs/builder.rb
-- lib//meta/utils/kwargs/check.rb
 - lib//meta/utils/kwargs/checker.rb
+- lib//meta/utils/kwargs/consumers.rb
+- lib//meta/utils/kwargs/extras_consumers.rb
+- lib//meta/utils/kwargs/helpers.rb
 - lib//meta/utils/path.rb
 - lib//meta/utils/route_dsl_builders.rb
 - meta-api.gemspec

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

@@ -1,91 +0,0 @@
-# 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