Module: Tina4::Router

Defined in:
lib/tina4/router.rb

Defined Under Namespace

Classes: GroupContext

Class Method Summary collapse

Class Method Details

.add(method, path, handler, auth_handler: nil, swagger_meta: {}, middleware: [], template: nil) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/tina4/router.rb', line 324

def add(method, path, handler, auth_handler: nil, swagger_meta: {}, middleware: [], template: nil)
  route = Route.new(method, path, handler,
                    auth_handler: auth_handler,
                    swagger_meta: swagger_meta,
                    middleware: middleware,
                    template: template)
  routes << route
  method_index[route.method] << route
  Tina4::Log.debug("Route registered: #{method.upcase} #{path}")
  route
end

.any(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object 



356
357
358
 
# File 'lib/tina4/router.rb', line 356

def any(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("ANY", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.clear! ⇒ Object Also known as: clear 



475
476
477
478
479
 
# File 'lib/tina4/router.rb', line 475

def clear!
  @routes = []
  @method_index = Hash.new { |h, k| h[k] = [] }
  @ws_routes = []
end

.delete(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object 



352
353
354
 
# File 'lib/tina4/router.rb', line 352

def delete(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("DELETE", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.find_route(method, path) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/tina4/router.rb', line 379

def find_route(method, path)
  normalized_method = method.upcase
  # Normalize path once (not per-route)
  normalized_path = path.gsub("\\", "/")
  normalized_path = "/#{normalized_path}" unless normalized_path.start_with?("/")
  normalized_path = normalized_path.chomp("/") unless normalized_path == "/"

  # Check ANY routes first, then method-specific routes
  candidates = (method_index["ANY"] || []) + (method_index[normalized_method] || [])
  candidates.each do |route|
    params = route.match_path(normalized_path)
    return [route, params] if params
  end

  # RFC 9110 §9.3.2: HEAD is identical to GET except for the absence
  # of a response body. If no explicit HEAD route matched, fall back
  # to the GET route — the dispatcher strips the body on the way out
  # so the handler doesn't need to know HEAD even happened.
  if normalized_method == "HEAD"
    (method_index["GET"] || []).each do |route|
      params = route.match_path(normalized_path)
      return [route, params] if params
    end
  end

  nil
end

.find_ws_route(path) ⇒ Object

Find a matching WebSocket route for a given path. Returns [ws_route, params] or nil.



307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/tina4/router.rb', line 307

def find_ws_route(path)
  normalized = path.gsub("\\", "/")
  normalized = "/#{normalized}" unless normalized.start_with?("/")
  normalized = normalized.chomp("/") unless normalized == "/"

  ws_routes.each do |ws_route|
    params = ws_route.match?(normalized)
    return [ws_route, params] if params
  end
  nil
end

.get(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object

Convenience registration methods



336
337
338
 
# File 'lib/tina4/router.rb', line 336

def get(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("GET", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.get_routes ⇒ Object 



275
276
277
 
# File 'lib/tina4/router.rb', line 275

def get_routes
  routes
end

.get_web_socket_routes ⇒ Object

Parity alias — returns all registered WebSocket routes.



289
290
291
 
# File 'lib/tina4/router.rb', line 289

def get_web_socket_routes
  ws_routes
end

.group(prefix, auth_handler: nil, middleware: [], &block) ⇒ Object 



482
483
484
 
# File 'lib/tina4/router.rb', line 482

def group(prefix, auth_handler: nil, middleware: [], &block)
  GroupContext.new(prefix, auth_handler, middleware).instance_eval(&block)
end

.head(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object

Register an explicit HEAD route. By default the framework auto-handles HEAD by falling back to the GET route and stripping the body (RFC 9110 §9.3.2). Use this only when you need a HEAD handler that does something different from GET — e.g. cheaper existence-check logic, custom validator headers without the cost of building the body. The framework still strips the response body for you on the way out.



366
367
368
 
# File 'lib/tina4/router.rb', line 366

def head(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("HEAD", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.list_routes ⇒ Object 



279
280
281
 
# File 'lib/tina4/router.rb', line 279

def list_routes
  routes
end

.load_routes(directory) ⇒ Object

Load route files from a directory (file-based route discovery).

Idempotent: files already loaded by a previous call are skipped, so calling load_routes repeatedly (e.g. on /__dev/api/reload) only picks up NEW files. Records the directory so #rescan_routes! can re-run without re-passing it.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/tina4/router.rb', line 492

def load_routes(directory)
  return unless Dir.exist?(directory)

  @loaded_route_files ||= {}
  @last_routes_dir = directory

  files = Dir.glob(File.join(directory, "**/*.rb")).sort
  total = files.length
  files.each do |file|
    next if @loaded_route_files[file]
    begin
      load file
      @loaded_route_files[file] = true
      Tina4::Log.debug("Route loaded: #{file}")
    rescue ScriptError, StandardError => e
      # ScriptError catches SyntaxError, which is NOT a StandardError —
      # a bare `rescue => e` would let a syntax-broken route file crash
      # the whole discovery pass.
      Tina4::Log.error("Failed to load route #{file}: #{e.message}")
      record_broken_route_import(file, e)
    end
  end

  # Zero-routes warning — src/routes/ has .rb files but the router
  # is still empty. Almost certainly the user forgot Tina4::Router.get.
  if total > 0 && routes.empty?
    Tina4::Log.warning(
      "Auto-discover found #{total} .rb file(s) in #{directory} but no routes registered. " \
      "Each route file must call Tina4::Router.get / .post / etc."
    )
  end
end

.match(method, path) ⇒ Object

Find a route matching method + path. Returns [route, params] or nil. match(method, path) — consistent with Python, PHP, and Node.



455
456
457
 
# File 'lib/tina4/router.rb', line 455

def match(method, path)
  find_route(method, path)
end

.method_index ⇒ Object

Routes indexed by HTTP method for O(1) method lookup



320
321
322
 
# File 'lib/tina4/router.rb', line 320

def method_index
  @method_index ||= Hash.new { |h, k| h[k] = [] }
end

.methods_allowed_for_path(path) ⇒ Object

Return the list of HTTP methods registered for “path“, in the order GET / POST / PUT / PATCH / DELETE / HEAD / OPTIONS. Used by the dispatcher to build the “Allow:“ header on 405 / OPTIONS responses (RFC 9110 §10.2.1, §9.3.7).

If GET is registered for the path, HEAD is appended implicitly (HEAD auto-fallback). OPTIONS is appended whenever the path has any registered method (the framework auto-handles OPTIONS).



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/tina4/router.rb', line 415

def methods_allowed_for_path(path)
  normalized_path = path.gsub("\\", "/")
  normalized_path = "/#{normalized_path}" unless normalized_path.start_with?("/")
  normalized_path = normalized_path.chomp("/") unless normalized_path == "/"

  method_order = %w[GET POST PUT PATCH DELETE HEAD OPTIONS]
  seen = []
  any_matched = false

  method_index.each do |m, routes_for_method|
    next if routes_for_method.empty?
    matched = routes_for_method.any? { |r| r.match_path(normalized_path) }
    next unless matched
    if m == "ANY"
      any_matched = true
    elsif method_order.include?(m)
      seen << m unless seen.include?(m)
    end
  end

  seen = method_order.dup if any_matched

  if !seen.empty?
    seen << "HEAD" if seen.include?("GET") && !seen.include?("HEAD")
    seen << "OPTIONS" unless seen.include?("OPTIONS")
  end

  method_order.select { |m| seen.include?(m) }
end

.options(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object

Register an explicit OPTIONS route. By default the framework auto- handles OPTIONS by building an Allow header from every method registered for the path and returning 204 (RFC 9110 §9.3.7). Use this to take over that behaviour — e.g. to return a richer OPTIONS payload describing the resource.



375
376
377
 
# File 'lib/tina4/router.rb', line 375

def options(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("OPTIONS", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.patch(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object 



348
349
350
 
# File 'lib/tina4/router.rb', line 348

def patch(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("PATCH", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.post(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object 



340
341
342
 
# File 'lib/tina4/router.rb', line 340

def post(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("POST", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.put(path, middleware: [], swagger_meta: {}, template: nil, &block) ⇒ Object 



344
345
346
 
# File 'lib/tina4/router.rb', line 344

def put(path, middleware: [], swagger_meta: {}, template: nil, &block)
  add("PUT", path, block, middleware: middleware, swagger_meta: swagger_meta, template: template)
end

.record_broken_route_import(file, error) ⇒ Object

Write a .broken sentinel so /health and the dev dashboard surface auto-discover failures instead of swallowing them into a log line.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/tina4/router.rb', line 546

def record_broken_route_import(file, error)
  broken_dir = File.join(Dir.pwd, "data", ".broken")
  FileUtils.mkdir_p(broken_dir) unless Dir.exist?(broken_dir)
  slug = file.gsub(%r{[/\\]}, "_")
  payload = JSON.generate(
    type: "auto_discover_failure",
    file: file,
    error: "#{error.class}: #{error.message}"
  )
  File.write(File.join(broken_dir, "discover_#{slug}.broken"), payload)
rescue StandardError
  # If the .broken write itself fails, the original error is already
  # in the log — nothing more to do.
end

.rescan_routes! ⇒ Object

Re-run the most recent load_routes — called by /__dev/api/reload so files dropped into src/routes/ after server boot get picked up without a restart. No-op if load_routes has never been called.



528
529
530
531
532
533
534
535
 
# File 'lib/tina4/router.rb', line 528

def rescan_routes!
  return [] if @last_routes_dir.nil? || @last_routes_dir.empty?
  before = routes.length
  load_routes(@last_routes_dir)
  added = routes.length - before
  Tina4::Log.info("Re-discovered #{added} new route(s) on reload") if added.positive?
  added
end

.reset_route_discovery! ⇒ Object

Test-only helper — reset the loaded-files state so tests can scan the same directory multiple times with different file contents.



539
540
541
542
 
# File 'lib/tina4/router.rb', line 539

def reset_route_discovery!
  @loaded_route_files = {}
  @last_routes_dir = nil
end

.routes ⇒ Object 



271
272
273
 
# File 'lib/tina4/router.rb', line 271

def routes
  @routes ||= []
end

.trailing_slash_redirect? ⇒ Boolean

When TINA4_TRAILING_SLASH_REDIRECT is truthy, the rack app uses this to detect whether the original (un-stripped) path differed from the canonical form so it can issue a 301 redirect. Default false — silent match keeps backward compatibility.

Returns:

  • (Boolean) 


449
450
451
 
# File 'lib/tina4/router.rb', line 449

def trailing_slash_redirect?
  %w[true 1 yes on].include?(ENV.fetch("TINA4_TRAILING_SLASH_REDIRECT", "").to_s.strip.downcase)
end

.use(klass) ⇒ Object

Register a class-based middleware globally. The class should define static before_* and/or after_* methods. Example:

class AuthMiddleware
  def self.before_auth(request, response)
    unless request.headers["authorization"]
      return [request, response.json({ error: "Unauthorized" }, 401)]
    end
    [request, response]
  end
end
Tina4::Router.use(AuthMiddleware)



471
472
473
 
# File 'lib/tina4/router.rb', line 471

def use(klass)
  Tina4::Middleware.use(klass)
end

.websocket(path, &block) ⇒ Object

Register a WebSocket route. The handler block receives (connection, event, data) where:

connection — WebSocketConnection with #send, #broadcast, #close, #params
event      — :open, :message, or :close
data       — String payload for :message, nil for :open/:close



298
299
300
301
302
303
 
# File 'lib/tina4/router.rb', line 298

def websocket(path, &block)
  ws_route = WebSocketRoute.new(path, block)
  ws_routes << ws_route
  Tina4::Log.debug("WebSocket route registered: #{path}")
  ws_route
end

.ws_routes ⇒ Object

Registered WebSocket routes



284
285
286
 
# File 'lib/tina4/router.rb', line 284

def ws_routes
  @ws_routes ||= []
end