dead_end 1.1.7 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49c72ccc76282ed1e7f9256f51f0adc1c886e1a05b3951e8f86d45eca0f22609
-  data.tar.gz: 2d1fc7eefe0fb741a516adf09ea5c5472d8f678572cc73858a3a1b4468b10457
+  metadata.gz: 64abeaee0636d3ded8df0f0dc124674a70f954287b37302dff7151f04b746557
+  data.tar.gz: 02e6eea73a9e9e832b898f9294c1ce3f7f38f9b8996554a8f6527abf7027d115
 SHA512:
-  metadata.gz: a4007362e70da478bb4590ad7196897b50fe4ab31bf384a4e4a80df44b906cee5faadf992a400a45d85e16b4864a42f17cc49490e8411020a4058310c088d84c
-  data.tar.gz: 1cd5eaa6385bf7e451801c33d13f89a69c6412608067dc8acc23d7955ecc8ca5796ae839b966767a37f12b48e0d280fb0a1946e9d5e24f92edf14b2913b36c68
+  metadata.gz: e7381458f44ef92f5053ac3171ac8bc59e89a805d793dde1c48ce1eda855dcea624ef6dc7a1faa3da9c20abc53983675fc66a7b08e3e02893801b4b4ff0edf65
+  data.tar.gz: 8b92dee56fac32777f31b76e25a0b778b2a4ffa1ff6914f24ef835bbf5ab79898f4a3a5607a9bebc641f86b05f2a88224504f0f8aaab83c3262b1d067ea32af0

data/.circleci/config.yml

@@ -1,12 +1,17 @@
 version: 2.1
 orbs:
-  ruby: circleci/ruby@1.1.2
+  ruby: circleci/ruby@1.2.0
 references:
   unit: &unit
     run:
       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,25 @@ jobs:
       - ruby/install-deps
       - <<: *unit
 
+  "ruby-3-1":
+    docker:
+      - image: 'cimg/base:stable'
+    steps:
+      - checkout
+      - ruby/install:
+          version: '3.1.0-preview1'
+      - run: ruby -v
+      - ruby/install-deps
+      - <<: *unit
+
+  "lint":
+    docker:
+      - image: circleci/ruby:3.0
+    steps:
+      - checkout
+      - ruby/install-deps
+      - <<: *lint
+
 workflows:
   version: 2
   build:
@@ -48,3 +72,5 @@ workflows:
       - "ruby-2-6"
       - "ruby-2-7"
       - "ruby-3-0"
+      - "ruby-3-1"
+      - "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,65 @@
 ## HEAD (unreleased)
 
+## 3.1.1
+
+- Fix case where Ripper lexing identified incorrect code as a keyword (https://github.com/zombocom/dead_end/pull/122)
+
+## 3.1.0
+
+- Add support for Ruby 3.1 by updating `require_relative` logic (https://github.com/zombocom/dead_end/pull/120)
+- Requiring `dead_end/auto` is now deprecated please require `dead_end` instead (https://github.com/zombocom/dead_end/pull/119)
+- Requiring `dead_end/api` now loads code without monkeypatching core extensions (https://github.com/zombocom/dead_end/pull/119)
+- The interface `DeadEnd.handle_error` is declared public and stable (https://github.com/zombocom/dead_end/pull/119)
+
+## 3.0.3
+
+- Expand explanations coming from additional Ripper errors (https://github.com/zombocom/dead_end/pull/117)
+- Fix explanation involving shorthand syntax for literals like `%w[]` and `%Q{}` (https://github.com/zombocom/dead_end/pull/116)
+
+## 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)
+- DeadEnd is now fired on EVERY syntax error (https://github.com/zombocom/dead_end/pull/94)
+- Output format changes:
+  - Parse errors emitted per-block rather than for the whole document (https://github.com/zombocom/dead_end/pull/94)
+  - The "banner" is now based on lexical analysis rather than parser regex (fix #68, fix #87) (https://github.com/zombocom/dead_end/pull/96)
+
+## 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/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

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

data/Gemfile.lock

@@ -1,13 +1,20 @@
 PATH
   remote: .
   specs:
-    dead_end (1.1.7)
+    dead_end (3.1.1)
 
 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,27 @@ 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-prof (1.4.3)
+    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
@@ -30,7 +57,9 @@ DEPENDENCIES
   dead_end!
   rake (~> 12.0)
   rspec (~> 3.0)
+  ruby-prof
   stackprof
+  standard
 
 BUNDLED WITH
-   2.2.16
+   2.3.4

data/README.md

@@ -2,19 +2,14 @@
 
 An error in your code forces you to stop. DeadEnd helps you find those errors to get you back on your way faster.
 
-    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.
-
-    file: path/to/dog.rb
-    simplified:
+```
+Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?
 
-       3  class Dog
-    ❯  5    defbark
-    ❯  7    end
-      12  end
+  1  class Dog
+❯ 2    defbark
+❯ 4    end
+  5  end
+```
 
 ## Installation in your codebase
 
@@ -50,58 +45,112 @@ 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:
+
 - Missing `end`:
 
+<!--
 ```ruby
 class Dog
   def bark
     puts "bark"
-
-  def woof
-    puts "woof"
-  end
 end
-# => scratch.rb:8: syntax error, unexpected end-of-input, expecting `end'
 ```
+-->
 
-- Unexpected `end`
+```
+Unmatched keyword, missing `end' ?
 
+❯ 1  class Dog
+❯ 2    def bark
+❯ 4  end
+```
+
+- Missing keyword
+<!--
 ```ruby
 class Dog
   def speak
-    @sounds.each |sound| # Note the missing `do` here
+    @sounds.each |sound|
       puts sound
     end
   end
 end
-# => scratch.rb:7: syntax error, unexpected `end', expecting end-of-input
+```
+-->
+
+```
+Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?
+
+  1  class Dog
+  2    def speak
+❯ 3      @sounds.each |sound|
+❯ 5      end
+  6    end
+  7  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.
+- Missing pair characters (like `{}`, `[]`, `()` , or `|<var>|`)
+<!--
 
-## What other errors does it handle?
+```ruby
+class Dog
+  def speak(sound
+    puts sound
+  end
+end
+```
+-->
 
-In addition to syntax errors, the NoMethodError is annotated to show the line where the error occured, and the surrounding context:
+```
+Unmatched `(', missing `)' ?
 
+  1  class Dog
+❯ 2    def speak(sound
+❯ 4    end
+  5  end
 ```
-scratch.rb:7:in `call': undefined method `upcase' for nil:NilClass (NoMethodError)
 
+- Any ambiguous or unknown errors will be annotated by the original ripper error output:
+
+<!--
+class Dog
+  def meals_last_month
+    puts 3 *
+  end
+end
+-->
 
-  1  class Pet
-  6    def call
-❯ 7      puts "Come here #{@neam.upcase}"
-  8    end
-  9  end
 ```
+syntax error, unexpected end-of-input
 
-## Sounds cool, but why isn't this baked into Ruby directly?
+  1  class Dog
+  2    def meals_last_month
+❯ 3      puts 3 *
+  4    end
+  5  end
+```
 
-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:
+## How is it better than `ruby -wc`?
 
-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.
+Ruby allows you to syntax check a file with warnings using `ruby -wc`. This emits a parser error instead of a human focused error. Ruby's parse errors attempt to narrow down the location and can tell you if there is a glaring indentation error involving `end`.
+
+The `dead_end` algorithm doesn't just guess at the location of syntax errors, it re-parses the document to prove that it captured them.
+
+This library focuses on the human side of syntax errors. It cares less about why the document could not be parsed (computer problem) and more on what the programmer needs (human problem) to fix the problem.
+
+## Sounds cool, but why isn't this baked into Ruby directly?
+
+We are now talking about it https://bugs.ruby-lang.org/issues/18159#change-93682.
 
 ## Artificial Inteligence?
 
@@ -117,15 +166,53 @@ Here's an example:
 
 ![](assets/syntax_search.gif)
 
+## Use internals
+
+To use the `dead_end` gem without monkeypatching you can  `require 'dead_en/api'`. This will allow you to load `dead_end` and use its internals without mutating `require`.
+
+Stable internal interface(s):
+
+- `DeadEnd.handle_error(e)`
+
+Any other entrypoints are subject to change without warning. If you want to use an internal interface from `dead_end` not on this list, open an issue to explain your use case.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### How to debug changes to output display
+
+You can see changes to output against a variety of invalid code by running specs and using the `DEBUG_DISPLAY=1` environment variable. For example:
+
+```
+$ DEBUG_DISPLAY=1 bundle exec rspec spec/ --format=failures
+```
+
+### Run profiler
+
+You can output profiler data to the `tmp` directory by running:
+
+```
+$ DEBUG_PERF=1 bundle exec rspec spec/integration/dead_end_spec.rb
+```
+
+Some outputs are in text format, some are html, the raw marshaled data is available in `raw.rb.marshal`. See https://ruby-prof.github.io/#reports for more info. One interesting one, is the "kcachegrind" interface. To view this on mac:
+
+```
+$ brew install qcachegrind
+```
+
+Open:
+
+```
+$ 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
@@ -134,4 +221,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/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,70 +1,7 @@
 #!/usr/bin/env ruby
 
-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|
-  opts.banner = <<~EOM
-    Usage: dead_end <file> [options]
-
-    Parses a ruby source file and searches for syntax error(s) such as
-    unexpected `end', expecting end-of-input.
-
-    Example:
-
-      $ dead_end dog.rb
-
-      # ...
-
-        ❯ 10  defdog
-        ❯ 15  end
-        ❯ 16
-
-    Env options:
-
-      DEAD_END_RECORD_DIR=<dir>
-
-      When enabled, records the steps used to search for a syntax error to the
-      given directory
-
-    Options:
-  EOM
-
-  opts.on("--help", "Help - displays this message") do |v|
-    puts opts
-    exit
-  end
-
-  opts.on("--record <dir>", "When enabled, records the steps used to search for a syntax error to the given directory") do |v|
-    options[:record_dir] = v
-  end
-
-  opts.on("--no-terminal", "Disable terminal highlighting") do |v|
-    options[:terminal] = false
-  end
-end
-parser.parse!
-
-file = ARGV[0]
-
-if file.nil? || file.empty?
-  # Display help if raw command
-  parser.parse! %w[--help]
-end
-
-file = Pathname(file)
-options[:record_dir] = "tmp" if ENV["DEBUG"]
-
-$stderr.puts "Record dir: #{options[:record_dir]}"  if options[:record_dir]
-
-DeadEnd.call(
-  source: file.read,
-  filename: file.expand_path,
-  terminal: options[:terminal],
-  record_dir: options[:record_dir]
-)
+DeadEnd::Cli.new(
+  argv: ARGV
+).call