syntax_suggest 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 930f25a74c71bd7440dfe5cb89a57216414fef8110eae8786bddc9396b542dff
-  data.tar.gz: cb679eceb6f2ee38ec68f84f1745aefa5dff73450f5b7ad835b8a05b531d1023
+  metadata.gz: f3c694e7b419ea1a715d2cccf55e706be86035c2563e2f4506769da76829a65a
+  data.tar.gz: a42f42ceb34fc29e0534072cc25e27e7b416c7a954ec6ccdc75c5748db491e22
 SHA512:
-  metadata.gz: 68bc380be685aaf34df8992c8fdc599ac3e4cd3367e13c7d014acbf4b82c50edff1e684964f8d6f7503a9408095160ea47b5573bb901fbce2d6ac1e9e7fdd455
-  data.tar.gz: 15c6acaf604d5d4f4bdabea04a6cfad1310214c20f9581397d87a03c67d3079ea26c8924d4f3258b59925105d304f9b7ded5dd0e65e959e691cc8a342588006f
+  metadata.gz: 755b4e3e2a5bb86ae61b4f29417a0a4f6531dbe5866ce32d56e0cb2452496fb858469bbeb3aa369ca953814e475cb52e93c2273eb54ec203cff98520d10bac07
+  data.tar.gz: 178a7ecd8a04d8f53f1778a331400273a2980f42451942012c3e98d5171ab30c590e76eaf69b6c78d7c63274f8040cce2e4e4f85ad35601c34fe46149420aa44

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/check_changelog.yml

@@ -13,7 +13,7 @@ jobs:
       !contains(github.event.pull_request.body, '[skip ci]') &&
       !contains(github.event.pull_request.labels.*.name, 'skip changelog')
     steps:
-      - uses: actions/checkout@v2.3.5
+      - uses: actions/checkout@v3.2.0
       - name: Check that CHANGELOG is touched
         run: |
           git fetch origin ${{ github.base_ref }} --depth 1 && \

data/.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.2.0
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -29,11 +29,11 @@ jobs:
           - 2.7
           - '3.0'
           - 3.1
-          - "3.2.0-preview1"
+          - "3.2.0-rc1"
           - head
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.2.0
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## HEAD (unreleased)
 
+## 1.0.2
+
+- Drop support or Ruby 3.2.0 preview, now that 3.2.0-rc1 is available (https://github.com/ruby/syntax_suggest/pull/165)
+- Native support of `SyntaxError#path`, support 3.2.0-preview3 will be dropped with the release of 3.2.0-preview4 (https://github.com/ruby/syntax_suggest/pull/164)
+- Added dependabot for GitHub Actions (https://github.com/ruby/syntax_suggest/pull/160)
+
+## 1.0.1
+
+- Replace `❯` with `>` in error output for compatability with more fonts (https://github.com/ruby/syntax_suggest/pull/161)
+
 ## 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)

data/Gemfile.lock

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

data/README.md

@@ -6,8 +6,8 @@ An error in your code forces you to stop. SyntaxSuggest helps you find those err
 Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?
 
   1  class Dog
-❯ 2    defbark
-❯ 4    end
+> 2    defbark
+> 4    end
   5  end
 ```
 
@@ -72,9 +72,9 @@ end
 ```
 Unmatched keyword, missing `end' ?
 
-❯ 1  class Dog
-❯ 2    def bark
-❯ 4  end
+> 1  class Dog
+> 2    def bark
+> 4  end
 ```
 
 - Missing keyword
@@ -95,8 +95,8 @@ Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?
 
   1  class Dog
   2    def speak
-❯ 3      @sounds.each |sound|
-❯ 5      end
+> 3      @sounds.each |sound|
+> 5      end
   6    end
   7  end
 ```
@@ -117,8 +117,8 @@ end
 Unmatched `(', missing `)' ?
 
   1  class Dog
-❯ 2    def speak(sound
-❯ 4    end
+> 2    def speak(sound
+> 4    end
   5  end
 ```
 
@@ -137,7 +137,7 @@ syntax error, unexpected end-of-input
 
   1  class Dog
   2    def meals_last_month
-❯ 3      puts 3 *
+> 3      puts 3 *
   4    end
   5  end
 ```

data/lib/syntax_suggest/capture_code_context.rb

@@ -140,7 +140,7 @@ module SyntaxSuggest
     # However due to https://github.com/ruby/syntax_suggest/issues/32
     # the problem line will be identified as:
     #
-    #  ❯ class Dog       # 1
+    #  > class Dog       # 1
     #
     # Because lines 2, 3, and 4 are technically valid code and are expanded
     # first, deemed valid, and hidden. We need to un-hide the matching end
@@ -200,7 +200,7 @@ module SyntaxSuggest
     #
     # the problem line will be identified as:
     #
-    #  ❯ end            # 4
+    #  > end            # 4
     #
     # This happens because lines 1, 2, and 3 are technically valid code and are expanded
     # first, deemed valid, and hidden. We need to un-hide the matching keyword on

data/lib/syntax_suggest/cli.rb

@@ -92,8 +92,8 @@ module SyntaxSuggest
 
             # ...
 
-              ❯ 10  defdog
-              ❯ 15  end
+              > 10  defdog
+              > 15  end
 
           ENV options:
 

data/lib/syntax_suggest/core_ext.rb

@@ -3,6 +3,10 @@
 # Ruby 3.2+ has a cleaner way to hook into Ruby that doesn't use `require`
 if SyntaxError.method_defined?(:detailed_message)
   module SyntaxSuggest
+    # Mini String IO [Private]
+    #
+    # Acts like a StringIO with reduced API, but without having to require that
+    # class.
     class MiniStringIO
       def initialize(isatty: $stderr.isatty)
         @string = +""
@@ -16,46 +20,49 @@ if SyntaxError.method_defined?(:detailed_message)
 
       attr_reader :string
     end
-  end
-
-  SyntaxError.prepend Module.new {
-    def detailed_message(highlight: true, syntax_suggest: true, **kwargs)
-      return super unless syntax_suggest
-
-      require "syntax_suggest/api" unless defined?(SyntaxSuggest::DEFAULT_VALUE)
-
-      message = super
-      file = if highlight
-        SyntaxSuggest::PathnameFromMessage.new(super(highlight: false, **kwargs)).call.name
-      else
-        SyntaxSuggest::PathnameFromMessage.new(message).call.name
-      end
-
-      io = SyntaxSuggest::MiniStringIO.new
 
-      if file
-        SyntaxSuggest.call(
-          io: io,
-          source: file.read,
-          filename: file,
-          terminal: highlight
-        )
-        annotation = io.string
-
-        annotation + message
-      else
-        message
-      end
-    rescue => e
-      if ENV["SYNTAX_SUGGEST_DEBUG"]
-        $stderr.warn(e.message)
-        $stderr.warn(e.backtrace)
-      end
-
-      # Ignore internal errors
-      message
+    # SyntaxSuggest.record_dir [Private]
+    #
+    # Used to monkeypatch SyntaxError via Module.prepend
+    def self.module_for_detailed_message
+      Module.new {
+        def detailed_message(highlight: true, syntax_suggest: true, **kwargs)
+          return super unless syntax_suggest
+
+          require "syntax_suggest/api" unless defined?(SyntaxSuggest::DEFAULT_VALUE)
+
+          message = super
+
+          if path
+            file = Pathname.new(path)
+            io = SyntaxSuggest::MiniStringIO.new
+
+            SyntaxSuggest.call(
+              io: io,
+              source: file.read,
+              filename: file,
+              terminal: highlight
+            )
+            annotation = io.string
+
+            annotation + message
+          else
+            message
+          end
+        rescue => e
+          if ENV["SYNTAX_SUGGEST_DEBUG"]
+            $stderr.warn(e.message)
+            $stderr.warn(e.backtrace)
+          end
+
+          # Ignore internal errors
+          message
+        end
+      }
     end
-  }
+  end
+
+  SyntaxError.prepend(SyntaxSuggest.module_for_detailed_message)
 else
   autoload :Pathname, "pathname"
 

data/lib/syntax_suggest/display_code_with_line_numbers.rb

@@ -14,8 +14,8 @@ module SyntaxSuggest
   #   # =>
   #       1
   #       2  def cat
-  #     ❯ 3    Dir.chdir
-  #     ❯ 4    end
+  #     > 3    Dir.chdir
+  #     > 4    end
   #       5  end
   #       6
   class DisplayCodeWithLineNumbers
@@ -50,7 +50,7 @@ module SyntaxSuggest
     private def format(contents:, number:, empty:, highlight: false)
       string = +""
       string << if highlight
-        "❯ "
+        "> "
       else
         "  "
       end

data/lib/syntax_suggest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_suggest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-25 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
@@ -19,6 +19,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/check_changelog.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Find syntax errors in your source in a snap