swagcov 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aec9444a5e8dfd1d4b23fc61c710d4ccc28d5c7985df0fbef5e8c02e16e7519
-  data.tar.gz: a19a3c8f73ad9efb814ff7469b6306bacb52d296893130b7fb42740d1d7e7db4
+  metadata.gz: 10f7019116f2fb27f9bcf01ed15450bb26e715778722c26448571ed006fb1675
+  data.tar.gz: 35d038789bbdb47d93720fa0ab5e07d95eefc92810145e083fb3076e6f151e13
 SHA512:
-  metadata.gz: cc64199a92c0322fe3c42bbaa882d103a9a8f18e1c3dbe02ddb5b56bb21d13eae763536fbcdb2f84aa8a045fb6d92726f1a953eaa27595118cbe6a7324dd5c2a
-  data.tar.gz: 9713fa38210e7f6273e2f9004a7dc791994ebd80e50e0852381de005f67b1c238ce995060c3643b2b1db7520d46687defa554067e3ff2a75ae71ec70a809f496
+  metadata.gz: 53e051e7b1c1b50b1cf23f0774fdd13aad99619463e7838ef8c5834d7e172fb5948e682813787ac22bfac8db64452dc4405ebc436d0266a99935915b012ebc90
+  data.tar.gz: bc67b90db65336931ba6895ad5ee51f63ad3aea5855b2e44f53e05a6c7b7cc57746f483f5d2c24bb651841f437b4c6d5c09bfec77d419cb0cf5e15f7b119f53d

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# CHANGELOG
+## main (unreleased)
+-
+
+## 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
+    ```
+
+## 0.4.1 (2025-03-18)
+### Fix
+- 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
+
+## 0.4.0 (2022-08-11)
+  - Improve OpenAPI file processing ([#26](https://github.com/smridge/swagcov/pull/26))
+
+## 0.3.0 (2022-02-21)
+### Enhancement
+  - Raise specific `Swagcov::BadConfigurationError` for malinformed 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))
+
+### 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))
+
+### 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))
+
+## 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))
+
+## 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))
+### Enhancement
+  - 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))
+
+## 0.2.2 (2021-04-22)
+### Fix
+  - 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))
+
+## 0.2.0 (2021-04-20)
+### Enhancement
+  - 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

@@ -21,7 +21,11 @@ Execute:
 bundle
 ```
 
-Create a `.swagcov.yml` in root of your Rails application.
+Create a `.swagcov.yml` in root of your Rails application. Alternatively, run:
+```shell
+bundle exec rake swagcov:install
+```
+
 - Add the paths of your `openapi` yml files (**required**):
   ```yml
   docs:
@@ -99,59 +103,21 @@ bundle exec rake swagcov
         - ^/v2
       ignore:
         - /v2/users
+        - /v2/users/:id:
+          - GET
   ```
   <img src="https://raw.githubusercontent.com/smridge/swagcov/main/images/ignore-and-only-endpoints.png">
 
-## Development
-```shell
-git clone git@github.com:smridge/swagcov.git
-```
-
-Add this line to your application's Gemfile:
-```ruby
- # Use the relative path from your application, to the swagcov folder
-gem "swagcov", path: "../swagcov"
-```
-
-```shell
-bundle
-```
-
-Run Tests
-```
-bundle exec rspec spec --exclude-pattern spec/sandbox_**/**/*_spec.rb
-```
-
-### Test via Sandbox Application
-- Go to any sandbox application within the `spec` directory
-  - For example, `cd spec/sandbox_5_2/`
-- Install the ruby version specified in `.ruby-version` file
-- Install gems: `bundle install`
-- Run tests: `bundle exec rspec spec`
-- Run `bundle exec rake swagcov`
-  - This will run against any changes made to your branch.
-
-## Publish (internal)
-> Note: Publishing a new version of this gem is only meant for maintainers.
-- Ensure you have access to publish on [rubygems](https://rubygems.org/gems/swagcov).
-- Update [CHANGELOG](https://github.com/smridge/swagcov/blob/main/CHANGELOG.md).
-- Update [`VERSION`](https://github.com/smridge/swagcov/blob/main/lib/swagcov/version.rb).
-- Run `bundle update` for each sandbox application to reflect new swagcov version in each `Gemfile.lock`
-- Open a Pull Request to ensure all specs pass, then merge to `main`.
-- Checkout the latest `main` on your machine.
-- Run: `rake release`
-  - This command builds the gem, creates a tag and publishes to rubygems, see [bundler docs](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
-
 ## TODO
-- Create Rails 7 / Ruby 3.1 Sandbox
 - Add autogeneration of ignore paths
-- Add `CONTRIBUTING.md`
-- Add GitHub Action for linting
 
-## Credit
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detail
+
+### Credit
 To [@lonelyelk](https://github.com/lonelyelk) for initial development!
 
-## Contributors
+### Contributors
 <a href="https://github.com/smridge/swagcov/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=smridge/swagcov" />
 </a>

data/lib/swagcov/coverage.rb

@@ -38,7 +38,7 @@ module Swagcov
 
         next if third_party_route?(route, path)
 
-        if dotfile.ignore_path?(path)
+        if dotfile.ignore_path?(path, verb: route.verb)
           @ignored += 1
           @routes_ignored << { verb: route.verb, path: path, status: "ignored" }
           next
@@ -75,13 +75,22 @@ module Swagcov
       routes.each do |route|
         $stdout.puts(
           format(
-            "%<verb>10s %<path>-90s %<status>s",
+            "%<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 =
+        @routes_covered.map { |hash| hash[key] } +
+        @routes_ignored.map { |hash| hash[key] } +
+        @routes_not_covered.map { |hash| hash[key] }
+
+      strings.max_by(&:length).size
+    end
+
     def final_output
       $stdout.puts
       $stdout.puts(

data/lib/swagcov/dotfile.rb

@@ -13,8 +13,14 @@ module Swagcov
       raise BadConfigurationError, "Invalid config file (#{DEFAULT_CONFIG_FILE_NAME})" unless valid?
     end
 
-    def ignore_path? path
-      ignored_regex&.match?(path)
+    def ignore_path? path, verb:
+      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)
+
+      ignored_verbs.values.flatten.map(&:downcase).any?(verb.downcase)
     end
 
     def only_path_mismatch? path
@@ -38,7 +44,11 @@ module Swagcov
     end
 
     def ignored_regex
-      @ignored_regex ||= path_config_regex(dotfile.dig("routes", "paths", "ignore"))
+      @ignored_regex ||= path_config_regex(ignored_config)
+    end
+
+    def ignored_config
+      @ignored_config ||= dotfile.dig("routes", "paths", "ignore")
     end
 
     def only_regex
@@ -48,7 +58,14 @@ module Swagcov
     def path_config_regex path_config
       return unless path_config
 
-      config = path_config.map { |path| path.first == "^" ? path : "^#{path}$" }
+      config =
+        path_config.map do |path|
+          if path.is_a?(::Hash)
+            "^#{path.keys.first}$"
+          else
+            path.first == "^" ? path : "^#{path}$"
+          end
+        end
 
       /#{config.join('|')}/
     end

data/lib/swagcov/install.rb

@@ -0,0 +1,41 @@
+# 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

data/lib/swagcov/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Swagcov
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/swagcov.rb

@@ -7,6 +7,7 @@ if defined?(Rails)
   require "swagcov/dotfile"
   require "swagcov/coverage"
   require "swagcov/openapi_files"
+  require "swagcov/install"
 end
 
 require "swagcov/core_ext/string"

data/lib/tasks/swagcov/install.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :swagcov do
+  desc "create config file"
+  task install: :environment do
+    Swagcov::Install.new.generate_dotfile
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sarah Ridge
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,83 +23,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description:
 email:
 - sarahmarie@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
@@ -108,9 +37,11 @@ files:
 - lib/swagcov/core_ext/string.rb
 - lib/swagcov/coverage.rb
 - lib/swagcov/dotfile.rb
+- lib/swagcov/install.rb
 - lib/swagcov/openapi_files.rb
 - lib/swagcov/railtie.rb
 - lib/swagcov/version.rb
+- lib/tasks/swagcov/install.rake
 - lib/tasks/swagcove.rake
 homepage: https://github.com/smridge/swagcov
 licenses:
@@ -121,7 +52,6 @@ metadata:
   source_code_uri: https://github.com/smridge/swagcov
   changelog_uri: https://github.com/smridge/swagcov/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
-summary: Open API docs coverage for Rails Routes
+summary: OpenAPI documentation coverage for Rails Routes
 test_files: []