reqcord 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2203f5a2f9ca4548874caf3a40a93c8fbe5a73e6f9d916f6162cbd843fec4341
-  data.tar.gz: 05b67df4290c1e6aeba3e5a29416df3f5e779c2d5fcf3eef6cfd76e4a8fabdb8
+  metadata.gz: 5b5479eb9ebc313b6b16250eb40692a664c4d7f56eba83a5875a061153714941
+  data.tar.gz: 61a8fa46ddcef53e0e318589d94fd485e25f7666a3042d2050d05138350db83b
 SHA512:
-  metadata.gz: 11602f1a318f214c92cec4f68723d47ba8b237fa8fb4d7a46e2fe2628168441e9ab3ec8f1f8cf73922f2b3bc5ac0954876e2904e03f9454fd8c99faa7648141f
-  data.tar.gz: a273eb86d0b0939215a3375054239c2361d1520c0bf2c8faa8429ae15a9db8c1d923cf005731bd8690da67529496217c807d75abb760f2d963588109273f9e9e
+  metadata.gz: 3794123441aba25e1aa5a0fd5560ef280cda236ce4eee98b939f684d2cb40a6833b82358331cdf5a609b18076112901b7b9cefa623bea10145350a5d6f729205
+  data.tar.gz: 5b416b598625d8f76df50cdce032eafddd6102f0a00f364231f334c7d3939041b2e5d622adb801ee3e04ef00d61936ab0c75b1850c3018445954e78ea8236869

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [0.1.3] - Unreleased
+
+### Added
+
+* `routes.prefix` accepts a list (`[/v1, /v2, /partner]`) for APIs whose
+  versions or audiences do not share a root.
+
+### Changed
+
+* The `reqcord:init` template now names test directories (`test.paths`)
+  instead of running the whole suite, and documents every key inline.
+
+## [0.1.2] - 2026-09-16
+
+### Added
+
+* Rails 7.1 and 7.2 are supported alongside 8.x (Ruby 3.2+); CI runs every
+  supported Ruby × Rails pair through `gemfiles/`.
+
+### Fixed
+
+* CI resolves the bundle per Ruby (no committed `Gemfile.lock`) and pins
+  `json < 3` for development: activesupport 8.1 calls `JSON.parse(json,
+  options)`, a signature json 3.0 dropped.
+
 ## [0.1.1] - 2026-09-15
 
 ### Added

data/Gemfile

@@ -3,3 +3,8 @@
 source "https://rubygems.org"
 
 gemspec
+
+# activesupport 8.1.3.1 calls JSON.parse(json, options), a signature json 3.0
+# dropped, so every JSON request body fails to parse with a 400. Development
+# only: the gemspec leaves json to the host application and to Rails.
+gem "json", "< 3"

data/README.md

@@ -1,5 +1,7 @@
 # Reqcord
 
+[![CI](https://github.com/ahmetsaridogan/reqcord/actions/workflows/ci.yml/badge.svg)](https://github.com/ahmetsaridogan/reqcord/actions/workflows/ci.yml)
+
 **Turn your Rails integration tests into living API documentation.**
 
 Reqcord observes real HTTP requests and responses executed by your Rails test suite and converts them into static, readable API documentation.
@@ -212,6 +214,17 @@ The internal dataset is framework-independent and output-independent.
 
 This allows Reqcord to support additional test frameworks and documentation formats without coupling them together.
 
+## Supported versions
+
+| | |
+| --- | --- |
+| Ruby | 3.2, 3.3, 3.4 |
+| Rails | 7.1, 7.2, 8.0, 8.1 |
+| Test frameworks | Minitest integration tests, RSpec request specs |
+
+Every Ruby × Rails pair that Rails itself supports runs in CI
+(`gemfiles/rails_*.gemfile`).
+
 ## Installation
 
 Add Reqcord to the development and test groups:

data/docs/configuration.md

@@ -146,6 +146,20 @@ routes:
   prefix: /api/v2
 ```
 
+A list documents routes under any of the prefixes — for APIs whose versions
+or audiences do not share a root:
+
+```yaml
+routes:
+  prefix:
+    - /v1
+    - /v2
+    - /partner
+```
+
+One prefix already covers every version beneath it (`/api` includes `/api/v1`
+and `/api/v2`); use `VERSION=v2` to generate for one of them.
+
 Rails' own routes (`rails/…`, Active Storage, Action Mailbox, Turbo) are always
 left out. `redirect(...)` routes and plain Rack mounts cannot be documented from
 a test; they are counted as *skipped* in the report rather than dropped.

data/examples/reqcord.yml

@@ -20,8 +20,10 @@ test:
   # command: bin/rails test test/integration test/api
 
 routes:
-  # Only routes under this prefix are documented. Filter a single run with
-  # RESOURCE=customers,cart or VERSION=v2 instead of editing this file.
+  # Only routes under this prefix are documented; a list works too:
+  #   prefix: [/api, /partner]
+  # Filter a single run with RESOURCE=customers,cart or VERSION=v2 instead of
+  # editing this file.
   prefix: /api
 
 output:

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# CI: BUNDLE_GEMFILE=gemfiles/rails_7.1.gemfile bundle exec rake test
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "railties", "~> 7.1.0"
+gem "actionpack", "~> 7.1.0"
+
+# activesupport calls JSON.parse(json, options); json 3.0 dropped that signature.
+gem "json", "< 3"

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# CI: BUNDLE_GEMFILE=gemfiles/rails_7.2.gemfile bundle exec rake test
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "railties", "~> 7.2.0"
+gem "actionpack", "~> 7.2.0"
+
+# activesupport calls JSON.parse(json, options); json 3.0 dropped that signature.
+gem "json", "< 3"

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# CI: BUNDLE_GEMFILE=gemfiles/rails_8.0.gemfile bundle exec rake test
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "railties", "~> 8.0.0"
+gem "actionpack", "~> 8.0.0"
+
+# activesupport calls JSON.parse(json, options); json 3.0 dropped that signature.
+gem "json", "< 3"

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# CI: BUNDLE_GEMFILE=gemfiles/rails_8.1.gemfile bundle exec rake test
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "railties", "~> 8.1.0"
+gem "actionpack", "~> 8.1.0"
+
+# activesupport calls JSON.parse(json, options); json 3.0 dropped that signature.
+gem "json", "< 3"

data/lib/reqcord/configuration.rb

@@ -123,8 +123,14 @@ module Reqcord
       Array(data.dig("test", "paths")).map(&:to_s)
     end
 
+    # `prefix: /api` or `prefix: [/v1, /v2]`; a route under any of them is
+    # documented. Empty means every route.
+    def route_prefixes
+      Array(data.dig("routes", "prefix")).map(&:to_s).reject(&:empty?)
+    end
+
     def route_prefix
-      data.dig("routes", "prefix")
+      route_prefixes.first
     end
 
     def output_directory

data/lib/reqcord/generator.rb

@@ -187,7 +187,7 @@ module Reqcord
       collector = RouteCollector.new(
         resources: resources,
         version: version,
-        prefix: configuration.route_prefix
+        prefix: configuration.route_prefixes
       )
 
       routes = collector.call

data/lib/reqcord/route_collector.rb

@@ -211,10 +211,12 @@ module Reqcord
       )
     end
 
+    # `prefix` is one string or a list; nothing configured means every route.
     def matches_prefix?(path)
-      return true if prefix.nil? || prefix.empty?
+      prefixes = Array(prefix).map(&:to_s).reject(&:empty?)
+      return true if prefixes.empty?
 
-      path.start_with?(prefix)
+      prefixes.any? { |candidate| path.start_with?(candidate) }
     end
 
     # `RESOURCE=customers`, `RESOURCE=cart` (a singular resource is served by

data/lib/reqcord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reqcord
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/tasks/reqcord.rake

@@ -11,31 +11,58 @@ namespace :reqcord do
     end
 
     content = <<~YAML
+      # Reqcord configuration. Every key is documented in the gem's
+      # docs/configuration.md. Precedence: environment > this file > defaults.
       version: 1
 
       test:
+        # minitest or rspec
         framework: minitest
-        command: bin/rails test
+
+        # The tests that exercise your API. Reqcord runs `bin/rails test <paths>`
+        # (or `rspec <paths>`) with capture enabled; a directory is enough.
+        paths:
+          - test/integration
+
+        # Or spell the command out yourself; it wins over `paths`.
+        # command: bin/rails test test/integration test/api
 
       routes:
+        # Only routes under this prefix are documented; a list works too
+        # (`prefix: [/v1, /v2]`). Filter a single run with
+        # RESOURCE=customers,cart or VERSION=v2.
         prefix: /api
 
       output:
         directory: docs/api
+
+        # Routes no test reached with a 2xx are listed in the index either
+        # way; `true` also writes a page for each of them.
         include_uncovered: false
 
+      # markdown: pages under docs/api, curl: one runnable .sh per endpoint,
+      # postman: postman/collection.json (import into Postman or Hoppscotch).
       exporters:
         - curl
         - markdown
         - postman
 
       variables:
+        # Host of every generated cURL and the Postman `base_url` variable.
         base_url: http://localhost:3000
 
       sanitize:
+        # Header values are replaced verbatim. Authorization, Cookie and
+        # X-Api-Key are always redacted, configured here or not.
         headers:
           Authorization: "Bearer {{token}}"
           X-Api-Key: "{{api_key}}"
+
+        # Body keys, matched at any depth in requests and responses. password,
+        # token, access_token, api_key, secret are always redacted; add the
+        # fields your API exposes (a signed payment link, for example).
+        body:
+          password: "{{password}}"
     YAML
 
     File.write(path, content)
@@ -82,7 +109,7 @@ namespace :reqcord do
       Reqcord::RouteCollector.call(
         resources: ENV.fetch("RESOURCE", "").split(",").map(&:strip).reject(&:empty?),
         version: ENV["VERSION"],
-        prefix: Reqcord.configuration.route_prefix
+        prefix: Reqcord.configuration.route_prefixes
       )
 
     if routes.empty?

data/reqcord.gemspec

@@ -24,23 +24,37 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["rubygems_mfa_required"] = "true"
 
+  # What ships: lib/, the rake task, the docs and the annotated config. Tests,
+  # CI files and the example apps (with their generated output) stay on
+  # GitHub — `git ls-files` runs against the checkout, so `gem build` must be
+  # run from the repository root.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |file|
       file.start_with?(
         "test/",
         "spec/",
         "features/",
-        ".git/",
+        "examples/",
+        ".git",
         ".github/"
       ) || file.end_with?(".gem")
-    end
+    end + ["examples/reqcord.yml"]
   end
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 8.0", "< 9.0"
-  spec.add_dependency "actionpack", ">= 8.0", "< 9.0"
+  # Rails 7.1 through 8.x; every version is exercised in CI (see gemfiles/).
+  spec.add_dependency "railties", ">= 7.1", "< 9.0"
+  spec.add_dependency "actionpack", ">= 7.1", "< 9.0"
 
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
+
+  # The test suite serves the dummy app over HTTP to replay the generated
+  # cURL and Postman collection, validates the collection against the
+  # Postman schema, and runs the RSpec example apps.
+  spec.add_development_dependency "puma"
+  spec.add_development_dependency "json-schema"
+  spec.add_development_dependency "rspec-core"
+  spec.add_development_dependency "rspec-expectations"
 end