lib/swagcov/coverage.rb
# frozen_string_literal: true module Swagcov class Coverage def initialize dotfile: ::Swagcov::Dotfile.new, routes: ::Swagcov.project_routes @dotfile = dotfile @openapi_files = ::Swagcov::OpenapiFiles.new(filepaths: @dotfile.docs_config) @routes = routes @rails_version = ::Rails::VERSION::STRING @data = { covered: [], ignored: [], uncovered: [], total_count: 0, covered_count: 0, ignored_count: 0, uncovered_count: 0 } end def collect @routes.each do |route| path = route_path(route) verb = route_verb(route) next if default_skipped_route?(route, path) if dotfile.ignore_path?(path, verb: verb) update_data(:ignored, verb, path, "ignored") next end next if dotfile.only_path_mismatch?(path) @data[:total_count] += 1 if (response_keys = openapi_files.find_response_keys(path: path, route_verb: verb)) update_data(:covered, verb, path, response_keys.join(" ")) else update_data(:uncovered, verb, path, "none") end end @data end private attr_reader :dotfile, :openapi_files, :rails_version def route_path route route.path.spec.to_s.chomp("(.:format)") end def route_verb route rails_version > "5" ? route.verb : route.verb.inspect.gsub(%r{[$^/]}, "") end def default_skipped_route? route, path third_party_route?(route, path) || non_api_route?(route, path) 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"] internal_rails_route?(route) || # Skips routes like "/sidekiq" route.verb.blank? || # Exclude routes that are part of the rails frameworks that you would not write documentation for path.include?("/active_storage/") || path.include?("/action_mailbox/") || turbo_rails_route?(route, path) end def internal_rails_route? route if rails_version > "5" route.internal else ::ActionDispatch::Routing::RouteWrapper.new(route).internal? end end def turbo_rails_route? route, path # TODO: add route.source_location.include?("turbo-rails") - working on local machine but not in test env path.include?("_historical_location") && route.name.include?("turbo_") end def non_api_route? route, path # By default/convention these are non api routes generated by rails %w[new edit].include?(route.defaults[:action]) && (path.include?("/new") || path.include?("/edit")) end def update_data key, verb, path, status @data[:"#{key}_count"] += 1 @data[key] << { verb: verb, path: path, status: status } end end end