Module: Ruact::Routing

Included in:
ActionDispatch::Routing::Mapper
Defined in:
lib/ruact/routing.rb

Overview

Story 9.4 (D8) — the ‘ruact_queries` routing macro. Included into `ActionDispatch::Routing::Mapper` by the Railtie, so it is available inside `Rails.application.routes.draw`:

Rails.application.routes.draw do
  ruact_queries CatalogQuery        # GET /q/categories, GET /q/searchUsers, …
  resources :posts
end

For each ‘public_instance_methods(false)` of the query class — methods inherited from `Ruact::Query` / `ApplicationQuery` or mixed in from user modules are NOT mounted (AC1) — one NAMED GET route is drawn at `GET <Ruact.config.query_route_prefix>/<jsIdentifier>` (default `/q`, contract decision #7), pointing at the query class’s generated internal dispatch controller (ServerFunctions::QueryDispatch). Every query is visible in ‘rails routes` — no hidden endpoint; the route table stays the single source of truth.

The path segment reuses ServerFunctions::NameBridge verbatim (D4): ‘def search_users` → `GET /q/searchUsers`, named `ruact_query_searchUsers`. Invalid or JS-reserved method names raise ConfigurationError at route-draw time; two query classes mounting the same method name collide on the route NAME / path and fail Rails’ own duplicate checks — both are loud boot failures, never request-time surprises.

The generated dispatch controller PRESERVES the query class’s namespace (review round 4) — ‘Admin::CatalogQuery` →`Ruact::ServerFunctions::QueryDispatch::Admin::CatalogQueryController` — so the controller constant is an injective function of the query class’s fully-qualified name: two distinct query classes can never map to the same constant, and there is no flatten collision to detect (across any number of RouteSets / mounted engines sharing the global dispatch namespace).

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.draw_query_routes(mapper, query_class) ⇒ Object

method ‘ruact_queries` adds to the routing DSL surface is itself.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ruact/routing.rb', line 52

def draw_query_routes(mapper, query_class)
  ServerFunctions::QueryDispatch.controller_for(query_class)
  target = ServerFunctions::QueryDispatch.route_target_for(query_class)
  prefix = Ruact.config.query_route_prefix

  query_class.public_instance_methods(false).each do |query_method|
    js_identifier = ServerFunctions::NameBridge.to_js_identifier(query_method)
    mapper.get("#{prefix}/#{js_identifier}",
               to: "#{target}##{query_method}",
               as: :"ruact_query_#{js_identifier}")
  end
end

Instance Method Details

#ruact_queries(*query_classes) ⇒ void

This method returns an undefined value.

Draws the named GET routes for one or more Query subclasses.

Parameters:

  • query_classes (Array<Class>) —

    ‘Ruact::Query` subclasses to mount.



44
45
46
47
 
# File 'lib/ruact/routing.rb', line 44

def ruact_queries(*query_classes)
  query_classes.each { |query_class| Ruact::Routing.draw_query_routes(self, query_class) }
  nil
end