swagcov 0.1.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c84f31d41e49c7d90290cbdc863d512896100660cf777b66fc2a41837dafadf5
-  data.tar.gz: 87af9e2410c54d994f4c6d2832b7a905216aba3a4d25a27691ec49f78c8f5715
+  metadata.gz: 83f05163f3408b08db9f9810e5eb82a4285877d9e7b7af60a83e44386eab5c04
+  data.tar.gz: 76b1bf03e51bc42e516f5b77536d1ae38685dd642823094a0ac8e67fa8c67ac3
 SHA512:
-  metadata.gz: 28db77ab060836b1b98a4e38de339b96f613de5d954f67050840f722a0d6b484c2d12da003479999ebcee42d506963826a776a28faaa85bb9d437b4a44e178cb
-  data.tar.gz: 382179ddd4f08e04823f0c9bf2f2f8925ba1929bc12d6baadb0882de172684a8361d95fddb55b66ab5669e76cc3d6062bac9cf3f5c1a0d4149273fa27d35b6ab
+  metadata.gz: 82610986597a8a832173354fb452a4d63c7c0a22a342ec10fd2ac6bcb3eef845d306c6d37225ac837b22febcb12a0ba093167b71d3acc94aaabb8394789b77a7
+  data.tar.gz: a1cdf7691af9fce07dfc50711a748bcbfe903ef0f5f5b94e3d1b3d7fd605ac125de92db23121a8ccdb8622494bfba431f7f3710e55f6392a20160e5c2bfd4e4f

data/README.md

@@ -72,10 +72,22 @@ gem "swagcov", path: "../swagcov"
 bundle
 ```
 
+## 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).
+- Commit changes to `main` branch locally.
+- 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
 - Add specs
 - Test against different rails versions
+- Create Sandbox Apps for Rails 5 & 6
 - Add autogeneration of ignore paths
+- Add `CONTRIBUTING.md`
+- Add GitHub Actions for specs/linting
 
 ## Credit
 To [@lonelyelk](https://github.com/lonelyelk) for initial development!

data/lib/swagcov.rb

@@ -4,8 +4,11 @@ require "swagcov/version"
 
 if defined?(Rails)
   require "swagcov/railtie"
+  require "swagcov/dotfile"
   require "swagcov/coverage"
 end
 
+require "swagcov/core_ext/string"
+
 module Swagcov
 end

data/lib/swagcov/core_ext/string.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class String
+  COLORS = {
+    red: 31,
+    green: 32,
+    yellow: 33,
+    blue: 34
+  }.freeze
+
+  # returns bold colors
+  COLORS.each_pair do |color, value|
+    define_method(color) do
+      "\e[1;#{value}m#{self}\e[0m"
+    end
+  end
+end

data/lib/swagcov/coverage.rb

@@ -9,19 +9,32 @@ module Swagcov
       @routes_not_covered = []
       @routes_covered = []
       @routes_ignored = []
+      @dotfile = Swagcov::Dotfile.new
     end
 
     def report
       Rails.application.routes.routes.each do |route|
+        # 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"]
+        next if route.internal
+
+        # Skips routes like "/sidekiq"
+        next unless route.verb.present?
+
         path = route.path.spec.to_s.sub(/\(\.:format\)$/, "")
 
-        if ignore_path?(path)
+        # Exclude routes that are part of the rails gem that you would not write documentation for
+        # https://github.com/rails/rails/tree/main/activestorage/app/controllers/active_storage
+        # https://github.com/rails/rails/tree/main/actionmailbox/app/controllers/action_mailbox
+        next if path.include?("/active_storage/") || path.include?("/action_mailbox/")
+
+        if dotfile.ignore_path?(path)
           @ignored += 1
           @routes_ignored << { verb: route.verb, path: path, status: "ignored" }
           next
         end
 
-        next if only_path_mismatch?(path)
+        next if dotfile.only_path_mismatch?(path)
 
         @total += 1
         regex = Regexp.new("#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}(\\.[^/]+)?$")
@@ -41,44 +54,18 @@ module Swagcov
 
       final_output
 
-      (@total - @covered).zero?
-    end
-
-    def dotfile
-      @dotfile ||= YAML.load_file(Rails.root.join(".swagcov.yml"))
+      exit @total - @covered
     end
 
     def docs_paths
-      @docs_paths ||= Dir.glob(dotfile["docs"]["paths"]).reduce({}) do |acc, docspath|
+      @docs_paths ||= Dir.glob(dotfile.doc_paths).reduce({}) do |acc, docspath|
         acc.merge(YAML.load_file(docspath)["paths"])
       end
     end
 
     private
 
-    def ignore_path? path
-      ignored_regex&.match?(path)
-    end
-
-    def ignored_regex
-      @ignored_regex ||= path_config_regex(dotfile.dig("routes", "paths", "ignore"))
-    end
-
-    def only_path_mismatch? path
-      only_regex && !only_regex.match?(path)
-    end
-
-    def only_regex
-      @only_regex ||= path_config_regex(dotfile.dig("routes", "paths", "only"))
-    end
-
-    def path_config_regex path_config
-      return unless path_config
-
-      config = path_config.map { |path| path.first == "^" ? path : "#{path}$" }
-
-      /#{config.join('|')}/
-    end
+    attr_reader :dotfile
 
     def routes_output routes, status_color
       routes.each do |route|

data/lib/swagcov/dotfile.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Swagcov
+  class BadConfigurationError < RuntimeError
+  end
+
+  class Dotfile
+    def initialize
+      pathname = Rails.root.join(".swagcov.yml")
+      raise BadConfigurationError, "Missing .swagcov.yml" unless pathname.exist?
+
+      @dotfile = YAML.load_file(pathname)
+      raise BadConfigurationError, "Invalid .swagcov.yml" unless valid?
+    end
+
+    def ignore_path? path
+      ignored_regex&.match?(path)
+    end
+
+    def only_path_mismatch? path
+      only_regex && !only_regex.match?(path)
+    end
+
+    def doc_paths
+      dotfile.dig("docs", "paths")
+    end
+
+    private
+
+    attr_reader :dotfile
+
+    def ignored_regex
+      @ignored_regex ||= path_config_regex(dotfile.dig("routes", "paths", "ignore"))
+    end
+
+    def only_regex
+      @only_regex ||= path_config_regex(dotfile.dig("routes", "paths", "only"))
+    end
+
+    def path_config_regex path_config
+      return unless path_config
+
+      config = path_config.map { |path| path.first == "^" ? path : "^#{path}$" }
+
+      /#{config.join('|')}/
+    end
+
+    def valid?
+      dotfile && doc_paths
+    end
+  end
+end

data/lib/swagcov/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagcov
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Sarah Ridge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -77,7 +77,9 @@ files:
 - README.md
 - Rakefile
 - lib/swagcov.rb
+- lib/swagcov/core_ext/string.rb
 - lib/swagcov/coverage.rb
+- lib/swagcov/dotfile.rb
 - lib/swagcov/railtie.rb
 - lib/swagcov/version.rb
 - lib/tasks/swagcove.rake
@@ -104,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Open API docs coverage for Rails Routes