swagcov 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b15b82b2a87742868a94cd6964469cb4aff857259d3752fe258e595f0dcfc1
-  data.tar.gz: cc35beef6a1b53c6f418337d1a59b48ce7d5152e1abf9746a0847fda08721bfc
+  metadata.gz: 6982166b311ad4760552a4d9b867dd0933b08f67e27da868a5b679e3cf93e4f4
+  data.tar.gz: 27bf743505dd26ce0180e1cfb47cdaba3b08690b746a5577b47e9e3e0f821026
 SHA512:
-  metadata.gz: 4c1c0133c991c4dea09e0120aa54eab71b59746c5a9ec4e1718a2fc21d86802dec7b51039bfde1638fd9055932d1fc93a958285400fa9cb777378e5c02e91851
-  data.tar.gz: 00c4c6b3508b19cb0f2c89debfc920c6aa234a4e9ec5142a11cc5995fed34d255eb70000e482d47c50a7d4f88ab026b27592b7cd1f143add31d777c48898533a
+  metadata.gz: df6f5c0dcd71a4f71954f40c818a831584a964983790bbb25e9aa335f569453b41cd6d6d1a5dc092389dc061338e90e3a44907cbf2c77016f7e43faae0ac2ca6
+  data.tar.gz: e27a24e341a0fee8d7122c92e778543c9dd64de52b9b7ad74a60f60c808ac96aed4b779945f15221560803094fffe131ebedb72f5a4440b7ad5be54d6ad94034

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 ## main (unreleased)
 -
 
+## 0.9.0 (2025-05-07)
+### Enhancement
+- Add support for `.json` OpenAPI file types ([#112](https://github.com/smridge/swagcov/pull/112), [#113](https://github.com/smridge/swagcov/pull/113))
+- Update rake task descriptions ([#114](https://github.com/smridge/swagcov/pull/114))
+- Improve performance of OpenAPI response key matching for route paths ([#115](https://github.com/smridge/swagcov/pull/115))
+
 ## 0.8.1 (2025-04-29)
 ### Fix
 - Performance of coverage output by memoizing path string length ([#108](https://github.com/smridge/swagcov/pull/108))

data/README.md

@@ -17,9 +17,9 @@ See OpenAPI documentation coverage report for Rails Routes.
 
 | `rake task` | `rails console` | Description |
 | :--- | :--- | :--- |
-| `rake swagcov` | `Swagcov::Command::ReportCoverage.new.run` | Check documentation coverage |
-| `rake swagcov:install` | `Swagcov::Command::GenerateDotfile.new.run` | Install required `.swagcov.yml` config file |
-| `rake swagcov:generate_todo` | `Swagcov::Command::GenerateTodoFile.new.run` | Generate `.swagcov_todo.yml` |
+| `rake swagcov` | `Swagcov::Command::ReportCoverage.new.run` | Check OpenAPI documentation coverage for Rails Route endpoints |
+| `rake swagcov:install` | `Swagcov::Command::GenerateDotfile.new.run` | Generate required `.swagcov.yml` config file |
+| `rake swagcov:generate_todo` | `Swagcov::Command::GenerateTodoFile.new.run` | Generate optional `.swagcov_todo.yml` config file |
 
 ## Ruby and Rails Version Support
 Versioning support from a test coverage perspective, see [tests.yml](/.github/workflows/tests.yml) for detail
@@ -51,11 +51,12 @@ Create a `.swagcov.yml` in root of your Rails application. Alternatively, run:
 bundle exec rake swagcov:install
 ```
 
-- Add the paths of your `openapi` yml files (**required**):
+- Add the paths of your OpenAPI `.yml` and/or `.json` files (**required**):
   ```yml
   docs:
     paths:
       - swagger.yaml
+      - swagger.json
   ```
 
 - Add `only` routes (**optional**) :

data/lib/swagcov/command/generate_dotfile.rb

@@ -19,10 +19,11 @@ module Swagcov
           dotfile,
           <<~YAML
             ## Required field:
-            # List your OpenAPI documentation files
+            # List your OpenAPI documentation file(s) (accepts json or yaml)
             docs:
               paths:
                 - swagger.yaml
+                - swagger.json
 
             ## Optional fields:
             # routes:

data/lib/swagcov/openapi_files.rb

@@ -5,13 +5,14 @@ module Swagcov
     def initialize filepaths:
       @filepaths = filepaths
       @openapi_paths = load_yamls
+      @openapi_path_keys = @openapi_paths.keys
     end
 
     def find_response_keys path:, route_verb:
       # replace :id with {id}
       regex = ::Regexp.new("^#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}?$")
 
-      matching_paths_key = @openapi_paths.keys.grep(regex).first
+      matching_paths_key = @openapi_path_keys.grep(regex).first
       matching_request_method_key = @openapi_paths.dig(matching_paths_key, route_verb.downcase)
 
       matching_request_method_key["responses"].keys.map(&:to_s).sort if matching_request_method_key
@@ -26,8 +27,8 @@ module Swagcov
     end
 
     def load_yaml filepath
-      ::YAML.load_file(filepath)["paths"]
-    rescue ::Psych::SyntaxError
+      ::YAML.load_file(filepath)["paths"] # loads yaml or json
+    rescue ::Psych::SyntaxError, ::JSON::ParserError
       raise ::Swagcov::Errors::BadConfiguration, "Malformed openapi file (#{filepath})"
     end
   end

data/lib/swagcov/version.rb

@@ -2,6 +2,6 @@
 
 module Swagcov
   module Version
-    STRING = "0.8.1"
+    STRING = "0.9.0"
   end
 end

data/lib/tasks/swagcov/generate_todo.rake

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 namespace :swagcov do
-  desc "generate todo config file"
+  desc "Generate optional .swagcov_todo.yml config file acting as a TODO list"
   task generate_todo: :environment do
     exit Swagcov::Command::GenerateTodoFile.new.run
   end

data/lib/tasks/swagcov/install.rake

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 namespace :swagcov do
-  desc "create config file"
+  desc "Generate required .swagcov.yml config file"
   task install: :environment do
     exit Swagcov::Command::GenerateDotfile.new.run
   end

data/lib/tasks/swagcov.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-desc "check documentation coverage for endpoints"
+desc "Check OpenAPI documentation coverage for Rails Route endpoints"
 task swagcov: :environment do
   exit Swagcov::Command::ReportCoverage.new.run
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Sarah Ridge