r2-oas 0.3.4 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -1
- data/GEMSPEC.md +2 -2
- data/README.ja.md +54 -37
- data/README.md +50 -31
- data/lib/r2-oas.rb +3 -3
- data/lib/r2-oas/app_configuration.rb +16 -0
- data/lib/r2-oas/app_configuration/deprecation.rb +28 -0
- data/lib/r2-oas/configuration.rb +52 -0
- data/lib/r2-oas/deploy/client.rb +1 -1
- data/lib/r2-oas/{plugins/schema/v3/object → dynamic/schema/v3/object/from_routes}/hookable_base_object.rb +7 -7
- data/lib/r2-oas/errors.rb +5 -0
- data/lib/r2-oas/hooks/hook.rb +7 -5
- data/lib/r2-oas/pluggable_configuration.rb +8 -5
- data/lib/r2-oas/plugin/base.rb +44 -0
- data/lib/r2-oas/plugin/executor.rb +148 -0
- data/lib/r2-oas/plugin/hookable.rb +42 -0
- data/lib/r2-oas/plugin/public.rb +3 -0
- data/lib/r2-oas/plugin/transform/transform.rb +10 -0
- data/lib/r2-oas/plugin/transform/v3/transform.rb +20 -0
- data/lib/r2-oas/plugin/transform/v3/visitable.rb +37 -0
- data/lib/r2-oas/public.rb +5 -0
- data/lib/r2-oas/schema/base.rb +1 -1
- data/lib/r2-oas/schema/builder.rb +1 -1
- data/lib/r2-oas/schema/v3/analyzer/path_analyzer.rb +1 -1
- data/lib/r2-oas/schema/v3/builder.rb +1 -1
- data/lib/r2-oas/schema/v3/builder/base_builder.rb +14 -2
- data/lib/r2-oas/schema/v3/builder/doc_builder.rb +10 -2
- data/lib/r2-oas/schema/v3/generator/base_generator.rb +7 -2
- data/lib/r2-oas/schema/v3/generator/doc_generator.rb +1 -1
- data/lib/r2-oas/schema/v3/manager/file/include_ref_base_file_manager.rb +3 -2
- data/lib/r2-oas/schema/v3/object/from_files/base_object.rb +62 -0
- data/lib/r2-oas/schema/v3/object/from_files/components/request_body_object.rb +103 -0
- data/lib/r2-oas/schema/v3/object/from_files/components/schema_object.rb +102 -0
- data/lib/r2-oas/schema/v3/object/from_files/components_object.rb +46 -0
- data/lib/r2-oas/schema/v3/object/from_files/external_document_object.rb +23 -0
- data/lib/r2-oas/schema/v3/object/from_files/info_object.rb +23 -0
- data/lib/r2-oas/schema/v3/object/from_files/openapi_object.rb +61 -0
- data/lib/r2-oas/schema/v3/object/from_files/path_item_object.rb +110 -0
- data/lib/r2-oas/schema/v3/object/from_files/paths_object.rb +33 -0
- data/lib/r2-oas/schema/v3/object/from_files/utils/all.rb +4 -0
- data/lib/r2-oas/schema/v3/object/from_files/utils/deep_methods.rb +27 -0
- data/lib/r2-oas/schema/v3/object/from_files/utils/refs.rb +151 -0
- data/lib/r2-oas/schema/v3/object/{base_object.rb → from_routes/base_object.rb} +11 -1
- data/lib/r2-oas/schema/v3/object/{components → from_routes/components}/request_body_object.rb +23 -19
- data/lib/r2-oas/schema/v3/object/{components → from_routes/components}/schema_object.rb +16 -12
- data/lib/r2-oas/schema/v3/object/{components_object.rb → from_routes/components_object.rb} +11 -11
- data/lib/r2-oas/schema/v3/object/from_routes/external_document_object.rb +28 -0
- data/lib/r2-oas/schema/v3/object/{info_object.rb → from_routes/info_object.rb} +11 -2
- data/lib/r2-oas/schema/v3/object/{openapi_object.rb → from_routes/openapi_object.rb} +12 -11
- data/lib/r2-oas/schema/v3/object/{path_item_object.rb → from_routes/path_item_object.rb} +6 -6
- data/lib/r2-oas/schema/v3/object/{paths_object.rb → from_routes/paths_object.rb} +11 -8
- data/lib/r2-oas/schema/v3/object/{public.rb → from_routes/public.rb} +0 -0
- data/lib/r2-oas/schema/v3/object/{server_object.rb → from_routes/server_object.rb} +0 -0
- data/lib/r2-oas/schema/v3/object/{tag_object.rb → from_routes/tag_object.rb} +2 -1
- data/lib/r2-oas/schema/v3/object/store.rb +54 -0
- data/lib/r2-oas/shared/all.rb +1 -0
- data/lib/r2-oas/shared/callable.rb +17 -0
- data/lib/r2-oas/store.rb +20 -16
- data/lib/r2-oas/support/deprecation.rb +24 -0
- data/lib/r2-oas/support/deprecation/behavior.rb +21 -0
- data/lib/r2-oas/support/deprecation/instance_delegator.rb +42 -0
- data/lib/r2-oas/support/deprecation/reporting.rb +91 -0
- data/lib/r2-oas/task_logging.rb +3 -3
- data/lib/r2-oas/tasks/common.rake +1 -1
- data/lib/r2-oas/tasks/main.rake +31 -9
- data/lib/r2-oas/tasks/tool.rake +7 -4
- data/lib/r2-oas/version.rb +1 -1
- metadata +49 -22
- data/lib/r2-oas/schema/v3/object/external_document_object.rb +0 -19
data/lib/r2-oas/schema/base.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
require_relative 'base_analyzer'
|
4
4
|
require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
|
5
5
|
require 'r2-oas/schema/v3/manager/file_manager'
|
6
|
-
require 'r2-oas/schema/v3/object/tag_object'
|
6
|
+
require 'r2-oas/schema/v3/object/from_routes/tag_object'
|
7
7
|
|
8
8
|
# Scope Rails
|
9
9
|
module R2OAS
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
require 'r2-oas/schema/v3/base'
|
4
4
|
require 'r2-oas/routing/parser'
|
5
|
-
require 'r2-oas/schema/v3/object/openapi_object'
|
5
|
+
require 'r2-oas/schema/v3/object/from_routes/openapi_object'
|
6
6
|
require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
|
7
7
|
|
8
8
|
module R2OAS
|
@@ -11,8 +11,14 @@ module R2OAS
|
|
11
11
|
class BaseBuilder < Base
|
12
12
|
include Sortable
|
13
13
|
|
14
|
-
def initialize(
|
14
|
+
def initialize(opts = {})
|
15
15
|
super
|
16
|
+
|
17
|
+
opts.keys.each do |key|
|
18
|
+
send("#{key}=", opts[key])
|
19
|
+
end
|
20
|
+
|
21
|
+
@opts = opts
|
16
22
|
@glob_schema_paths = create_glob_schema_paths
|
17
23
|
end
|
18
24
|
|
@@ -20,6 +26,12 @@ module R2OAS
|
|
20
26
|
|
21
27
|
attr_accessor :unit_paths_file_path
|
22
28
|
attr_accessor :skip_load_dot_paths
|
29
|
+
attr_accessor :opts
|
30
|
+
attr_accessor :use_plugin
|
31
|
+
attr_accessor :output
|
32
|
+
|
33
|
+
alias use_plugin? use_plugin
|
34
|
+
alias output? output
|
23
35
|
|
24
36
|
def schema_file_do_not_exists?
|
25
37
|
schema_files_paths.count == 0
|
@@ -2,13 +2,18 @@
|
|
2
2
|
|
3
3
|
require 'yaml'
|
4
4
|
require 'fileutils'
|
5
|
+
require 'r2-oas/schema/v3/object/from_files/openapi_object'
|
5
6
|
require_relative 'base_builder'
|
6
7
|
|
7
8
|
module R2OAS
|
8
9
|
module Schema
|
9
10
|
module V3
|
10
11
|
class DocBuilder < BaseBuilder
|
11
|
-
attr_accessor :oas_doc
|
12
|
+
attr_accessor :oas_doc, :pure_oas_doc
|
13
|
+
|
14
|
+
def initialize(opts = {})
|
15
|
+
super
|
16
|
+
end
|
12
17
|
|
13
18
|
def build_docs
|
14
19
|
logger.info '[Build OAS schema files] start'
|
@@ -34,8 +39,11 @@ module R2OAS
|
|
34
39
|
result_before_squeeze
|
35
40
|
end
|
36
41
|
|
42
|
+
@pure_oas_doc = result.dup
|
43
|
+
rsult = FromFiles::OpenapiObject.new(result, opts).to_doc if use_plugin?
|
37
44
|
@oas_doc = result
|
38
|
-
|
45
|
+
|
46
|
+
File.write(output? ? output_path : doc_save_file_path, result.to_yaml)
|
39
47
|
end
|
40
48
|
end
|
41
49
|
end
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
require 'r2-oas/schema/v3/base'
|
4
4
|
require 'r2-oas/routing/parser'
|
5
|
-
require 'r2-oas/schema/v3/object/openapi_object'
|
5
|
+
require 'r2-oas/schema/v3/object/from_routes/openapi_object'
|
6
6
|
require 'r2-oas/schema/v3/manager/file/path_item_file_manager'
|
7
7
|
require 'r2-oas/store'
|
8
8
|
|
@@ -14,7 +14,12 @@ module R2OAS
|
|
14
14
|
|
15
15
|
def initialize(options = {})
|
16
16
|
super
|
17
|
-
|
17
|
+
|
18
|
+
options.keys.each do |key|
|
19
|
+
send("#{key}=", options[key])
|
20
|
+
end
|
21
|
+
|
22
|
+
@store = ::R2OAS::Store.create(:schema)
|
18
23
|
@glob_schema_paths = create_glob_schema_paths
|
19
24
|
end
|
20
25
|
|
@@ -36,12 +36,13 @@ module R2OAS
|
|
36
36
|
attr_accessor :parent_save_file_paths, :recursive_search_class
|
37
37
|
|
38
38
|
def deep_search_ref_recursive(yaml, &block)
|
39
|
-
|
39
|
+
case yaml
|
40
|
+
when Hash
|
40
41
|
yaml.each do |key, value|
|
41
42
|
process_deep_search_ref_recursive(key, value, &block)
|
42
43
|
end
|
43
44
|
# Support allOf/oneOf/anyOf
|
44
|
-
|
45
|
+
when Array
|
45
46
|
yaml.each do |el|
|
46
47
|
next unless el.is_a?(Hash)
|
47
48
|
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'forwardable'
|
4
|
+
require 'key_flatten'
|
5
|
+
|
6
|
+
require 'r2-oas/plugin/executor'
|
7
|
+
require 'r2-oas/schema/v3/object/store'
|
8
|
+
|
9
|
+
module R2OAS
|
10
|
+
module Schema
|
11
|
+
module V3
|
12
|
+
module FromFiles
|
13
|
+
class BaseObject
|
14
|
+
extend Forwardable
|
15
|
+
|
16
|
+
class << self
|
17
|
+
def obj_store
|
18
|
+
::R2OAS::Schema::V3::Store.create(:obj)
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
def_delegators :@plugin_executor, :execute_transform_plugins
|
23
|
+
|
24
|
+
def initialize(opts = {})
|
25
|
+
@opts = opts
|
26
|
+
plugins = app_configuration_options[:plugins]
|
27
|
+
@plugin_executor = ::R2OAS::Plugin::Executor.new(plugins, opts)
|
28
|
+
end
|
29
|
+
|
30
|
+
def to_doc
|
31
|
+
raise 'Implement Inherit Class'
|
32
|
+
end
|
33
|
+
|
34
|
+
private
|
35
|
+
|
36
|
+
def obj_store
|
37
|
+
self.class.obj_store
|
38
|
+
end
|
39
|
+
|
40
|
+
def set_root_doc(root_doc)
|
41
|
+
obj_store.root_doc = root_doc.dup
|
42
|
+
end
|
43
|
+
|
44
|
+
def root_doc
|
45
|
+
obj_store.root_doc
|
46
|
+
end
|
47
|
+
|
48
|
+
def set_components_name_list(root_doc)
|
49
|
+
obj_store.components_schema_name_list = (root_doc.fetch('components', nil)&.fetch('schemas', nil) || {}).keys.sort.uniq
|
50
|
+
obj_store.components_request_body_name_list = (root_doc.fetch('components', nil)&.fetch('schemas', nil) || {}).keys.sort.uniq
|
51
|
+
end
|
52
|
+
|
53
|
+
def app_configuration_options
|
54
|
+
R2OAS.app_configuration_options
|
55
|
+
end
|
56
|
+
|
57
|
+
attr_accessor :opts
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'r2-oas/shared/callable'
|
4
|
+
require 'r2-oas/errors'
|
5
|
+
require_relative '../base_object'
|
6
|
+
require_relative 'schema_object'
|
7
|
+
require_relative '../utils/all'
|
8
|
+
|
9
|
+
module R2OAS
|
10
|
+
module Schema
|
11
|
+
module V3
|
12
|
+
module FromFiles
|
13
|
+
module Components
|
14
|
+
class RequestBodyObject < ::R2OAS::Schema::V3::FromFiles::BaseObject
|
15
|
+
include ::R2OAS::Callable
|
16
|
+
include DeepMethods
|
17
|
+
|
18
|
+
def initialize(doc, ref, opts)
|
19
|
+
super(opts)
|
20
|
+
@doc = doc
|
21
|
+
@parent_ref = Components::RequestBodyRef.new(ref)
|
22
|
+
resolve_dependencies!
|
23
|
+
end
|
24
|
+
|
25
|
+
def to_doc
|
26
|
+
call_ref_path!
|
27
|
+
|
28
|
+
# MEMO:
|
29
|
+
# If it is overwritten, it may lead to unexpected problems, so give a copy
|
30
|
+
execute_transform_plugins(:components_request_body, @doc, ref_dup)
|
31
|
+
@doc
|
32
|
+
end
|
33
|
+
|
34
|
+
def resolve_dependencies!
|
35
|
+
deep_replace!(@doc, '$ref') do |ref_path|
|
36
|
+
schema_obj, schema_type, pure_schema_name = ref_path.split('/').slice(1..-1)
|
37
|
+
schema_doc = root_doc&.fetch(schema_obj, nil)&.fetch(schema_type, nil)&.fetch(pure_schema_name, nil) || {}
|
38
|
+
|
39
|
+
ref = create_child_ref(pure_schema_name)
|
40
|
+
obj = Components::SchemaObject.new(schema_doc, ref, opts)
|
41
|
+
|
42
|
+
obj_store.add('components/schemas', pure_schema_name, obj)
|
43
|
+
obj
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def call_ref_path!
|
48
|
+
callback = proc { |obj| obj.ref_path }
|
49
|
+
deep_call(@doc, '$ref', callback)
|
50
|
+
end
|
51
|
+
|
52
|
+
def schema_name
|
53
|
+
return @resolved_schema_name if @resolved_schema_name.present?
|
54
|
+
|
55
|
+
before_schema_name = ref_dup[:schema_name]
|
56
|
+
|
57
|
+
_ref_dup = ref_dup
|
58
|
+
execute_transform_plugins(:components_request_body_name, _ref_dup)
|
59
|
+
@resolved_schema_name = _ref_dup[:schema_name]
|
60
|
+
|
61
|
+
if before_schema_name != @resolved_schema_name
|
62
|
+
if reserved_schema_name_list.include?(@resolved_schema_name)
|
63
|
+
raise DepulicateSchemaNameError, "Transformed schema name: '#{@resolved_schema_name}' cannot be used. It already exists."
|
64
|
+
else
|
65
|
+
obj_store.appended_components_request_body_name_list.push(@resolved_schema_name)
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
@resolved_schema_name
|
70
|
+
end
|
71
|
+
|
72
|
+
def ref_path
|
73
|
+
"#/components/requestBodies/#{schema_name}"
|
74
|
+
end
|
75
|
+
|
76
|
+
private
|
77
|
+
|
78
|
+
def ref_dup
|
79
|
+
@parent_ref.dup
|
80
|
+
end
|
81
|
+
|
82
|
+
def reserved_schema_name_list
|
83
|
+
(
|
84
|
+
obj_store.components_request_body_name_list +
|
85
|
+
obj_store.appended_components_request_body_name_list
|
86
|
+
).uniq
|
87
|
+
end
|
88
|
+
|
89
|
+
def create_child_ref(schema_name)
|
90
|
+
local_ref_hash = ref_dup.to_h
|
91
|
+
parent_schema_name = local_ref_hash[:schema_name]
|
92
|
+
depth = local_ref_hash[:depth] + 1
|
93
|
+
ref_data = local_ref_hash.merge({ from: :request_body, schema_name: schema_name, parent_schema_name: parent_schema_name, depth: depth })
|
94
|
+
ref = Components::SchemaRef.new(ref_data)
|
95
|
+
ref.send(:parent=, ref_dup)
|
96
|
+
ref
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
@@ -0,0 +1,102 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'r2-oas/shared/callable'
|
4
|
+
require 'r2-oas/errors'
|
5
|
+
require_relative '../base_object'
|
6
|
+
require_relative '../utils/all'
|
7
|
+
|
8
|
+
module R2OAS
|
9
|
+
module Schema
|
10
|
+
module V3
|
11
|
+
module FromFiles
|
12
|
+
module Components
|
13
|
+
class SchemaObject < ::R2OAS::Schema::V3::FromFiles::BaseObject
|
14
|
+
include ::R2OAS::Callable
|
15
|
+
include DeepMethods
|
16
|
+
|
17
|
+
def initialize(doc, ref, opts)
|
18
|
+
super(opts)
|
19
|
+
@doc = doc
|
20
|
+
@parent_ref = Components::SchemaRef.new(ref)
|
21
|
+
resolve_dependencies!
|
22
|
+
end
|
23
|
+
|
24
|
+
def to_doc
|
25
|
+
call_ref_path!
|
26
|
+
|
27
|
+
# MEMO:
|
28
|
+
# If it is overwritten, it may lead to unexpected problems, so give a copy
|
29
|
+
execute_transform_plugins(:components_schema, @doc, ref_dup)
|
30
|
+
@doc
|
31
|
+
end
|
32
|
+
|
33
|
+
def resolve_dependencies!
|
34
|
+
deep_replace!(@doc, '$ref') do |ref_path|
|
35
|
+
schema_obj, schema_type, pure_schema_name = ref_path.split('/').slice(1..-1)
|
36
|
+
schema_doc = root_doc&.fetch(schema_obj, nil)&.fetch(schema_type, nil)&.fetch(pure_schema_name, nil) || {}
|
37
|
+
|
38
|
+
ref = create_child_ref(pure_schema_name)
|
39
|
+
obj = Components::SchemaObject.new(schema_doc, ref, opts)
|
40
|
+
|
41
|
+
obj_store.add('components/schemas', pure_schema_name, obj)
|
42
|
+
obj
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
def call_ref_path!
|
47
|
+
callback = proc { |obj| obj.ref_path }
|
48
|
+
deep_call(@doc, '$ref', callback)
|
49
|
+
end
|
50
|
+
|
51
|
+
def schema_name
|
52
|
+
return @resolved_schema_name if @resolved_schema_name.present?
|
53
|
+
|
54
|
+
before_schema_name = ref_dup[:schema_name]
|
55
|
+
|
56
|
+
_ref_dup = ref_dup
|
57
|
+
execute_transform_plugins(:components_schema_name, _ref_dup)
|
58
|
+
@resolved_schema_name = _ref_dup[:schema_name]
|
59
|
+
|
60
|
+
if before_schema_name != @resolved_schema_name
|
61
|
+
if reserved_schema_name_list.include?(@resolved_schema_name)
|
62
|
+
raise DepulicateSchemaNameError, "Transformed schema name: '#{@resolved_schema_name}' cannot be used. It already exists."
|
63
|
+
else
|
64
|
+
obj_store.appended_components_schema_name_list.push(@resolved_schema_name)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
@resolved_schema_name
|
69
|
+
end
|
70
|
+
|
71
|
+
def ref_path
|
72
|
+
"#/components/schemas/#{schema_name}"
|
73
|
+
end
|
74
|
+
|
75
|
+
private
|
76
|
+
|
77
|
+
def ref_dup
|
78
|
+
@parent_ref.dup
|
79
|
+
end
|
80
|
+
|
81
|
+
def reserved_schema_name_list
|
82
|
+
(
|
83
|
+
obj_store.components_schema_name_list +
|
84
|
+
obj_store.appended_components_schema_name_list
|
85
|
+
).uniq
|
86
|
+
end
|
87
|
+
|
88
|
+
def create_child_ref(schema_name)
|
89
|
+
local_ref_hash = ref_dup.to_h
|
90
|
+
parent_schema_name = local_ref_hash[:schema_name]
|
91
|
+
depth = local_ref_hash[:depth] + 1
|
92
|
+
ref_data = local_ref_hash.merge({ from: :schema, schema_name: schema_name, parent_schema_name: parent_schema_name, depth: depth })
|
93
|
+
ref = Components::SchemaRef.new(ref_data)
|
94
|
+
ref.send(:parent=, ref_dup)
|
95
|
+
ref
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative 'base_object'
|
4
|
+
require_relative 'components/schema_object'
|
5
|
+
require_relative 'components/request_body_object'
|
6
|
+
|
7
|
+
module R2OAS
|
8
|
+
module Schema
|
9
|
+
module V3
|
10
|
+
module FromFiles
|
11
|
+
class ComponentsObject < BaseObject
|
12
|
+
def initialize(doc, opts = {})
|
13
|
+
super(opts)
|
14
|
+
@doc = doc
|
15
|
+
end
|
16
|
+
|
17
|
+
def to_doc
|
18
|
+
create_doc
|
19
|
+
@doc
|
20
|
+
end
|
21
|
+
|
22
|
+
private
|
23
|
+
|
24
|
+
def create_doc
|
25
|
+
create_components_schema_docs!
|
26
|
+
create_components_request_body_docs!
|
27
|
+
end
|
28
|
+
|
29
|
+
def create_components_schema_docs!
|
30
|
+
result = obj_store.gets('components/schemas').each_with_object({}) do |obj, data|
|
31
|
+
data[obj.schema_name] = obj.to_doc
|
32
|
+
end
|
33
|
+
@doc.merge!('schemas' => result) if result.present?
|
34
|
+
end
|
35
|
+
|
36
|
+
def create_components_request_body_docs!
|
37
|
+
result = obj_store.gets('components/requestBodies').each_with_object({}) do |obj, data|
|
38
|
+
data[obj.schema_name] = obj.to_doc
|
39
|
+
end
|
40
|
+
@doc.merge!('requestBodies' => result) if result.present?
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|