rspec-openapi 0.1.0 → 0.18.4

data/lib/rspec/openapi.rb

@@ -1,10 +1,96 @@
+# frozen_string_literal: true
+
 require 'rspec/openapi/version'
-require 'rspec/openapi/hooks' if ENV['OPENAPI']
+require 'rspec/openapi/components_updater'
+require 'rspec/openapi/default_schema'
+require 'rspec/openapi/record_builder'
+require 'rspec/openapi/result_recorder'
+require 'rspec/openapi/schema_builder'
+require 'rspec/openapi/schema_file'
+require 'rspec/openapi/schema_merger'
+require 'rspec/openapi/schema_cleaner'
+require 'rspec/openapi/schema_sorter'
+require 'rspec/openapi/key_transformer'
+require 'rspec/openapi/shared_hooks'
+require 'rspec/openapi/extractors'
+require 'rspec/openapi/extractors/rack'
 
 module RSpec::OpenAPI
+  class Config
+    class << self
+      attr_accessor :debug_enabled
+
+      def load_environment_settings
+        @debug_enabled = ['', '1', 'true'].include?(ENV['DEBUG']&.downcase)
+      end
+    end
+  end
+
   @path = 'doc/openapi.yaml'
+  @title = File.basename(Dir.pwd)
+  @comment = nil
+  @enable_example = true
+  @description_builder = ->(example) { example.description }
+  @summary_builder = ->(example) { example.metadata[:summary] }
+  @tags_builder = ->(example) { example.metadata[:tags] }
+  @info = {}
+  @application_version = '1.0.0'
+  @request_headers = []
+  @servers = []
+  @security_schemes = []
+  @example_types = %i[request]
+  @response_headers = []
+  @path_records = Hash.new { |h, k| h[k] = [] }
+  @ignored_path_params = %i[controller action format]
+  @ignored_paths = []
+  @post_process_hook = nil
+
+  # This is the configuraion override file name we look for within each path.
+  @config_filename = 'rspec_openapi.rb'
 
   class << self
-    attr_accessor :path
+    attr_accessor :path,
+                  :title,
+                  :comment,
+                  :enable_example,
+                  :description_builder,
+                  :summary_builder,
+                  :tags_builder,
+                  :info,
+                  :application_version,
+                  :request_headers,
+                  :servers,
+                  :security_schemes,
+                  :example_types,
+                  :response_headers,
+                  :path_records,
+                  :ignored_paths,
+                  :ignored_path_params,
+                  :post_process_hook
+
+    attr_reader   :config_filename
   end
 end
+
+if ENV['OPENAPI']
+  RSpec::OpenAPI::Config.load_environment_settings
+
+  begin
+    require 'hanami'
+  rescue LoadError
+    warn 'Hanami not detected' if RSpec::OpenAPI::Config.debug_enabled
+  else
+    require 'rspec/openapi/extractors/hanami'
+  end
+
+  begin
+    require 'rails'
+  rescue LoadError
+    warn 'Rails not detected' if RSpec::OpenAPI::Config.debug_enabled
+  else
+    require 'rspec/openapi/extractors/rails'
+  end
+end
+
+require 'rspec/openapi/minitest_hooks' if Object.const_defined?('Minitest')
+require 'rspec/openapi/rspec_hooks' if ENV['OPENAPI'] && Object.const_defined?('RSpec')

data/rspec-openapi.gemspec

@@ -1,27 +1,35 @@
+# frozen_string_literal: true
+
 require_relative 'lib/rspec/openapi/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rspec-openapi'
   spec.version       = RSpec::OpenAPI::VERSION
-  spec.authors       = ['Takashi Kokubun']
-  spec.email         = ['takashikkbn@gmail.com']
+  spec.authors       = ['Takashi Kokubun', 'TATSUNO Yasuhiro']
+  spec.email         = ['takashikkbn@gmail.com', 'ytatsuno.jp@gmail.com']
 
-  spec.summary       = %q{Generate OpenAPI specs from RSpec request specs}
-  spec.description   = %q{Generate OpenAPI specs from RSpec request specs}
-  spec.homepage      = 'https://github.com/k0kubun/rspec-openapi'
+  spec.summary       = 'Generate OpenAPI schema from RSpec request specs'
+  spec.description   = 'Generate OpenAPI from RSpec request specs'
+  spec.homepage      = 'https://github.com/exoego/rspec-openapi'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  # spec.metadata['changelog_uri'] = 'TODO'
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/exoego/rspec-openapi',
+    'source_code_uri' => 'https://github.com/exoego/rspec-openapi',
+    'changelog_uri' => "https://github.com/exoego/rspec-openapi/releases/tag/v#{RSpec::OpenAPI::VERSION}",
+    'rubygems_mfa_required' => 'true',
+  }
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rspec'
+  spec.add_dependency 'actionpack', '>= 5.2.0'
+  spec.add_dependency 'rails-dom-testing'
+  spec.add_dependency 'rspec-core'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/scripts/rspec

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (The MIT License)
+# Copyright (c) 2012 Chad Humphries, David Chelimsky, Myron Marston
+# Copyright (c) 2009 Chad Humphries, David Chelimsky
+# Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+# Copyright (c) 2005 Steven Baker
+
+require 'rspec/core'
+RSpec::Core::Runner.invoke

data/scripts/rspec_with_simplecov

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (The MIT License)
+# Copyright (c) 2012 Chad Humphries, David Chelimsky, Myron Marston
+# Copyright (c) 2009 Chad Humphries, David Chelimsky
+# Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+# Copyright (c) 2005 Steven Baker
+
+# Turn on verbose to make sure we not generating any ruby warning
+$VERBOSE = true
+
+# So our "did they run the rspec command?" detection logic thinks
+# that we run `rspec`.
+$0 = 'rspec'
+
+# This is necessary for when `--standalone` is being used.
+$LOAD_PATH.unshift File.expand_path '../bundle', __dir__
+
+# For the travis build we put the bundle directory up a directory
+# so it can be shared among the repos for faster bundle installs.
+$LOAD_PATH.unshift File.expand_path '../../bundle', __dir__
+
+require 'bundler/setup'
+
+# To use simplecov while running rspec-core's test suite, we must
+# load simplecov _before_ loading any of rspec-core's files.
+# So, this executable exists purely as a wrapper script that
+# first loads simplecov, and then loads rspec.
+begin
+  # Simplecov emits some ruby warnings when loaded, so silence them.
+  old_verbose = $VERBOSE
+  $VERBOSE = false
+
+  unless (ENV.fetch('COVERAGE', nil) && ENV['COVERAGE'].empty?) || RUBY_VERSION < '1.9.3'
+    require 'simplecov'
+
+    SimpleCov.start do
+      enable_coverage :branch
+    end
+  end
+rescue LoadError
+  # simplecov is not available
+ensure
+  $VERBOSE = old_verbose
+end
+
+load File.expand_path('rspec', __dir__)

metadata

@@ -1,17 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.18.4
 platform: ruby
 authors:
 - Takashi Kokubun
-autorequire: 
+- TATSUNO Yasuhiro
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: rails-dom-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,16 +53,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate OpenAPI specs from RSpec request specs
+description: Generate OpenAPI from RSpec request specs
 email:
 - takashikkbn@gmail.com
+- ytatsuno.jp@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/release.yaml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".simplecov_spawn.rb"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -42,22 +79,39 @@ files:
 - bin/console
 - bin/setup
 - lib/rspec/openapi.rb
+- lib/rspec/openapi/components_updater.rb
 - lib/rspec/openapi/default_schema.rb
-- lib/rspec/openapi/hooks.rb
+- lib/rspec/openapi/extractors.rb
+- lib/rspec/openapi/extractors/hanami.rb
+- lib/rspec/openapi/extractors/rack.rb
+- lib/rspec/openapi/extractors/rails.rb
+- lib/rspec/openapi/hash_helper.rb
+- lib/rspec/openapi/key_transformer.rb
+- lib/rspec/openapi/minitest_hooks.rb
 - lib/rspec/openapi/record.rb
 - lib/rspec/openapi/record_builder.rb
+- lib/rspec/openapi/result_recorder.rb
+- lib/rspec/openapi/rspec_hooks.rb
 - lib/rspec/openapi/schema_builder.rb
+- lib/rspec/openapi/schema_cleaner.rb
 - lib/rspec/openapi/schema_file.rb
 - lib/rspec/openapi/schema_merger.rb
+- lib/rspec/openapi/schema_sorter.rb
+- lib/rspec/openapi/shared_hooks.rb
 - lib/rspec/openapi/version.rb
 - rspec-openapi.gemspec
-homepage: https://github.com/k0kubun/rspec-openapi
+- scripts/rspec
+- scripts/rspec_with_simplecov
+- test.png
+homepage: https://github.com/exoego/rspec-openapi
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/k0kubun/rspec-openapi
-  source_code_uri: https://github.com/k0kubun/rspec-openapi
-post_install_message: 
+  homepage_uri: https://github.com/exoego/rspec-openapi
+  source_code_uri: https://github.com/exoego/rspec-openapi
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.18.4
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,15 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
-summary: Generate OpenAPI specs from RSpec request specs
+summary: Generate OpenAPI schema from RSpec request specs
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4

data/lib/rspec/openapi/hooks.rb

@@ -1,24 +0,0 @@
-require 'rspec'
-require 'rspec/openapi/default_schema'
-require 'rspec/openapi/record_builder'
-require 'rspec/openapi/schema_builder'
-require 'rspec/openapi/schema_file'
-require 'rspec/openapi/schema_merger'
-
-records = []
-
-RSpec.configuration.after(:each) do |example|
-  if example.metadata[:type] == :request && example.metadata[:openapi] != false && request && response
-    records << RSpec::OpenAPI::RecordBuilder.build(self, example: example)
-  end
-end
-
-RSpec.configuration.after(:suite) do
-  title = File.basename(Dir.pwd)
-  RSpec::OpenAPI::SchemaFile.new(RSpec::OpenAPI.path).edit do |spec|
-    RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::DefaultSchema.build(title))
-    records.each do |record|
-      RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
-    end
-  end
-end