open_api_annotator 0.5.0 → 0.6.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/test.yml +29 -0
- data/.gitignore +1 -0
- data/.ruby-version +1 -1
- data/CHANGELOG.md +9 -0
- data/CODE_OF_CONDUCT.md +1 -1
- data/README.md +3 -3
- data/gemfiles/rails-6.1.gemfile +8 -0
- data/gemfiles/rails-7.0.gemfile +8 -0
- data/lib/open_api_annotator/serializer_annotatable.rb +1 -1
- data/lib/open_api_annotator/version.rb +1 -1
- data/open_api_annotator.gemspec +8 -7
- metadata +24 -20
- data/.travis.yml +0 -18
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dde2d52c30c7150fb7545c2f596c0e4efb03d34b681e3425e8756d42d7fb4cba
|
4
|
+
data.tar.gz: f642b9b214e53220e18cf68902ea5551982b2442605efafdd3db49dc1dd2b281
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a977753c408743b9b632bdad47a5f953f7db1ec0ecf88789da40119a10b22e1b4dd386f653d78c02c768ab5790d7f8953f2a0dbbccf8d630aa5ef8863305ddb3
|
7
|
+
data.tar.gz: '029cdffd9e9105a742ba3756e7fc927be2d0ea09d744587bb0c322f1c18945048be0e533d2822a9e258862a6f6d92b23802ff0d033df845509b0457881785cf5'
|
@@ -0,0 +1,29 @@
|
|
1
|
+
name: test
|
2
|
+
on: [push, pull_request]
|
3
|
+
jobs:
|
4
|
+
test:
|
5
|
+
strategy:
|
6
|
+
matrix:
|
7
|
+
ruby: ["3.0", "3.1", "3.2"]
|
8
|
+
gemfile: [Gemfile]
|
9
|
+
include:
|
10
|
+
- ruby: "3.2"
|
11
|
+
gemfile: "gemfiles/rails-7.0.gemfile"
|
12
|
+
- ruby: "3.2"
|
13
|
+
gemfile: "gemfiles/rails-6.1.gemfile"
|
14
|
+
|
15
|
+
env:
|
16
|
+
BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
|
17
|
+
|
18
|
+
runs-on: ubuntu-latest
|
19
|
+
steps:
|
20
|
+
- uses: actions/checkout@v4
|
21
|
+
- uses: ruby/setup-ruby@v1
|
22
|
+
with:
|
23
|
+
ruby-version: ${{ matrix.ruby }}
|
24
|
+
bundler-cache: true
|
25
|
+
- run: bundle exec rake
|
26
|
+
- name: Send coverage
|
27
|
+
uses: paambaati/codeclimate-action@v5
|
28
|
+
env:
|
29
|
+
CC_TEST_REPORTER_ID: 921d046db793707b7d0c0d1305970a137fdf98fbc6ceeb6c355c44757040244f
|
data/.gitignore
CHANGED
data/.ruby-version
CHANGED
@@ -1 +1 @@
|
|
1
|
-
2.
|
1
|
+
3.2.2
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,14 @@
|
|
1
1
|
## Not released yet
|
2
2
|
|
3
|
+
## 0.6.1
|
4
|
+
|
5
|
+
- Reflect ownership transfer https://github.com/wantedly/open_api_annotator/pull/18
|
6
|
+
- Bump Ruby and Rails https://github.com/wantedly/open_api_annotator/pull/19
|
7
|
+
- Supported Rubies: 3.0, 3.1, 3.2
|
8
|
+
- Supported Rails: 6.1, 7.0, 7.1
|
9
|
+
|
10
|
+
## 0.6.0
|
11
|
+
- Support Ruby 3.0 and Rails 6.1
|
3
12
|
## 0.5.0
|
4
13
|
- Allow using with rails 6
|
5
14
|
|
data/CODE_OF_CONDUCT.md
CHANGED
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
|
|
55
55
|
## Enforcement
|
56
56
|
|
57
57
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
-
reported by contacting the project team at
|
58
|
+
reported by contacting the project team at dev@wantedly.com. All
|
59
59
|
complaints will be reviewed and investigated and will result in a response that
|
60
60
|
is deemed necessary and appropriate to the circumstances. The project team is
|
61
61
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# OpenApiAnnotator [![Gem Version](https://badge.fury.io/rb/open_api_annotator.svg)](https://badge.fury.io/rb/open_api_annotator) [![Build Status](https://travis-ci.org/
|
1
|
+
# OpenApiAnnotator [![Gem Version](https://badge.fury.io/rb/open_api_annotator.svg)](https://badge.fury.io/rb/open_api_annotator) [![Build Status](https://travis-ci.org/wantedly/open_api_annotator.svg?branch=master)](https://travis-ci.org/wantedly/open_api_annotator) [![Maintainability](https://api.codeclimate.com/v1/badges/8be7a273496459c62190/maintainability)](https://codeclimate.com/github/wantedly/open_api_annotator/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/8be7a273496459c62190/test_coverage)](https://codeclimate.com/github/wantedly/open_api_annotator/test_coverage)
|
2
2
|
|
3
3
|
OpenApiAnnotator realizes to generate OpenAPI spec by annotating to controllers and serializers.
|
4
4
|
If you use ActiveModelSerializer, this is the best way to generate OpenAPI spec.
|
@@ -80,7 +80,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
80
80
|
|
81
81
|
## Contributing
|
82
82
|
|
83
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
83
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/wantedly/open_api_annotator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
84
84
|
|
85
85
|
## License
|
86
86
|
|
@@ -88,4 +88,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
|
|
88
88
|
|
89
89
|
## Code of Conduct
|
90
90
|
|
91
|
-
Everyone interacting in the OpenApiAnnotator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/
|
91
|
+
Everyone interacting in the OpenApiAnnotator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wantedly/open_api_annotator/blob/master/CODE_OF_CONDUCT.md).
|
@@ -34,7 +34,7 @@ module OpenApiAnnotator
|
|
34
34
|
validate_open_api_format!(options[:format])
|
35
35
|
validate_open_api_nullable!(options[:nullable])
|
36
36
|
rescue ValidationError => e
|
37
|
-
Rails.logger.warn(e.message)
|
37
|
+
Rails.logger.warn("Within #{self.name}, #{field}: #{e.message}")
|
38
38
|
end
|
39
39
|
|
40
40
|
def validate_open_api_type!(type)
|
data/open_api_annotator.gemspec
CHANGED
@@ -6,12 +6,12 @@ require "open_api_annotator/version"
|
|
6
6
|
Gem::Specification.new do |spec|
|
7
7
|
spec.name = "open_api_annotator"
|
8
8
|
spec.version = OpenApiAnnotator::VERSION
|
9
|
-
spec.authors = ["Kent Nagata"]
|
10
|
-
spec.email = ["ngtknt@me.com"]
|
9
|
+
spec.authors = ["Kent Nagata", "Wantedly, Inc."]
|
10
|
+
spec.email = ["ngtknt@me.com", "dev@wantedly.com"]
|
11
11
|
|
12
12
|
spec.summary = %q{OpenApi spec generation by bottom-up.}
|
13
13
|
spec.description = %q{OpenApiAnnotator realizes to generate OpenApi spec by annotating to Controller and ActiveModelSerializer.}
|
14
|
-
spec.homepage = "https://github.com/
|
14
|
+
spec.homepage = "https://github.com/wantedly/open_api_annotator"
|
15
15
|
spec.license = "MIT"
|
16
16
|
|
17
17
|
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
@@ -24,14 +24,15 @@ Gem::Specification.new do |spec|
|
|
24
24
|
spec.add_dependency "open_api", ">= 0.5.0"
|
25
25
|
spec.add_dependency "active_model_serializers", "~> 0.10.0"
|
26
26
|
|
27
|
-
rails_versions = ['>= 5.0', '<
|
27
|
+
rails_versions = ['>= 5.0', '< 7.2']
|
28
28
|
spec.add_dependency "actionpack", rails_versions
|
29
29
|
spec.add_dependency "railties", rails_versions
|
30
30
|
|
31
|
-
spec.add_development_dependency "bundler", "~> 2.
|
32
|
-
spec.add_development_dependency "rake", "~>
|
31
|
+
spec.add_development_dependency "bundler", "~> 2.0"
|
32
|
+
spec.add_development_dependency "rake", "~> 13.0"
|
33
33
|
spec.add_development_dependency "rspec", "~> 3.0"
|
34
34
|
spec.add_development_dependency "pry"
|
35
|
-
|
35
|
+
# Pin to 1.17 due to https://github.com/codeclimate/test-reporter/issues/413
|
36
|
+
spec.add_development_dependency "simplecov", "~> 0.17.0"
|
36
37
|
spec.add_development_dependency "bump"
|
37
38
|
end
|
metadata
CHANGED
@@ -1,14 +1,15 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: open_api_annotator
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Kent Nagata
|
8
|
-
|
8
|
+
- Wantedly, Inc.
|
9
|
+
autorequire:
|
9
10
|
bindir: exe
|
10
11
|
cert_chain: []
|
11
|
-
date:
|
12
|
+
date: 2023-11-10 00:00:00.000000000 Z
|
12
13
|
dependencies:
|
13
14
|
- !ruby/object:Gem::Dependency
|
14
15
|
name: open_api
|
@@ -47,7 +48,7 @@ dependencies:
|
|
47
48
|
version: '5.0'
|
48
49
|
- - "<"
|
49
50
|
- !ruby/object:Gem::Version
|
50
|
-
version: '
|
51
|
+
version: '7.2'
|
51
52
|
type: :runtime
|
52
53
|
prerelease: false
|
53
54
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -57,7 +58,7 @@ dependencies:
|
|
57
58
|
version: '5.0'
|
58
59
|
- - "<"
|
59
60
|
- !ruby/object:Gem::Version
|
60
|
-
version: '
|
61
|
+
version: '7.2'
|
61
62
|
- !ruby/object:Gem::Dependency
|
62
63
|
name: railties
|
63
64
|
requirement: !ruby/object:Gem::Requirement
|
@@ -67,7 +68,7 @@ dependencies:
|
|
67
68
|
version: '5.0'
|
68
69
|
- - "<"
|
69
70
|
- !ruby/object:Gem::Version
|
70
|
-
version: '
|
71
|
+
version: '7.2'
|
71
72
|
type: :runtime
|
72
73
|
prerelease: false
|
73
74
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -77,35 +78,35 @@ dependencies:
|
|
77
78
|
version: '5.0'
|
78
79
|
- - "<"
|
79
80
|
- !ruby/object:Gem::Version
|
80
|
-
version: '
|
81
|
+
version: '7.2'
|
81
82
|
- !ruby/object:Gem::Dependency
|
82
83
|
name: bundler
|
83
84
|
requirement: !ruby/object:Gem::Requirement
|
84
85
|
requirements:
|
85
86
|
- - "~>"
|
86
87
|
- !ruby/object:Gem::Version
|
87
|
-
version: 2.
|
88
|
+
version: '2.0'
|
88
89
|
type: :development
|
89
90
|
prerelease: false
|
90
91
|
version_requirements: !ruby/object:Gem::Requirement
|
91
92
|
requirements:
|
92
93
|
- - "~>"
|
93
94
|
- !ruby/object:Gem::Version
|
94
|
-
version: 2.
|
95
|
+
version: '2.0'
|
95
96
|
- !ruby/object:Gem::Dependency
|
96
97
|
name: rake
|
97
98
|
requirement: !ruby/object:Gem::Requirement
|
98
99
|
requirements:
|
99
100
|
- - "~>"
|
100
101
|
- !ruby/object:Gem::Version
|
101
|
-
version: '
|
102
|
+
version: '13.0'
|
102
103
|
type: :development
|
103
104
|
prerelease: false
|
104
105
|
version_requirements: !ruby/object:Gem::Requirement
|
105
106
|
requirements:
|
106
107
|
- - "~>"
|
107
108
|
- !ruby/object:Gem::Version
|
108
|
-
version: '
|
109
|
+
version: '13.0'
|
109
110
|
- !ruby/object:Gem::Dependency
|
110
111
|
name: rspec
|
111
112
|
requirement: !ruby/object:Gem::Requirement
|
@@ -138,16 +139,16 @@ dependencies:
|
|
138
139
|
name: simplecov
|
139
140
|
requirement: !ruby/object:Gem::Requirement
|
140
141
|
requirements:
|
141
|
-
- - "
|
142
|
+
- - "~>"
|
142
143
|
- !ruby/object:Gem::Version
|
143
|
-
version:
|
144
|
+
version: 0.17.0
|
144
145
|
type: :development
|
145
146
|
prerelease: false
|
146
147
|
version_requirements: !ruby/object:Gem::Requirement
|
147
148
|
requirements:
|
148
|
-
- - "
|
149
|
+
- - "~>"
|
149
150
|
- !ruby/object:Gem::Version
|
150
|
-
version:
|
151
|
+
version: 0.17.0
|
151
152
|
- !ruby/object:Gem::Dependency
|
152
153
|
name: bump
|
153
154
|
requirement: !ruby/object:Gem::Requirement
|
@@ -166,14 +167,15 @@ description: OpenApiAnnotator realizes to generate OpenApi spec by annotating to
|
|
166
167
|
and ActiveModelSerializer.
|
167
168
|
email:
|
168
169
|
- ngtknt@me.com
|
170
|
+
- dev@wantedly.com
|
169
171
|
executables: []
|
170
172
|
extensions: []
|
171
173
|
extra_rdoc_files: []
|
172
174
|
files:
|
175
|
+
- ".github/workflows/test.yml"
|
173
176
|
- ".gitignore"
|
174
177
|
- ".rspec"
|
175
178
|
- ".ruby-version"
|
176
|
-
- ".travis.yml"
|
177
179
|
- CHANGELOG.md
|
178
180
|
- CODE_OF_CONDUCT.md
|
179
181
|
- Gemfile
|
@@ -182,6 +184,8 @@ files:
|
|
182
184
|
- Rakefile
|
183
185
|
- bin/console
|
184
186
|
- bin/setup
|
187
|
+
- gemfiles/rails-6.1.gemfile
|
188
|
+
- gemfiles/rails-7.0.gemfile
|
185
189
|
- lib/open_api_annotator.rb
|
186
190
|
- lib/open_api_annotator/association.rb
|
187
191
|
- lib/open_api_annotator/attribute.rb
|
@@ -201,11 +205,11 @@ files:
|
|
201
205
|
- lib/open_api_annotator/version.rb
|
202
206
|
- lib/tasks/api_spec.rake
|
203
207
|
- open_api_annotator.gemspec
|
204
|
-
homepage: https://github.com/
|
208
|
+
homepage: https://github.com/wantedly/open_api_annotator
|
205
209
|
licenses:
|
206
210
|
- MIT
|
207
211
|
metadata: {}
|
208
|
-
post_install_message:
|
212
|
+
post_install_message:
|
209
213
|
rdoc_options: []
|
210
214
|
require_paths:
|
211
215
|
- lib
|
@@ -220,8 +224,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
220
224
|
- !ruby/object:Gem::Version
|
221
225
|
version: '0'
|
222
226
|
requirements: []
|
223
|
-
rubygems_version: 3.
|
224
|
-
signing_key:
|
227
|
+
rubygems_version: 3.4.10
|
228
|
+
signing_key:
|
225
229
|
specification_version: 4
|
226
230
|
summary: OpenApi spec generation by bottom-up.
|
227
231
|
test_files: []
|
data/.travis.yml
DELETED
@@ -1,18 +0,0 @@
|
|
1
|
-
env:
|
2
|
-
global:
|
3
|
-
- CC_TEST_REPORTER_ID=921d046db793707b7d0c0d1305970a137fdf98fbc6ceeb6c355c44757040244f
|
4
|
-
sudo: false
|
5
|
-
language: ruby
|
6
|
-
rvm:
|
7
|
-
- 2.4.9
|
8
|
-
- 2.5.7
|
9
|
-
- 2.6.5
|
10
|
-
before_install:
|
11
|
-
- gem install -v 2.1.4 bundler
|
12
|
-
- bundle _2.1.4_ install
|
13
|
-
before_script:
|
14
|
-
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
15
|
-
- chmod +x ./cc-test-reporter
|
16
|
-
- ./cc-test-reporter before-build
|
17
|
-
after_script:
|
18
|
-
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
|