dead_end 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91a09272a46d3519c0ca78dcd3fd38199898fea1d6261c18576ff832e55351bd
-  data.tar.gz: f50e76a749fe0ecdf871fdaf6aead25132cb26a5d03068cbc611476c6eb06a8c
+  metadata.gz: 125719d74f88dcc5d196a1570508bd36d83d7ece6058b029a579da90a70cc099
+  data.tar.gz: 2eea6be22997101b46ff2820dfabaef4e473424a552e7f9c2835e43471c4431b
 SHA512:
-  metadata.gz: 89e7c7734a7a74c735479d35418ffda7d53557ce7d0c8a47fb2a67f5581d87d1be8117ff62d6590ed2cbf633fb566b797a6f3c3033e6c6a50b543cfbba9f4718
-  data.tar.gz: 2804e68394e928f36803859eb0e193bf96dc088138c4fea87510d6bc0d70e9c5485b6ca4c402762174c1ba3b139b9a4d1af28a6b31e87ec4e36859f659afc42d
+  metadata.gz: 674e35c603ec9ed2a8662e6ee3472381c6108a8734f455d39ef30472e38d13fd08a23cb107333f9ff8353ace614cb6c1f5bcb21e6aeb5384911ad1a61eb1ff58
+  data.tar.gz: 4ed5351764e96b5c95b2c4f68403bd81a3739163ad83d9e473829a1f6571f7e3614b855f56f21f5e8f15434817f7b7e8a947146044d4ac4c4f9314a15cd6b9bf

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD (unreleased)
 
+## 1.0.2
+
+- Fix bug where empty lines were interpreted to have a zero indentation (https://github.com/zombocom/dead_end/pull/39)
+- Better results when missing "end" comes at the end of a capturing block (such as a class or module definition) (https://github.com/zombocom/dead_end/issues/32)
+
 ## 1.0.1
 
 - Fix performance issue when evaluating multiple block combinations (https://github.com/zombocom/dead_end/pull/35)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dead_end (1.0.1)
+    dead_end (1.0.2)
 
 GEM
   remote: https://rubygems.org/

data/lib/dead_end/around_block_scan.rb

@@ -163,8 +163,8 @@ module DeadEnd
 
     def scan_adjacent_indent
       before_after_indent = []
-      before_after_indent << next_up&.indent || 0
-      before_after_indent << next_down&.indent || 0
+      before_after_indent << (next_up&.indent || 0)
+      before_after_indent << (next_down&.indent || 0)
 
       indent = before_after_indent.min
       self.scan_while {|line| line.not_empty? && line.indent >= indent }

data/lib/dead_end/capture_code_context.rb

@@ -35,20 +35,9 @@ module DeadEnd
 
     def call
       @blocks.each do |block|
-        around_lines = AroundBlockScan.new(code_lines: @code_lines, block: block)
-          .start_at_next_line
-          .capture_neighbor_context
-
-        around_lines -= block.lines
-
-        @lines_to_output.concat(around_lines)
-
-        AroundBlockScan.new(
-          block: block,
-          code_lines: @code_lines,
-        ).on_falling_indent do |line|
-          @lines_to_output << line
-        end
+        capture_last_end_same_indent(block)
+        capture_before_after_kws(block)
+        capture_falling_indent(block)
       end
 
       @lines_to_output.select!(&:not_empty?)
@@ -58,5 +47,70 @@ module DeadEnd
 
       return @lines_to_output
     end
+
+    def capture_falling_indent(block)
+      AroundBlockScan.new(
+        block: block,
+        code_lines: @code_lines,
+      ).on_falling_indent do |line|
+        @lines_to_output << line
+      end
+    end
+
+    def capture_before_after_kws(block)
+      around_lines = AroundBlockScan.new(code_lines: @code_lines, block: block)
+        .start_at_next_line
+        .capture_neighbor_context
+
+      around_lines -= block.lines
+
+      @lines_to_output.concat(around_lines)
+    end
+
+    # Problems heredocs are back in play
+    def capture_last_end_same_indent(block)
+      start_index = block.visible_lines.first.index
+      lines = @code_lines[start_index..block.lines.last.index]
+      kw_end_lines = lines.select {|line| line.indent == block.current_indent && (line.is_end? || line.is_kw?) }
+
+
+      # TODO handle case of heredocs showing up here
+      #
+      # Due to https://github.com/zombocom/dead_end/issues/32
+      # There's a special case where a keyword right before the last
+      # end of a valid block accidentally ends up identifying that the problem
+      # was with the block instead of before it. To handle that
+      # special case, we can re-parse back through the internals of blocks
+      # and if they have mis-matched keywords and ends show the last one
+      end_lines = kw_end_lines.select(&:is_end?)
+      end_lines.each_with_index  do |end_line, i|
+        start_index = i.zero? ? 0 : end_lines[i-1].index
+        end_index = end_line.index - 1
+        lines = @code_lines[start_index..end_index]
+
+        stop_next = false
+        kw_count = 0
+        end_count = 0
+        lines = lines.reverse.take_while do |line|
+          next false if stop_next
+
+          end_count += 1 if line.is_end?
+          kw_count += 1 if line.is_kw?
+
+          stop_next = true if !kw_count.zero? && kw_count >= end_count
+          true
+        end.reverse
+
+        next unless kw_count > end_count
+
+        lines = lines.select {|line| line.is_kw? || line.is_end? }
+
+        next if lines.empty?
+
+        @lines_to_output << end_line
+        @lines_to_output << lines.first
+        @lines_to_output << lines.last
+      end
+    end
   end
 end

data/lib/dead_end/code_block.rb

@@ -17,10 +17,12 @@ module DeadEnd
   #
   #
   class CodeBlock
+    UNSET = Object.new.freeze
     attr_reader :lines
 
     def initialize(lines: [])
       @lines = Array(lines)
+      @valid = UNSET
     end
 
     def visible_lines
@@ -68,7 +70,8 @@ module DeadEnd
     end
 
     def valid?
-      DeadEnd.valid?(self.to_s)
+      return @valid if @valid != UNSET
+      @valid = DeadEnd.valid?(self.to_s)
     end
 
     def to_s

data/lib/dead_end/code_frontier.rb

@@ -10,20 +10,20 @@ module DeadEnd
   # sorted and then the frontier can be filtered. Large blocks that totally contain a
   # smaller block will cause the smaller block to be evicted.
   #
-  #   CodeFrontier#<<
-  #   CodeFrontier#pop
+  #   CodeFrontier#<<(block) # Adds block to frontier
+  #   CodeFrontier#pop # Removes block from frontier
   #
   # ## Knowing where we can go
   #
-  # Internally it keeps track of an "indent hash" which is exposed via `next_indent_line`
+  # Internally it keeps track of "unvisited" lines which is exposed via `next_indent_line`
   # when called this will return a line of code with the most indentation.
   #
-  # This line of code can be used to build a CodeBlock via and then when that code block
-  # is added back to the frontier, then the lines in the code block are removed from the
-  # indent hash so we don't double-create the same block.
+  # This line of code can be used to build a CodeBlock and then when that code block
+  # is added back to the frontier, then the lines are removed from the
+  # "unvisited" so we don't double-create the same block.
   #
-  #   CodeFrontier#next_indent_line
-  #   CodeFrontier#register_indent_block
+  #   CodeFrontier#next_indent_line # Shows next line
+  #   CodeFrontier#register_indent_block(block) # Removes lines from unvisited
   #
   # ## Knowing when to stop
   #
@@ -42,13 +42,7 @@ module DeadEnd
     def initialize(code_lines: )
       @code_lines = code_lines
       @frontier = []
-      @indent_hash = {}
-      code_lines.each do |line|
-        next if line.empty?
-
-        @indent_hash[line.indent] ||= []
-        @indent_hash[line.indent] << line
-      end
+      @unvisited_lines = @code_lines.sort_by(&:indent_index)
     end
 
     def count
@@ -75,38 +69,31 @@ module DeadEnd
       return @frontier.pop
     end
 
-    def indent_hash_indent
-      @indent_hash.keys.sort.last
-    end
-
     def next_indent_line
-      indent = @indent_hash.keys.sort.last
-      @indent_hash[indent]&.first
+      @unvisited_lines.last
     end
 
     def expand?
       return false if @frontier.empty?
-      return true if @indent_hash.empty?
+      return true if @unvisited_lines.empty?
 
       frontier_indent = @frontier.last.current_indent
-      hash_indent = @indent_hash.keys.sort.last
+      unvisited_indent= next_indent_line.indent
 
       if ENV["DEBUG"]
         puts "```"
         puts @frontier.last.to_s
         puts "```"
         puts "  @frontier indent: #{frontier_indent}"
-        puts "  @hash indent:     #{hash_indent}"
+        puts "  @unvisited indent:     #{unvisited_indent}"
       end
 
-      frontier_indent >= hash_indent
+      # Expand all blocks before moving to unvisited lines
+      frontier_indent >= unvisited_indent
     end
 
     def register_indent_block(block)
-      block.lines.each do |line|
-        @indent_hash[line.indent]&.delete(line)
-      end
-      @indent_hash.select! {|k, v| !v.empty?}
+      @unvisited_lines -= block.lines
       self
     end
 

data/lib/dead_end/code_line.rb

@@ -36,9 +36,14 @@ module DeadEnd
     def initialize(line: , index:)
       @original_line = line.freeze
       @line = @original_line
-      @empty = line.strip.empty?
+      if line.strip.empty?
+        @empty = true
+        @indent = 0
+      else
+        @empty = false
+        @indent = SpaceCount.indent(line)
+      end
       @index = index
-      @indent = SpaceCount.indent(line)
       @status = nil # valid, invalid, unknown
       @invalid = false
 
@@ -60,9 +65,10 @@ module DeadEnd
         end
       end
 
+      @is_comment = lex.detect {|lex| lex.type != :on_sp}&.type == :on_comment
+      return if @is_comment
       @is_kw = (kw_count - end_count) > 0
       @is_end = (end_count - kw_count) > 0
-      @is_comment = lex.detect {|lex| lex.type != :on_sp}&.type == :on_comment
       @is_trailing_slash = lex.last.token == TRAILING_SLASH
     end
 
@@ -72,6 +78,10 @@ module DeadEnd
       @is_trailing_slash
     end
 
+    def indent_index
+      @indent_index ||= [indent, index]
+    end
+
     def <=>(b)
       self.index <=> b.index
     end
@@ -92,15 +102,6 @@ module DeadEnd
       @is_end
     end
 
-    def mark_invalid
-      @invalid = true
-      self
-    end
-
-    def marked_invalid?
-      @invalid
-    end
-
     def mark_invisible
       @line = ""
       self

data/lib/dead_end/code_search.rb

@@ -75,7 +75,7 @@ module DeadEnd
       record(block: block, name: name)
 
       if block.valid?
-        block.lines.each(&:mark_invisible)
+        block.mark_invisible
         frontier << block
       else
         frontier << block
@@ -92,7 +92,7 @@ module DeadEnd
 
     # Parses the most indented lines into blocks that are marked
     # and added to the frontier
-    def add_invalid_blocks
+    def visit_new_blocks
       max_indent = frontier.next_indent_line&.indent
 
       while (line = frontier.next_indent_line) && (line.indent == max_indent)
@@ -145,7 +145,7 @@ module DeadEnd
         if frontier.expand?
           expand_invalid_block
         else
-          add_invalid_blocks
+          visit_new_blocks
         end
       end
 

data/lib/dead_end/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeadEnd
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_end
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Find syntax errors in your source in a snap