meta-api 0.0.8 → 0.1.0

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative '../../utils/kwargs/check'
+require_relative '../support/schema_options'
+require_relative 'scoping_schema'
+require_relative 'unsupported_schema'
+
+module Meta
+  module JsonSchema
+    # 内含 param_schema, render_schema, default_schema，分别用于不同的阶段。
+    class StagingSchema < BaseSchema
+      attr_reader :param_schema, :render_schema
+
+      def initialize(param_schema:, render_schema:)
+        raise ArgumentError, 'param_schema 选项重复提交为 StagingSchema' if param_schema.is_a?(StagingSchema)
+        raise ArgumentError, 'render_schema 选项重复提交为 StagingSchema' if render_schema.is_a?(StagingSchema)
+
+        @param_schema = param_schema
+        @render_schema = render_schema
+      end
+
+      def filter(value, user_options = {})
+        if user_options[:stage] == :param
+          param_schema.filter(value, user_options)
+        elsif user_options[:stage] == :render
+          render_schema.filter(value, user_options)
+        else
+          raise ArgumentError, "stage 选项必须是 :param 或 :render"
+        end
+      end
+
+      def staged(stage)
+        if stage == :param
+          param_schema
+        elsif stage == :render
+          render_schema
+        else
+          raise ArgumentError, "stage 选项必须是 :param 或 :render"
+        end
+      end
+
+      def defined_scopes(stage:, **kwargs)
+        staged(stage).defined_scopes(stage: stage, **kwargs)
+      end
+
+      def self.build_from_options(options, build_schema = ->(opts) { BaseSchema.new(opts) })
+        param_opts, render_opts, common_opts = SchemaOptions.divide_to_param_and_render(options)
+        if param_opts == common_opts && render_opts == common_opts
+          return ScopingSchema.build_from_options(common_opts, build_schema)
+        else
+          StagingSchema.new(
+            param_schema: param_opts ? ScopingSchema.build_from_options(param_opts, build_schema) : UnsupportedSchema.new(:stage, :param),
+            render_schema: render_opts ? ScopingSchema.build_from_options(render_opts, build_schema) : UnsupportedSchema.new(:stage, :render)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Meta
+  module JsonSchema
+    class UnsupportedSchema < BaseSchema
+      attr_reader :key, :value
+
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+
+      def filter?
+        false
+      end
+
+      def filter(value, options)
+        raise UnsupportedError, "不支持的 #{key}: #{value}}"
+      end
+    end
+  end
+end

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

@@ -34,5 +34,8 @@ module Meta
         errors['']
       end
     end
+
+    class UnsupportedError < StandardError
+    end
   end
 end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# 将 Ruby 类型包装成 JsonObject 类型，以便可以通过 [key] 访问。同时，保留其他方法的调用，将其转发到原始对象上。
+module Meta
+  module JsonSchema
+    class JsonObject
+      def initialize(target)
+        @target = target
+      end
+
+      def __target__
+        @target
+      end
+
+      def key?(key)
+        @target.respond_to?(key)
+      end
+
+      def [](key)
+        @target.__send__(key)
+      end
+
+      def method_missing(method, *args)
+        @target.__send__(method, *args)
+      end
+
+      def self.wrap(target)
+        case target
+        when JsonObject, Hash
+          target
+        else
+          new(target)
+        end
+      end
+    end
+  end
+end

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

@@ -9,11 +9,6 @@ module Meta
         scope: [],
         required: false
       }
-      @allowable_options = (
-        %i[type description in value using default presenter convert scope items using] +
-        @default_options.keys + 
-        JsonSchema::Validators.keys
-      ).uniq
 
       class << self
         def divide_to_param_and_render(options)
@@ -37,10 +32,6 @@ module Meta
             end
           end
 
-          # 处理 validators
-          unknown_validators = options.keys - @allowable_options
-          raise "未知的选项：#{unknown_validators.join(', ')}" unless unknown_validators.empty?
-
           options
         end
 

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Meta
+  module JsonSchema
+    class ScopeMatcher
+      attr_reader :defined_scopes
+
+      def initialize(query_clause)
+        query_clause = [query_clause] if query_clause.is_a?(String) || query_clause.is_a?(Symbol)
+        query_clause = { some_of: query_clause } if query_clause.is_a?(Array)
+
+        @match_type, @defined_scopes = query_clause.first
+      end
+
+      def match?(scopes)
+        return false if scopes.empty?
+
+        case @match_type
+        when :some_of
+          (@defined_scopes & scopes).any?
+        when :all_of
+          (@defined_scopes - scopes).empty?
+        else
+          raise "Unknown match type: #{@match_type}"
+        end
+      end
+    end
+  end
+end

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

@@ -1,31 +1,10 @@
 # frozen_string_literal: true
 
 require 'bigdecimal'
+require_relative 'json_object'
 
 module Meta
   module JsonSchema
-    class ObjectWrapper
-      def initialize(target)
-        @target = target
-      end
-
-      def __target__
-        @target
-      end
-
-      def key?(key)
-        @target.respond_to?(key)
-      end
-
-      def [](key)
-        @target.__send__(key)
-      end
-
-      def method_missing(method, *args)
-        @target.__send__(method, *args)
-      end
-    end
-
     module TypeConverter
       # 定义客户类型对应的 Ruby 类型
       @definity_types = {
@@ -34,7 +13,7 @@ module Meta
         'number' => [Integer, Float, BigDecimal],
         'string' => [String],
         'array' => [Array],
-        'object' => [Hash, ObjectWrapper]
+        'object' => [Hash, JsonObject]
       }
 
       # 定义从 Ruby 类型转化为对应类型的逻辑
@@ -101,7 +80,7 @@ module Meta
             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)
+          JsonObject.new(value)
         end
       }
 

data/lib/meta/route_dsl/meta_builder.rb

@@ -9,7 +9,7 @@ module Meta
       def initialize(route_full_path:, route_method: :all, &block)
         @route_full_path = route_full_path
         @method = route_method
-        @meta = {}
+        @meta = { scope: [] }
         @parameters_builder = ParametersBuilder.new(route_full_path: route_full_path, route_method: route_method) # 默认给一个空的参数构建器，它只会处理 path 参数
 
         instance_exec &block if block_given?
@@ -43,7 +43,7 @@ module Meta
         codes.each { |code| @meta[:responses][code] = entity_schema }
       end
 
-      [:tags, :title, :description].each do |method_name|
+      [:tags, :title, :description, :scope].each do |method_name|
         define_method(method_name) do |value|
           @meta[method_name] = value
         end

data/lib/meta/swagger_doc.rb

@@ -5,7 +5,7 @@ module Meta
     class << self
       def generate(application, info: {}, servers: [])
         paths_and_routes = get_paths_and_routes!(application)
-        return generate_from_paths_and_routes(paths_and_routes, info: info, servers: servers)
+        generate_from_paths_and_routes(paths_and_routes, info: info, servers: servers)
       end
 
       def generate_from_paths_and_routes(paths_and_routes, info: {}, servers: [])
@@ -32,7 +32,7 @@ module Meta
 
       # 生成单个路由的文档
       def generate_operation_object(route, schemas)
-        route.meta.generate_operation_doc(schemas)
+        route.generate_operation_doc(schemas)
       end
 
       private
@@ -62,28 +62,5 @@ module Meta
         store_routes
       end
     end
-
-    class Path
-      def initialize(parts = [])
-        @parts = parts.freeze
-      end
-
-      def append(part)
-        part = part[1..-1] if part.start_with?('/')
-        parts = part.split('/')
-
-        self.class.new(@parts + parts)
-      end
-
-      def to_s
-        '/' + @parts.join('/')
-      end
-
-      def self.from_string(path)
-        path = path[1..-1] if path.start_with?('/')
-        parts = path.split('/')
-        self.class.new(parts)
-      end
-    end
   end
 end

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

@@ -58,15 +58,17 @@ module Meta
         def initialize(name:, normalizer: DEFAULT_TRANSFORMER, validator: nil, default: nil, alias_names: [])
           @key_name = name
           @consumer_names = [name] + alias_names
-          @normalizer = default ? ->(value) { normalizer.call(value || default) } : normalizer
+          @default_value = default
+          @normalizer = normalizer
           @validator = validator
         end
 
         def consume(final_args, args)
           @consumer_names.each do |name|
-            return true if consume_name(final_args, args, name)
+            return if consume_name(final_args, args, name)
           end
-          return false
+
+          final_args[@key_name] = @default_value unless @default_value.nil?
         end
 
         def consume_name(final_args, args, consumer_name)

data/lib/meta/utils/route_dsl_builders.rb

@@ -10,11 +10,12 @@ module Meta
             final_options[:parameters] = options1[:parameters].merge(options2[:parameters])
           end
           if options1[:request_body].is_a?(Meta::JsonSchema::ObjectSchema) && options2[:request_body].is_a?(Meta::JsonSchema::ObjectSchema)
-            final_options[:request_body] = options1[:request_body].merge_other_properties(options2[:request_body].properties)
+            final_options[:request_body] = options1[:request_body].properties.merge(options2[:request_body].properties)
           end
           if options1[:responses] && options2[:responses]
             final_options[:responses] = options1[:responses].merge(options2[:responses])
           end
+          final_options[:scope] = [options1[:scope] || [], options2[:scope] || []].flatten.uniq
           final_options
         end
 

data/meta-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "meta-api"
-  spec.version       = "0.0.8"
+  spec.version       = "0.1.0"
   spec.authors       = ["yetrun"]
   spec.email         = ["yetrun@foxmail.com"]
 
@@ -14,10 +14,11 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/yetrun/web-frame.git"
 
+  spec.add_dependency "hash_to_struct", "~> 1.0.0"
+
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files = Dir.glob("{config,lib}/{.rb,/**/*}", File::FNM_DOTMATCH).reject {|f| File.directory?(f) }
+  spec.files += %w[CHANGELOG.md LICENSE.txt meta-api.gemspec]
+
   spec.require_paths = ["lib"]
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: meta-api
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - yetrun
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_to_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: 一个 Web API 框架，该框架采用定义元信息的方式编写 API，并同步生成 API 文档
 email:
 - yetrun@foxmail.com
@@ -17,112 +31,62 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 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
-- examples/rack_app/README.md
-- 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/linked_action.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/around_action_builder.rb
-- lib/meta/route_dsl/chain_builder.rb
-- lib/meta/route_dsl/meta_builder.rb
-- lib/meta/route_dsl/parameters_builder.rb
-- 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/kwargs/checker.rb
-- lib/meta/utils/path.rb
-- lib/meta/utils/route_dsl_builders.rb
+- config//locales/zh-CN.yml
+- lib//meta/api.rb
+- lib//meta/application.rb
+- lib//meta/application/application.rb
+- lib//meta/application/execution.rb
+- lib//meta/application/linked_action.rb
+- lib//meta/application/metadata.rb
+- lib//meta/application/parameters.rb
+- lib//meta/application/path_matching_mod.rb
+- lib//meta/application/responses.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/named_properties.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/schemas/scoping_schema.rb
+- lib//meta/json_schema/schemas/staging_schema.rb
+- lib//meta/json_schema/schemas/unsupported_schema.rb
+- lib//meta/json_schema/support/errors.rb
+- lib//meta/json_schema/support/json_object.rb
+- lib//meta/json_schema/support/presenters.rb
+- lib//meta/json_schema/support/schema_options.rb
+- lib//meta/json_schema/support/scope_matcher.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/around_action_builder.rb
+- lib//meta/route_dsl/chain_builder.rb
+- lib//meta/route_dsl/meta_builder.rb
+- lib//meta/route_dsl/parameters_builder.rb
+- 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/kwargs/checker.rb
+- lib//meta/utils/path.rb
+- lib//meta/utils/route_dsl_builders.rb
 - meta-api.gemspec
 homepage: https://github.com/yetrun/web-frame
 licenses:
@@ -131,7 +95,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
@@ -146,8 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: 一个 Web API 框架
 test_files: []

data/.autoenv.zsh

@@ -1 +0,0 @@
-alias rspec="bundle exec rspec"

data/.gitignore

@@ -1,7 +0,0 @@
-.DS_Store
-*.gem
-.idea
-.ruby-version
-
-.bundle
-vendor

data/.rubocop.yml

@@ -1,28 +0,0 @@
-# https://docs.rubocop.org/rubocop/1.24/cops_style.html
-
-AllCops:
-  NewCops: enable
-
-Style/BlockDelimiters:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/GuardClause:
-  Enabled: false
-Style/RaiseArgs:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 20
-Metrics/BlockLength:
-  IgnoredMethods: ['describe', 'context']
-Metrics/AbcSize:
-  CountRepeatedAttributes: false
-  Max: 30
-Metrics/PerceivedComplexity:
-  Max: 10
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver

data/Gemfile

@@ -1,19 +0,0 @@
-source 'https://gems.ruby-china.com/'
-
-# Specify your gem's dependencies in xxx.gemspec
-gemspec
-
-gem "rake", "~> 12.0"
-gem 'i18n'
-gem 'hash_to_struct'
-
-group :test do
-  gem 'rspec'
-  gem 'rack-test'
-  gem 'grape-entity'
-end
-
-group :test, :development do
-  gem 'rack'
-  gem 'pry-byebug'
-end