[P4M-331] Update forked rspec_api_documentation gem

josephcruz · web-flow · commit c607486f1d14 · 2025-02-19T08:20:31.000-08:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    # Check for updates to GitHub Actions every weekday
+    interval: "daily"
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,65 @@
+---
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: "Testing"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Recent Rubies and Rails
+          - ruby-version: '3.2'
+          - ruby-version: '3.1'
+          - ruby-version: '3.0'
+          - ruby-version: '2.7'
+          - ruby-version: '2.6'
+          - ruby-version: '2.6'
+          - ruby-version: '2.7'
+          - ruby-version: '2.6'
+          # Old Rubies and Rails
+          - ruby-version: '2.5'
+            bundler: '1'
+          - ruby-version: '2.4'
+            bundler: '1'
+          - ruby-version: '2.4'
+            bundler: '1'
+          # Failing with a stack trace in active support
+          # - ruby-version: '2.4'
+          #   rails-version: '4.1'
+          #   bundler: '1'
+
+    continue-on-error: "${{ endsWith(matrix.ruby-version, 'head') }}"
+
+    env:
+      CI: "1"
+
+    steps:
+      - name:                     "Checkout Code"
+        uses:                     "actions/checkout@v4"
+        timeout-minutes:          5
+        with:
+          fetch-depth:            0
+
+      # - name: Install required libs
+      #   run: |
+      #     sudo apt-get -yqq install libsqlite3-dev
+
+      - name: "Build Ruby"
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version:   "${{ matrix.ruby-version }}"
+          bundler:        "${{ matrix.bundler || 2 }}"
+          bundler-cache:  true
+        # env:
+        #   RAILS_VERSION: ${{ matrix.rails-version }}
+
+      - name: "Run tests"
+        run: |
+          bundle exec rake
+        # env:
+        #   RAILS_VERSION: ${{ matrix.rails-version }}
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ example/public/docs
 *.swp
 /html/
 /.idea
+Gemfile.lock
diff --git a/.travis.yml b/.travis.yml
diff --git a/Gemfile b/Gemfile
@@ -1,5 +1,3 @@
 source 'http://rubygems.org'
 
 gemspec
-
-gem 'inch'
diff --git a/Gemfile.lock b/Gemfile.lock
diff --git a/README.md b/README.md
@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/zipmark/rspec_api_documentation.svg?branch=master)](https://travis-ci.org/zipmark/rspec_api_documentation)
-[![Dependency Status](https://gemnasium.com/badges/github.com/zipmark/rspec_api_documentation.svg)](https://gemnasium.com/github.com/zipmark/rspec_api_documentation)
 [![Code Climate](https://codeclimate.com/github/zipmark/rspec_api_documentation/badges/gpa.svg)](https://codeclimate.com/github/zipmark/rspec_api_documentation)
 [![Inline docs](https://inch-ci.org/github/zipmark/rspec_api_documentation.svg?branch=master)](https://inch-ci.org/github/zipmark/rspec_api_documentation)
 [![Gem Version](https://badge.fury.io/rb/rspec_api_documentation.svg)](https://badge.fury.io/rb/rspec_api_documentation)
@@ -185,6 +183,7 @@ RspecApiDocumentation.configure do |config|
   config.configurations_dir = Rails.root.join("doc", "configurations", "api")
 
   # Output folder
+  # **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory.
   config.docs_dir = Rails.root.join("doc", "api")
 
   # An array of output format(s).
@@ -238,6 +237,7 @@ RspecApiDocumentation.configure do |config|
   config.define_group :public do |config|
     # By default the group's doc_dir is a subfolder under the parent group, based
     # on the group's name.
+    # **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory.
     config.docs_dir = Rails.root.join("doc", "api", "public")
 
     # Change the filter to only include :public examples
diff --git a/features/oauth2_mac_client.feature b/features/oauth2_mac_client.feature
@@ -2,6 +2,7 @@ Feature: Use OAuth2 MAC client as a test client
   Background:
     Given a file named "app_spec.rb" with:
       """
+      require "webmock/rspec"
       require "rspec_api_documentation"
       require "rspec_api_documentation/dsl"
       require "rack/builder"
diff --git a/features/readme.md b/features/readme.md
@@ -1,6 +1,3 @@
-[![Travis status](https://secure.travis-ci.org/zipmark/rspec_api_documentation.png)](https://secure.travis-ci.org/zipmark/rspec_api_documentation)
-[![Gemnasium status](https://gemnasium.com/zipmark/rspec_api_documentation.png)](https://gemnasium.com/zipmark/rspec_api_documentation)
-
 http://github.com/zipmark/rspec_api_documentation
 
 # RSpec API Doc Generator
diff --git a/lib/rspec_api_documentation.rb b/lib/rspec_api_documentation.rb
@@ -1,7 +1,9 @@
 require 'active_support'
 require 'active_support/inflector'
+require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/keys'
 require 'cgi'
 require 'json'
 
diff --git a/lib/rspec_api_documentation/dsl/resource.rb b/lib/rspec_api_documentation/dsl/resource.rb
@@ -30,7 +30,7 @@ def self.define_action(method)
 
       def callback(*args, &block)
         begin
-          require 'webmock'
+          require 'webmock/rspec'
         rescue LoadError
           raise "Callbacks require webmock to be installed"
         end
diff --git a/lib/rspec_api_documentation/oauth2_mac_client.rb b/lib/rspec_api_documentation/oauth2_mac_client.rb
@@ -4,7 +4,7 @@
   # ActiveSupport::SecureRandom not provided in activesupport >= 3.2
 end
 begin
-  require "webmock"
+  require "webmock/rspec"
 rescue LoadError
   raise "Webmock needs to be installed before using the OAuth2MACClient"
 end
diff --git a/rspec_api_documentation.gemspec b/rspec_api_documentation.gemspec
@@ -18,20 +18,25 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "mustache", "~> 1.0", ">= 0.99.4"
 
-  s.add_development_dependency "bundler", "~> 1.0"
-  s.add_development_dependency "fakefs", "~> 0.4"
-  s.add_development_dependency "sinatra", "~> 1.4", ">= 1.4.4"
-  s.add_development_dependency "aruba", "~> 0.5"
-  s.add_development_dependency "capybara", "~> 2.2"
-  s.add_development_dependency "rake", "~> 10.1"
-  s.add_development_dependency "rack-test", "~> 0.6.2"
-  s.add_development_dependency "rack-oauth2", "~> 1.2.2", ">= 1.0.7"
-  s.add_development_dependency "webmock", "~> 1.7"
-  s.add_development_dependency "rspec-its", "~> 1.0"
-  s.add_development_dependency "faraday", "~> 0.9", ">= 0.9.0"
-  s.add_development_dependency "thin", "~> 1.6", ">= 1.6.3"
-  s.add_development_dependency "nokogiri", "~> 1.8", ">= 1.8.2"
-  s.add_development_dependency "yard", ">= 0.9.11"
+  s.add_development_dependency "bundler", ">= 1.16"
+  s.add_development_dependency "fakefs", "~> 0.6.0"
+  s.add_development_dependency "sinatra", "~> 2.0.8"
+  s.add_development_dependency "aruba", "~> 0.14.14"
+  s.add_development_dependency "capybara", "~> 3.39.2"
+  s.add_development_dependency "rake", "~> 13.2.1"
+  s.add_development_dependency "rack-test", "~> 0.6.3"
+  s.add_development_dependency "rack-oauth2", "~> 1.12.0"
+  s.add_development_dependency "webmock", "~> 3.23.0"
+  s.add_development_dependency "rspec-its", "~> 1.3.0"
+  s.add_development_dependency "faraday", "~> 1.0.0"
+  s.add_development_dependency "nokogiri", "~> 1.8.4"
+  s.add_development_dependency "yard", "~> 0.9.15"
+  s.add_development_dependency "inch", "~> 0.8.0"
+  s.add_development_dependency "minitest", "~> 5.8.4"
+  s.add_development_dependency "contracts", "~> 0.17"
+  s.add_development_dependency "gherkin", "~> 9.0.0"
+  s.add_development_dependency "multi_json", "~> 1.15.0"
+  s.add_development_dependency "rspec", "~> 3.0"
 
   s.files        = Dir.glob("lib/**/*") + Dir.glob("templates/**/*")
   s.require_path = "lib"
diff --git a/spec/http_test_client_spec.rb b/spec/http_test_client_spec.rb
@@ -3,19 +3,12 @@
 require 'capybara'
 require 'capybara/server'
 require 'sinatra/base'
-require 'webmock'
+require 'webmock/rspec'
 require 'support/stub_app'
 
 describe RspecApiDocumentation::HttpTestClient do
   before(:all) do
     WebMock.allow_net_connect!
-
-    Capybara.server do |app, port|
-      require 'rack/handler/thin'
-      Thin::Logging.silent = true
-      Rack::Handler::Thin.run(app, :Port => port)
-    end
-
     server = Capybara::Server.new(StubApp.new, 8888)
     server.boot
   end
diff --git a/spec/views/api_blueprint_index_spec.rb b/spec/views/api_blueprint_index_spec.rb

-Original file line number
+Diff line change
 *.swp
 /html/
 /.idea
 +Gemfile.lock