meta-api 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c114ab0d95b902ecefcd5e720f0c38fbcc420b2839194842c2974d2d073505fd
-  data.tar.gz: 994b7e975626f9907467edfe4283875aa113957edc860b74ed1b29e27560f196
+  metadata.gz: 6b35c78915baab28213ceb9f2b6184c8ae177742ce0524529c681132fa6e0390
+  data.tar.gz: bc4ca96b46e0284f10fa41360ef4308aa7378121ead9f0cd1a536ac027cd590e
 SHA512:
-  metadata.gz: 6b62b24879f309c6cc67e45bc9bfd250b47ec8ad6c25f5fe1e9f5098b970ff8466f239b8799b4e653ebdc5568cbbb87fdd7c086703a99ef8525945ce24c44617
-  data.tar.gz: edec25f4ea37588611af7dceca41a443c5cb6d83586096f51f9f27ce75fdf290ec7085e4f27bf87043779e1ed289f7cbaa0a7e9568839e2ed206eef1d7d4f4b7
+  metadata.gz: c5cf6b6c1ee9ba5af2826b6682e57a357bbd74caf7807a5f3f9cbd124b99bdce4bcc7cba7040b45b2c1d62b9abfda1e4ee6c47853c2ebcb57bfd2d8a224db622
+  data.tar.gz: 5043cc4c8516d7c6bc827d32889e26a2164299ba0a71b1439bd1594aabdd1975bbd1994139fed2ffca93409e9c1f2118157301b3cef502767750c52b061c7367

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem 'i18n'
+gem 'hash_to_struct'
 
 group :test do
   gem 'rspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    meta-api (0.0.7)
+    meta-api (0.0.8)
 
 GEM
   remote: https://gems.ruby-china.com/
@@ -18,6 +18,7 @@ GEM
     grape-entity (0.10.1)
       activesupport (>= 3.0.0)
       multi_json (>= 1.3.2)
+    hash_to_struct (1.0.0)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
@@ -54,6 +55,7 @@ PLATFORMS
 
 DEPENDENCIES
   grape-entity
+  hash_to_struct
   i18n
   meta-api!
   pry-byebug

data/README.md

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

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

@@ -1645,3 +1645,64 @@ class DemoApp < Meta::Application
   end
 end
 ```
+
+### 实体内部引入另一个实体的字段（轨迹）
+
+我们有时候遇到这样一个需求：需要把另一个实体的字段合并到当前的实体。在其他框架里，你会发现诸如继承（inherited）、轨迹（trait）这样的术语；但是 Meta 框架没有。事实上，我们可以通过 Ruby 语言本身的表达做到这样的效果，因此对于该特性 Meta 框架目前采取谨慎加入的态度。
+
+举一个表单控件实体和控件值实体的例子。下面是控件实体：
+
+```ruby
+class ControlEntity < Meta::Entity
+  property :id, type: 'integer', description: '控件 ID'
+  property :label, type: 'string', description: '标签名称，显示在控件的左边'
+  property :style, type: 'string', description: '控件类型，如文本框、下拉框、单选框等'
+  property :required, type: boolean, description: '是否必选'
+  property :multiple, type: boolean, description: '是否多项值，当用在下拉框时可选中多个值'
+end
+```
+
+另有一个控件值实体：
+
+```ruby
+class ControlValueEntity < Meta::Entity
+  property :id, type: 'integer', description: '控件 ID'
+  property :label, type: 'string', description: '标签名称，显示在控件的左边'
+  # 包含控件的其他字段……
+    
+  property :value, type: 'object', description: '控件填入的值'
+end
+```
+
+以上显然有重复。我们可以将 `ControlEntity` 的代码放到一个 `Proc` 中，两个实体内都执行一次：
+
+```ruby
+ControlEntityProc = Proc.new do
+  property :id, type: 'integer', description: '控件 ID'
+  property :label, type: 'string', description: '标签名称，显示在控件的左边'
+  property :style, type: 'string', description: '控件类型，如文本框、下拉框、单选框等'
+  property :required, type: boolean, description: '是否必选'
+  property :multiple, type: boolean, description: '是否多项值，当用在下拉框时可选中多个值'
+end
+
+class ControlEntity < Meta::Entity
+  instance_exec &ControlEntityProc
+end
+
+class ControlValueEntity < Meta::Entity
+  instance_exec &ControlEntityProc
+    
+  property :value, type: 'object', description: '控件填入的值'
+end
+```
+
+Meta 框架还提供了一个 `use` 方法，它可以代替 `instance_exec` 方法。没什么特别的意思，只是简化了一丢丢代码而已：
+
+```ruby
+class ControlValueEntity < Meta::Entity
+  use ControlEntityProc
+    
+  property :value, type: 'object', description: '控件填入的值'
+end
+```
+

data/lib/meta/config.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-module Meta
-  class Config
-    attr_accessor :default_locked_scope,
-                  :json_schema_user_options,
-                  :json_schema_param_stage_options,
-                  :json_schema_render_stage_options
+require 'hash_to_struct'
 
-    def initialize
-      @default_locked_scope = nil
-      @json_schema_user_options = {}
-      @json_schema_param_stage_options = {}
-      @json_schema_render_stage_options = {}
-    end
-  end
+module Meta
+  DEFAULT_OPTIONS = {
+    default_locked_scope: nil,
+    json_schema_user_options: {},
+    json_schema_param_stage_options: {},
+    json_schema_render_stage_options: {}
+  }
 
-  @config = Config.new
   class << self
     attr_reader :config
+
+    def initialize_configuration(*options_list)
+      final_options = options_list.reduce(DEFAULT_OPTIONS, :deep_merge)
+      @config = HashToStruct.struct(final_options)
+    end
   end
 end
+Meta.initialize_configuration

data/lib/meta/route_dsl/uniformed_params_builder.rb

@@ -15,16 +15,16 @@ module Meta
 
       def param(name, options = {}, &block)
         options = (options || {}).dup
-        in_op = options.delete(:in) || \
           if path_param_names.include?(name)
-            'path'
+            options = Utils::KeywordArgs::Checker.fix!(options, in: 'path', required: true)
           elsif @route_method == :get
-            'query'
+            options = Utils::KeywordArgs::Checker.merge_defaults!(options, in: 'query')
           else
-            'body'
+            options = Utils::KeywordArgs::Checker.merge_defaults!(options, in: 'body')
           end
 
-        if in_op == 'body'
+        if options[:in] == 'body'
+          options.delete(:in)
           property name, options, &block
         else
           @parameters_builder.param name, options

data/meta-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "meta-api"
-  spec.version       = "0.0.7"
+  spec.version       = "0.0.8"
   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.7
+  version: 0.0.8
 platform: ruby
 authors:
 - yetrun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies: []
 description: 一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档
 email: