swagcov 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820849bdcc13ddb85e1ff404bcc881dbe8f8154090bb6111d0afbdbdd286ce4f
-  data.tar.gz: 90de5bb3a335673d58524344dd871182e06c1eb3185192a92026be5be0ce372e
+  metadata.gz: 5aaf6a7a919c70669dc24a129159b2ce961aa237495d57cfd1d94350bbad526f
+  data.tar.gz: e312bf832ceca1bc66017b131c958ab9f70ea4efddc32fac9bda0fcb369d7696
 SHA512:
-  metadata.gz: b49673a8bfca29bb64ece42acc8c1a85f34339b4aa643036c72f4c1849e6e061a933c6471df2502da4e5ba4676c4f75cec559518c87242c7a3a31d6c0e817000
-  data.tar.gz: 1b60f5d474d4be3c5c51a6180cb0343b380bca69a4fa99fe0c55063e7037a4f1134d3cbd284a411aa2a9b6ef257898df55facdf99b8827fe2fde3c069c8222be
+  metadata.gz: 14de18f74737e418b16153aea8c9f107545b9445fc5956dd0617ddbae4a0ad78be83017d6df8f442724186d38fd44a47b8462d4dc7ce2590c2b7aae26aaff201
+  data.tar.gz: b22dc442442935535df66b494d9f24f4475517eb36468208d24a3ad3b43f49202eb6ada1679efc1657804ea2e789b62b8dac030009ad1bf282fc9b6b3cfa1853

data/README.md

@@ -6,6 +6,10 @@
 
 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.
+
 ## Installation
 Add this line to your application's Gemfile:
 ```ruby
@@ -41,7 +45,7 @@ Create a `.swagcov.yml` in root of your Rails application.
         - /v1/foobar/:token
   ```
 
-- Example `.swagcov.yml` Config File:
+- Full Example `.swagcov.yml` Config File:
   ```yml
   docs:
     paths:
@@ -60,7 +64,7 @@ Execute:
 bundle exec rake swagcov
 ```
 
-## Example configurations and output from running `bundle exec rake swagcov` from the root of your Rails Application:
+### Example configurations and output from running `bundle exec rake swagcov` from the root of your Rails Application:
 - All Routes (minimal configuration):
   ```yml
   docs:
@@ -115,12 +119,14 @@ bundle
 
 Run Tests
 ```
-bundle exec rspec spec --exclude-pattern spec/sandbox_5_2/**/*_spec.rb
+bundle exec rspec spec --exclude-pattern spec/sandbox_**/**/*_spec.rb
 ```
 
 ### Test via Sandbox Application
-For Rails 5
-- `cd spec/sandbox_5_2/`
+- 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.
@@ -135,12 +141,15 @@ For Rails 5
   - 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
-- Add specs
-- Test against different rails versions
-- Create Sandbox App for Rails 6
+- Create Rails 7 / Ruby 3.1 Sandbox
 - Add autogeneration of ignore paths
 - Add `CONTRIBUTING.md`
-- Add GitHub Actions for specs/linting
+- Add GitHub Action for linting
 
 ## Credit
 To [@lonelyelk](https://github.com/lonelyelk) for initial development!
+
+## 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

@@ -23,7 +23,7 @@ module Swagcov
 
       final_output
 
-      exit @total - @covered
+      @total - @covered
     end
 
     private
@@ -46,7 +46,7 @@ module Swagcov
 
         @total += 1
         regex = Regexp.new("^#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}(\\.[^/]+)?$")
-        matching_keys = docs_paths.keys.select { |k| regex.match?(k) }
+        matching_keys = docs_paths.keys.grep(regex)
 
         if (doc = docs_paths.dig(matching_keys.first, route.verb.downcase))
           @covered += 1
@@ -59,10 +59,16 @@ module Swagcov
 
     def docs_paths
       @docs_paths ||= Dir.glob(dotfile.doc_paths).reduce({}) do |acc, docspath|
-        acc.merge(YAML.load_file(docspath)["paths"])
+        acc.merge(load_yaml(docspath))
       end
     end
 
+    def load_yaml docspath
+      YAML.load_file(docspath)["paths"]
+    rescue Psych::SyntaxError
+      raise BadConfigurationError, "Malinformed openapi file (#{docspath})"
+    end
+
     def third_party_route? route, path
       # 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"]

data/lib/swagcov/dotfile.rb

@@ -7,10 +7,9 @@ module Swagcov
   class Dotfile
     DEFAULT_CONFIG_FILE_NAME = ".swagcov.yml"
 
-    def initialize pathname: Rails.root.join(DEFAULT_CONFIG_FILE_NAME)
-      raise BadConfigurationError, "Missing config file (#{DEFAULT_CONFIG_FILE_NAME})" unless pathname.exist?
+    def initialize pathname: ::Rails.root.join(DEFAULT_CONFIG_FILE_NAME)
+      @dotfile = load_yaml(pathname)
 
-      @dotfile = YAML.load_file(pathname)
       raise BadConfigurationError, "Invalid config file (#{DEFAULT_CONFIG_FILE_NAME})" unless valid?
     end
 
@@ -30,6 +29,14 @@ module Swagcov
 
     attr_reader :dotfile
 
+    def load_yaml pathname
+      raise BadConfigurationError, "Missing config file (#{DEFAULT_CONFIG_FILE_NAME})" unless pathname.exist?
+
+      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(dotfile.dig("routes", "paths", "ignore"))
     end

data/lib/swagcov/version.rb

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

data/lib/tasks/swagcove.rake

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Sarah Ridge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -119,6 +119,7 @@ metadata:
   homepage_uri: https://github.com/smridge/swagcov
   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:
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Open API docs coverage for Rails Routes