open_api_annotator 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 928d9daca39028c7d5016fa2e44ca116891194210ebaee873e325240bff2a428
-  data.tar.gz: f40479f6b544ccef964c611acf974763bc205b623682b6114d66707253638b75
+  metadata.gz: a53663269a69d9eca0b1148da5698071fcfeba3d2457f4614c3e76303bb28aa9
+  data.tar.gz: 3c1db3245019f65a0f1936cb47911c717cf9b1a024d362c2ea916621dca78418
 SHA512:
-  metadata.gz: 7bfb5f922e2b92ef554b3b2d042a108471a4fe666fd69ed9c242eeae1e48b1105af7dc30caafd8d7be64babeb478990918136563b1deedf1d3f18099addfd098
-  data.tar.gz: 7198242aec1d0c81b3e47e0ba44bcbbbfea679673f9bdf31de31c753b45aff536e4c15f46cd26b854220fbe249c82b3aa46d1a78f8b2cdc86920f26a36cdbfe2
+  metadata.gz: 24b7421c28a82949a4e89fa68c1f5e12e97d48d19c8f0a45e104405af6b7636a0f5cb9fed57f1f01dbff7afbe3e5a9a714f743a90e8898ca42f285479de6d1d8
+  data.tar.gz: d686bed20207c8c59b89b5481aa9c2dad353d4a04b537da660e72246e27b362c72ab550a5b1fa8cffe82446d50e34c3f4577b6fe2db888197a1f9ff27581e25c

data/.github/workflows/test.yml

@@ -4,26 +4,28 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: ["2.5", "2.6", "2.7", "3.0"]
+        ruby: ["3.3", "3.4", "4.0"]
         gemfile: [Gemfile]
         include:
-          - ruby: "2.7"
-            gemfile: "gemfiles/rails-6.0.gemfile"
-          - ruby: "2.6"
-            gemfile: "gemfiles/rails-5.2.gemfile"
+          - ruby: "3.3"
+            gemfile: "gemfiles/rails-8.0.gemfile"
+          - ruby: "3.3"
+            gemfile: "gemfiles/rails-7.2.gemfile"
+          - ruby: "3.3"
+            gemfile: "gemfiles/rails-7.1.gemfile"
+          - ruby: "3.3"
+            gemfile: "gemfiles/rails-7.0.gemfile"
+          - ruby: "4.0"
+            gemfile: "gemfiles/rails-7.0.gemfile"
 
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
 
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - run: bundle exec rake
-    - name: Send coverage
-      uses: paambaati/codeclimate-action@v2.7.5
-      env:
-        CC_TEST_REPORTER_ID: 921d046db793707b7d0c0d1305970a137fdf98fbc6ceeb6c355c44757040244f

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+4.0.9

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## Not released yet
 
+## 0.6.2
+
+- Fix `rake api_spec` raising `NoMethodError` on Rails 7.0 or later https://github.com/wantedly/open_api_annotator/pull/20
+- Fix `$ref` of `belongs_to` with `serializer:` option being an array like `#/components/schemas/["User"]` https://github.com/wantedly/open_api_annotator/pull/20
+- Skip `has_many` annotated with a non-array type (e.g. `type: User`) or an empty array with a warning, instead of raising an error or emitting a broken `$ref` https://github.com/wantedly/open_api_annotator/pull/20
+- Require open_api >= 0.6.3 https://github.com/wantedly/open_api_annotator/pull/20
+- Bump Ruby and Rails https://github.com/wantedly/open_api_annotator/pull/20
+  - Supported Rubies: 3.3, 3.4, 4.0
+  - Supported Rails: 7.0, 7.1, 7.2, 8.0, 8.1
+
+## 0.6.1
+
+- Reflect ownership transfer https://github.com/wantedly/open_api_annotator/pull/18
+- Bump Ruby and Rails https://github.com/wantedly/open_api_annotator/pull/19
+  - Supported Rubies: 3.0, 3.1, 3.2
+  - Supported Rails: 6.1, 7.0, 7.1
+
 ## 0.6.0
 - Support Ruby 3.0 and Rails 6.1
 ## 0.5.0

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at ngtknt@me.com. All
+reported by contacting the project team at dev@wantedly.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/README.md

@@ -1,4 +1,4 @@
-# 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/ngtk/open_api_annotator.svg?branch=master)](https://travis-ci.org/ngtk/open_api_annotator) [![Maintainability](https://api.codeclimate.com/v1/badges/8be7a273496459c62190/maintainability)](https://codeclimate.com/github/ngtk/open_api_annotator/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/8be7a273496459c62190/test_coverage)](https://codeclimate.com/github/ngtk/open_api_annotator/test_coverage)
+# 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)
 
 OpenApiAnnotator realizes to generate OpenAPI spec by annotating to controllers and serializers.
 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
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ngtk/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.
+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.
 
 ## License
 
@@ -88,4 +88,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-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/ngtk/open_api_annotator/blob/master/CODE_OF_CONDUCT.md).
+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).

data/gemfiles/{rails-5.2.gemfile → rails-7.0.gemfile}

@@ -5,4 +5,4 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in open_api_annotator.gemspec
 gemspec path: '..'
 
-gem 'railties', '~> 5.2.0'
+gem 'railties', '~> 7.0.0'

data/gemfiles/{rails-6.0.gemfile → rails-7.1.gemfile}

@@ -5,4 +5,4 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in open_api_annotator.gemspec
 gemspec path: '..'
 
-gem 'railties', '~> 6.0.0'
+gem 'railties', '~> 7.1.0'

data/gemfiles/rails-7.2.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_api_annotator.gemspec
+gemspec path: '..'
+
+gem 'railties', '~> 7.2.0'

data/gemfiles/rails-8.0.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_api_annotator.gemspec
+gemspec path: '..'
+
+gem 'railties', '~> 8.0.0'

data/lib/open_api_annotator/components_builder.rb

@@ -56,8 +56,12 @@ module OpenApiAnnotator
       properties = {}
       serializer.open_api_has_many_associations.each do |association|
         next unless association.valid?
-        content = association.type.first
-        return unless content
+        # Calling `first` on a non-array type (e.g. an ActiveRecord model) would run a query
+        content = association.type.first if association.type.is_a?(Array)
+        unless content
+          warn "Skipped #{serializer.name}##{association.name}: type of has_many should be an array with one element, but got #{association.type}."
+          next
+        end
         content_name = content.try(:name) || content.to_s
         properties[association.name.to_sym] = OpenApi::Schema.new(
           type: "array",

data/lib/open_api_annotator/paths_builder.rb

@@ -140,7 +140,7 @@ module OpenApiAnnotator
     def find_all
       @routes ||= Rails.application.routes.routes.routes.map do |route|
         parameters = []
-        path = PathResolver.new.resolve(route.path.ast, parameters)
+        path = PathResolver.new.resolve(route.path.spec, parameters)
         controller = route.requirements[:controller]
         action = route.requirements[:action]
         Route.new(http_verb: route.verb, path: path, controller_name: controller, action_name: action, parameters: parameters)

data/lib/open_api_annotator/serializer_annotatable.rb

@@ -77,7 +77,7 @@ module OpenApiAnnotator
           reflection.is_a?(ActiveModel::Serializer::BelongsToReflection)
         }.map do |reflection|
           serializer_class = reflection.options[:serializer]
-          type = serializer_class ? [serializer_class.open_api_resource_name] : reflection.options[:type]
+          type = serializer_class ? serializer_class.open_api_resource_name : reflection.options[:type]
           Association.new(reflection.name.to_sym, type, reflection.options[:nullable])
         end
       end

data/lib/open_api_annotator/version.rb

@@ -1,3 +1,3 @@
 module OpenApiAnnotator
-  VERSION = "0.6.0"
+  VERSION = "0.6.2"
 end

data/open_api_annotator.gemspec

@@ -6,12 +6,12 @@ require "open_api_annotator/version"
 Gem::Specification.new do |spec|
   spec.name          = "open_api_annotator"
   spec.version       = OpenApiAnnotator::VERSION
-  spec.authors       = ["Kent Nagata"]
-  spec.email         = ["ngtknt@me.com"]
+  spec.authors       = ["Kent Nagata", "Wantedly, Inc."]
+  spec.email         = ["ngtknt@me.com", "dev@wantedly.com"]
 
   spec.summary       = %q{OpenApi spec generation by bottom-up.}
   spec.description   = %q{OpenApiAnnotator realizes to generate OpenApi spec by annotating to Controller and ActiveModelSerializer.}
-  spec.homepage      = "https://github.com/ngtk/open_api_annotator"
+  spec.homepage      = "https://github.com/wantedly/open_api_annotator"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -21,14 +21,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "open_api", ">= 0.5.0"
+  spec.add_dependency "open_api", ">= 0.6.3"
   spec.add_dependency "active_model_serializers", "~> 0.10.0"
 
-  rails_versions = ['>= 5.0', '< 6.2']
+  rails_versions = ['>= 5.0', '< 8.2']
   spec.add_dependency "actionpack", rails_versions
   spec.add_dependency "railties", rails_versions
 
-  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_annotator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Kent Nagata
-autorequire:
+- Wantedly, Inc.
 bindir: exe
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +47,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,21 +77,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +152,7 @@ description: OpenApiAnnotator realizes to generate OpenApi spec by annotating to
   and ActiveModelSerializer.
 email:
 - ngtknt@me.com
+- dev@wantedly.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -182,8 +169,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/rails-5.2.gemfile
-- gemfiles/rails-6.0.gemfile
+- gemfiles/rails-7.0.gemfile
+- gemfiles/rails-7.1.gemfile
+- gemfiles/rails-7.2.gemfile
+- gemfiles/rails-8.0.gemfile
 - lib/open_api_annotator.rb
 - lib/open_api_annotator/association.rb
 - lib/open_api_annotator/attribute.rb
@@ -203,11 +192,10 @@ files:
 - lib/open_api_annotator/version.rb
 - lib/tasks/api_spec.rake
 - open_api_annotator.gemspec
-homepage: https://github.com/ngtk/open_api_annotator
+homepage: https://github.com/wantedly/open_api_annotator
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: OpenApi spec generation by bottom-up.
 test_files: []