class
Analyzer::Ruby::Padrino
- Analyzer::Ruby::Padrino
- Analyzer::Ruby::RubyEngine
- Analyzer
- Reference
- Object
Overview
Padrino layers two things on top of Sinatra's route table:
- Named, block-scoped routes declared through the controller DSL —
AppName.controllers :posts do get :index, map: '/blog' do ... end end— where the effective URL is derived from the controller name, the route name, and the optionalmap:/with:/parent:options rather than a literal path string. - Base-path mounting of each sub-app from
config/apps.rb—Padrino.mount('blog', app_class: 'BlogApp').to('/blog')— which every route inside that sub-app inherits as a prefix.
ruby_padrino supersedes ruby_sinatra (see the catalog entry), so this
analyzer also re-implements Sinatra's own literal-path route matching
(get "/path" do, namespace "/x" do) via the shared RubyEngine
helpers — when both techs are detected, the Sinatra analyzer does not
run at all, and nothing may be lost by dropping it.
Defined in:
analyzer/analyzers/ruby/padrino.crConstant Summary
-
APP_CLASS_OPT_RE =
/(?::app_class\s*=>|app_class:)\s*['"]([^'"]+)['"]/ -
CLASS_APP_RE =
/\bclass\s+([\w:]+)\s*<\s*Padrino::Application\b/ -
class BlogApp < Padrino::Application— opens an (empty-prefix) controller scope so a bareget :index dowritten directly in the app class body (no enclosingcontrollersblock) still resolves. -
CONTROLLER_OPEN_RE =
/^(?:[\w:]+\s*\.\s*)?controllers?\b(.*?)(?:\bdo\b|\{)/ -
<Receiver>.controllers :name do/controllers :name do(no receiver, called inside the app class body) /controllers "/admin" do(explicit string prefix) / barecontroller do(grouping only, no prefix). Group 1 is the argument list between the keyword and the block opener. -
MAP_OPTION_RE =
/(?::map\s*=>|map:)\s*['"]([^'"]+)['"]/ -
map:/:map =>,with:/:with =>,parent:/:parent =>— Padrino apps span enough Ruby-version history that both hash syntaxes show up in real projects. -
MOUNT_LINE_RE =
/Padrino\.mount\s*\(\s*['"]([^'"]+)['"]\s*(?:,\s*(.*?))?\)\s*\.to\(\s*['"]([^'"]*)['"]\s*\)/ -
Padrino.mount('blog', app_class: 'BlogApp').to('/blog')— matched per-line (mount declarations are always a single statement in every real-worldconfig/apps.rb), so a[^)]*options capture never has to worry about matching past the end of the file. -
NAMESPACE_OPEN_RE =
/^namespace\s*\(?\s*['"]([^'"]+)['"]\s*\)?\s*(?:do\b|\{)/ -
PADRINO_DEPTH_TOKEN_RE =
/\bend\b|\bdo\b|(?:^|;)\s*(?:if|unless|case|begin|while|until|for|class|module|def)\b/ -
Same block-nesting delta as the Sinatra analyzer (see its
SINATRA_DEPTH_TOKEN_REfor the detailed rationale) — duplicated rather than shared so this analyzer stays self-contained. -
PADRINO_RESERVED_PARAMS =
Set {"splat", "captures"} -
Same params surface as Sinatra:
params[...]/params.fetch(...)as query params,request.env[...]/headers[...]as headers,cookies[...]as cookies.splat/capturesare Sinatra's own pattern bindings, not user-supplied fields. -
PARENT_OPTION_RE =
/(?::parent\s*=>|parent:)\s*:?['"]?(\w+)/ -
SYMBOL_VERB_PATTERNS =
HTTP_VERBS.map do |verb| {verb, /^#{verb}\s*\(?\s*:(\w+)\b(.*)$/} end -
Precompile the
<verb> :namematchers once — same reasoning asRubyEngine::VERB_ROUTE_PATTERNS(interpolated regex literals are recompiled on every evaluation otherwise). Group 1 is the route name, group 2 is everything after it on the line (options + block opener). -
WITH_OPTION_RE =
/(?::with\s*=>|with:)\s*(\[[^\]]*\]|:[\w]+)/
Class Method Summary
Instance Method Summary
- #analyze
-
#tech : String
Instance-side view of the same declaration.
Instance methods inherited from class Analyzer::Ruby::RubyEngine
line_to_endpoint(content : String, details : Details | Nil = nil) : Endpoint
line_to_endpoint
Class methods inherited from class Analyzer::Ruby::RubyEngine
ruby_test_path?(path : String) : Bool
ruby_test_path?
Instance methods inherited from class Analyzer
analyze
analyze,
base_path : String
base_path,
base_paths : Array(String)
base_paths,
base_relative_path(path : String) : String
base_relative_path,
callees_needed? : Bool
callees_needed?,
content_matches?(content : String, markers : Regex) : Bool
content_matches?,
http_header_name(name : String) : String | Nil
http_header_name,
line_number_for_index(content : String, char_index : Int32) : Int32
line_number_for_index,
logger : NoirLogger
logger,
parallel_analyze(files : Array(String), &block : String -> Nil)
parallel_analyze,
read_file_content(path : String) : String
read_file_content,
result : Array(Endpoint)
result,
tech : String
tech,
unique_params(params : Array(Param)) : Array(Param)
unique_params,
url : String
url,
web_root_path(path : String, markers : Array(String)) : String
web_root_path
Constructor methods inherited from class Analyzer
new(options : Hash(String, YAML::Any))
new
Macros inherited from class Analyzer
analyzer_for(tech)
analyzer_for
Instance methods inherited from module FileHelper
all_files : Array(String)
all_files,
get_files_by_basename(basename : String) : Array(String)
get_files_by_basename,
get_files_by_extension(extension : String) : Array(String)
get_files_by_extension,
get_files_by_extensions(extensions : Array(String)) : Array(String)
get_files_by_extensions,
get_files_by_prefix(prefix : String) : Array(String)
get_files_by_prefix,
get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String)
get_files_by_prefix_and_extension,
get_files_by_relative_path(relative_path : String, root : String = "") : Array(String)
get_files_by_relative_path,
get_public_dir_files(base_path : String, folder : String) : Array(String)
get_public_dir_files,
get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String)
get_public_files,
walked_path(expanded : String) : String
walked_path
Class Method Detail
Instance Method Detail
Instance-side view of the same declaration. The per-file rescues live on
this base class, which has no way to name the analyzer that is running
inside them, so a skipped file could not be attributed to a tech.
Deriving it from analyzer_for keeps the name written exactly once.