Class: DeadEnd::AroundBlockScan

Inherits:
Object
  • Object
show all
Defined in:
lib/dead_end/around_block_scan.rb

Overview

This class is useful for exploring contents before and after a block

It searches above and below the passed in block to match for whatever criteria you give it:

Example:

def dog         # 1
  puts "bark"   # 2
  puts "bark"   # 3
end             # 4

scan = AroundBlockScan.new(
  code_lines: code_lines
  block: CodeBlock.new(lines: code_lines[1])
)

scan.scan_while { true }

puts scan.before_index # => 0
puts scan.after_index  # => 3

Contents can also be filtered using AroundBlockScan#skip

To grab the next surrounding indentation use AroundBlockScan#scan_adjacent_indent

Instance Method Summary collapse

Constructor Details

#initialize(code_lines:, block:) ⇒ AroundBlockScan

Returns a new instance of AroundBlockScan.



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/dead_end/around_block_scan.rb', line 31

def initialize(code_lines:, block:)
  @code_lines = code_lines
  @orig_before_index = block.lines.first.index
  @orig_after_index = block.lines.last.index
  @orig_indent = block.current_indent
  @skip_array = []
  @after_array = []
  @before_array = []
  @stop_after_kw = false

  @skip_hidden = false
  @skip_empty = false
end

Instance Method Details

#after_index ⇒ Object 



212
213
214
 
# File 'lib/dead_end/around_block_scan.rb', line 212

def after_index
  @after_index ||= @orig_after_index
end

#before_index ⇒ Object 



208
209
210
 
# File 'lib/dead_end/around_block_scan.rb', line 208

def before_index
  @before_index ||= @orig_before_index
end

#capture_neighbor_context ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/dead_end/around_block_scan.rb', line 108

def capture_neighbor_context
  lines = []
  kw_count = 0
  end_count = 0
  before_lines.reverse_each do |line|
    next if line.empty?
    break if line.indent < @orig_indent
    next if line.indent != @orig_indent

    kw_count += 1 if line.is_kw?
    end_count += 1 if line.is_end?
    if kw_count != 0 && kw_count == end_count
      lines << line
      break
    end

    lines << line
  end

  lines.reverse!

  kw_count = 0
  end_count = 0
  after_lines.each do |line|
    next if line.empty?
    break if line.indent < @orig_indent
    next if line.indent != @orig_indent

    kw_count += 1 if line.is_kw?
    end_count += 1 if line.is_end?
    if kw_count != 0 && kw_count == end_count
      lines << line
      break
    end

    lines << line
  end

  lines
end

#code_block ⇒ Object 



200
201
202
 
# File 'lib/dead_end/around_block_scan.rb', line 200

def code_block
  CodeBlock.new(lines: lines)
end

#lines ⇒ Object 



204
205
206
 
# File 'lib/dead_end/around_block_scan.rb', line 204

def lines
  @code_lines[before_index..after_index]
end

#next_down ⇒ Object 



177
178
179
 
# File 'lib/dead_end/around_block_scan.rb', line 177

def next_down
  @code_lines[after_index.next]
end

#next_up ⇒ Object 



173
174
175
 
# File 'lib/dead_end/around_block_scan.rb', line 173

def next_up
  @code_lines[before_index.pred]
end

#on_falling_indent ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/dead_end/around_block_scan.rb', line 149

def on_falling_indent
  last_indent = @orig_indent
  before_lines.reverse_each do |line|
    next if line.empty?
    if line.indent < last_indent
      yield line
      last_indent = line.indent
    end
  end

  last_indent = @orig_indent
  after_lines.each do |line|
    next if line.empty?
    if line.indent < last_indent
      yield line
      last_indent = line.indent
    end
  end
end

#scan_adjacent_indent ⇒ Object 



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/dead_end/around_block_scan.rb', line 181

def scan_adjacent_indent
  before_after_indent = []
  before_after_indent << (next_up&.indent || 0)
  before_after_indent << (next_down&.indent || 0)

  indent = before_after_indent.min
  scan_while { |line| line.not_empty? && line.indent >= indent }

  self
end

#scan_neighbors ⇒ Object 



169
170
171
 
# File 'lib/dead_end/around_block_scan.rb', line 169

def scan_neighbors
  scan_while { |line| line.not_empty? && line.indent >= @orig_indent }
end

#scan_while ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/dead_end/around_block_scan.rb', line 62

def scan_while
  stop_next = false

  kw_count = 0
  end_count = 0
  index = before_lines.reverse_each.take_while do |line|
    next false if stop_next
    next true if @skip_hidden && line.hidden?
    next true if @skip_empty && line.empty?

    kw_count += 1 if line.is_kw?
    end_count += 1 if line.is_end?
    if @stop_after_kw && kw_count > end_count
      stop_next = true
    end

    yield line
  end.last&.index

  if index && index < before_index
    @before_index = index
  end

  stop_next = false
  kw_count = 0
  end_count = 0
  index = after_lines.take_while do |line|
    next false if stop_next
    next true if @skip_hidden && line.hidden?
    next true if @skip_empty && line.empty?

    kw_count += 1 if line.is_kw?
    end_count += 1 if line.is_end?
    if @stop_after_kw && end_count > kw_count
      stop_next = true
    end

    yield line
  end.last&.index

  if index && index > after_index
    @after_index = index
  end
  self
end

#skip(name) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/dead_end/around_block_scan.rb', line 45

def skip(name)
  case name
  when :hidden?
    @skip_hidden = true
  when :empty?
    @skip_empty = true
  else
    raise "Unsupported skip #{name}"
  end
  self
end

#start_at_next_line ⇒ Object 



192
193
194
195
196
197
198
 
# File 'lib/dead_end/around_block_scan.rb', line 192

def start_at_next_line
  before_index
  after_index
  @before_index -= 1
  @after_index += 1
  self
end

#stop_after_kw ⇒ Object 



57
58
59
60
 
# File 'lib/dead_end/around_block_scan.rb', line 57

def stop_after_kw
  @stop_after_kw = true
  self
end