class Analyzer::Perl::Cli

Overview

Surfaces the command-line attack surface of Perl programs as cli:// endpoints: Getopt::Long (GetOptions) / Getopt::Std (getopts) / Getopt::Long::Descriptive (describe_options) / MooX::Options (option) plus @ARGV indexing and %ENV. Line-scan; root attribution (these libs are flat), merged by URL.

Included Modules

Defined in:

analyzer/analyzers/perl/cli.cr

Constant Summary

ARGV_IDX = /\$ARGV\s*\[\s*(\d+)\s*\]/
CLI_TEST_PATH_RE = Regex.union("/t/", "/test/", "_test.")

One precompiled Regex.union scan (PCRE2 JIT) replaces three separate String#includes? scans of the same buffer -- Crystal's includes? is not Boyer-Moore accelerated, so a single regex pass over lower is cheaper than three. Equivalent to the OR-of-substrings it replaces (union escapes each literal).

DESCRIBE_OPT_SPEC = /\[\s*['"]([a-zA-Z][\w-]*)[^'"]*['"]/

describe_options('%c %o', ['verbose|v' => 'be verbose'], ...) — each array-ref's leading quoted spec string. Only the leading identifier is captured so Getopt::Long::Descriptive suffix modifiers (|alias, =s, !, +, :i, ...) don't leak into the reported flag name.

ENV_READ = /\$ENV\{\s*['"]?([A-Za-z_]\w*)['"]?\s*\}/
GETOPT_KEY = /["']([a-zA-Z][\w-]*)[^"']*["']\s*=>\s*\\/

GetOptions("port=i" => $port) — the spec string bound to a reference.

GETOPTS = /\bgetopts?\s*\(\s*['"]([^'"]*)['"]/
MARKERS = /\buse\s+Getopt::(?:Long|Std)\b|\bGetOptions\s*\(|\bgetopts?\s*\(|\buse\s+App::Cmd\b|\bMooseX::Getopt\b|\$ARGV\s*\[\s*\d+\s*\]|\buse\s+Getopt::Long::Descriptive\b|\bdescribe_options\s*\(|\buse\s+MooX::Options\b/
MOOX_MARKER = /\buse\s+MooX::Options\b/
MOOX_OPTION = /\boption\s+['"]([a-zA-Z][\w-]*)['"]\s*=>/

option 'name' => (is => 'ro', ...); — MooX::Options attribute decl. Only extracted when use MooX::Options was actually seen in the file, so an unrelated bareword sub/call literally named option elsewhere doesn't get misattributed as a MooX::Options flag.

WEB_RE = /\buse\s+(?:Mojolicious|Mojo::|Dancer2?|Catalyst|Plack|Dancer)\b/

Class Method Summary

Instance Method Summary

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

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

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.


[View source]