Class: Brakeman::RescanReport
- Includes:
- Util
- Defined in:
- lib/brakeman/rescanner.rb
Overview
Class to make reporting of rescan results simpler to deal with
Constant Summary
Constants included from Util
Util::ALL_PARAMETERS, Util::COOKIES, Util::COOKIES_SEXP, Util::PARAMETERS, Util::PARAMS_SEXP, Util::PATH_PARAMETERS, Util::QUERY_PARAMETERS, Util::REQUEST_ENV, Util::REQUEST_PARAMETERS, Util::REQUEST_PARAMS, Util::SESSION, Util::SESSION_SEXP
Instance Attribute Summary collapse
-
#new_results ⇒ Object
readonly
Returns the value of attribute new_results.
-
#old_results ⇒ Object
readonly
Returns the value of attribute old_results.
Instance Method Summary collapse
-
#all_warnings ⇒ Object
Returns an array of all warnings found.
-
#any_warnings? ⇒ Boolean
Returns true if any warnings were found (new or old).
-
#diff ⇒ Object
Returns a hash of arrays for :new and :fixed warnings.
-
#existing_warnings ⇒ Object
Returns an array of warnings which were in the old report and the new report.
-
#fixed_warnings ⇒ Object
Returns an array of warnings which were in the old report but are not in the new report after rescanning.
-
#initialize(old_results, tracker) ⇒ RescanReport
constructor
A new instance of RescanReport.
-
#new_warnings ⇒ Object
Returns an array of warnings which were in the new report but were not in the old report.
-
#to_s(verbose = false) ⇒ Object
Output total, fixed, and new warnings.
-
#warnings_changed? ⇒ Boolean
Returns true if there are any new or fixed warnings.
Methods included from Util
#array?, #block?, #call?, #camelize, #contains_class?, #context_for, #cookies?, #false?, #file_by_name, #file_for, #github_url, #hash?, #hash_access, #hash_insert, #hash_iterate, #integer?, #make_call, #node_type?, #number?, #params?, #pluralize, #regexp?, #relative_path, #request_env?, #request_value?, #result?, #set_env_defaults, #sexp?, #string?, #symbol?, #table_to_csv, #template_path_to_name, #true?, #truncate_table, #underscore
Constructor Details
#initialize(old_results, tracker) ⇒ RescanReport
Returns a new instance of RescanReport.
417 418 419 420 421 422 |
# File 'lib/brakeman/rescanner.rb', line 417 def initialize old_results, tracker @tracker = tracker @old_results = old_results @all_warnings = nil @diff = nil end |
Instance Attribute Details
#new_results ⇒ Object (readonly)
Returns the value of attribute new_results.
415 416 417 |
# File 'lib/brakeman/rescanner.rb', line 415 def new_results @new_results end |
#old_results ⇒ Object (readonly)
Returns the value of attribute old_results.
415 416 417 |
# File 'lib/brakeman/rescanner.rb', line 415 def old_results @old_results end |
Instance Method Details
#all_warnings ⇒ Object
Returns an array of all warnings found
430 431 432 |
# File 'lib/brakeman/rescanner.rb', line 430 def all_warnings @all_warnings ||= @tracker.filtered_warnings end |
#any_warnings? ⇒ Boolean
Returns true if any warnings were found (new or old)
425 426 427 |
# File 'lib/brakeman/rescanner.rb', line 425 def any_warnings? not all_warnings.empty? end |
#diff ⇒ Object
Returns a hash of arrays for :new and :fixed warnings
452 453 454 |
# File 'lib/brakeman/rescanner.rb', line 452 def diff @diff ||= Brakeman::Differ.new(all_warnings, @old_results).diff end |
#existing_warnings ⇒ Object
Returns an array of warnings which were in the old report and the new report
457 458 459 460 461 |
# File 'lib/brakeman/rescanner.rb', line 457 def existing_warnings @old ||= all_warnings.select do |w| not new_warnings.include? w end end |
#fixed_warnings ⇒ Object
Returns an array of warnings which were in the old report but are not in the new report after rescanning
436 437 438 |
# File 'lib/brakeman/rescanner.rb', line 436 def fixed_warnings diff[:fixed] end |
#new_warnings ⇒ Object
Returns an array of warnings which were in the new report but were not in the old report
442 443 444 |
# File 'lib/brakeman/rescanner.rb', line 442 def new_warnings diff[:new] end |
#to_s(verbose = false) ⇒ Object
Output total, fixed, and new warnings
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/brakeman/rescanner.rb', line 464 def to_s(verbose = false) if !verbose <<-OUTPUT Total warnings: #{all_warnings.length} Fixed warnings: #{fixed_warnings.length} New warnings: #{new_warnings.length} OUTPUT else #Eventually move this to different method, or make default to_s out = "" {:fixed => fixed_warnings, :new => new_warnings, :existing => existing_warnings}.each do |warning_type, warnings| if warnings.length > 0 out << "#{warning_type.to_s.titleize} warnings: #{warnings.length}\n" table = Terminal::Table.new(:headings => ["Confidence", "Class", "Method", "Warning Type", "Message"]) do |t| warnings.sort_by { |w| w.confidence}.each do |warning| w = warning.to_row w["Confidence"] = Brakeman::Report::TEXT_CONFIDENCE[w["Confidence"]] t << [w["Confidence"], w["Class"], w["Method"], w["Warning Type"], w["Message"]] end end out << truncate_table(table.to_s) end end out end end |
#warnings_changed? ⇒ Boolean
Returns true if there are any new or fixed warnings
447 448 449 |
# File 'lib/brakeman/rescanner.rb', line 447 def warnings_changed? not (diff[:new].empty? and diff[:fixed].empty?) end |