abstract class Analyzer::Specification::SpecificationEngine

Overview

Base for the specification-format analyzers (OpenAPI, Postman, HAR, Terraform, k8s manifests, proxy exports, …).

They do not walk the file tree the way the language engines do. The detector recognises a document and pushes its path into CodeLocator under a key, and the analyzer later drains that key. Forty-odd analyzers each open-coded the same drain:

locator = CodeLocator.instance
files = locator.all("some-key")
return @result unless files.is_a?(Array(String))
files.each do |path|
  next unless File.exists?(path)
  begin
    ...
  rescue e
    @logger.debug "..."
    @logger.debug_sub e
  end
end

with just enough variation between copies that some dropped the existence check, some dropped the per-file rescue (letting one malformed document abort every remaining file for that analyzer), and the log wording differed everywhere. each_spec_file is that drain, once.

Direct Known Subclasses

Defined in:

analyzer/engines/specification_engine.cr

Constant Summary

ABSOLUTE_SERVER_URL = /\A[A-Za-z][A-Za-z0-9+.\-]*:\/\//

scheme:// prefix of an absolute URL. //host/path is deliberately not matched here — it is protocol-relative and handled separately.

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, 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