syntax_suggest 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 338fe09b04529ea04747cadd14a39b290802d6c524f1484b8a80fbaacd1ae7e5
-  data.tar.gz: 507b73a5e7fd07872db31ced86da79b0de641036bbff0ffd92fd24bb5686a10a
+  metadata.gz: 930f25a74c71bd7440dfe5cb89a57216414fef8110eae8786bddc9396b542dff
+  data.tar.gz: cb679eceb6f2ee38ec68f84f1745aefa5dff73450f5b7ad835b8a05b531d1023
 SHA512:
-  metadata.gz: 1e58c6b3bff188226bce33e89f85ce909794a2ee92317d8c86e59d25b442c7ff92ef8e19e8bee6cfcd80d1415f15f086a8c197ccf705e833a65feb4d4e0a0cbe
-  data.tar.gz: f4b6078565ec509cec459355bdabe4e799e1a7a2857361a71e060d6d9ce02daaa3595c7459bead91874fbdacca26f0517d7984240613269baa718853c631daa6
+  metadata.gz: 68bc380be685aaf34df8992c8fdc599ac3e4cd3367e13c7d014acbf4b82c50edff1e684964f8d6f7503a9408095160ea47b5573bb901fbce2d6ac1e9e7fdd455
+  data.tar.gz: 15c6acaf604d5d4f4bdabea04a6cfad1310214c20f9581397d87a03c67d3079ea26c8924d4f3258b59925105d304f9b7ded5dd0e65e959e691cc8a342588006f

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+      - name: Linting
+        run: bundle exec standardrb
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - "3.2.0-preview1"
+          - head
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: test
+        run: bundle exec rake test
+        continue-on-error: ${{ matrix.ruby == 'head' }}

data/CHANGELOG.md

@@ -1,48 +1,52 @@
 ## HEAD (unreleased)
 
+## 1.0.0 (Library renamed to syntax_suggest )
+
+- [Breaking] Output "Syntax OK" will no longer be output when `syntax_suggest` is fired due to a syntax error. (https://github.com/ruby/syntax_suggest/pull/158)
 - [Breaking] Rename `dead_end` to `syntax_suggest` (https://github.com/zombocom/dead_end/pull/154)
 - [Breaking] Lazy loading moved from `autoload` to manually checking for constants and requiring `dead_end/api`. To manually use any SyntaxSuggest internals you MUST require `dead_end/api`, otherwise it will be lazy loaded on syntax error (https://github.com/zombocom/dead_end/pull/148)
 - Default to highlighted output on Ruby 3.2 (https://github.com/zombocom/dead_end/pull/150)
 - Debug functionality enabled by `DEBUG=1` env var is now under `SYNTAX_SUGGEST_DEBUG=1`. Note this is not a stable interface or feature. Output content is subject to change without major version change (https://github.com/zombocom/dead_end/pull/149)
 - Enable/Disable dead_end by using the `dead_end` kwarg in `detailed_message` (https://github.com/zombocom/dead_end/pull/147)
 - Respect `highlight` kwarg in Ruby 3.2's `detailed_message` to enable/disable control characters (https://github.com/zombocom/dead_end/pull/147)
+- Added workarounds for running on ruby/ruby repo (https://github.com/ruby/syntax_suggest/pull/156)
 
-## 4.0.0
+## dead_end 4.0.0
 
 - Code that does not have an associated file (eval and streamed) no longer produce a warning saying that the file could not be found. To produce a warning with these code types run with DEBUG=1 environment variable. (https://github.com/zombocom/dead_end/pull/143)
 - [Breaking] Lazy load SyntaxSuggest internals only if there is a Syntax error. Use `require "dead_end"; require "dead_end/api"` to load eagerly all internals. Otherwise `require "dead_end"` will set up an autoload for the first time the SyntaxSuggest module is used in code. This should only happen on a syntax error. (https://github.com/zombocom/dead_end/pull/142)
 - Monkeypatch `SyntaxError#detailed_message` in Ruby 3.2+ instead of `require`, `load`, and `require_relative` (https://github.com/zombocom/dead_end/pull/139)
 
-## 3.1.2
+## dead_end 3.1.2
 
 - Fixed internal class AroundBlockScan, minor changes in outputs (https://github.com/zombocom/dead_end/pull/131)
 
-## 3.1.1
+## dead_end 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
+## dead_end 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 `SyntaxSuggest.handle_error` is declared public and stable (https://github.com/zombocom/dead_end/pull/119)
 
-## 3.0.3
+## dead_end 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
+## dead_end 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
+## dead_end 3.0.1
 
 - Fix CLI parsing when flags come before filename (https://github.com/zombocom/dead_end/pull/102)
 
-## 3.0.0
+## dead_end 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)
@@ -53,11 +57,11 @@
   - 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
+## dead_end 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
+## dead_end 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)
@@ -65,94 +69,94 @@
 - 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
+## dead_end 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
+## dead_end 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
+## dead_end 1.1.7
 
 - Fix sinatra support for `require_relative` (https://github.com/zombocom/dead_end/pull/63)
 
-## 1.1.6
+## dead_end 1.1.6
 
 - Consider if syntax error caused an unexpected variable instead of end (https://github.com/zombocom/dead_end/pull/58)
 
-## 1.1.5
+## dead_end 1.1.5
 
 - Parse error once and not twice if there's more than one available (https://github.com/zombocom/dead_end/pull/57)
 
-## 1.1.4
+## dead_end 1.1.4
 
 - Avoid including demo gif in built gem (https://github.com/zombocom/dead_end/pull/53)
 
-## 1.1.3
+## dead_end 1.1.3
 
 - Add compatibility with zeitwerk (https://github.com/zombocom/dead_end/pull/52)
 
-## 1.1.2
+## dead_end 1.1.2
 
 - Namespace Kernel method aliases (https://github.com/zombocom/dead_end/pull/51)
 
-## 1.1.1
+## dead_end 1.1.1
 
 - Safer NoMethodError annotation (https://github.com/zombocom/dead_end/pull/48)
 
-## 1.1.0
+## dead_end 1.1.0
 
 - Annotate NoMethodError in non-production environments (https://github.com/zombocom/dead_end/pull/46)
 - Do not count trailing if/unless as a keyword (https://github.com/zombocom/dead_end/pull/44)
 
-## 1.0.2
+## dead_end 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
+## dead_end 1.0.1
 
 - Fix performance issue when evaluating multiple block combinations (https://github.com/zombocom/dead_end/pull/35)
 
-## 1.0.0
+## dead_end 1.0.0
 
 - Gem name changed from `syntax_search` to `dead_end` (https://github.com/zombocom/syntax_search/pull/30)
 - Moved `syntax_search/auto` behavior to top level require (https://github.com/zombocom/syntax_search/pull/30)
 - Error banner now indicates when missing a `|` or `}` in addition to `end` (https://github.com/zombocom/syntax_search/pull/29)
 - Trailing slashes are now handled (joined) before the code search (https://github.com/zombocom/syntax_search/pull/28)
 
-## 0.2.0
+## dead_end 0.2.0
 
 - Simplify large file output so minimal context around the invalid section is shown (https://github.com/zombocom/syntax_search/pull/26)
 - Block expansion is now lexically aware of keywords (def/do/end etc.) (https://github.com/zombocom/syntax_search/pull/24)
 - Fix bug where not all of a source is lexed which is used in heredoc detection/removal (https://github.com/zombocom/syntax_search/pull/23)
 
-## 0.1.5
+## dead_end 0.1.5
 
 - Strip out heredocs in documents first (https://github.com/zombocom/syntax_search/pull/19)
 
-## 0.1.4
+## dead_end 0.1.4
 
 - Parser gem replaced with Ripper (https://github.com/zombocom/syntax_search/pull/17)
 
-## 0.1.3
+## dead_end 0.1.3
 
 - Internal refactor (https://github.com/zombocom/syntax_search/pull/13)
 
-## 0.1.2
+## dead_end 0.1.2
 
 - Codeblocks in output are now indented with 4 spaces and "code fences" are removed (https://github.com/zombocom/syntax_search/pull/11)
 - "Unmatched end" and "missing end" not generate different error text instructions (https://github.com/zombocom/syntax_search/pull/10)
 
-## 0.1.1
+## dead_end 0.1.1
 
 - Fire search on both unexpected end-of-input and unexected end (https://github.com/zombocom/syntax_search/pull/8)
 
-## 0.1.0
+## dead_end 0.1.0
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_suggest (0.0.1)
+    syntax_suggest (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -11,6 +11,8 @@ Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?
   5  end
 ```
 
+> This project was previously named `dead_end` as it attempted to find dangling `end` keywords. The name was changed to be more descriptive and welcoming as part of the effort to merge it into [Ruby 3.2](https://bugs.ruby-lang.org/issues/18159#note-29).
+
 ## Installation in your codebase
 
 To automatically annotate errors when they happen, add this to your Gemfile:

data/Rakefile

@@ -6,3 +6,4 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+task test: :spec

data/lib/syntax_suggest/capture_code_context.rb

@@ -137,7 +137,7 @@ module SyntaxSuggest
     #       puts "woof" # 3
     #   end             # 4
     #
-    # However due to https://github.com/zombocom/syntax_suggest/issues/32
+    # However due to https://github.com/ruby/syntax_suggest/issues/32
     # the problem line will be identified as:
     #
     #  ❯ class Dog       # 1

data/lib/syntax_suggest/cli.rb

@@ -65,6 +65,7 @@ module SyntaxSuggest
       )
 
       if display.document_ok?
+        @io.puts "Syntax OK"
         @exit_obj.exit(0)
       else
         @exit_obj.exit(1)

data/lib/syntax_suggest/display_invalid_blocks.rb

@@ -23,7 +23,6 @@ module SyntaxSuggest
 
     def call
       if document_ok?
-        @io.puts "Syntax OK"
         return self
       end
 

data/lib/syntax_suggest/pathname_from_message.rb

@@ -4,7 +4,7 @@ module SyntaxSuggest
   # 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/syntax_suggest/issues/111
+  # such as on a windows file system: https://github.com/ruby/syntax_suggest/issues/111
   #
   # Example:
   #

data/lib/syntax_suggest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxSuggest
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/{dead_end.gemspec → syntax_suggest.gemspec}

@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
 
   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/syntax_suggest.git"
+  spec.homepage = "https://github.com/ruby/syntax_suggest.git"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/zombocom/syntax_suggest.git"
+  spec.metadata["source_code_uri"] = "https://github.com/ruby/syntax_suggest.git"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_suggest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -19,8 +19,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/workflows/check_changelog.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".standard.yml"
@@ -33,7 +33,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- dead_end.gemspec
 - exe/syntax_suggest
 - lib/syntax_suggest.rb
 - lib/syntax_suggest/api.rb
@@ -60,12 +59,13 @@ files:
 - lib/syntax_suggest/ripper_errors.rb
 - lib/syntax_suggest/unvisited_lines.rb
 - lib/syntax_suggest/version.rb
-homepage: https://github.com/zombocom/syntax_suggest.git
+- syntax_suggest.gemspec
+homepage: https://github.com/ruby/syntax_suggest.git
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/zombocom/syntax_suggest.git
-  source_code_uri: https://github.com/zombocom/syntax_suggest.git
+  homepage_uri: https://github.com/ruby/syntax_suggest.git
+  source_code_uri: https://github.com/ruby/syntax_suggest.git
 post_install_message:
 rdoc_options: []
 require_paths:

data/.circleci/config.yml

@@ -1,91 +0,0 @@
-version: 2.1
-orbs:
-  ruby: circleci/ruby@1.8.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:
-      - image: circleci/ruby:2.5
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-
-  "ruby-2-6":
-    docker:
-      - image: circleci/ruby:2.6
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-
-  "ruby-2-7":
-    docker:
-      - image: circleci/ruby:2.7
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-
-  "ruby-3-0":
-    docker:
-      - image: circleci/ruby:3.0
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-
-  "ruby-3-1":
-    docker:
-      - image: 'cimg/ruby:3.1'
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-
-  "ruby-3-2":
-    docker:
-      - image: 'ruby:3.2.0-preview1'
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-  "ruby-3-2-yjit":
-    docker:
-      - image: 'ruby:3.2.0-preview1'
-    steps:
-      - run: echo "export RUBY_YJIT_ENABLE=1" >> $BASH_ENV
-      - checkout
-      - ruby/install-deps
-      - <<: *unit
-
-  "lint":
-    docker:
-      - image: circleci/ruby:3.0
-    steps:
-      - checkout
-      - ruby/install-deps
-      - <<: *lint
-
-workflows:
-  version: 2
-  build:
-    jobs:
-      - "ruby-2-5"
-      - "ruby-2-6"
-      - "ruby-2-7"
-      - "ruby-3-0"
-      - "ruby-3-1"
-      - "ruby-3-2"
-      - "ruby-3-2-yjit"
-      - "lint"