Class: Ask::Rails::Harness::Tools::RouteInspector

Inherits:
Ask::Rails::Harness::Tool show all
Defined in:
lib/ask/rails/harness/tools/route_inspector.rb

Instance Method Summary collapse

Methods inherited from Ask::Rails::Harness::Tool

#call, #rails_root, session_id, session_id=

Instance Method Details

#execute(controller: nil, pattern: nil, verbose: false) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ask/rails/harness/tools/route_inspector.rb', line 16

def execute(controller: nil, pattern: nil, verbose: false)
  return { routes: [], count: 0 } unless defined?(::Rails) && ::Rails.application&.routes

  all_routes = ::Rails.application.routes.routes.map do |route|
    entry = {
      verb: verb_for(route),
      path: route.path.spec.to_s.delete_suffix("(.:format)"),
      controller: route.defaults[:controller]&.to_s,
      action: route.defaults[:action]&.to_s,
      name: route.name&.to_s
    }

    if verbose
      entry[:requirements] = route.required_parts.presence
      entry[:defaults] = route.defaults.except(:controller, :action).presence
      entry[:constraints] = route.constraints.except(:request_method).presence if route.constraints.any?
    end

    entry
  end

  # Remove internal/engine routes unless verbose
  unless verbose
    all_routes.reject! { |r| r[:controller].nil? || r[:controller].start_with?("rails/") }
  end

  # Apply filters
  all_routes.select! { |r| r[:controller] == controller } if controller
  all_routes.select! { |r| r[:path].include?(pattern) } if pattern

  {
    routes: all_routes,
    count: all_routes.size
  }
end