Class: Brakeman::Differ

Inherits:
Object
  • Object
show all
Defined in:
lib/brakeman/differ.rb

Overview

extracting the diff logic to it’s own class for consistency. Currently handles an array of Brakeman::Warnings or plain hash representations.

Constant Summary collapse

DEFAULT_HASH = 
{:new => [], :fixed => []}
OLD_WARNING_KEYS = 
[:warning_type, :location, :code, :message, :file, :link, :confidence, :user_input]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(new_warnings, old_warnings) ⇒ Differ

Returns a new instance of Differ.



8
9
10
11
 
# File 'lib/brakeman/differ.rb', line 8

def initialize new_warnings, old_warnings
  @new_warnings = new_warnings
  @old_warnings = old_warnings
end

Instance Attribute Details

#new_warnings ⇒ Object (readonly)

Returns the value of attribute new_warnings.



6
7
8
 
# File 'lib/brakeman/differ.rb', line 6

def new_warnings
  @new_warnings
end

#old_warnings ⇒ Object (readonly)

Returns the value of attribute old_warnings.



6
7
8
 
# File 'lib/brakeman/differ.rb', line 6

def old_warnings
  @old_warnings
end

Instance Method Details

#diff ⇒ Object 



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/brakeman/differ.rb', line 13

def diff
  # get the type of elements
  return DEFAULT_HASH if @new_warnings.empty?

  warnings = {}
  warnings[:new] = @new_warnings - @old_warnings
  warnings[:fixed] = @old_warnings - @new_warnings

  second_pass(warnings)
end

#eql_except_line_number(new_warning, fixed_warning) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/brakeman/differ.rb', line 49

def eql_except_line_number new_warning, fixed_warning
  # can't do this ahead of time, as callers may be expecting a Brakeman::Warning
  if new_warning.is_a? Brakeman::Warning 
    new_warning = new_warning.to_hash
    fixed_warning = fixed_warning.to_hash
  end

  if new_warning[:fingerprint] and fixed_warning[:fingerprint]
    new_warning[:fingerprint] == fixed_warning[:fingerprint]
  else
   OLD_WARNING_KEYS.each do |attr|
      return false if new_warning[attr] != fixed_warning[attr]
    end

    true
  end
end

#second_pass(warnings) ⇒ Object

second pass to cleanup any vulns which have changed in line number only. Given a list of new warnings, delete pairs of new/fixed vulns that differ only by line number. Horrible O(n^2) performance. Keep n small :-/



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/brakeman/differ.rb', line 28

def second_pass(warnings)
  # keep track of the number of elements deleted because the index numbers
  # won't update as the list is modified
  elements_deleted_offset = 0

  # dup this list since we will be deleting from it and the iterator gets confused.
  # use _with_index for fast deletion as opposed to .reject!{|obj| obj == *_warning}
  warnings[:new].dup.each_with_index do |new_warning, new_warning_id|
    warnings[:fixed].each_with_index do |fixed_warning, fixed_warning_id|
      if eql_except_line_number new_warning, fixed_warning
        warnings[:new].delete_at(new_warning_id - elements_deleted_offset)
        elements_deleted_offset += 1
        warnings[:fixed].delete_at(fixed_warning_id)
        break
      end
    end
  end

  warnings
end