Class: Brakeman::RescanReport

Inherits:
Object
  • Object
show all
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_COOKIES, Util::ALL_PARAMETERS, Util::COOKIES, Util::COOKIES_SEXP, Util::DIR_CONST, Util::LITERALS, Util::PARAMETERS, Util::PARAMS_SEXP, Util::PATH_PARAMETERS, Util::QUERY_PARAMETERS, Util::REQUEST_COOKIES, Util::REQUEST_ENV, Util::REQUEST_PARAMETERS, Util::REQUEST_PARAMS, Util::REQUEST_REQUEST_PARAMETERS, Util::SAFE_LITERAL, Util::SESSION, Util::SESSION_SEXP, Util::SIMPLE_LITERALS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#all_literals?, #array?, #block?, #call?, #camelize, #class_name, #constant?, #contains_class?, #cookies?, #dir_glob?, #false?, #hash?, #hash_access, #hash_insert, #hash_iterate, #hash_values, #integer?, #kwsplat?, #literal?, #make_call, #node_type?, #number?, #params?, #pluralize, #rails_version, #recurse_check?, #regexp?, #remove_kwsplat, #request_headers?, #request_value?, #result?, #safe_literal, #safe_literal?, #safe_literal_target?, #set_env_defaults, #sexp?, #simple_literal?, #string?, #string_interp?, #symbol?, #template_path_to_name, #true?, #underscore

Constructor Details

#initialize(old_results, tracker) ⇒ RescanReport

Returns a new instance of RescanReport.



84
85
86
87
88
89
 
# File 'lib/brakeman/rescanner.rb', line 84

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.



82
83
84
 
# File 'lib/brakeman/rescanner.rb', line 82

def new_results
  @new_results
end

#old_results ⇒ Object (readonly)

Returns the value of attribute old_results.



82
83
84
 
# File 'lib/brakeman/rescanner.rb', line 82

def old_results
  @old_results
end

Instance Method Details

#all_warnings ⇒ Object

Returns an array of all warnings found



97
98
99
 
# File 'lib/brakeman/rescanner.rb', line 97

def all_warnings
  @all_warnings ||= @tracker.filtered_warnings
end

#any_warnings? ⇒ Boolean

Returns true if any warnings were found (new or old)

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/brakeman/rescanner.rb', line 92

def any_warnings?
  not all_warnings.empty?
end

#diff ⇒ Object

Returns a hash of arrays for :new and :fixed warnings



119
120
121
 
# File 'lib/brakeman/rescanner.rb', line 119

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



124
125
126
127
128
 
# File 'lib/brakeman/rescanner.rb', line 124

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



103
104
105
 
# File 'lib/brakeman/rescanner.rb', line 103

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



109
110
111
 
# File 'lib/brakeman/rescanner.rb', line 109

def new_warnings
  diff[:new]
end

#to_s ⇒ Object

Output total, fixed, and new warnings



131
132
133
134
135
136
137
 
# File 'lib/brakeman/rescanner.rb', line 131

def to_s
  <<~OUTPUT
    Total warnings: #{all_warnings.length}
    Fixed warnings: #{fixed_warnings.length}
    New warnings: #{new_warnings.length}
  OUTPUT
end

#warnings_changed? ⇒ Boolean

Returns true if there are any new or fixed warnings

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/brakeman/rescanner.rb', line 114

def warnings_changed?
  not (diff[:new].empty? and diff[:fixed].empty?)
end