open_api_annotator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c25f0d206c6a39ed21f7dd1a15fb886aaad9e6ed05db73aeda5ffa7e852a1ed
-  data.tar.gz: ce7c5a930ec200636792afee7e4545ac13e8ebcc703281dd0da9da431d1857d6
+  metadata.gz: 1bb9e46a88ce7e7634106d19d12c7df63d2f5760456c0419bf90607e49e5f10b
+  data.tar.gz: 0f6d152a177721e6b753a2867cc7670d93d63c78734b38da6119ba57f273f9bb
 SHA512:
-  metadata.gz: 5a7ac62a5ce7fddc89b62b8694f5e0c364a18d963b162f6b7479229d7e5ad1571fda1d64690eef4f1cd833c6bd661e4956788469e6357cf6b2769a3844b26610
-  data.tar.gz: 5ba222eb03b1a1496ef8ce300cf5eaef0b179ee4e5b365348351c71a4eb78da607f8d3b2a1093013e3ad925e09b751b82f7db4b72b2ae62fe2983535aba06472
+  metadata.gz: 5ffe01f6857c993dad939e5e0ae61091bc2536223ac6705c06d2f50d7646a53c8db746a7b76db88f24406e295dc2bf5f10b38cd9862175d3a8410afe65113da2
+  data.tar.gz: 65d7dd45c64987f61bcaee80fa44c2a1b33215ccce83e5e7119a66cd61b96ead87682ab94858b952e3714806f3753beb648cfb6b9c59c22feac36775acea9410

data/README.md

@@ -1,7 +1,7 @@
-# OpenApiAnnotator [![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/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 realizes to generate OpenApi spec by annotating to controllers and serializers.
-If you use ActiveModelSerializer, this is the best to generate OpenAPI spec.
+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.
 
 ## Installation
 

data/lib/open_api_annotator.rb

@@ -6,6 +6,7 @@ require 'rails'
 
 require 'open_api'
 
+require 'open_api_annotator/endpoint'
 require 'open_api_annotator/field'
 require 'open_api_annotator/attribute'
 require 'open_api_annotator/association'

data/lib/open_api_annotator/components_builder.rb

@@ -59,7 +59,15 @@ module OpenApiAnnotator
       associations.each do |association|
         next unless association.valid?
         content_name = association.type.try(:name) || association.type.to_s
-        properties[association.name.to_sym] = OpenApi::Reference.new(ref: "#/components/schemas/#{content_name}")
+        reference = OpenApi::Reference.new(ref: "#/components/schemas/#{content_name}")
+        properties[association.name.to_sym] = if association.nullable
+          OpenApi::Schema.new(
+            nullable: true,
+            allOf: [reference]
+          )
+        else
+          reference
+        end
       end
       properties
     end

data/lib/open_api_annotator/controller_annotatable.rb

@@ -1,7 +1,7 @@
 module OpenApiAnnotator
   module ControllerAnnotatable
-    def type_hash
-      @type_hash ||= {}
+    def endpoint_hash
+      @endpoint_hash ||= {}
     end
 
     def validate_open_api_type!(type)
@@ -11,7 +11,7 @@ module OpenApiAnnotator
 
     def endpoint(type)
       validate_open_api_type!(type)
-      @last_type = type
+      @last_endpoint = Endpoint.new(type)
 
     rescue ValidationError => e
       raise TypeError, <<~EOL
@@ -32,14 +32,14 @@ module OpenApiAnnotator
 
     def method_added(name)
       super
-      return unless @last_type
+      return unless @last_endpoint
 
-      type = @last_type
-      @last_type = nil
+      endpoint = @last_endpoint
+      @last_endpoint = nil
 
       return if private_method_defined?(name)
 
-      type_hash[name] = type
+      endpoint_hash[name] = endpoint
     end
   end
 end

data/lib/open_api_annotator/endpoint.rb

@@ -0,0 +1,4 @@
+module OpenApiAnnotator
+  class Endpoint < Struct.new(:type)
+  end
+end

data/lib/open_api_annotator/paths_builder.rb

@@ -3,8 +3,9 @@ module OpenApiAnnotator
     def build
       paths = OpenApi::Paths.new
       routes = RoutesFinder.new.find_all
-      if OpenApiAnnotator.config.path_regexp
-        routes.select! { |route| route.path.match(OpenApiAnnotator.config.path_regexp) }
+      path_regexp = OpenApiAnnotator.config.path_regexp
+      if path_regexp
+        routes.select! { |route| route.path.match(path_regexp) }
       end
       routes.group_by(&:path).each do |path_name, routes|
         paths[path_name] = build_path_item(routes)
@@ -41,9 +42,9 @@ module OpenApiAnnotator
 
       case type
       when Array
-        "Returns array of #{type.first.name}"
+        "Returns an array of #{type.first.name}"
       when Class
-        "Returns #{type.name}"
+        "Returns a #{type.name}"
       else
         raise "not supported class #{type.class}"
       end
@@ -76,7 +77,7 @@ module OpenApiAnnotator
       end
       return unless controller_class < OpenApiAnnotator.config.application_controller_class
 
-      controller_class.type_hash[action_name.to_sym]
+      controller_class.endpoint_hash[action_name.to_sym]&.type
     end
   end
 

data/lib/open_api_annotator/serializer_annotatable.rb

@@ -67,7 +67,7 @@ module OpenApiAnnotator
           reflection.is_a?(ActiveModel::Serializer::HasOneReflection)
         }.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.1.0"
+  VERSION = "0.2.0"
 end

data/open_api_annotator.gemspec

@@ -21,7 +21,7 @@ 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.3.3"
+  spec.add_dependency "open_api", ">= 0.3.4"
   spec.add_dependency "active_model_serializers", "~> 0.10.0"
 
   rails_versions = ['>= 4.1', '< 6']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_annotator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kent Nagata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2019-02-01 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.3.3
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +189,7 @@ files:
 - lib/open_api_annotator/config.rb
 - lib/open_api_annotator/configurable.rb
 - lib/open_api_annotator/controller_annotatable.rb
+- lib/open_api_annotator/endpoint.rb
 - lib/open_api_annotator/errors.rb
 - lib/open_api_annotator/field.rb
 - lib/open_api_annotator/format_validator.rb
@@ -219,8 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: OpenApi spec generation by bottom-up.