dead_end 1.1.7 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49c72ccc76282ed1e7f9256f51f0adc1c886e1a05b3951e8f86d45eca0f22609
-  data.tar.gz: 2d1fc7eefe0fb741a516adf09ea5c5472d8f678572cc73858a3a1b4468b10457
+  metadata.gz: ec9e05716b47eb5d96ac063126a59977d98b8cf3e6f09ba0a0065d425a3c15e5
+  data.tar.gz: c78047c6dd36c1c716e1970e9bec5887bbcaf1fcc0341cbb5c11405043a07105
 SHA512:
-  metadata.gz: a4007362e70da478bb4590ad7196897b50fe4ab31bf384a4e4a80df44b906cee5faadf992a400a45d85e16b4864a42f17cc49490e8411020a4058310c088d84c
-  data.tar.gz: 1cd5eaa6385bf7e451801c33d13f89a69c6412608067dc8acc23d7955ecc8ca5796ae839b966767a37f12b48e0d280fb0a1946e9d5e24f92edf14b2913b36c68
+  metadata.gz: 2eca38b35ef1371cae5fd104fa88dad33d44b17cb6bf29b01b5dea0c650d3d21c0dfbf2b1ac96f0a6f307e7d541cf2a2f7be062d59f1626b16c82f1a2f7d3a3e
+  data.tar.gz: 1a09171cb208465cf48ff5ac0346240d5bf155aebb886c27b6259742f325bc58a0b73ec9998fcbb1544440e6df7363fa7ab57a04dba9e7887207f30916e8c3a9

data/.circleci/config.yml

@@ -7,6 +7,11 @@ references:
       name: Run test suite
       command: bundle exec rspec spec/
 
+  lint: &lint
+    run:
+      name: Run linter, fix with `standardrb --fix` locally
+      command: bundle exec standardrb
+
 jobs:
   "ruby-2-5":
     docker:
@@ -40,6 +45,14 @@ jobs:
       - ruby/install-deps
       - <<: *unit
 
+  "lint":
+    docker:
+      - image: circleci/ruby:3.0
+    steps:
+      - checkout
+      - ruby/install-deps
+      - <<: *lint
+
 workflows:
   version: 2
   build:
@@ -48,3 +61,4 @@ workflows:
       - "ruby-2-6"
       - "ruby-2-7"
       - "ruby-3-0"
+      - "lint"

data/.github/workflows/check_changelog.yml

@@ -1,13 +1,20 @@
 name: Check Changelog
 
 on:
- pull_request:
-  types: [opened, reopened, edited, synchronize]
+  pull_request:
+    types: [opened, reopened, edited, labeled, unlabeled, synchronize]
+
 jobs:
-  build:
+  check-changelog:
     runs-on: ubuntu-latest
+    if: |
+      !contains(github.event.pull_request.body, '[skip changelog]') &&
+      !contains(github.event.pull_request.body, '[changelog skip]') &&
+      !contains(github.event.pull_request.body, '[skip ci]') &&
+      !contains(github.event.pull_request.labels.*.name, 'skip changelog')
     steps:
-    - uses: actions/checkout@v1
-    - name: Check that CHANGELOG is touched
-      run: |
-        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md
+      - uses: actions/checkout@v2.3.5
+      - name: Check that CHANGELOG is touched
+        run: |
+          git fetch origin ${{ github.base_ref }} --depth 1 && \
+          git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.5.9

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## HEAD (unreleased)
 
+## 2.0.2
+
+- Don't print terminal color codes when output is not tty (https://github.com/zombocom/dead_end/pull/91)
+
+## 2.0.1
+
+- Reintroduce Ruby 2.5 support (https://github.com/zombocom/dead_end/pull/90)
+- Support naked braces/brackets/parens, invert labels on banner (https://github.com/zombocom/dead_end/pull/89)
+- Handle mismatched end when using rescue without begin (https://github.com/zombocom/dead_end/pull/83)
+- CLI returns non-zero exit code when syntax error is found (https://github.com/zombocom/dead_end/pull/86)
+- Let -v respond with gem version instead of 'unknown' (https://github.com/zombocom/dead_end/pull/82)
+
+## 2.0.0
+
+- Support "endless" oneline method definitions for Ruby 3+ (https://github.com/zombocom/dead_end/pull/80)
+- Reduce timeout to 1 second (https://github.com/zombocom/dead_end/pull/79)
+- Logically consecutive lines (such as chained methods are now joined) (https://github.com/zombocom/dead_end/pull/78)
+- Output improvement for cases where the only line is an single `end` (https://github.com/zombocom/dead_end/pull/78)
+
+## 1.2.0
+
+- Output improvements via less greedy unmatched kw capture https://github.com/zombocom/dead_end/pull/73
+- Remove NoMethodError patching instead use https://github.com/ruby/error_highlight/ (https://github.com/zombocom/dead_end/pull/71)
+
 ## 1.1.7
 
 - Fix sinatra support for `require_relative` (https://github.com/zombocom/dead_end/pull/63)

data/Gemfile

@@ -8,3 +8,4 @@ gemspec
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "stackprof"
+gem "standard"

data/Gemfile.lock

@@ -1,13 +1,20 @@
 PATH
   remote: .
   specs:
-    dead_end (1.1.7)
+    dead_end (2.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -21,7 +28,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
     stackprof (0.2.16)
+    standard (1.3.0)
+      rubocop (= 1.20.0)
+      rubocop-performance (= 1.11.5)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -31,6 +57,7 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
   stackprof
+  standard
 
 BUNDLED WITH
-   2.2.16
+   2.2.29

data/README.md

@@ -81,27 +81,9 @@ end
 
 As well as unmatched `|` and unmatched `}`. These errors can be time consuming to debug because Ruby often only tells you the last line in the file. The command `ruby -wc path/to/file.rb` can narrow it down a little bit, but this library does a better job.
 
-## What other errors does it handle?
-
-In addition to syntax errors, the NoMethodError is annotated to show the line where the error occured, and the surrounding context:
-
-```
-scratch.rb:7:in `call': undefined method `upcase' for nil:NilClass (NoMethodError)
-
-
-  1  class Pet
-  6    def call
-❯ 7      puts "Come here #{@neam.upcase}"
-  8    end
-  9  end
-```
-
 ## Sounds cool, but why isn't this baked into Ruby directly?
 
-I would love to get something like this directly in Ruby, but I first need to prove it's useful. The `did_you_mean` functionality started as a gem that was eventually adopted by a bunch of people and then Ruby core liked it enough that they included it in the source. The goal of this gem is to:
-
-1. Get real world useage and feedback. If we gave you an awful suggestion, let us know! We try to handle lots of cases well, but maybe we could be better.
-2. Prove out demand. If you like this idea, then vote for it by putting it in your Gemfile.
+We are now talking about it https://bugs.ruby-lang.org/issues/18159#change-93682.
 
 ## Artificial Inteligence?
 

data/Rakefile

@@ -5,4 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/dead_end.gemspec

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'lib/dead_end/version'
+require_relative "lib/dead_end/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "dead_end"
-  spec.version       = DeadEnd::VERSION
-  spec.authors       = ["schneems"]
-  spec.email         = ["richard.schneeman+foo@gmail.com"]
+  spec.name = "dead_end"
+  spec.version = DeadEnd::VERSION
+  spec.authors = ["schneems"]
+  spec.email = ["richard.schneeman+foo@gmail.com"]
 
-  spec.summary       = %q{Find syntax errors in your source in a snap}
-  spec.description   = %q{When you get an "unexpected end" in your syntax this gem helps you find it}
-  spec.homepage      = "https://github.com/zombocom/dead_end.git"
-  spec.license       = "MIT"
+  spec.summary = "Find syntax errors in your source in a snap"
+  spec.description = 'When you get an "unexpected end" in your syntax this gem helps you find it'
+  spec.homepage = "https://github.com/zombocom/dead_end.git"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|assets)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 end

data/exe/dead_end

@@ -1,11 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'pathname'
+require "pathname"
 require "optparse"
-require_relative "../lib/dead_end.rb"
+require_relative "../lib/dead_end"
 
 options = {}
-options[:terminal] = true
 options[:record_dir] = ENV["DEAD_END_RECORD_DIR"]
 
 parser = OptionParser.new do |opts|
@@ -35,6 +34,8 @@ parser = OptionParser.new do |opts|
     Options:
   EOM
 
+  opts.version = DeadEnd::VERSION
+
   opts.on("--help", "Help - displays this message") do |v|
     puts opts
     exit
@@ -44,6 +45,10 @@ parser = OptionParser.new do |opts|
     options[:record_dir] = v
   end
 
+  opts.on("--terminal", "Enable terminal highlighting") do |v|
+    options[:terminal] = true
+  end
+
   opts.on("--no-terminal", "Disable terminal highlighting") do |v|
     options[:terminal] = false
   end
@@ -60,11 +65,17 @@ end
 file = Pathname(file)
 options[:record_dir] = "tmp" if ENV["DEBUG"]
 
-$stderr.puts "Record dir: #{options[:record_dir]}"  if options[:record_dir]
+warn "Record dir: #{options[:record_dir]}" if options[:record_dir]
 
-DeadEnd.call(
+display = DeadEnd.call(
   source: file.read,
   filename: file.expand_path,
-  terminal: options[:terminal],
+  terminal: options.fetch(:terminal, DeadEnd::DEFAULT_VALUE),
   record_dir: options[:record_dir]
 )
+
+if display.document_ok?
+  exit(0)
+else
+  exit(1)
+end

data/lib/dead_end/around_block_scan.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-#
+
 module DeadEnd
   # This class is useful for exploring contents before and after
   # a block
@@ -9,10 +9,10 @@ module DeadEnd
   #
   # Example:
   #
-  #   def dog
-  #     puts "bark"
-  #     puts "bark"
-  #   end
+  #   def dog         # 1
+  #     puts "bark"   # 2
+  #     puts "bark"   # 3
+  #   end             # 4
   #
   #   scan = AroundBlockScan.new(
   #     code_lines: code_lines
@@ -22,13 +22,13 @@ module DeadEnd
   #   scan.scan_while { true }
   #
   #   puts scan.before_index # => 0
-  #   puts scan.after_index # => 3
+  #   puts scan.after_index  # => 3
   #
   # Contents can also be filtered using AroundBlockScan#skip
   #
   # To grab the next surrounding indentation use AroundBlockScan#scan_adjacent_indent
   class AroundBlockScan
-    def initialize(code_lines: , block:)
+    def initialize(code_lines:, block:)
       @code_lines = code_lines
       @orig_before_index = block.lines.first.index
       @orig_after_index = block.lines.last.index
@@ -56,7 +56,7 @@ module DeadEnd
       end_count = 0
       @before_index = before_lines.reverse_each.take_while do |line|
         next false if stop_next
-        next true if @skip_array.detect {|meth| line.send(meth) }
+        next true if @skip_array.detect { |meth| line.send(meth) }
 
         kw_count += 1 if line.is_kw?
         end_count += 1 if line.is_end?
@@ -65,14 +65,14 @@ module DeadEnd
         end
 
         block.call(line)
-      end.reverse.first&.index
+      end.last&.index
 
       stop_next = false
       kw_count = 0
       end_count = 0
       @after_index = after_lines.take_while do |line|
         next false if stop_next
-        next true if @skip_array.detect {|meth| line.send(meth) }
+        next true if @skip_array.detect { |meth| line.send(meth) }
 
         kw_count += 1 if line.is_kw?
         end_count += 1 if line.is_end?
@@ -89,7 +89,7 @@ module DeadEnd
       lines = []
       kw_count = 0
       end_count = 0
-      before_lines.reverse.each do |line|
+      before_lines.reverse_each do |line|
         next if line.empty?
         break if line.indent < @orig_indent
         next if line.indent != @orig_indent
@@ -109,8 +109,6 @@ module DeadEnd
       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
@@ -124,14 +122,13 @@ module DeadEnd
 
         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|
+      before_lines.reverse_each do |line|
         next if line.empty?
         if line.indent < last_indent
           yield line
@@ -150,7 +147,7 @@ module DeadEnd
     end
 
     def scan_neighbors
-      self.scan_while {|line| line.not_empty? && line.indent >= @orig_indent }
+      scan_while { |line| line.not_empty? && line.indent >= @orig_indent }
     end
 
     def next_up
@@ -167,13 +164,14 @@ module DeadEnd
       before_after_indent << (next_down&.indent || 0)
 
       indent = before_after_indent.min
-      self.scan_while {|line| line.not_empty? && line.indent >= indent }
+      scan_while { |line| line.not_empty? && line.indent >= indent }
 
       self
     end
 
     def start_at_next_line
-      before_index; after_index
+      before_index
+      after_index
       @before_index -= 1
       @after_index += 1
       self

data/lib/dead_end/auto.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-#
+
 require_relative "../dead_end/internals"
 
 # Monkey patch kernel to ensure that all `require` calls call the same
@@ -40,6 +40,7 @@ end
 # am I doing something different?
 class Object
   private
+
   def load(path, wrap = false)
     Kernel.load(path, wrap)
   rescue SyntaxError => e
@@ -52,53 +53,3 @@ class Object
     DeadEnd.handle_error(e)
   end
 end
-
-module DeadEnd
-  IsProduction = -> {
-    ENV["RAILS_ENV"] == "production" || ENV["RACK_ENV"] == "production"
-  }
-end
-
-# Unlike a syntax error, a NoMethodError can occur hundreds or thousands of times and
-# chew up CPU and other resources. Since this is primarilly a "development" optimization
-# we can attempt to disable this behavior in a production context.
-if !DeadEnd::IsProduction.call
-  class NoMethodError
-    alias :dead_end_original_to_s :to_s
-
-    def to_s
-      return super if DeadEnd::IsProduction.call
-
-      file, line, _ = backtrace[0].split(":")
-      return super if !File.exist?(file)
-
-      index = line.to_i - 1
-      source = File.read(file)
-      code_lines = DeadEnd::CodeLine.parse(source)
-
-      block = DeadEnd::CodeBlock.new(lines: code_lines[index])
-      lines = DeadEnd::CaptureCodeContext.new(
-        blocks: block,
-        code_lines: code_lines
-      ).call
-
-      message = super.dup
-      message << $/
-      message << $/
-
-      message << DeadEnd::DisplayCodeWithLineNumbers.new(
-        lines: lines,
-        highlight_lines: block.lines,
-        terminal: self.class.to_tty?
-      ).call
-
-      message << $/
-      message
-    rescue => e
-      puts "DeadEnd Internal error: #{e.dead_end_original_to_s}"
-      puts "DeadEnd Internal backtrace:"
-      puts backtrace.map {|l| "    " + l }.join($/)
-      super
-    end
-  end
-end

data/lib/dead_end/banner.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module DeadEnd
+  class Banner
+    attr_reader :invalid_obj
+
+    def initialize(invalid_obj:)
+      @invalid_obj = invalid_obj
+    end
+
+    def call
+      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 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 *WhoDisSyntaxError::CHARACTERS.keys
+          <<~EOM
+            DeadEnd: Unmatched `#{unmatched_symbol}` character detected
+
+            It appears a `#{missing_character}` might be missing.
+          EOM
+        else
+          "DeadEnd: Unmatched `#{unmatched_symbol}` detected"
+        end
+      end
+    end
+
+    private def unmatched_symbol
+      invalid_obj.unmatched_symbol
+    end
+
+    private def missing_character
+      WhoDisSyntaxError::CHARACTERS[unmatched_symbol]
+    end
+  end
+end

data/lib/dead_end/block_expand.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module DeadEnd
   # This class is responsible for taking a code block that exists
   # at a far indentaion and then iteratively increasing the block
@@ -30,7 +31,7 @@ module DeadEnd
   #      end
   #
   class BlockExpand
-    def initialize(code_lines: )
+    def initialize(code_lines:)
       @code_lines = code_lines
     end
 
@@ -43,7 +44,7 @@ module DeadEnd
     end
 
     def expand_indent(block)
-      block = AroundBlockScan.new(code_lines: @code_lines, block: block)
+      AroundBlockScan.new(code_lines: @code_lines, block: block)
         .skip(:hidden?)
         .stop_after_kw
         .scan_adjacent_indent
@@ -59,15 +60,15 @@ module DeadEnd
       # Slurp up empties
       if grab_empty
         scan = AroundBlockScan.new(code_lines: @code_lines, block: scan.code_block)
-          .scan_while {|line| line.empty? || line.hidden? }
+          .scan_while { |line| line.empty? || line.hidden? }
       end
 
       new_block = scan.code_block
 
       if block.lines == new_block.lines
-        return nil
+        nil
       else
-        return new_block
+        new_block
       end
     end
   end