class SyntaxSuggest::AroundBlockScan

此类可用于探索代码块之前和之后的内容

它会搜索传入的代码块的上方和下方，以匹配您提供的任何条件

示例

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

Public Class Methods

new (code_lines:, block:)

Source

# File lib/syntax_suggest/around_block_scan.rb, line 30
def initialize(code_lines:, block:)
  @code_lines = code_lines
  @orig_indent = block.current_indent

  @stop_after_kw = false
  @force_add_empty = false
  @force_add_hidden = false
  @target_indent = nil

  @scanner = ScanHistory.new(code_lines: code_lines, block: block)
end

Public Instance Methods

code_block ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 217
def code_block
  CodeBlock.new(lines: lines)
end

将当前匹配的行返回为一个 ‘CodeBlock`

创建 ‘CodeBlock` 时，它会收集有关自身的元数据，因此这不是免费转换。避免分配比需要更多的 CodeBlock

force_add_empty ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 60
def force_add_empty
  @force_add_empty = true
  self
end

使用此标志时，‘scan_while` 将绕过其给定的代码块，并始终添加一个响应 ‘CodeLine#empty?` 真值的行

空行不包含代码，只包含空格，如前导空格和换行符。

force_add_hidden ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 49
def force_add_hidden
  @force_add_hidden = true
  self
end

使用此标志时，‘scan_while` 将绕过其给定的代码块，并始终添加一个响应 ‘CodeLine#hidden?` 真值的行

当解析器将行评估为代码块的一部分并发现它们包含有效代码时，这些行将被隐藏。

inspect ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 228
def inspect
  "#<#{self.class}:0x0000123843lol >"
end

可管理的 rspec 错误

lines ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 223
def lines
  @scanner.lines
end

以 CodeLines 数组形式返回当前扫描匹配的行

lookahead_balance_one_line ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 141
def lookahead_balance_one_line
  kw_count = 0
  end_count = 0
  lines.each do |line|
    kw_count += 1 if line.is_kw?
    end_count += 1 if line.is_end?
  end

  return self if kw_count == end_count # nothing to balance

  @scanner.commit_if_changed # Rollback point if we don't find anything to optimize

  # Try to eat up empty lines
  @scanner.scan(
    up: ->(line, _, _) { line.hidden? || line.empty? },
    down: ->(line, _, _) { line.hidden? || line.empty? }
  )

  # More ends than keywords, check if we can balance expanding up
  next_up = @scanner.next_up
  next_down = @scanner.next_down
  case end_count - kw_count
  when 1
    if next_up&.is_kw? && next_up.indent >= @target_indent
      @scanner.scan(
        up: ->(line, _, _) { line == next_up },
        down: ->(line, _, _) { false }
      )
      @scanner.commit_if_changed
    end
  when -1
    if next_down&.is_end? && next_down.indent >= @target_indent
      @scanner.scan(
        up: ->(line, _, _) { false },
        down: ->(line, _, _) { line == next_down }
      )
      @scanner.commit_if_changed
    end
  end
  # Rollback any uncommitted changes
  @scanner.stash_changes

  self
end

扫描故意保守，因为我们目前无法回滚激进的代码块

如果由于某个微不足道的原因（例如空行）停止了一个代码块，但下一行本会使其平衡，那么我们可以检查该条件并向上或向下获取一行。

例如，在下面，如果我们向上扫描，第 2 行可能会导致扫描停止。这是因为空行可能表示用户有意将代码分块的逻辑中断，这是一个检查有效性的好地方。不幸的是，这也意味着我们可能会有一个“悬空”的关键字或 end。

1 def bark
2
3 end

如果第 2 行和第 3 行在代码块中，那么当运行此方法时，它会发现它是未平衡的，但获取第 1 行会使其平衡，所以它就是这样做的。

scan_adjacent_indent ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 200
def scan_adjacent_indent
  before_after_indent = []

  before_after_indent << (@scanner.next_up&.indent || 0)
  before_after_indent << (@scanner.next_down&.indent || 0)

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

  self
end

根据代码块上方/下方下一行的缩进扫描代码块

确定当前代码块上方/下方下一行的缩进。

通常，当一个代码块已扩展以捕获相同（或更高）缩进的所有“邻居”并且需要向外扩展时，会调用此方法。例如，围绕方法的 ‘def/end` 行。

scan_neighbors_not_empty ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 188
def scan_neighbors_not_empty
  @target_indent = @orig_indent
  scan_while { |line| line.not_empty? && line.indent >= @target_indent }
end

查找相同或更高缩进的代码行，并将它们添加到代码块中

scan_while () { |line| ... }

Source

# File lib/syntax_suggest/around_block_scan.rb, line 88
def scan_while
  stop_next_up = false
  stop_next_down = false

  @scanner.scan(
    up: ->(line, kw_count, end_count) {
      next false if stop_next_up
      next true if @force_add_hidden && line.hidden?
      next true if @force_add_empty && line.empty?

      if @stop_after_kw && kw_count > end_count
        stop_next_up = true
      end

      yield line
    },
    down: ->(line, kw_count, end_count) {
      next false if stop_next_down
      next true if @force_add_hidden && line.hidden?
      next true if @force_add_empty && line.empty?

      if @stop_after_kw && end_count > kw_count
        stop_next_down = true
      end

      yield line
    }
  )

  self
end

主要工作方法

‘scan_while` 方法接受一个代码块，该代码块会产生代码块上方和下方的行。如果产生返回 true，则 @before_index 或 @after_index 会被修改以包含匹配的行。

除了产生单独的行之外，此对象的内部还提供了一个迷你 DSL 来处理常见情况，例如停止是否在某个方向上发现了关键字/end 错配。

stop_after_kw ()

Source

# File lib/syntax_suggest/around_block_scan.rb, line 73
def stop_after_kw
  @stop_after_kw = true
  self
end

告诉 ‘scan_while` 查找不匹配的关键字/end-s

向上扫描时，如果看到的关键字多于 end-s，则会停止。这可能发生在扫描方法体外部时。第一行扫描将是一个关键字，此设置将触发停止。

向下扫描时，如果 end-s 多于关键字，则停止。