swagcov 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aaf6a7a919c70669dc24a129159b2ce961aa237495d57cfd1d94350bbad526f
-  data.tar.gz: e312bf832ceca1bc66017b131c958ab9f70ea4efddc32fac9bda0fcb369d7696
+  metadata.gz: a9d919e84a0746826d0688b1624f11e8218c8e7ec9cfd4e7ae6457368672a275
+  data.tar.gz: ca13f5821ffc64ec599c4a171e6e15d019a6edbae43b3e765ef7d2fe101b0186
 SHA512:
-  metadata.gz: 14de18f74737e418b16153aea8c9f107545b9445fc5956dd0617ddbae4a0ad78be83017d6df8f442724186d38fd44a47b8462d4dc7ce2590c2b7aae26aaff201
-  data.tar.gz: b22dc442442935535df66b494d9f24f4475517eb36468208d24a3ad3b43f49202eb6ada1679efc1657804ea2e789b62b8dac030009ad1bf282fc9b6b3cfa1853
+  metadata.gz: b6e6ef15038466cbede2c5299bbffc4c72fafaccf61ea6a3771538f48ccf6102eb7a2458f8f195ee20146b01ed39534f2b46a1186cf7e41afb687d1242e3389a
+  data.tar.gz: 8a2eb6ade077b3f1d955d3053a35f3754560a87395df2a7f90177d69a94d061933db93c9fbb0afc170bd9ad2426bd49e0f4a08e6fc97b2db9a5192be589271f9

data/README.md

@@ -26,7 +26,7 @@ Create a `.swagcov.yml` in root of your Rails application.
   ```yml
   docs:
     paths:
-      - swagger/v1/swagger.yaml
+      - swagger.yaml
   ```
 
 - Add `only` routes (**optional**) :
@@ -49,7 +49,7 @@ Create a `.swagcov.yml` in root of your Rails application.
   ```yml
   docs:
     paths:
-      - swagger/v1/swagger.yaml
+      - swagger.yaml
 
   routes:
     paths:
@@ -91,7 +91,7 @@ bundle exec rake swagcov
   ```yml
   docs:
     paths:
-      - swagger/v1/swagger.yaml
+      - swagger.yaml
 
   routes:
     paths:
@@ -136,15 +136,15 @@ bundle exec rspec spec --exclude-pattern spec/sandbox_**/**/*_spec.rb
 - 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).
-- Commit changes to `main` branch locally.
+- 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
 To [@lonelyelk](https://github.com/lonelyelk) for initial development!

data/lib/swagcov/coverage.rb

@@ -31,8 +31,10 @@ module Swagcov
     attr_reader :dotfile
 
     def collect_coverage
+      openapi_files = ::Swagcov::OpenapiFiles.new(filepaths: dotfile.doc_paths)
+
       @routes.each do |route|
-        path = route.path.spec.to_s.sub(/\(\.:format\)$/, "")
+        path = route.path.spec.to_s.chomp("(.:format)")
 
         next if third_party_route?(route, path)
 
@@ -45,30 +47,16 @@ module Swagcov
         next if dotfile.only_path_mismatch?(path)
 
         @total += 1
-        regex = Regexp.new("^#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}(\\.[^/]+)?$")
-        matching_keys = docs_paths.keys.grep(regex)
 
-        if (doc = docs_paths.dig(matching_keys.first, route.verb.downcase))
+        if (response_keys = openapi_files.find_response_keys(path: path, route_verb: route.verb))
           @covered += 1
-          @routes_covered << { verb: route.verb, path: path, status: doc["responses"].keys.map(&:to_s).sort.join("  ") }
+          @routes_covered << { verb: route.verb, path: path, status: response_keys.join("  ") }
         else
           @routes_not_covered << { verb: route.verb, path: path, status: "none" }
         end
       end
     end
 
-    def docs_paths
-      @docs_paths ||= Dir.glob(dotfile.doc_paths).reduce({}) do |acc, docspath|
-        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"]
@@ -87,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/openapi_files.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Swagcov
+  class OpenapiFiles
+    def initialize filepaths:
+      @filepaths = filepaths
+      @openapi_paths = load_yamls
+    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_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
+    end
+
+    private
+
+    def load_yamls
+      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})"
+    end
+  end
+end

data/lib/swagcov/version.rb

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

data/lib/swagcov.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sarah Ridge
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,77 +23,6 @@ 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: []
@@ -108,6 +36,7 @@ files:
 - lib/swagcov/core_ext/string.rb
 - lib/swagcov/coverage.rb
 - lib/swagcov/dotfile.rb
+- lib/swagcov/openapi_files.rb
 - lib/swagcov/railtie.rb
 - lib/swagcov/version.rb
 - lib/tasks/swagcove.rake
@@ -120,7 +49,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
@@ -135,8 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-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: []