Module: RoutesCoverage

Defined in:
lib/routes_coverage.rb,
lib/routes_coverage/result.rb,
lib/routes_coverage/version.rb,
lib/routes_coverage/middleware.rb,
lib/routes_coverage/adapters/rspec.rb,
lib/routes_coverage/adapters/atexit.rb,
lib/routes_coverage/formatters/base.rb,
lib/routes_coverage/formatters/html.rb,
lib/routes_coverage/adapters/simplecov.rb,
lib/routes_coverage/formatters/full_text.rb,
lib/routes_coverage/formatters/summary_text.rb

Defined Under Namespace

Modules: Adapters, Formatters Classes: Middleware, Railtie, Result, Settings

Constant Summary collapse

VERSION = 
"0.5.2"

Class Method Summary collapse

Class Method Details

._collect_all_routes ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/routes_coverage.rb', line 101

def self._collect_all_routes
  all_routes = ::Rails.application.routes.routes.routes.dup

  if defined?(::Sprockets) && defined?(::Sprockets::Environment)
    all_routes.reject! { |r| r.app.is_a?(::Sprockets::Environment) }
  end

  if settings.exclude_put_fallbacks
    all_routes.reject! do |put_route|
      (
        put_route.verb == /^PUT$/ ||
        put_route.verb == "PUT" # rails 5
      ) &&
        put_route.name.nil? &&
        route_hit_count[put_route].zero? &&
        all_routes.any? do |patch_route|
          (
            patch_route.verb == /^PATCH$/ ||
            patch_route.verb == "PATCH" # rails5
          ) &&
            patch_route.defaults == put_route.defaults &&
            patch_route.ip == put_route.ip &&
            patch_route.path.spec.to_s == put_route.path.spec.to_s
        end
    end
  end
  all_routes
end

._collect_route_groups(all_routes) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/routes_coverage.rb', line 130

def self._collect_route_groups(all_routes)
  settings.groups.map do |group_name, matcher|
    group_routes = all_routes.select do |route|
      if matcher.respond_to?(:call)
        matcher.call(route)
      elsif matcher.is_a?(Hash)
        matcher.all? do |key, value|
          case key
          when :path
            route.path.spec.to_s =~ value
          when :action
            route.requirements[:action]&.match(value)
          when :controller
            route.requirements[:controller]&.match(value)
          when :constraints
            value.all? do |constraint_name, constraint_value|
              if constraint_value.present?
                route.constraints[constraint_name] && route.constraints[constraint_name].match?(constraint_value)
              else
                route.constraints[constraint_name].blank?
              end
            end
          end
        end
      else
        route.path.spec.to_s.match?(matcher)
      end
    end

    [group_name, Result.new(group_routes, route_hit_count.slice(*group_routes), settings)]
  end.to_h
end

._touch_route(route) ⇒ Object 



163
164
165
166
 
# File 'lib/routes_coverage.rb', line 163

def self._touch_route(route)
  reset! unless route_hit_count
  route_hit_count[route] += 1
end

.configure {|settings| ... } ⇒ Object

Yields:



60
61
62
 
# File 'lib/routes_coverage.rb', line 60

def self.configure
  yield settings
end

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/routes_coverage.rb', line 52

def self.enabled?
  ::Rails.env.test?
end

.perform_report ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/routes_coverage.rb', line 78

def self.perform_report
  return unless settings.perform_report

  all_routes = _collect_all_routes
  all_result = Result.new(all_routes, route_hit_count, settings)
  groups = _collect_route_groups(all_routes)

  if groups.size > 1
    ungroupped_routes = all_routes.reject do |r|
      groups.values.any? do |group_routes|
        group_routes.all_routes.include? r
      end
    end

    if ungroupped_routes.any?
      groups["Ungroupped"] = Result.new(ungroupped_routes, route_hit_count.slice(*ungroupped_routes), settings)
    end
  end

  puts
  puts settings.formatter_class.new(all_result, groups, settings).format # rubocop:disable Rails/Output
end

.pid ⇒ Object

used in at_exit adapter to skip subprocesses



65
66
67
 
# File 'lib/routes_coverage.rb', line 65

def self.pid
  @pid
end

.reset! ⇒ Object 



73
74
75
76
 
# File 'lib/routes_coverage.rb', line 73

def self.reset!
  @route_hit_count = Hash.new(0)
  @pid = Process.pid
end

.route_hit_count ⇒ Object 



69
70
71
 
# File 'lib/routes_coverage.rb', line 69

def self.route_hit_count
  @route_hit_count
end

.settings ⇒ Object 



56
57
58
 
# File 'lib/routes_coverage.rb', line 56

def self.settings
  @settings ||= Settings.new
end