class Brakeman::FileParser
This class handles reading and parsing files.
Attributes
errors[R]
file_list[R]
Public Class Methods
new(app_tree, timeout, parallel = true, use_prism = false)
click to toggle source
# File lib/brakeman/file_parser.rb, line 10 def initialize app_tree, timeout, parallel = true, use_prism = false @use_prism = use_prism if @use_prism begin require 'prism' rescue LoadError => e Brakeman.debug "Asked to use Prism, but failed to load: #{e}" @use_prism = false end end @app_tree = app_tree @timeout = timeout @file_list = [] @errors = [] @parallel = parallel end
Public Instance Methods
parse_files(list)
click to toggle source
# File lib/brakeman/file_parser.rb, line 29 def parse_files list if @parallel parallel_options = {} else # Disable parallelism parallel_options = { in_threads: 0 } end # Parse the files in parallel. # By default, the parsing will be in separate processes. # So we map the result to ASTFiles and/or Exceptions # then partition them into ASTFiles and Exceptions # and add the Exceptions to @errors # # Basically just a funky way to deal with two possible # return types that are returned from isolated processes. # # Note this method no longer uses read_files @file_list, new_errors = Parallel.map(list, parallel_options) do |file_name| file_path = @app_tree.file_path(file_name) contents = file_path.read begin if ast = parse_ruby(contents, file_path.relative) ASTFile.new(file_name, ast) end rescue Exception => e e end end.compact.partition do |result| result.is_a? ASTFile end errors.concat new_errors end
parse_ruby(input, path)
click to toggle source
path can be a string or a Brakeman::FilePath
# File lib/brakeman/file_parser.rb, line 82 def parse_ruby input, path if path.is_a? Brakeman::FilePath path = path.relative end Brakeman.debug "Parsing #{path}" if @use_prism begin parse_with_prism input, path rescue => e Brakeman.debug "Prism failed to parse #{path}: #{e}" parse_with_ruby_parser input, path end else parse_with_ruby_parser input, path end end
read_files(list) { |file, read| ... }
click to toggle source
# File lib/brakeman/file_parser.rb, line 65 def read_files list list.each do |path| file = @app_tree.file_path(path) begin result = yield file, file.read if result @file_list << result end rescue Exception => e @errors << e end end end
Private Instance Methods
parse_with_prism(input, path)
click to toggle source
# File lib/brakeman/file_parser.rb, line 104 def parse_with_prism input, path Prism::Translation::RubyParser.parse(input, path) end
parse_with_ruby_parser(input, path)
click to toggle source
# File lib/brakeman/file_parser.rb, line 108 def parse_with_ruby_parser input, path begin RubyParser.new.parse input, path, @timeout rescue Racc::ParseError => e raise e.exception(e.message + "\nCould not parse #{path}") rescue Timeout::Error => e raise Exception.new("Parsing #{path} took too long (> #{@timeout} seconds). Try increasing the limit with --parser-timeout") rescue => e raise e.exception(e.message + "\nWhile processing #{path}") end end