swagcov 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba29f88b400a4b44a37ee42725f70a5a97aa8ec9186de531ea13de33e8fec205
-  data.tar.gz: 6651caaa48d8fa61bd90f1598cfd3d78b8d6612ca6f14f76360ef8d85a256828
+  metadata.gz: 1df02b05f23038aacedc8a990a47012d27f90f64f7185c689507face26acd8c4
+  data.tar.gz: 8d2e127ed1b1de208ef87fe6a8920fe505fbdceade1f430300b26e2bb6441d19
 SHA512:
-  metadata.gz: 86b8e97506c580b7981090803aa41a609d1c1396613a57da1faf7c66864c40ac0337675fa009a5c48311ceff89bf8e6f1eb683d098a0153525a71d95cdb9c124
-  data.tar.gz: e62b2919cb26ff819d28abf200fce58d23b7f509b47200114ce6f69bc23d086fb2399b21be6e0363a6a15102f845d6ad5dc003e5fb36f175ab1c87947b21a68a
+  metadata.gz: 4faad26270ff8aceddad224fdb26b6fcd8c86eb0d1c2a75c8bff082aa829187a5d571b7aff037b4a8c5bc907c26c446d55a5807420b111f18abc5c7b475a445c
+  data.tar.gz: a8bbfa8964e97929d4e190353729e399e9f0bf59d78acef28084699e902be2689bf8e7bf2a2ea3289f10114040c10112204c0954da319da4c38971c6ea7f0c5e

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 ## main (unreleased)
 -
 
+## 0.7.0 (2025-04-18)
+### Enhancement
+- Add support for Ruby 3.5 ([#98](https://github.com/smridge/swagcov/pull/98))
+- Add rake task for auto-generation of `.swagcov_todo.yml` file ([#93](https://github.com/smridge/swagcov/pull/93), [#96](https://github.com/smridge/swagcov/pull/96))
+  ```shell
+  bundle exec rake swagcov:generate_todo
+  ```
+
+### Refactor
+- Add `Swagcov.project_root` method ([#86](https://github.com/smridge/swagcov/pull/86))
+- Separate coverage collection and output ([#83](https://github.com/smridge/swagcov/pull/83))
+- Replace ActiveSupport string method with ruby string method ([#85](https://github.com/smridge/swagcov/pull/85))
+- Replace `Swagcov::Coverage.new.report` with `Swagcov::Command::ReportCoverage.new.run` ([#89](https://github.com/smridge/swagcov/pull/89))
+- Rename `Swagcov::Install` to `Swagcov::Command::GenerateDotfile` ([#88](https://github.com/smridge/swagcov/pull/88))
+- Refactor `GenerateDotfile` to be consistent with `GenerateTodoFile` ([#97](https://github.com/smridge/swagcov/pull/97))
+
+### Fix
+- Add exit code to install task + update messaging ([#87](https://github.com/smridge/swagcov/pull/87))
+- Ignored path verb matching when duplicate path keys are present ([#92](https://github.com/smridge/swagcov/pull/92))
+- Fix exit code error handling ([#95](https://github.com/smridge/swagcov/pull/95))
+
+### Development
+- Add irb console for local development ([#94](https://github.com/smridge/swagcov/pull/94))
+
 ## 0.6.0 (2025-04-09)
 ### Fix
 - Grammatical number for endpoint(s) count output ([#78](https://github.com/smridge/swagcov/pull/78))
@@ -15,23 +39,23 @@
 - 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))
+- 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))
-    ```shell
-    bundle exec rake swagcov:install
-    ```
-  - Extend `ignore` routes configuration to exclude only specific actions ([#60](https://github.com/smridge/swagcov/pull/60))
-    ```yml
-    routes:
-      paths:
-        ignore:
-          - /v2/users # existing configuration that ignores all associated actions (verbs)
-          - /v2/users/:id: # new option to extend to specific actions
-            - GET
-    ```
+- Add rake task for configuration installation ([#59](https://github.com/smridge/swagcov/pull/59))
+  ```shell
+  bundle exec rake swagcov:install
+  ```
+- Extend `ignore` routes configuration to exclude only specific actions ([#60](https://github.com/smridge/swagcov/pull/60))
+  ```yml
+  routes:
+    paths:
+      ignore:
+        - /v2/users # existing configuration that ignores all associated actions (verbs)
+        - /v2/users/:id: # new option to extend to specific actions
+          - GET
+  ```
 
 ## 0.4.1 (2025-03-18)
 ### Fix
@@ -45,48 +69,49 @@
 
 ## 0.3.0 (2022-02-21)
 ### Enhancement
-  - Raise specific `Swagcov::BadConfigurationError` for malinformed yaml files ([#23](https://github.com/smridge/swagcov/pull/23))
+- Raise specific `Swagcov::BadConfigurationError` for malformed yaml files ([#23](https://github.com/smridge/swagcov/pull/23))
 
 ### Security
-  - Require Multi-Factor Authentication for RubyGems privileged operations ([#16](https://github.com/smridge/swagcov/pull/16))
+- Require Multi-Factor Authentication for RubyGems privileged operations ([#16](https://github.com/smridge/swagcov/pull/16))
 
 ### Code Coverage
-  - Add Sandbox Application and specs for Rails 5.1 ([#20](https://github.com/smridge/swagcov/pull/20))
-  - Add specs for Rails 5.2 ([#7](https://github.com/smridge/swagcov/pull/7)), ([#14](https://github.com/smridge/swagcov/pull/14))
-  - Add Sandbox Application and specs for Rails 6.0 ([#17](https://github.com/smridge/swagcov/pull/17))
-  - Add Sandbox Application and specs for Rails 6.1 ([#22](https://github.com/smridge/swagcov/pull/22))
-  - Add GitHub Actions to run specs ([#18](https://github.com/smridge/swagcov/pull/18))
-  - Add GitHub CodeQL ([#13](https://github.com/smridge/swagcov/pull/13))
+- Add Sandbox Application and specs for Rails 5.1 ([#20](https://github.com/smridge/swagcov/pull/20))
+- Add specs for Rails 5.2 ([#7](https://github.com/smridge/swagcov/pull/7)), ([#14](https://github.com/smridge/swagcov/pull/14))
+- Add Sandbox Application and specs for Rails 6.0 ([#17](https://github.com/smridge/swagcov/pull/17))
+- Add Sandbox Application and specs for Rails 6.1 ([#22](https://github.com/smridge/swagcov/pull/22))
+- Add GitHub Actions to run specs ([#18](https://github.com/smridge/swagcov/pull/18))
+- Add GitHub CodeQL ([#13](https://github.com/smridge/swagcov/pull/13))
 
 ### Refactor
-  - Move `SystemExit` to rake task for easier testing ([#24](https://github.com/smridge/swagcov/pull/24))
-  - Reduce complexity when matching routes ([#15](https://github.com/smridge/swagcov/pull/15))
+- Move `SystemExit` to rake task for easier testing ([#24](https://github.com/smridge/swagcov/pull/24))
+- Reduce complexity when matching routes ([#15](https://github.com/smridge/swagcov/pull/15))
 
 ## 0.2.5 (2021-09-14)
 ### Fix
-  - Matching routes against swagger paths. Previously, partial paths could result in a match ([#12](https://github.com/smridge/swagcov/pull/12))
+- Matching routes against swagger paths. Previously, partial paths could result in a match ([#12](https://github.com/smridge/swagcov/pull/12))
 
 ## 0.2.4 (2021-04-30)
 ### Fix
-  - If a route path does not start with "^" match the entire path ([#5](https://github.com/smridge/swagcov/pull/5))
+- If a route path does not start with "^" match the entire path ([#5](https://github.com/smridge/swagcov/pull/5))
+
 ### Enhancement
-  - Raise specific `Swagcov::BadConfigurationError` error if bad or missing configuration ([#5](https://github.com/smridge/swagcov/pull/5))
+- Raise specific `Swagcov::BadConfigurationError` error if bad or missing configuration ([#5](https://github.com/smridge/swagcov/pull/5))
 
 ## 0.2.3 (2021-04-23)
 ### Fix
-  - Exclude ActiveStorage and ActionMailer routes ([#3](https://github.com/smridge/swagcov/pull/3))
+- Exclude ActiveStorage and ActionMailer routes ([#3](https://github.com/smridge/swagcov/pull/3))
 
 ## 0.2.2 (2021-04-22)
 ### Fix
-  - Exclude Rails Internal Routes and Mounted Applications ([#2](https://github.com/smridge/swagcov/pull/2))
+- Exclude Rails Internal Routes and Mounted Applications ([#2](https://github.com/smridge/swagcov/pull/2))
 
 ## 0.2.1 (2021-04-21)
 ### Fix
-  - Exceptions caused by missing dependency for strings. ([#1](https://github.com/smridge/swagcov/pull/1))
+- Exceptions caused by missing dependency for strings. ([#1](https://github.com/smridge/swagcov/pull/1))
 
 ## 0.2.0 (2021-04-20)
 ### Enhancement
-  - Add Exit status to easily build a pass/fail into build pipeline
+- Add Exit status to easily build a pass/fail into build pipeline
 
 ## 0.1.0 (2021-02-24)
 - Create Rake Task for checking documentation coverage (rails only)

data/README.md

@@ -15,6 +15,12 @@ See OpenAPI documentation coverage report for Rails Routes.
 - See overview of different endpoints covered, missing and what you choose to ignore.
 - Add pass/fail to your build pipeline when missing Documentation Coverage.
 
+| `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` |
+
 ## 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` |
@@ -27,6 +33,7 @@ Versioning support from a test coverage perspective, see [tests.yml](/.github/wo
 | `3.2` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
 | `3.3` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
 | `3.4` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| `3.5` | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -88,7 +95,8 @@ Execute:
 bundle exec rake swagcov
 ```
 
-### Example configurations and output from running `bundle exec rake swagcov` from the root of your Rails Application:
+## Examples
+Configurations and output from running `bundle exec rake swagcov` from the root of your Rails Application
 - All Routes (minimal configuration):
   ```yml
   docs:

data/lib/swagcov/command/generate_dotfile.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Swagcov
+  module Command
+    class GenerateDotfile
+      attr_reader :dotfile
+
+      def initialize basename: ::Swagcov::Dotfile::DEFAULT_CONFIG_FILE_NAME
+        @dotfile = ::Swagcov.project_root.join(basename)
+      end
+
+      def run
+        if ::File.exist?(@dotfile)
+          $stdout.puts "#{@dotfile.basename} already exists at #{@dotfile.dirname}"
+          return ::Swagcov::STATUS_ERROR
+        end
+
+        ::File.write(
+          dotfile,
+          <<~YAML
+            ## Required field:
+            # List your OpenAPI documentation files
+            docs:
+              paths:
+                - swagger.yaml
+
+            ## Optional fields:
+            # routes:
+            #   paths:
+            #     only:
+            #       - ^/v2 # only track v2 endpoints
+            #     ignore:
+            #       - /v2/users # do not track certain endpoints
+            #       - /v2/users/:id: # ignore only certain actions (verbs)
+            #         - GET
+          YAML
+        )
+
+        $stdout.puts "created #{@dotfile.basename} at #{@dotfile.dirname}"
+
+        ::Swagcov::STATUS_SUCCESS
+      end
+    end
+  end
+end

data/lib/swagcov/command/generate_todo_file.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Swagcov
+  module Command
+    class GenerateTodoFile
+      def initialize basename: ::Swagcov::Dotfile::TODO_CONFIG_FILE_NAME,
+                     data: ::Swagcov::Coverage.new(dotfile: ::Swagcov::Dotfile.new(skip_todo: true)).collect[:uncovered]
+        @dotfile = ::Swagcov.project_root.join(basename)
+        @data = data
+      end
+
+      def run
+        ::File.write(
+          @dotfile,
+          <<~YAML
+            # This configuration was auto generated
+            # The intent is to remove these route configurations as documentation is added
+            #{routes_yaml}
+          YAML
+        )
+
+        $stdout.puts "created #{@dotfile.basename} at #{@dotfile.dirname}"
+
+        ::Swagcov::STATUS_SUCCESS
+      end
+
+      private
+
+      def routes_yaml
+        return if routes.empty?
+
+        {
+          "routes" => {
+            "paths" => {
+              "ignore" => routes
+            }
+          }
+        }.to_yaml.strip
+      end
+
+      def routes
+        hash = {}
+
+        @data.each do |route|
+          hash[route[:path]] ? hash[route[:path]] << route[:verb] : hash[route[:path]] = [route[:verb]]
+        end
+
+        @routes ||= hash.map { |key, value| { key => value } }
+      end
+    end
+  end
+end

data/lib/swagcov/command/report_coverage.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Swagcov
+  module Command
+    class ReportCoverage
+      def initialize data: nil
+        @data = data
+      end
+
+      def run
+        data = @data || ::Swagcov::Coverage.new.collect
+
+        ::Swagcov::Formatter::Console.new(data: data).run
+      rescue ::Swagcov::Errors::BadConfiguration => e
+        warn "#{e.class}: #{e.message}"
+        ::Swagcov::STATUS_ERROR
+      end
+    end
+  end
+end

data/lib/swagcov/coverage.rb

@@ -2,7 +2,7 @@
 
 module Swagcov
   class Coverage
-    attr_reader :data
+    attr_reader :dotfile
 
     def initialize dotfile: ::Swagcov::Dotfile.new, routes: ::Rails.application.routes.routes
       @dotfile = dotfile
@@ -18,22 +18,7 @@ module Swagcov
       }
     end
 
-    def report
-      collect_coverage
-      routes_output(@data[:covered], "green")
-      routes_output(@data[:ignored], "yellow")
-      routes_output(@data[:uncovered], "red")
-
-      final_output
-
-      @data[:uncovered_count]
-    end
-
-    private
-
-    attr_reader :dotfile
-
-    def collect_coverage
+    def collect
       openapi_files = ::Swagcov::OpenapiFiles.new(filepaths: dotfile.docs_config)
       rails_version = ::Rails::VERSION::STRING
 
@@ -58,8 +43,12 @@ module Swagcov
           update_data(:uncovered, verb, path, "none")
         end
       end
+
+      @data
     end
 
+    private
+
     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"]
@@ -86,59 +75,5 @@ module Swagcov
       @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(
-          format(
-            "%<verb>10s %<path>-#{min_width(:path) + 1}s %<status>s",
-            { verb: route[:verb], path: route[:path], status: route[:status].send(status_color) }
-          )
-        )
-      end
-    end
-
-    def min_width key
-      strings =
-        @data[:covered].map { |hash| hash[key] } +
-        @data[:ignored].map { |hash| hash[key] } +
-        @data[:uncovered].map { |hash| hash[key] }
-
-      strings.max_by(&:length).size
-    end
-
-    def final_output
-      $stdout.puts
-      $stdout.puts(
-        format(
-          "OpenAPI documentation coverage %<percentage>.2f%% (%<covered>d/%<total>d)",
-          {
-            percentage: 100.0 * @data[:covered_count] / @data[:total_count],
-            covered: @data[:covered_count],
-            total: @data[:total_count]
-          }
-        )
-      )
-
-      count_output
-    end
-
-    def count_output
-      {
-        ignored: "yellow",
-        total: "blue",
-        covered: "green",
-        uncovered: "red"
-      }.each do |key, color|
-        count = @data[:"#{key}_count"]
-
-        $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

@@ -3,12 +3,14 @@
 module Swagcov
   class Dotfile
     DEFAULT_CONFIG_FILE_NAME = ".swagcov.yml"
+    TODO_CONFIG_FILE_NAME = ".swagcov_todo.yml"
 
-    def initialize pathname: ::Rails.root.join(DEFAULT_CONFIG_FILE_NAME)
-      @dotfile = load_yaml(pathname)
+    def initialize basename: DEFAULT_CONFIG_FILE_NAME, todo_basename: TODO_CONFIG_FILE_NAME, skip_todo: false
+      @dotfile = load_yaml(basename, required: true)
 
       raise ::Swagcov::Errors::BadConfiguration, "Invalid config file (#{DEFAULT_CONFIG_FILE_NAME})" unless valid?
 
+      @todo_file = load_yaml(todo_basename) unless skip_todo
       @ignored_regex = path_config_regex(ignored_config)
       @only_regex = path_config_regex(only_config)
     end
@@ -18,11 +20,12 @@ module Swagcov
 
       ignore_all_path_actions = @ignored_regex.match?(path)
 
-      ignored_verbs = @ignored_config.find { |config| config[path] }
+      ignored_verbs =
+        @ignored_config.select { |config| config[path]&.is_a?(::Array) }.map(&:values).flatten.map(&:downcase)
 
-      return ignore_all_path_actions unless ignored_verbs.is_a?(::Hash)
+      return ignore_all_path_actions if ignored_verbs.empty?
 
-      ignored_verbs.values.flatten.map(&:downcase).any?(verb.downcase)
+      ignored_verbs.any?(verb.downcase)
     end
 
     def only_path_mismatch? path
@@ -34,7 +37,11 @@ module Swagcov
     end
 
     def ignored_config
-      @ignored_config ||= dotfile.dig("routes", "paths", "ignore")
+      dotfile_routes = dotfile.dig("routes", "paths", "ignore").to_a
+      todo_routes = todo_file ? todo_file.dig("routes", "paths", "ignore").to_a : []
+      routes = dotfile_routes + todo_routes
+
+      @ignored_config ||= routes.empty? ? nil : routes
     end
 
     def only_config
@@ -43,16 +50,18 @@ module Swagcov
 
     private
 
-    attr_reader :dotfile
+    attr_reader :dotfile, :todo_file
+
+    def load_yaml basename, required: false
+      pathname = ::Swagcov.project_root.join(basename)
+
+      raise ::Swagcov::Errors::BadConfiguration, "Missing config file (#{basename})" if !pathname.exist? && required
 
-    def load_yaml pathname
-      unless pathname.exist?
-        raise ::Swagcov::Errors::BadConfiguration, "Missing config file (#{DEFAULT_CONFIG_FILE_NAME})"
-      end
+      return unless pathname.exist?
 
       ::YAML.load_file(pathname)
-    rescue Psych::SyntaxError
-      raise ::Swagcov::Errors::BadConfiguration, "Malinformed config file (#{DEFAULT_CONFIG_FILE_NAME})"
+    rescue ::Psych::SyntaxError
+      raise ::Swagcov::Errors::BadConfiguration, "Malformed config file (#{basename})"
     end
 
     def path_config_regex path_config
@@ -63,7 +72,7 @@ module Swagcov
           if path.is_a?(::Hash)
             "^#{path.keys.first}$"
           else
-            path.first == "^" ? path : "^#{path}$"
+            path.chr == "^" ? path : "^#{path}$"
           end
         end
 

data/lib/swagcov/formatter/console.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Swagcov
+  module Formatter
+    class Console
+      attr_reader :data
+
+      def initialize data: ::Swagcov::Coverage.new.collect
+        @data = data
+      end
+
+      def run
+        routes_output(data[:covered], "green")
+        routes_output(data[:ignored], "yellow")
+        routes_output(data[:uncovered], "red")
+        final_output
+
+        data[:uncovered_count].zero? ? ::Swagcov::STATUS_SUCCESS : ::Swagcov::STATUS_OFFENSES
+      end
+
+      private
+
+      def routes_output routes, status_color
+        routes.each do |route|
+          $stdout.puts(
+            format(
+              "%<verb>10s %<path>-#{min_width(:path) + 1}s %<status>s",
+              { verb: route[:verb], path: route[:path], status: route[:status].send(status_color) }
+            )
+          )
+        end
+      end
+
+      def min_width key
+        strings =
+          data[:covered].map { |hash| hash[key] } +
+          data[:ignored].map { |hash| hash[key] } +
+          data[:uncovered].map { |hash| hash[key] }
+
+        strings.max_by(&:length).size
+      end
+
+      def final_output
+        $stdout.puts
+        $stdout.puts(
+          format(
+            "OpenAPI documentation coverage %<percentage>.2f%% (%<covered>d/%<total>d)",
+            {
+              percentage: 100.0 * data[:covered_count] / data[:total_count],
+              covered: data[:covered_count],
+              total: data[:total_count]
+            }
+          )
+        )
+
+        count_output
+      end
+
+      def count_output
+        {
+          ignored: "yellow",
+          total: "blue",
+          covered: "green",
+          uncovered: "red"
+        }.each do |key, color|
+          count = data[:"#{key}_count"]
+
+          $stdout.puts(
+            format(
+              "%<status>s #{key} #{count == 1 ? 'endpoint' : 'endpoints'}",
+              { status: count.to_s.send(color) }
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/swagcov/openapi_files.rb

@@ -28,7 +28,7 @@ module Swagcov
     def load_yaml filepath
       ::YAML.load_file(filepath)["paths"]
     rescue ::Psych::SyntaxError
-      raise ::Swagcov::Errors::BadConfiguration, "Malinformed openapi file (#{filepath})"
+      raise ::Swagcov::Errors::BadConfiguration, "Malformed openapi file (#{filepath})"
     end
   end
 end

data/lib/swagcov/version.rb

@@ -2,6 +2,6 @@
 
 module Swagcov
   module Version
-    STRING = "0.6.0"
+    STRING = "0.7.0"
   end
 end

data/lib/swagcov.rb

@@ -1,16 +1,27 @@
 # frozen_string_literal: true
 
 require "rails"
-require "active_support/core_ext"
 
+require "swagcov/command/generate_dotfile"
+require "swagcov/command/generate_todo_file"
+require "swagcov/command/report_coverage"
 require "swagcov/core_ext/string"
+require "swagcov/formatter/console"
 require "swagcov/coverage"
 require "swagcov/dotfile"
 require "swagcov/errors"
-require "swagcov/install"
 require "swagcov/openapi_files"
 require "swagcov/railtie"
 require "swagcov/version"
 
 module Swagcov
+  module_function
+
+  STATUS_SUCCESS     = 0
+  STATUS_OFFENSES    = 1
+  STATUS_ERROR       = 2
+
+  def project_root
+    ::Rails.root || ::Pathname.new(::FileUtils.pwd)
+  end
 end

data/lib/tasks/swagcov/generate_todo.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :swagcov do
+  desc "generate todo config file"
+  task generate_todo: :environment do
+    exit Swagcov::Command::GenerateTodoFile.new.run
+  end
+end

data/lib/tasks/swagcov/install.rake

@@ -3,6 +3,6 @@
 namespace :swagcov do
   desc "create config file"
   task install: :environment do
-    Swagcov::Install.new.generate_dotfile
+    exit Swagcov::Command::GenerateDotfile.new.run
   end
 end

data/lib/tasks/swagcov.rake

@@ -2,5 +2,5 @@
 
 desc "check documentation coverage for endpoints"
 task swagcov: :environment do
-  exit Swagcov::Coverage.new.report
+  exit Swagcov::Command::ReportCoverage.new.run
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sarah Ridge
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,15 +34,19 @@ files:
 - README.md
 - Rakefile
 - lib/swagcov.rb
+- lib/swagcov/command/generate_dotfile.rb
+- lib/swagcov/command/generate_todo_file.rb
+- lib/swagcov/command/report_coverage.rb
 - lib/swagcov/core_ext/string.rb
 - lib/swagcov/coverage.rb
 - lib/swagcov/dotfile.rb
 - lib/swagcov/errors.rb
-- lib/swagcov/install.rb
+- lib/swagcov/formatter/console.rb
 - lib/swagcov/openapi_files.rb
 - lib/swagcov/railtie.rb
 - lib/swagcov/version.rb
 - lib/tasks/swagcov.rake
+- lib/tasks/swagcov/generate_todo.rake
 - lib/tasks/swagcov/install.rake
 homepage: https://github.com/smridge/swagcov
 licenses:
@@ -67,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.8
 specification_version: 4
 summary: OpenAPI documentation coverage for Rails Routes
 test_files: []

data/lib/swagcov/install.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Swagcov
-  class Install
-    attr_reader :dotfile
-
-    def initialize pathname: ::Rails.root.join(::Swagcov::Dotfile::DEFAULT_CONFIG_FILE_NAME).to_s
-      @dotfile = pathname
-    end
-
-    def generate_dotfile
-      if ::File.exist?(dotfile)
-        $stdout.puts "#{dotfile} already exists"
-        return
-      end
-
-      ::File.write(
-        dotfile,
-        <<~YAML
-          ## Required field:
-          # List your OpenAPI documentation files
-          docs:
-            paths:
-              - swagger.yaml
-
-          ## Optional fields:
-          # routes:
-          #   paths:
-          #     only:
-          #       - ^/v2 # only track v2 endpoints
-          #     ignore:
-          #       - /v2/users # do not track certain endpoints
-          #       - /v2/users/:id: # ignore only certain actions (verbs)
-          #         - GET
-        YAML
-      )
-
-      $stdout.puts "created #{::Swagcov::Dotfile::DEFAULT_CONFIG_FILE_NAME}"
-    end
-  end
-end