dead_end 1.1.6 → 2.0.1

data/lib/dead_end/display_invalid_blocks.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "banner"
 require_relative "capture_code_context"
 require_relative "display_code_with_line_numbers"
 
@@ -8,7 +9,7 @@ module DeadEnd
   class DisplayInvalidBlocks
     attr_reader :filename
 
-    def initialize(code_lines: ,blocks:, io: $stderr, filename: nil, terminal: false, invalid_obj: WhoDisSyntaxError::Null.new)
+    def initialize(code_lines:, blocks:, io: $stderr, filename: nil, terminal: false, invalid_obj: WhoDisSyntaxError::Null.new)
       @terminal = terminal
       @filename = filename
       @io = io
@@ -21,11 +22,15 @@ module DeadEnd
       @invalid_obj = invalid_obj
     end
 
+    def document_ok?
+      @blocks.none? { |b| !b.hidden? }
+    end
+
     def call
-      if @blocks.any? { |b| !b.hidden? }
-        found_invalid_blocks
-      else
+      if document_ok?
         @io.puts "Syntax OK"
+      else
+        found_invalid_blocks
       end
       self
     end
@@ -37,8 +42,10 @@ module DeadEnd
 
     private def found_invalid_blocks
       @io.puts
-      @io.puts banner
-      @io.puts
+      if banner
+        @io.puts banner
+        @io.puts
+      end
       @io.puts("file: #{filename}") if filename
       @io.puts <<~EOM
         simplified:
@@ -48,52 +55,15 @@ module DeadEnd
     end
 
     def banner
-      case @invalid_obj.error_symbol
-      when :missing_end
-        <<~EOM
-          DeadEnd: Missing `end` detected
-
-          This code has a missing `end`. Ensure that all
-          syntax keywords (`def`, `do`, etc.) have a matching `end`.
-        EOM
-      when :unmatched_syntax
-        case @invalid_obj.unmatched_symbol
-        when :end
-          <<~EOM
-            DeadEnd: Unmatched `end` detected
-
-            This code has an unmatched `end`. Ensure that all `end` lines
-            in your code have a matching syntax keyword  (`def`,  `do`, etc.)
-            and that you don't have any extra `end` lines.
-          EOM
-        when :|
-          <<~EOM
-            DeadEnd: Unmatched `|` character detected
-
-            Example:
-
-              `do |x` should be `do |x|`
-          EOM
-        when :"}"
-          <<~EOM
-            DeadEnd: Unmatched `}` character detected
-
-            This code has an unmatched `}`. Ensure that opening curl braces are
-            closed: `{ }`.
-          EOM
-        else
-          "DeadEnd: Unmatched `#{@invalid_obj.unmatched_symbol}` detected"
-        end
-      end
-
+      Banner.new(invalid_obj: @invalid_obj).call
     end
 
     def indent(string, with: "    ")
-      string.each_line.map {|l| with  + l }.join
+      string.each_line.map { |l| with + l }.join
     end
 
     def code_block
-      string = String.new("")
+      string = +""
       string << code_with_context
       string
     end
@@ -107,7 +77,7 @@ module DeadEnd
       DisplayCodeWithLineNumbers.new(
         lines: lines,
         terminal: @terminal,
-        highlight_lines: @invalid_lines,
+        highlight_lines: @invalid_lines
       ).call
     end
 
@@ -115,7 +85,7 @@ module DeadEnd
       DisplayCodeWithLineNumbers.new(
         lines: @code_lines.select(&:visible?),
         terminal: @terminal,
-        highlight_lines: @invalid_lines,
+        highlight_lines: @invalid_lines
       ).call
     end
   end

data/lib/dead_end/fyi.rb

@@ -1,7 +1,8 @@
 require_relative "../dead_end/internals"
 
-require_relative "auto.rb"
+require_relative "auto"
 
 DeadEnd.send(:remove_const, :SEARCH_SOURCE_ON_ERROR_DEFAULT)
 DeadEnd::SEARCH_SOURCE_ON_ERROR_DEFAULT = false
 
+warn "DEPRECATED: calling `require 'dead_end/fyi'` is deprecated, `require 'dead_end'` instead"

data/lib/dead_end/internals.rb

@@ -1,43 +1,41 @@
 # frozen_string_literal: true
-#
+
 # This is the top level file, but is moved to `internals`
-# so the top level file can instead enable the "automatic" behavior
+# so the top level require can instead enable the "automatic" behavior
 
 require_relative "version"
 
-require 'tmpdir'
-require 'stringio'
-require 'pathname'
-require 'ripper'
-require 'timeout'
+require "tmpdir"
+require "stringio"
+require "pathname"
+require "ripper"
+require "timeout"
 
 module DeadEnd
   class Error < StandardError; end
   SEARCH_SOURCE_ON_ERROR_DEFAULT = true
-  TIMEOUT_DEFAULT = ENV.fetch("DEAD_END_TIMEOUT", 5).to_i
+  TIMEOUT_DEFAULT = ENV.fetch("DEAD_END_TIMEOUT", 1).to_i
 
   def self.handle_error(e, search_source_on_error: SEARCH_SOURCE_ON_ERROR_DEFAULT)
-    raise e if !e.message.include?("end-of-input")
+    raise e unless e.message.include?("end-of-input")
 
     filename = e.message.split(":").first
 
     $stderr.sync = true
-    $stderr.puts "Run `$ dead_end #{filename}` for more options\n"
+    warn "Run `$ dead_end #{filename}` for more options\n"
 
     if search_source_on_error
-      self.call(
+      call(
         source: Pathname(filename).read,
         filename: filename,
-        terminal: true,
+        terminal: true
       )
     end
 
-    $stderr.puts ""
-    $stderr.puts ""
     raise e
   end
 
-  def self.call(source: , filename: , terminal: false, record_dir: nil, timeout: TIMEOUT_DEFAULT, io: $stderr)
+  def self.call(source:, filename:, terminal: false, record_dir: nil, timeout: TIMEOUT_DEFAULT, io: $stderr)
     search = nil
     Timeout.timeout(timeout) do
       record_dir ||= ENV["DEBUG"] ? "tmp" : nil
@@ -82,13 +80,13 @@ module DeadEnd
   #   )                                    # => true
   #
   #   DeadEnd.valid?(code_lines) # => false
-  def self.valid_without?(without_lines: , code_lines:)
+  def self.valid_without?(without_lines:, code_lines:)
     lines = code_lines - Array(without_lines).flatten
 
     if lines.empty?
-      return true
+      true
     else
-      return valid?(lines)
+      valid?(lines)
     end
   end
 
@@ -137,7 +135,6 @@ module DeadEnd
     !invalid?(source)
   end
 
-
   def self.invalid_type(source)
     WhoDisSyntaxError.new(source).call
   end
@@ -145,14 +142,13 @@ end
 
 require_relative "code_line"
 require_relative "code_block"
+require_relative "code_search"
 require_relative "code_frontier"
-require_relative "display_invalid_blocks"
-require_relative "around_block_scan"
-require_relative "block_expand"
-require_relative "parse_blocks_from_indent_line"
+require_relative "clean_document"
 
-require_relative "code_search"
-require_relative "who_dis_syntax_error"
-require_relative "heredoc_block_parse"
 require_relative "lex_all"
-require_relative "trailing_slash_join"
+require_relative "block_expand"
+require_relative "around_block_scan"
+require_relative "who_dis_syntax_error"
+require_relative "display_invalid_blocks"
+require_relative "parse_blocks_from_indent_line"

data/lib/dead_end/lex_all.rb

@@ -8,20 +8,24 @@ module DeadEnd
   class LexAll
     include Enumerable
 
-    def initialize(source: )
+    def initialize(source:)
       @lex = Ripper.lex(source)
-      lineno = @lex.last&.first&.first + 1
+      lineno = @lex.last.first.first + 1
       source_lines = source.lines
       last_lineno = source_lines.count
 
       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.lex(lines.join, "-", lineno + 1))
+        lineno = @lex.last.first.first + 1
       end
 
-      @lex.map! {|(line, _), type, token, state| LexValue.new(line, _, type, token, state) }
+      @lex.map! { |(line, _), type, token, state| LexValue.new(line, type, token, state) }
+    end
+
+    def to_a
+      @lex
     end
 
     def each
@@ -31,34 +35,14 @@ module DeadEnd
       end
     end
 
-    def last
-      @lex.last
+    def [](index)
+      @lex[index]
     end
 
-    # Value object for accessing lex values
-    #
-    # This lex:
-    #
-    #   [1, 0], :on_ident, "describe", CMDARG
-    #
-    # Would translate into:
-    #
-    #  lex.line # => 1
-    #  lex.type # => :on_indent
-    #  lex.token # => "describe"
-    class LexValue
-      attr_reader :line, :type, :token, :state
-
-      def initialize(line, _, type, token, state)
-        @line = line
-        @type = type
-        @token = token
-        @state = state
-      end
-
-      def expr_label?
-        state.allbits?(Ripper::EXPR_LABEL)
-      end
+    def last
+      @lex.last
     end
   end
 end
+
+require_relative "lex_value"

data/lib/dead_end/lex_value.rb

@@ -0,0 +1,62 @@
+module DeadEnd
+  # Value object for accessing lex values
+  #
+  # This lex:
+  #
+  #   [1, 0], :on_ident, "describe", CMDARG
+  #
+  # Would translate into:
+  #
+  #  lex.line # => 1
+  #  lex.type # => :on_indent
+  #  lex.token # => "describe"
+  class LexValue
+    attr_reader :line, :type, :token, :state
+
+    def initialize(line, type, token, state)
+      @line = line
+      @type = type
+      @token = token
+      @state = state
+
+      set_kw_end
+    end
+
+    private def set_kw_end
+      @is_end = false
+      @is_kw = false
+      return if type != :on_kw
+
+      case token
+      when "if", "unless", "while", "until"
+        # Only count if/unless when it's not a "trailing" if/unless
+        # https://github.com/ruby/ruby/blob/06b44f819eb7b5ede1ff69cecb25682b56a1d60c/lib/irb/ruby-lex.rb#L374-L375
+        @is_kw = true unless expr_label?
+      when "def", "case", "for", "begin", "class", "module", "do"
+        @is_kw = true
+      when "end"
+        @is_end = true
+      end
+    end
+
+    def ignore_newline?
+      type == :on_ignored_nl
+    end
+
+    def is_end?
+      @is_end
+    end
+
+    def is_kw?
+      @is_kw
+    end
+
+    def expr_beg?
+      state.anybits?(Ripper::EXPR_BEG)
+    end
+
+    def expr_label?
+      state.allbits?(Ripper::EXPR_LABEL)
+    end
+  end
+end

data/lib/dead_end/parse_blocks_from_indent_line.rb

@@ -4,7 +4,7 @@ module DeadEnd
   # This class is responsible for generating initial code blocks
   # that will then later be expanded.
   #
-  # The biggest concern when guessing about code blocks, is accidentally
+  # The biggest concern when guessing code blocks, is accidentally
   # grabbing one that contains only an "end". In this example:
   #
   #   def dog
@@ -29,7 +29,7 @@ module DeadEnd
   class ParseBlocksFromIndentLine
     attr_reader :code_lines
 
-    def initialize(code_lines: )
+    def initialize(code_lines:)
       @code_lines = code_lines
     end
 
@@ -38,7 +38,7 @@ module DeadEnd
       scan = AroundBlockScan.new(code_lines: code_lines, block: CodeBlock.new(lines: target_line))
         .skip(:empty?)
         .skip(:hidden?)
-        .scan_while {|line| line.indent >= target_line.indent }
+        .scan_while { |line| line.indent >= target_line.indent }
 
       neighbors = scan.code_block.lines
 
@@ -53,4 +53,3 @@ module DeadEnd
     end
   end
 end
-

data/lib/dead_end/version.rb

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

data/lib/dead_end/who_dis_syntax_error.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
 module DeadEnd
-  # Determines what type of syntax error is in the source
+  # Determines what type of syntax error that is in the source
   #
   # Example:
   #
   #   puts WhoDisSyntaxError.new("def foo;").call.error_symbol
   #   # => :missing_end
   class WhoDisSyntaxError < Ripper
+    CHARACTERS = {"{": :"}", "}": :"{", "[": :"]", "]": :"[", "(": :")", ")": :"("}
     class Null
-      def error_symbol; :missing_end; end
-      def unmatched_symbol; :end ; end
+      def error_symbol
+        :missing_end
+      end
+
+      def unmatched_symbol
+        :end
+      end
     end
     attr_reader :error, :run_once
 
@@ -53,12 +59,20 @@ module DeadEnd
       when /expecting end-of-input/
         @unmatched_symbol = :end
         @error_symbol = :unmatched_syntax
-      when /unexpected .* expecting '(?<unmatched_symbol>.*)'/
-        @unmatched_symbol = $1.to_sym if $1
+      when /unexpected .* expecting ['`]?(?<unmatched_symbol>[^']*)/
+        if $1
+          character = $1.to_sym
+          @unmatched_symbol = CHARACTERS[character] || character
+          @unmatched_symbol = :end if @unmatched_symbol == :keyword_end
+        end
+        @error_symbol = :unmatched_syntax
+      when /unexpected '(?<unmatched_symbol>.*)'/
+        @unmatched_symbol = $1.to_sym
+        @unmatched_symbol = :end if @unmatched_symbol == :keyword_end
         @error_symbol = :unmatched_syntax
-      when /unexpected `end'/,          # Ruby 2.7 and 3.0
-           /unexpected end/,            # Ruby 2.6
-           /unexpected keyword_end/i    # Ruby 2.5
+      when /unexpected `end'/, # Ruby 2.7 and 3.0
+           /unexpected end/, # Ruby 2.6
+           /unexpected keyword_end/i # Ruby 2.5
 
         @error_symbol = :unmatched_syntax
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_end
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 2.0.1
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -23,7 +23,7 @@ files:
 - ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -38,8 +38,10 @@ files:
 - lib/dead_end.rb
 - lib/dead_end/around_block_scan.rb
 - lib/dead_end/auto.rb
+- lib/dead_end/banner.rb
 - lib/dead_end/block_expand.rb
 - lib/dead_end/capture_code_context.rb
+- lib/dead_end/clean_document.rb
 - lib/dead_end/code_block.rb
 - lib/dead_end/code_frontier.rb
 - lib/dead_end/code_line.rb
@@ -47,11 +49,10 @@ files:
 - lib/dead_end/display_code_with_line_numbers.rb
 - lib/dead_end/display_invalid_blocks.rb
 - lib/dead_end/fyi.rb
-- lib/dead_end/heredoc_block_parse.rb
 - lib/dead_end/internals.rb
 - lib/dead_end/lex_all.rb
+- lib/dead_end/lex_value.rb
 - lib/dead_end/parse_blocks_from_indent_line.rb
-- lib/dead_end/trailing_slash_join.rb
 - lib/dead_end/version.rb
 - lib/dead_end/who_dis_syntax_error.rb
 homepage: https://github.com/zombocom/dead_end.git
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Find syntax errors in your source in a snap

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4

data/lib/dead_end/heredoc_block_parse.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module DeadEnd
-  # Takes in a source, and returns blocks containing each heredoc
-  class HeredocBlockParse
-    private; attr_reader :code_lines, :lex; public
-
-    def initialize(source:, code_lines: )
-      @code_lines = code_lines
-      @lex = LexAll.new(source: source)
-    end
-
-    def call
-      blocks = []
-      beginning = []
-      @lex.each do |lex|
-        case lex.type
-        when :on_heredoc_beg
-          beginning << lex.line
-        when :on_heredoc_end
-          start_index = beginning.pop - 1
-          end_index = lex.line - 1
-          blocks << CodeBlock.new(lines: code_lines[start_index..end_index])
-        end
-      end
-
-      blocks
-    end
-  end
-end

data/lib/dead_end/trailing_slash_join.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module DeadEnd
-  # Handles code that contains trailing slashes
-  # by turning multiple lines with trailing slash(es) into
-  # a single code line
-  #
-  #   expect(code_lines.join).to eq(<<~EOM)
-  #     it "trailing \
-  #        "slash" do
-  #     end
-  #   EOM
-  #
-  #   lines = TrailngSlashJoin(code_lines: code_lines).call
-  #   expect(lines.first.to_s).to eq(<<~EOM)
-  #     it "trailing \
-  #        "slash" do
-  #   EOM
-  #
-  class TrailingSlashJoin
-    def initialize(code_lines:)
-      @code_lines = code_lines
-      @code_lines_dup = code_lines.dup
-    end
-
-    def call
-      @trailing_lines = []
-      @code_lines.select(&:trailing_slash?).each do |trailing|
-        stop_next = false
-        lines = @code_lines[trailing.index..-1].take_while do |line|
-          next false if stop_next
-
-          if !line.trailing_slash?
-            stop_next = true
-          end
-
-          true
-        end
-
-        joined_line = CodeLine.new(line: lines.map(&:original_line).join, index: trailing.index)
-
-        @code_lines_dup[trailing.index] = joined_line
-
-        @trailing_lines << joined_line
-
-        lines.shift # Don't hide first trailing slash line
-        lines.each(&:mark_invisible)
-      end
-
-      return @code_lines_dup
-    end
-  end
-end