Fix code context capturing

Previously when we were trying to capture the "neighbors" context, we were using the same logic as when trying to "expand" a block. This logic looks for unmatched keyword pairs, so when it looks up it will stop at `def foo` but not at `def foo; end`. For grabbing context we want to stop after the first contextual pair so we cannot use that same method.

Instead a new method that is specialized to finding context is introduced to the AroundBlockScan class.

 When trying to capture code context, we don't want to look for a dangling keyword, we want the first matched pair

Author: schneems

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## HEAD (unreleased)
 
+- Simplify large file output so minimal context around the invalid section is shown (https://github.com/zombocom/syntax_search/pull/26)
 - Block expansion is now lexically aware of keywords (def/do/end etc.) (https://github.com/zombocom/syntax_search/pull/24)
 - Fix bug where not all of a source is lexed which is used in heredoc detection/removal (https://github.com/zombocom/syntax_search/pull/23)
 

lib/syntax_search/around_block_scan.rb

@@ -85,6 +85,50 @@ def scan_while(&block)
       self
     end
 
+    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|
+        # puts "line: #{line.number} #{line.original_line}, indent: #{line.indent}, #{line.empty?} #{line.indent == @orig_indent}"
+
+        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.select! {|line| !line.is_comment? }
+
+      lines
+    end
+
     def on_falling_indent
       last_indent = @orig_indent
       before_lines.reverse.each do |line|
@@ -119,16 +163,23 @@ def scan_adjacent_indent
       self
     end
 
+    def start_at_next_line
+      before_index; after_index
+      @before_index -= 1
+      @after_index += 1
+      self
+    end
+
     def code_block
       CodeBlock.new(lines: @code_lines[before_index..after_index])
     end
 
     def before_index
-      @before_index || @orig_before_index
+      @before_index ||= @orig_before_index
     end
 
     def after_index
-      @after_index || @orig_after_index
+      @after_index ||= @orig_after_index
     end
 
     private def before_lines

lib/syntax_search/capture_code_context.rb

@@ -36,11 +36,10 @@ def initialize(blocks: , code_lines:)
     def call
       @blocks.each do |block|
         around_lines = AroundBlockScan.new(code_lines: @code_lines, block: block)
-          .stop_after_kw
-          .scan_while {|line| line.empty? || line.indent >= block.current_indent }
-          .code_block
-          .lines
-          .select {|l| l.indent == block.current_indent && ! block.lines.include?(l) }
+          .start_at_next_line
+          .capture_neighbor_context
+
+        around_lines -= block.lines
 
         @lines_to_output.concat(around_lines)
 
@@ -52,7 +51,12 @@ def call
         end
       end
 
-      return @lines_to_output.uniq.select(&:not_empty?).sort
+      @lines_to_output.select!(&:not_empty?)
+      @lines_to_output.select!(&:not_comment?)
+      @lines_to_output.uniq!
+      @lines_to_output.sort!
+
+      return @lines_to_output
     end
   end
 end

lib/syntax_search/code_line.rb

@@ -68,6 +68,10 @@ def is_comment?
       @is_comment
     end
 
+    def not_comment?
+      !is_comment?
+    end
+
     def is_kw?
       @is_kw
     end
@@ -107,6 +111,8 @@ def line_number
       index + 1
     end
 
+    alias :number :line_number
+
     def not_empty?
       !empty?
     end

spec/unit/display_invalid_blocks_spec.rb

@@ -10,15 +10,21 @@ class Blerg
         end
         class OH
 
+          def nope
+          end
+
           def lol
           end
 
           it "foo"
+            puts "here"
           end
 
           def haha
           end
 
+          def nope
+          end
         end
 
         class Zerg
@@ -35,21 +41,21 @@ class Zerg
 
       # Finds lines previously hidden
       lines = code_context.call
-      expect(lines.select(&:hidden?).map(&:line_number)).to eq([11, 12])
+      # expect(lines.select(&:hidden?).map(&:line_number)).to eq([11, 12])
 
       out = DisplayCodeWithLineNumbers.new(
         lines: lines,
       ).call
 
       expect(out).to eq(<<~EOM.indent(2))
          3  class OH
-         5    def lol
-         6    end
-         8    it "foo"
+         8    def lol
          9    end
-        11    def haha
-        12    end
-        14  end
+        11    it "foo"
+        13    end
+        15    def haha
+        16    end
+        20  end
       EOM
     end
 

spec/unit/exe_spec.rb

@@ -38,9 +38,14 @@ def exe(cmd)
         out = exe("#{file.path} --no-terminal")
 
         expect(out).to include(<<~EOM.indent(4))
-             77    class Lookups
+             16  class Rexe
+             40    class Options < Struct.new(
+             71    end
+          ❯  77    class Lookups
           ❯  78      def input_modes
-            148    end
+          ❯ 148    end
+            152    class CommandLineParser
+            418    end
             551  end
         EOM
       end