swagcov 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10f7019116f2fb27f9bcf01ed15450bb26e715778722c26448571ed006fb1675
-  data.tar.gz: 35d038789bbdb47d93720fa0ab5e07d95eefc92810145e083fb3076e6f151e13
+  metadata.gz: ba29f88b400a4b44a37ee42725f70a5a97aa8ec9186de531ea13de33e8fec205
+  data.tar.gz: 6651caaa48d8fa61bd90f1598cfd3d78b8d6612ca6f14f76360ef8d85a256828
 SHA512:
-  metadata.gz: 53e051e7b1c1b50b1cf23f0774fdd13aad99619463e7838ef8c5834d7e172fb5948e682813787ac22bfac8db64452dc4405ebc436d0266a99935915b012ebc90
-  data.tar.gz: bc67b90db65336931ba6895ad5ee51f63ad3aea5855b2e44f53e05a6c7b7cc57746f483f5d2c24bb651841f437b4c6d5c09bfec77d419cb0cf5e15f7b119f53d
+  metadata.gz: 86b8e97506c580b7981090803aa41a609d1c1396613a57da1faf7c66864c40ac0337675fa009a5c48311ceff89bf8e6f1eb683d098a0153525a71d95cdb9c124
+  data.tar.gz: e62b2919cb26ff819d28abf200fce58d23b7f509b47200114ce6f69bc23d086fb2399b21be6e0363a6a15102f845d6ad5dc003e5fb36f175ab1c87947b21a68a

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 ## main (unreleased)
 -
 
+## 0.6.0 (2025-04-09)
+### Fix
+- Grammatical number for endpoint(s) count output ([#78](https://github.com/smridge/swagcov/pull/78))
+
+### Enhancement
+- Add support for Rails 4.2 ([#72](https://github.com/smridge/swagcov/pull/72))
+
+### Refactor
+- `BREAKING CHANGE`: `Swagcov::BadConfigurationError` is now `Swagcov::Errors::BadConfiguration` ([#74](https://github.com/smridge/swagcov/pull/74))
+- `BREAKING CHANGE`: `Swagcov::VERSION` is now `Swagcov::Version::STRING` ([#77](https://github.com/smridge/swagcov/pull/77))
+- Improve path matching processing for `ignore` and `only` routes ([#65](https://github.com/smridge/swagcov/pull/65))
+
+### Code Coverage
+  - Add test coverage reporting ([#68](https://github.com/smridge/swagcov/pull/68), [#69](https://github.com/smridge/swagcov/pull/69))
+
 ## 0.5.0 (2025-03-26)
 ### Enhancement
   - Add rake task for configuration installation ([#59](https://github.com/smridge/swagcov/pull/59))
@@ -23,7 +38,7 @@
 - Output width for better layout alignment ([#48](https://github.com/smridge/swagcov/pull/48))
 
 ### Code Coverage
-  - Added official support for ruby 3.3 and 3.4 and rails 7.1, 7.2, 8.0. See [unit_tests.yml](/.github/workflows/unit_tests.yml) and [system_tests.yml](/.github/workflows/system_tests.yml) for detail
+  - Added official support for ruby 3.3 and 3.4 and rails 7.1, 7.2, 8.0. See [tests.yml](/.github/workflows/tests.yml) for detail
 
 ## 0.4.0 (2022-08-11)
   - Improve OpenAPI file processing ([#26](https://github.com/smridge/swagcov/pull/26))

data/README.md

@@ -4,12 +4,30 @@
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 [![GitHub License](https://img.shields.io/github/license/smridge/swagcov.svg)](https://github.com/smridge/swagcov/blob/main/LICENSE)
 
+![Tests Build](https://github.com/smridge/swagcov/actions/workflows/tests.yml/badge.svg)
+![Linting Build](https://github.com/smridge/swagcov/actions/workflows/linting.yml/badge.svg)
+![CodeQL Build](https://github.com/smridge/swagcov/actions/workflows/codeql-analysis.yml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/smridge/swagcov/badge.svg?branch=main)](https://coveralls.io/github/smridge/swagcov?branch=main)
+
 See OpenAPI documentation coverage report for Rails Routes.
 
 ## Usages
 - See overview of different endpoints covered, missing and what you choose to ignore.
 - Add pass/fail to your build pipeline when missing Documentation Coverage.
 
+## Ruby and Rails Version Support
+Versioning support from a test coverage perspective, see [tests.yml](/.github/workflows/tests.yml) for detail
+| `ruby -v` | `rails 4.2` | `rails 5.0` | `rails 5.1` | `rails 5.2` | `rails 6.0` | `rails 6.1` | `rails 7.0` | `rails 7.1` | `rails 7.2` | `rails 8.0` |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+| `2.5` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
+| `2.6` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
+| `2.7` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ |
+| `3.0` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ |
+| `3.1` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
+| `3.2` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| `3.3` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| `3.4` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+
 ## Installation
 Add this line to your application's Gemfile:
 ```ruby
@@ -61,6 +79,8 @@ bundle exec rake swagcov:install
         - ^/v1
       ignore:
         - /v1/foobar/:token
+        - /v1/foobar:
+          - GET
   ```
 
 Execute:
@@ -108,9 +128,6 @@ bundle exec rake swagcov
   ```
   <img src="https://raw.githubusercontent.com/smridge/swagcov/main/images/ignore-and-only-endpoints.png">
 
-## TODO
-- Add autogeneration of ignore paths
-
 ## Contributing
 See [CONTRIBUTING.md](CONTRIBUTING.md) for detail
 

data/lib/swagcov/coverage.rb

@@ -2,28 +2,31 @@
 
 module Swagcov
   class Coverage
-    attr_reader :total, :covered, :ignored, :routes_not_covered, :routes_covered, :routes_ignored
-
-    def initialize dotfile: Swagcov::Dotfile.new, routes: ::Rails.application.routes.routes
-      @total = 0
-      @covered = 0
-      @ignored = 0
-      @routes_not_covered = []
-      @routes_covered = []
-      @routes_ignored = []
+    attr_reader :data
+
+    def initialize dotfile: ::Swagcov::Dotfile.new, routes: ::Rails.application.routes.routes
       @dotfile = dotfile
       @routes = routes
+      @data = {
+        covered: [],
+        ignored: [],
+        uncovered: [],
+        total_count: 0,
+        covered_count: 0,
+        ignored_count: 0,
+        uncovered_count: 0
+      }
     end
 
     def report
       collect_coverage
-      routes_output(@routes_covered, "green")
-      routes_output(@routes_ignored, "yellow")
-      routes_output(@routes_not_covered, "red")
+      routes_output(@data[:covered], "green")
+      routes_output(@data[:ignored], "yellow")
+      routes_output(@data[:uncovered], "red")
 
       final_output
 
-      @total - @covered
+      @data[:uncovered_count]
     end
 
     private
@@ -31,36 +34,36 @@ module Swagcov
     attr_reader :dotfile
 
     def collect_coverage
-      openapi_files = ::Swagcov::OpenapiFiles.new(filepaths: dotfile.doc_paths)
+      openapi_files = ::Swagcov::OpenapiFiles.new(filepaths: dotfile.docs_config)
+      rails_version = ::Rails::VERSION::STRING
 
       @routes.each do |route|
         path = route.path.spec.to_s.chomp("(.:format)")
+        verb = rails_version > "5" ? route.verb : route.verb.inspect.gsub(%r{[$^/]}, "")
 
-        next if third_party_route?(route, path)
+        next if third_party_route?(route, path, rails_version)
 
-        if dotfile.ignore_path?(path, verb: route.verb)
-          @ignored += 1
-          @routes_ignored << { verb: route.verb, path: path, status: "ignored" }
+        if dotfile.ignore_path?(path, verb: verb)
+          update_data(:ignored, verb, path, "ignored")
           next
         end
 
         next if dotfile.only_path_mismatch?(path)
 
-        @total += 1
+        @data[:total_count] += 1
 
-        if (response_keys = openapi_files.find_response_keys(path: path, route_verb: route.verb))
-          @covered += 1
-          @routes_covered << { verb: route.verb, path: path, status: response_keys.join("  ") }
+        if (response_keys = openapi_files.find_response_keys(path: path, route_verb: verb))
+          update_data(:covered, verb, path, response_keys.join("  "))
         else
-          @routes_not_covered << { verb: route.verb, path: path, status: "none" }
+          update_data(:uncovered, verb, path, "none")
         end
       end
     end
 
-    def third_party_route? route, path
+    def third_party_route? route, path, rails_version
       # https://github.com/rails/rails/blob/48f3c3e201b57a4832314b2c957a3b303e89bfea/actionpack/lib/action_dispatch/routing/inspector.rb#L105-L107
       # Skips route paths like ["/rails/info/properties", "/rails/info", "/rails/mailers"]
-      route.internal ||
+      internal_rails_route?(route, rails_version) ||
 
         # Skips routes like "/sidekiq"
         route.verb.blank? ||
@@ -71,6 +74,19 @@ module Swagcov
         path.include?("/active_storage/") || path.include?("/action_mailbox/")
     end
 
+    def internal_rails_route? route, rails_version
+      if rails_version > "5"
+        route.internal
+      else
+        ::ActionDispatch::Routing::RouteWrapper.new(route).internal?
+      end
+    end
+
+    def update_data key, verb, path, status
+      @data[:"#{key}_count"] += 1
+      @data[key] << { verb: verb, path: path, status: status }
+    end
+
     def routes_output routes, status_color
       routes.each do |route|
         $stdout.puts(
@@ -84,9 +100,9 @@ module Swagcov
 
     def min_width key
       strings =
-        @routes_covered.map { |hash| hash[key] } +
-        @routes_ignored.map { |hash| hash[key] } +
-        @routes_not_covered.map { |hash| hash[key] }
+        @data[:covered].map { |hash| hash[key] } +
+        @data[:ignored].map { |hash| hash[key] } +
+        @data[:uncovered].map { |hash| hash[key] }
 
       strings.max_by(&:length).size
     end
@@ -96,37 +112,33 @@ module Swagcov
       $stdout.puts(
         format(
           "OpenAPI documentation coverage %<percentage>.2f%% (%<covered>d/%<total>d)",
-          { percentage: 100.0 * @covered / @total, covered: @covered, total: @total }
-        )
-      )
-
-      $stdout.puts(
-        format(
-          "%<total>s endpoints ignored",
-          { total: @ignored.to_s.yellow }
+          {
+            percentage: 100.0 * @data[:covered_count] / @data[:total_count],
+            covered: @data[:covered_count],
+            total: @data[:total_count]
+          }
         )
       )
 
-      $stdout.puts(
-        format(
-          "%<total>s endpoints checked",
-          { total: @total.to_s.blue }
-        )
-      )
+      count_output
+    end
 
-      $stdout.puts(
-        format(
-          "%<covered>s endpoints covered",
-          { covered: @covered.to_s.green }
-        )
-      )
+    def count_output
+      {
+        ignored: "yellow",
+        total: "blue",
+        covered: "green",
+        uncovered: "red"
+      }.each do |key, color|
+        count = @data[:"#{key}_count"]
 
-      $stdout.puts(
-        format(
-          "%<missing>s endpoints missing documentation",
-          { missing: (@total - @covered).to_s.red }
+        $stdout.puts(
+          format(
+            "%<status>s #{key} #{count == 1 ? 'endpoint' : 'endpoints'}",
+            { status: count.to_s.send(color) }
+          )
         )
-      )
+      end
     end
   end
 end

data/lib/swagcov/dotfile.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
 module Swagcov
-  class BadConfigurationError < RuntimeError
-  end
-
   class Dotfile
     DEFAULT_CONFIG_FILE_NAME = ".swagcov.yml"
 
     def initialize pathname: ::Rails.root.join(DEFAULT_CONFIG_FILE_NAME)
       @dotfile = load_yaml(pathname)
 
-      raise BadConfigurationError, "Invalid config file (#{DEFAULT_CONFIG_FILE_NAME})" unless valid?
+      raise ::Swagcov::Errors::BadConfiguration, "Invalid config file (#{DEFAULT_CONFIG_FILE_NAME})" unless valid?
+
+      @ignored_regex = path_config_regex(ignored_config)
+      @only_regex = path_config_regex(only_config)
     end
 
     def ignore_path? path, verb:
-      ignore_all_path_actions = ignored_regex&.match?(path)
+      return false unless @ignored_config
 
-      ignored_verbs = ignored_config&.find { |config| config[path] }
+      ignore_all_path_actions = @ignored_regex.match?(path)
+
+      ignored_verbs = @ignored_config.find { |config| config[path] }
 
       return ignore_all_path_actions unless ignored_verbs.is_a?(::Hash)
 
@@ -24,11 +26,19 @@ module Swagcov
     end
 
     def only_path_mismatch? path
-      only_regex && !only_regex.match?(path)
+      @only_config && !@only_regex.match?(path)
+    end
+
+    def docs_config
+      @docs_config ||= dotfile.dig("docs", "paths")
+    end
+
+    def ignored_config
+      @ignored_config ||= dotfile.dig("routes", "paths", "ignore")
     end
 
-    def doc_paths
-      dotfile.dig("docs", "paths")
+    def only_config
+      @only_config ||= dotfile.dig("routes", "paths", "only")
     end
 
     private
@@ -36,23 +46,13 @@ module Swagcov
     attr_reader :dotfile
 
     def load_yaml pathname
-      raise BadConfigurationError, "Missing config file (#{DEFAULT_CONFIG_FILE_NAME})" unless pathname.exist?
+      unless pathname.exist?
+        raise ::Swagcov::Errors::BadConfiguration, "Missing config file (#{DEFAULT_CONFIG_FILE_NAME})"
+      end
 
-      YAML.load_file(pathname)
+      ::YAML.load_file(pathname)
     rescue Psych::SyntaxError
-      raise BadConfigurationError, "Malinformed config file (#{DEFAULT_CONFIG_FILE_NAME})"
-    end
-
-    def ignored_regex
-      @ignored_regex ||= path_config_regex(ignored_config)
-    end
-
-    def ignored_config
-      @ignored_config ||= dotfile.dig("routes", "paths", "ignore")
-    end
-
-    def only_regex
-      @only_regex ||= path_config_regex(dotfile.dig("routes", "paths", "only"))
+      raise ::Swagcov::Errors::BadConfiguration, "Malinformed config file (#{DEFAULT_CONFIG_FILE_NAME})"
     end
 
     def path_config_regex path_config
@@ -71,7 +71,7 @@ module Swagcov
     end
 
     def valid?
-      dotfile && doc_paths
+      dotfile && docs_config
     end
   end
 end

data/lib/swagcov/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Swagcov
+  module Errors
+    class BadConfiguration < ::RuntimeError
+    end
+  end
+end

data/lib/swagcov/openapi_files.rb

@@ -9,7 +9,7 @@ module Swagcov
 
     def find_response_keys path:, route_verb:
       # replace :id with {id}
-      regex = Regexp.new("^#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}?$")
+      regex = ::Regexp.new("^#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}?$")
 
       matching_paths_key = @openapi_paths.keys.grep(regex).first
       matching_request_method_key = @openapi_paths.dig(matching_paths_key, route_verb.downcase)
@@ -20,15 +20,15 @@ module Swagcov
     private
 
     def load_yamls
-      Dir.glob(@filepaths).reduce({}) do |hash, filepath|
+      ::Dir.glob(@filepaths).reduce({}) do |hash, filepath|
         hash.merge(load_yaml(filepath))
       end
     end
 
     def load_yaml filepath
-      YAML.load_file(filepath)["paths"]
-    rescue Psych::SyntaxError
-      raise BadConfigurationError, "Malinformed openapi file (#{filepath})"
+      ::YAML.load_file(filepath)["paths"]
+    rescue ::Psych::SyntaxError
+      raise ::Swagcov::Errors::BadConfiguration, "Malinformed openapi file (#{filepath})"
     end
   end
 end

data/lib/swagcov/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module Swagcov
-  VERSION = "0.5.0"
+  module Version
+    STRING = "0.6.0"
+  end
 end

data/lib/swagcov.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require "swagcov/version"
-
-if defined?(Rails)
-  require "swagcov/railtie"
-  require "swagcov/dotfile"
-  require "swagcov/coverage"
-  require "swagcov/openapi_files"
-  require "swagcov/install"
-end
+require "rails"
+require "active_support/core_ext"
 
 require "swagcov/core_ext/string"
+require "swagcov/coverage"
+require "swagcov/dotfile"
+require "swagcov/errors"
+require "swagcov/install"
+require "swagcov/openapi_files"
+require "swagcov/railtie"
+require "swagcov/version"
 
 module Swagcov
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Sarah Ridge
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4.2'
 email:
 - sarahmarie@hey.com
 executables: []
@@ -37,12 +37,13 @@ files:
 - lib/swagcov/core_ext/string.rb
 - lib/swagcov/coverage.rb
 - lib/swagcov/dotfile.rb
+- lib/swagcov/errors.rb
 - lib/swagcov/install.rb
 - lib/swagcov/openapi_files.rb
 - lib/swagcov/railtie.rb
 - lib/swagcov/version.rb
+- lib/tasks/swagcov.rake
 - lib/tasks/swagcov/install.rake
-- lib/tasks/swagcove.rake
 homepage: https://github.com/smridge/swagcov
 licenses:
 - MIT