class Swagcov::Coverage
Attributes
covered[R]
dotfile[R]
ignored[R]
routes_covered[R]
routes_ignored[R]
routes_not_covered[R]
total[R]
Public Class Methods
new(dotfile: Swagcov::Dotfile.new, routes: ::Rails.application.routes.routes)
click to toggle source
# File lib/swagcov/coverage.rb, line 7 def initialize dotfile: Swagcov::Dotfile.new, routes: ::Rails.application.routes.routes @total = 0 @covered = 0 @ignored = 0 @routes_not_covered = [] @routes_covered = [] @routes_ignored = [] @dotfile = dotfile @routes = routes end
Public Instance Methods
report()
click to toggle source
# File lib/swagcov/coverage.rb, line 18 def report collect_coverage routes_output(@routes_covered, "green") routes_output(@routes_ignored, "yellow") routes_output(@routes_not_covered, "red") final_output exit @total - @covered end
Private Instance Methods
collect_coverage()
click to toggle source
# File lib/swagcov/coverage.rb, line 33 def collect_coverage @routes.each do |route| path = route.path.spec.to_s.sub(/\(\.:format\)$/, "") next if third_party_route?(route, path) if dotfile.ignore_path?(path) @ignored += 1 @routes_ignored << { verb: route.verb, path: path, status: "ignored" } next end next if dotfile.only_path_mismatch?(path) @total += 1 regex = Regexp.new("^#{path.gsub(%r{:[^/]+}, '\\{[^/]+\\}')}(\\.[^/]+)?$") matching_keys = docs_paths.keys.select { |k| regex.match?(k) } if (doc = docs_paths.dig(matching_keys.first, route.verb.downcase)) @covered += 1 @routes_covered << { verb: route.verb, path: path, status: doc["responses"].keys.map(&:to_s).sort.join(" ") } else @routes_not_covered << { verb: route.verb, path: path, status: "none" } end end end
docs_paths()
click to toggle source
# File lib/swagcov/coverage.rb, line 60 def docs_paths @docs_paths ||= Dir.glob(dotfile.doc_paths).reduce({}) do |acc, docspath| acc.merge(YAML.load_file(docspath)["paths"]) end end
final_output()
click to toggle source
# File lib/swagcov/coverage.rb, line 91 def final_output $stdout.puts $stdout.puts( format( "OpenAPI documentation coverage %<percentage>.2f%% (%<covered>d/%<total>d)", { percentage: 100.0 * @covered / @total, covered: @covered, total: @total } ) ) $stdout.puts( format( "%<total>s endpoints ignored", { total: @ignored.to_s.yellow } ) ) $stdout.puts( format( "%<total>s endpoints checked", { total: @total.to_s.blue } ) ) $stdout.puts( format( "%<covered>s endpoints covered", { covered: @covered.to_s.green } ) ) $stdout.puts( format( "%<missing>s endpoints missing documentation", { missing: (@total - @covered).to_s.red } ) ) end
routes_output(routes, status_color)
click to toggle source
# File lib/swagcov/coverage.rb, line 80 def routes_output routes, status_color routes.each do |route| $stdout.puts( format( "%<verb>10s %<path>-90s %<status>s", { verb: route[:verb], path: route[:path], status: route[:status].send(status_color) } ) ) end end
third_party_route?(route, path)
click to toggle source
# File lib/swagcov/coverage.rb, line 66 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"] route.internal || # Skips routes like "/sidekiq" route.verb.blank? || # 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 path.include?("/active_storage/") || path.include?("/action_mailbox/") end