Class: Gitlab::Git::DiffCollection

Inherits:
Object
  • Object
show all
Includes:
Enumerable, EncodingHelper
Defined in:
lib/gitlab/git/diff_collection.rb

Constant Summary

Constants included from EncodingHelper

EncodingHelper::BOM_UTF8, EncodingHelper::ENCODING_CONFIDENCE_THRESHOLD, EncodingHelper::ESCAPED_CHARS, EncodingHelper::UNICODE_REPLACEMENT_CHARACTER

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from EncodingHelper

#binary_io, #detect_binary?, #detect_encoding, #detect_libgit2_binary?, #encode!, #encode_binary, #encode_utf8, #encode_utf8_no_detect, #encode_utf8_with_escaping!, #encode_utf8_with_replacement_character, #force_encode_utf8, #strip_bom, #unquote_path

Constructor Details

#initialize(iterator, options = {}) ⇒ DiffCollection

Returns a new instance of DiffCollection.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/gitlab/git/diff_collection.rb', line 37

def initialize(iterator, options = {})
  @iterator = iterator
  @generated_files = options.fetch(:generated_files, nil)
  @limits = self.class.limits(options)
  @enforce_limits = !!options.fetch(:limits, true)
  @expanded = !!options.fetch(:expanded, true)
  @offset_index = options.fetch(:offset_index, 0)

  @line_count = 0
  @byte_count = 0
  @overflow = false
  @empty = true
  @array = []
end

Instance Attribute Details

#limits ⇒ Object (readonly)

Returns the value of attribute limits.



11
12
13
 
# File 'lib/gitlab/git/diff_collection.rb', line 11

def limits
  @limits
end

Class Method Details

.collect_all_paths?(collect_all_paths) ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/gitlab/git/diff_collection.rb', line 17

def self.collect_all_paths?(collect_all_paths)
  Gitlab::Git::Diff.collect_patch_overage? ? collect_all_paths : false
end

.default_limits ⇒ Object 



13
14
15
 
# File 'lib/gitlab/git/diff_collection.rb', line 13

def self.default_limits
  { max_files: ::Commit.diff_safe_max_files, max_lines: ::Commit.diff_safe_max_lines }
end

.limits(options = {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/gitlab/git/diff_collection.rb', line 21

def self.limits(options = {})
  limits = {}
  defaults = default_limits
  limits[:max_files] = options.fetch(:max_files, defaults[:max_files])
  limits[:max_lines] = options.fetch(:max_lines, defaults[:max_lines])
  limits[:max_bytes] = limits[:max_files] * 5.kilobytes # Average 5 KB per file

  limits[:safe_max_files] = [limits[:max_files], defaults[:max_files]].min
  limits[:safe_max_lines] = [limits[:max_lines], defaults[:max_lines]].min
  limits[:safe_max_bytes] = limits[:safe_max_files] * 5.kilobytes # Average 5 KB per file
  limits[:max_patch_bytes] = Gitlab::Git::Diff.patch_hard_limit_bytes
  limits[:max_patch_bytes_for_file_extension] = options.fetch(:max_patch_bytes_for_file_extension, {})
  limits[:collect_all_paths] = collect_all_paths?(options.fetch(:collect_all_paths, false))
  limits
end

Instance Method Details

#collapsed_safe_bytes? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/gitlab/git/diff_collection.rb', line 106

def collapsed_safe_bytes?
  !!@collapsed_safe_bytes
end

#collapsed_safe_files? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/gitlab/git/diff_collection.rb', line 102

def collapsed_safe_files?
  !!@collapsed_safe_files
end

#collapsed_safe_limits? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/gitlab/git/diff_collection.rb', line 110

def collapsed_safe_limits?
  !!@collapsed_safe_limits
end

#collapsed_safe_lines? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/gitlab/git/diff_collection.rb', line 98

def collapsed_safe_lines?
  !!@collapsed_safe_lines
end

#decorate! ⇒ Object 



134
135
136
137
138
 
# File 'lib/gitlab/git/diff_collection.rb', line 134

def decorate!
  each_with_index do |element, i|
    @array[i] = yield(element)
  end
end

#each(&block) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/gitlab/git/diff_collection.rb', line 52

def each(&block)
  @array.each(&block)

  return if @overflow
  return if @iterator.nil?

  if @iterator.is_a?(Gitlab::GitalyClient::DiffStitcher)
    each_gitaly_patch(&block)
  else
    each_serialized_patch(&block)
  end

  @populated = true

  # Allow iterator to be garbage-collected. It cannot be reused anyway.
  @iterator = nil
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
79
 
# File 'lib/gitlab/git/diff_collection.rb', line 76

def empty?
  any? # Make sure the iterator has been exercised
  @empty
end

#line_count ⇒ Object 



128
129
130
131
132
 
# File 'lib/gitlab/git/diff_collection.rb', line 128

def line_count
  populate!

  @line_count
end

#overflow? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
84
 
# File 'lib/gitlab/git/diff_collection.rb', line 81

def overflow?
  populate!
  !!@overflow
end

#overflow_max_bytes? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/gitlab/git/diff_collection.rb', line 90

def overflow_max_bytes?
  !!@overflow_max_bytes
end

#overflow_max_files? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/gitlab/git/diff_collection.rb', line 94

def overflow_max_files?
  !!@overflow_max_files
end

#overflow_max_lines? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/gitlab/git/diff_collection.rb', line 86

def overflow_max_lines?
  !!@overflow_max_lines
end

#real_size ⇒ Object 



118
119
120
121
122
123
124
125
126
 
# File 'lib/gitlab/git/diff_collection.rb', line 118

def real_size
  populate!

  if @overflow
    "#{size}+"
  else
    size.to_s
  end
end

#size ⇒ Object 



114
115
116
 
# File 'lib/gitlab/git/diff_collection.rb', line 114

def size
  @size ||= count # forces a loop using each method
end

#sort(&block) ⇒ Object 



70
71
72
73
74
 
# File 'lib/gitlab/git/diff_collection.rb', line 70

def sort(&block)
  @array = @array.sort(&block)

  self
end