syntax_search 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64d391c1ee60a9784b3b53ec9c404739b06dd390d263793795110cdc555bdfb0
-  data.tar.gz: 70cbe011308ad0c94c88240e5aadf4e7e024b0f83ff65377b99fe82550779ebc
+  metadata.gz: 9efb5d44fe2c979f66237173d1bf7b215a1bcc8003b4a96cb595eabbcac606c6
+  data.tar.gz: 5757f68cdf7dace8980bb31b49a756b858fba8f7260156640621832374b4e635
 SHA512:
-  metadata.gz: 119be89600a50534968502162df65d972a4fe1ecd93a70378e843cbe22effbe0d3f4a7fb12761740efa95152d81bf3a30abc79401cfbff4ba8ad89e9b9390a47
-  data.tar.gz: aa93927ba70886754499d263087c89a546d2791b8de3911175e365d7aa111b1d8d659dd3ae015e8297b75b62b9c4e4958c8e9f6c08ac9a4d444f18ccdc7ad8fb
+  metadata.gz: b9fb23706395a520d52af51ea2a441d972115d6cd85a9e4048d17424d0e7077e679cd23d6ec1a9f43f4fde1e6d29ab8670906dc27451b730f2dab4c5c753789f
+  data.tar.gz: 13209882976145efe8087a5c5d52e1980d5295c4b7ab51628dc92007f6b83900933fb2e08046bac7ccf118056289bba04f3f5597b70400c74c32969468e31409

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,13 @@
+name: Check Changelog
+
+on:
+ pull_request:
+  types: [opened, reopened, edited, synchronize]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    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

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 ## HEAD (unreleased)
 
+## 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
 
-- Fix error message detection to fire on more rubies ()
+- Fire search on both unexpected end-of-input and unexected end (https://github.com/zombocom/syntax_search/pull/8)
 
 ## 0.1.0
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_search (0.1.1)
+    syntax_search (0.1.2)
       parser
 
 GEM

data/lib/syntax_search.rb

@@ -23,7 +23,7 @@ module SyntaxErrorSearch
       self.call(
         source: Pathname(filename).read,
         filename: filename,
-        terminal: true
+        terminal: true,
       )
     end
 
@@ -40,6 +40,7 @@ module SyntaxErrorSearch
       blocks: blocks,
       filename: filename,
       terminal: terminal,
+      invalid_type: invalid_type(source),
       io: $stderr
     ).call
   end
@@ -122,11 +123,30 @@ module SyntaxErrorSearch
 
     Parser::CurrentRuby.parse(source)
     true
-  rescue Parser::SyntaxError
+  rescue Parser::SyntaxError => e
+    yield e if block_given?
     false
   ensure
     $stderr = stderr if stderr
   end
+
+  def self.invalid_type(source)
+    message = nil
+    self.valid?(source) do |error|
+      message = error.message
+    end
+
+    case message
+    when nil
+      :none
+    when /token kEND/
+      :unmatched_end
+    when /token \$end/ #
+      :missing_end
+    else
+      raise "Unexpected message #{message}"
+    end
+  end
 end
 
 require_relative "syntax_search/code_line"

data/lib/syntax_search/display_invalid_blocks.rb

@@ -5,7 +5,7 @@ module SyntaxErrorSearch
   class DisplayInvalidBlocks
     attr_reader :filename
 
-    def initialize(blocks:, io: $stderr, filename: nil, terminal: false)
+    def initialize(blocks:, io: $stderr, filename: nil, terminal: false, invalid_type: :unmatched_end)
       @terminal = terminal
       @filename = filename
       @io = io
@@ -16,6 +16,7 @@ module SyntaxErrorSearch
       @digit_count = @code_lines.last&.line_number.to_s.length
 
       @invalid_line_hash = @lines.each_with_object({}) {|line, h| h[line] = true  }
+      @invalid_type = invalid_type
     end
 
     def call
@@ -33,15 +34,28 @@ module SyntaxErrorSearch
     end
 
     private def found_invalid_blocks
-      @io.puts <<~EOM
+      case @invalid_type
+      when :missing_end
+        @io.puts <<~EOM
 
-        SyntaxErrorSearch: A syntax error was detected
+          SyntaxSearch: Missing `end` detected
 
-        This code has an unmatched `end` this is caused by either
-        missing a syntax keyword (`def`,  `do`, etc.) or inclusion
-        of an extra `end` line
+          This code has a missing `end`. Ensure that all
+          syntax keywords (`def`, `do`, etc.) have a matching `end`.
+
+        EOM
+      when :unmatched_end
+        @io.puts <<~EOM
+
+          SyntaxSearch: 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
+      end
 
-      EOM
       @io.puts("file: #{filename}") if filename
       @io.puts <<~EOM
         simplified:
@@ -50,16 +64,13 @@ module SyntaxErrorSearch
       EOM
     end
 
-    def indent(string, with: "  ")
+    def indent(string, with: "    ")
       string.each_line.map {|l| with  + l }.join
     end
 
     def code_block
       string = String.new("")
-      string << "```\n"
-      # string << "#".rjust(@digit_count) + " filename: #{filename}\n\n" if filename
       string << code_with_lines
-      string << "```\n"
       string
     end
 

data/lib/syntax_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxErrorSearch
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_search
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -34,6 +34,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"