reqcord 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c23f11e62a357bbc63bc7479cd77d65da3245062b9c0594e4b3d3dc0421fd2
-  data.tar.gz: d20cfd0db3a617adc966f2641da79c155be232baad7fb94b47db235820da3a2d
+  metadata.gz: 5b5479eb9ebc313b6b16250eb40692a664c4d7f56eba83a5875a061153714941
+  data.tar.gz: 61a8fa46ddcef53e0e318589d94fd485e25f7666a3042d2050d05138350db83b
 SHA512:
-  metadata.gz: a5c2d1ebe2463d5c3647e843d4f70b04114fe3d225a8059b5e6e09d9461945305203c5bbfe4189039a8b48edc713cf39a3d0e5cafadefb6648f62f70aaff4595
-  data.tar.gz: 98406f42d54d21b3d7854a4b36960be53cfe0293be738ca1d1e64194215920b4194c30649a730662e078d4b9558298c1ec9a13d15096207bb4a99257733d4b1f
+  metadata.gz: 3794123441aba25e1aa5a0fd5560ef280cda236ce4eee98b939f684d2cb40a6833b82358331cdf5a609b18076112901b7b9cefa623bea10145350a5d6f729205
+  data.tar.gz: 5b416b598625d8f76df50cdce032eafddd6102f0a00f364231f334c7d3939041b2e5d622adb801ee3e04ef00d61936ab0c75b1850c3018445954e78ea8236869

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
-## [0.1.2] - Unreleased
+## [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
 

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/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.2"
+  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?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reqcord
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ahmet Saridogan