dead_end 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c232ccfce002bd3a79d6a5508ea46b27684a9a0ae2bb5d6f843d49e5ba59c0ac
-  data.tar.gz: 745847314c5c3ff09cb85b525a5d583f89c1c597e1f5b785ed54e01299bb72c4
+  metadata.gz: 802262fe82f2dcb82c0ca5d908852141a6fb7fe533b597f80c4d65b2e7f8b7e6
+  data.tar.gz: 2087ff7725c10acc2eac1278dfe6d64c1e2161ee9d4fe97bb87b33aecc73d468
 SHA512:
-  metadata.gz: c49f5b58a7a2f222606a01efc3256a2a0eceade66ff6e46f7c15172cf972a48aa4b6d55212eb714ad69dde1b6d80e91cf8589a9b7026ad2b3e9baafabb8c2e6c
-  data.tar.gz: f70fc9947a92d8de2d8f05e08ab803a791c9fc396f03a0bed812b0a88bdb74af33658b23ebdf148adbc716cc41870bee8fabe57c3ae62bd6c9e9b063717f0bbc
+  metadata.gz: 25b2a17f9901cbdf5d8a7c3085a931b95f70eda6a51661664c5b859a3f06b21e9fe4aa926e1d93e54f04b05bd4b27e67bfaa6ef84d61fcd0eacbf9929882bc43
+  data.tar.gz: f9aeb83c9d39c05d03be3f0e84c4c2fc86246a61f6b77b6185f2f0a25ec91885ed3d727e7ecf41948a11b5efd3d0b51aef3824103f83800e23734675a33bbed2

data/CHANGELOG.md

@@ -1,11 +1,17 @@
 ## HEAD (unreleased)
 
+## 3.0.2
+
+- Fix windows filename detection (https://github.com/zombocom/dead_end/pull/114)
+- Update links on readme and code of conduct (https://github.com/zombocom/dead_end/pull/107)
+
 ## 3.0.1
 
 - Fix CLI parsing when flags come before filename (https://github.com/zombocom/dead_end/pull/102)
 
 ## 3.0.0
 
+- [Breaking] CLI now outputs to STDOUT instead of STDERR (https://github.com/zombocom/dead_end/pull/98)
 - [Breaking] Remove previously deprecated `require "dead_end/fyi"` interface (https://github.com/zombocom/dead_end/pull/94)
 - Fix double output bug (https://github.com/zombocom/dead_end/pull/99)
 - Fix bug causing poor results (fix #95, fix #88) (https://github.com/zombocom/dead_end/pull/96)

data/CODE_OF_CONDUCT.md

@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
+available at [https://contributor-covenant.org/version/1/4/code-of-conduct/][version]
 
 [homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/
+[version]: https://contributor-covenant.org/version/1/4/code-of-conduct/

data/Gemfile.lock

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

data/README.md

@@ -45,6 +45,13 @@ To get the CLI and manually search for syntax errors (but not automatically anno
 
 This gives you the CLI command `$ dead_end` for more info run `$ dead_end --help`.
 
+## Editor integration
+
+An extension is available for VSCode:
+
+- Extension: https://marketplace.visualstudio.com/items?itemName=Zombocom.dead-end-vscode
+- GitHub: https://github.com/zombocom/dead_end-vscode
+
 ## What syntax errors does it handle?
 
 Dead end will fire against all syntax errors and can isolate any syntax error. In addition, dead_end attempts to produce human readable descriptions of what needs to be done to resolve the issue. For example:
@@ -195,7 +202,7 @@ $ qcachegrind tmp/last/profile.callgrind.out.<numbers>
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/zombocom/dead_end. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zombocom/dead_end/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/zombocom/dead_end. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zombocom/dead_end/blob/main/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -204,4 +211,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the DeadEnd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zombocom/dead_end/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DeadEnd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zombocom/dead_end/blob/main/CODE_OF_CONDUCT.md).

data/lib/dead_end/clean_document.rb

@@ -85,8 +85,8 @@ module DeadEnd
   #
   class CleanDocument
     def initialize(source:)
-      @source = clean_sweep(source: source)
-      @document = CodeLine.from_source(@source)
+      lines = clean_sweep(source: source)
+      @document = CodeLine.from_source(lines.join, lines: lines)
     end
 
     # Call all of the document "cleaners"
@@ -161,7 +161,7 @@ module DeadEnd
         else
           line
         end
-      end.join
+      end
     end
 
     # Smushes all heredoc lines into one line

data/lib/dead_end/code_frontier.rb

@@ -54,6 +54,8 @@ module DeadEnd
       @code_lines = code_lines
       @frontier = InsertionSort.new
       @unvisited_lines = @code_lines.sort_by(&:indent_index)
+      @visited_lines = {}
+
       @has_run = false
       @check_next = true
     end
@@ -128,7 +130,13 @@ module DeadEnd
     end
 
     def register_indent_block(block)
-      @unvisited_lines -= block.lines
+      block.lines.each do |line|
+        next if @visited_lines[line]
+        @visited_lines[line] = true
+
+        index = @unvisited_lines.bsearch_index { |l| line.indent_index <=> l.indent_index }
+        @unvisited_lines.delete_at(index)
+      end
       self
     end
 

data/lib/dead_end/code_line.rb

@@ -26,9 +26,10 @@ module DeadEnd
 
     # Returns an array of CodeLine objects
     # from the source string
-    def self.from_source(source)
-      lex_array_for_line = LexAll.new(source: source).each_with_object(Hash.new { |h, k| h[k] = [] }) { |lex, hash| hash[lex.line] << lex }
-      source.lines.map.with_index do |line, index|
+    def self.from_source(source, lines: nil)
+      lines ||= source.lines
+      lex_array_for_line = LexAll.new(source: source, source_lines: lines).each_with_object(Hash.new { |h, k| h[k] = [] }) { |lex, hash| hash[lex.line] << lex }
+      lines.map.with_index do |line, index|
         CodeLine.new(
           line: line,
           index: index,
@@ -42,28 +43,20 @@ module DeadEnd
       @lex = lex
       @line = line
       @index = index
-      @original = line.freeze
+      @original = line
       @line_number = @index + 1
+      strip_line = line.dup
+      strip_line.lstrip!
 
-      if line.strip.empty?
+      if strip_line.empty?
         @empty = true
         @indent = 0
       else
         @empty = false
-        @indent = SpaceCount.indent(line)
+        @indent = line.length - strip_line.length
       end
 
-      kw_count = 0
-      end_count = 0
-      @lex.each do |lex|
-        kw_count += 1 if lex.is_kw?
-        end_count += 1 if lex.is_end?
-      end
-
-      kw_count -= oneliner_method_count
-
-      @is_kw = (kw_count - end_count) > 0
-      @is_end = (end_count - kw_count) > 0
+      set_kw_end
     end
 
     # Used for stable sort via indentation level
@@ -179,8 +172,7 @@ module DeadEnd
     #
     # For some reason this introduces `on_ignore_newline` but with BEG type
     def ignore_newline_not_beg?
-      lex_value = lex.detect { |l| l.type == :on_ignored_nl }
-      !!(lex_value && !lex_value.expr_beg?)
+      @ignore_newline_not_beg
     end
 
     # Determines if the given line has a trailing slash
@@ -206,11 +198,22 @@ module DeadEnd
     #
     #   ENDFN -> BEG (token = '=' ) -> END
     #
-    private def oneliner_method_count
+    private def set_kw_end
       oneliner_count = 0
       in_oneliner_def = nil
 
+      kw_count = 0
+      end_count = 0
+
+      @ignore_newline_not_beg = false
       @lex.each do |lex|
+        kw_count += 1 if lex.is_kw?
+        end_count += 1 if lex.is_end?
+
+        if lex.type == :on_ignored_nl
+          @ignore_newline_not_beg = !lex.expr_beg?
+        end
+
         if in_oneliner_def.nil?
           in_oneliner_def = :ENDFN if lex.state.allbits?(Ripper::EXPR_ENDFN)
         elsif lex.state.allbits?(Ripper::EXPR_ENDFN)
@@ -227,7 +230,10 @@ module DeadEnd
         end
       end
 
-      oneliner_count
+      kw_count -= oneliner_count
+
+      @is_kw = (kw_count - end_count) > 0
+      @is_end = (end_count - kw_count) > 0
     end
   end
 end

data/lib/dead_end/lex_all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeadEnd
   # Ripper.lex is not guaranteed to lex the entire source document
   #
@@ -8,20 +10,22 @@ module DeadEnd
   class LexAll
     include Enumerable
 
-    def initialize(source:)
-      @lex = Ripper.lex(source)
-      lineno = @lex.last.first.first + 1
-      source_lines = source.lines
-      last_lineno = source_lines.count
+    def initialize(source:, source_lines: nil)
+      @lex = Ripper::Lexer.new(source, "-", 1).parse.sort_by(&:pos)
+      lineno = @lex.last.pos.first + 1
+      source_lines ||= source.lines
+      last_lineno = source_lines.length
 
       until lineno >= last_lineno
         lines = source_lines[lineno..-1]
 
-        @lex.concat(Ripper.lex(lines.join, "-", lineno + 1))
-        lineno = @lex.last.first.first + 1
+        @lex.concat(
+          Ripper::Lexer.new(lines.join, "-", lineno + 1).parse.sort_by(&:pos)
+        )
+        lineno = @lex.last.pos.first + 1
       end
 
-      @lex.map! { |(line, _), type, token, state| LexValue.new(line, type, token, state) }
+      @lex.map! { |elem| LexValue.new(elem.pos.first, elem.event, elem.tok, elem.state) }
     end
 
     def to_a

data/lib/dead_end/lex_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeadEnd
   # Value object for accessing lex values
   #

data/lib/dead_end/pathname_from_message.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DeadEnd
+  # Converts a SyntaxError message to a path
+  #
+  # Handles the case where the filename has a colon in it
+  # such as on a windows file system: https://github.com/zombocom/dead_end/issues/111
+  #
+  # Example:
+  #
+  #    message = "/tmp/scratch:2:in `require_relative': /private/tmp/bad.rb:1: syntax error, unexpected `end' (SyntaxError)"
+  #    puts PathnameFromMessage.new(message).call.name
+  #    # => "/tmp/scratch.rb"
+  #
+  class PathnameFromMessage
+    attr_reader :name
+
+    def initialize(message, io: $stderr)
+      @line = message.lines.first
+      @parts = @line.split(":")
+      @guess = []
+      @name = nil
+      @io = io
+    end
+
+    def call
+      until stop?
+        @guess << @parts.shift
+        @name = Pathname(@guess.join(":"))
+      end
+
+      if @parts.empty?
+        @io.puts "DeadEnd: could not find filename from #{@line.inspect}"
+        @name = nil
+      end
+
+      self
+    end
+
+    def stop?
+      return true if @parts.empty?
+      return false if @guess.empty?
+
+      @name&.exist?
+    end
+  end
+end

data/lib/dead_end/version.rb

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

data/lib/dead_end.rb

@@ -17,12 +17,14 @@ module DeadEnd
   TIMEOUT_DEFAULT = ENV.fetch("DEAD_END_TIMEOUT", 1).to_i
 
   def self.handle_error(e)
-    filename = e.message.split(":").first
+    file = PathnameFromMessage.new(e.message).call.name
+    raise e unless file
+
     $stderr.sync = true
 
     call(
-      source: Pathname(filename).read,
-      filename: filename
+      source: file.read,
+      filename: file
     )
 
     raise e
@@ -139,21 +141,24 @@ module DeadEnd
   end
 end
 
-require_relative "dead_end/code_line"
-require_relative "dead_end/code_block"
+# Integration
+require_relative "dead_end/cli"
+require_relative "dead_end/auto"
+
+# Core logic
 require_relative "dead_end/code_search"
 require_relative "dead_end/code_frontier"
+require_relative "dead_end/explain_syntax"
 require_relative "dead_end/clean_document"
 
+# Helpers
 require_relative "dead_end/lex_all"
+require_relative "dead_end/code_line"
+require_relative "dead_end/code_block"
 require_relative "dead_end/block_expand"
+require_relative "dead_end/ripper_errors"
 require_relative "dead_end/insertion_sort"
 require_relative "dead_end/around_block_scan"
-require_relative "dead_end/ripper_errors"
+require_relative "dead_end/pathname_from_message"
 require_relative "dead_end/display_invalid_blocks"
 require_relative "dead_end/parse_blocks_from_indent_line"
-
-require_relative "dead_end/explain_syntax"
-
-require_relative "dead_end/auto"
-require_relative "dead_end/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_end
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -54,6 +54,7 @@ files:
 - lib/dead_end/lex_all.rb
 - lib/dead_end/lex_value.rb
 - lib/dead_end/parse_blocks_from_indent_line.rb
+- lib/dead_end/pathname_from_message.rb
 - lib/dead_end/ripper_errors.rb
 - lib/dead_end/version.rb
 homepage: https://github.com/zombocom/dead_end.git