syntax_search 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2c76d5b7441b5c04e92205407605d6f71be326bfbf240b11763156fc00e188
-  data.tar.gz: 728230f8d8694e221149a671d0c44f44d82829407cf5a82b498523015d9df33f
+  metadata.gz: 520b6bbfe8e63c7045c02a1f209e73097e732a701e306c65ccc2a29f3e7645d1
+  data.tar.gz: 617a4e7177d8d3fb96624149f2afc7cc8698f43e4d1687e8f32ed45c19ec3ad6
 SHA512:
-  metadata.gz: 38ecea1a966f361809d3e13440ee16acffd3bbf79d7629a48d65d3a5f5bc4474c51a8b79c1b8f54f9f2737ef4aa86105394e45caae9bd02f125874b8bc9d4496
-  data.tar.gz: 13520d3877d427ce2423576543688c9d91e0813bd12bf9e1e886dc65874cea527b04a88763867b7767d2cad03bfd5fc0745b22cc69c96dc140477e54b80c7b08
+  metadata.gz: 9593ed43b2f33ac12b71630f7ceaa7a971b281c3b476eabad43dd5bd71db76ee37f9b20e303e3a6699ce1e67d467c32237d8c1fbab51d75823b59f63fbe756cc
+  data.tar.gz: 64567243a2c7404694b5719eb2c82482da882de1e6592e371d39349c1282e65ad05cb7cbe613e232bf7f7fa9440601ecce47b321063f3c9a0c5f2d5af2909cad

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## HEAD (unreleased)
 
+## 0.1.4
+
+- Parser gem replaced with Ripper (https://github.com/zombocom/syntax_search/pull/17)
+
 ## 0.1.3
 
 - Internal refactor (https://github.com/zombocom/syntax_search/pull/13)

data/Gemfile.lock

@@ -1,16 +1,12 @@
 PATH
   remote: .
   specs:
-    syntax_search (0.1.3)
-      parser
+    syntax_search (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
     diff-lcs (1.4.4)
-    parser (2.7.2.0)
-      ast (~> 2.4.1)
     rake (12.3.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)

data/README.md

@@ -10,30 +10,29 @@ What happened? Likely you forgot a `def`, `do`, or maybe you deleted some code a
 
 What if I told you, that there was a library that helped find your missing `def`s and missing `do`s. What if instead of searching through hundreds of lines of source for the cause of your syntax error, there was a way to highlight just code in the file that contained syntax errors.
 
-    $ syntax_search <path/to/file.rb>
+    $ syntax_search path/to/file.rb
 
-    SyntaxErrorSearch: A syntax error was detected
+    SyntaxSearch: Unmatched `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 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/file.rb
     simplified:
 
-    ```
-         1  require 'animals'
-         2
-      ❯ 10  defdog
-      ❯ 15  end
-      ❯ 16
-        20  def cat
-        22  end
-    ```
+       1  require 'zoo'
+       2
+       3  class Animal
+       4
+    ❯  5    defdog
+    ❯  7    end
+       8
+      12  end
 
 How much would you pay for such a library? A million, a billion, a trillion? Well friends, today is your lucky day because you can use this library today for free!
 
-## Installation
+## Installation in your codebase
 
 To automatically search syntax errors when they happen, add this to your Gemfile:
 
@@ -51,6 +50,16 @@ If your application is not calling `Bundler.require` then you must manually add
 require "syntax_search/auto"
 ```
 
+If you're using rspec add this to your `.rspec` file:
+
+```
+--require syntax_search/auto
+```
+
+> This is needed because people can execute a single test file via `bundle exec rspec path/to/file_spec.rb` and if that file has a syntax error, it won't load `spec_helper.rb` to trigger any requires.
+
+## Install the CLI
+
 To get the CLI and manually search for syntax errors, install the gem:
 
     $ gem install syntax_search
@@ -74,6 +83,10 @@ We know that source code that does not contain a syntax error can be parsed. We
 
 Since there can be multiple syntax errors in a document it's not good enough to check individual code blocks, we've got to check multiple at the same time. We will keep creating and adding new blocks to our search until we detect that our "frontier" (which contains all of our blocks) contains the syntax error. After this, we can stop our search and instead focus on filtering to find the smallest subset of blocks that contain the syntax error.
 
+Here's an example:
+
+![](assets/syntax_search.gif)
+
 ## How is source code broken up into smaller blocks?
 
 By definition source code with a syntax error in it cannot be parsed, so we have to guess how to chunk up the file into smaller pieces. Once we've split up the file we can safely rule out or zoom into a specific piece of code to determine the location of the syntax error. This libary uses indentation and empty lines to make guesses about what might be a "block" of code. Once we've got a chunk of code, we can test it.

data/lib/syntax_search.rb

@@ -2,10 +2,10 @@
 
 require_relative "syntax_search/version"
 
-require 'parser/current'
 require 'tmpdir'
 require 'stringio'
 require 'pathname'
+require 'ripper'
 
 module SyntaxErrorSearch
   class Error < StandardError; end
@@ -80,6 +80,13 @@ module SyntaxErrorSearch
     end
   end
 
+  def self.invalid?(source)
+    source = source.join if source.is_a?(Array)
+    source = source.to_s
+
+    Ripper.new(source).tap(&:parse).error?
+  end
+
   # Returns truthy if a given input source is valid syntax
   #
   #   SyntaxErrorSearch.valid?(<<~EOM) # => true
@@ -115,38 +122,12 @@ module SyntaxErrorSearch
   # so passing a CodeLine in as an object or as an array
   # will convert it to it's code representation.
   def self.valid?(source)
-    source = source.join if source.is_a?(Array)
-    source = source.to_s
-
-    # Parser writes to stderr even if you catch the error
-    stderr = $stderr
-    $stderr = StringIO.new
-
-    Parser::CurrentRuby.parse(source)
-    true
-  rescue Parser::SyntaxError => e
-    yield e if block_given?
-    false
-  ensure
-    $stderr = stderr if stderr
+    !invalid?(source)
   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
+  def self.invalid_type(source)
+    WhoDisSyntaxError.new(source).call.error_symbol
   end
 end
 
@@ -159,3 +140,4 @@ require_relative "syntax_search/block_expand"
 require_relative "syntax_search/parse_blocks_from_indent_line"
 
 require_relative "syntax_search/code_search"
+require_relative "syntax_search/who_dis_syntax_error"

data/lib/syntax_search/version.rb

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

data/lib/syntax_search/who_dis_syntax_error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SyntaxErrorSearch
+  # Determines what type of syntax error is in the source
+  #
+  # Example:
+  #
+  #   puts WhoDisSyntaxError.new("def foo;").call.error_symbol
+  #   # => :missing_end
+  class WhoDisSyntaxError < Ripper
+    attr_reader :error, :run_once, :error_symbol
+
+    def call
+      @run_once ||= begin
+        parse
+        true
+      end
+      self
+    end
+
+    def on_parse_error(msg)
+      @error = msg
+      if @error.match?(/unexpected end-of-input/)
+        @error_symbol = :missing_end
+      elsif @error.match?(/unexpected `end'/) || @error.match?(/expecting end-of-input/)
+        @error_symbol = :unmatched_end
+      else
+        @error_symbol = :nope
+      end
+    end
+  end
+end

data/syntax_search.gemspec

@@ -25,6 +25,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_dependency "parser"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: syntax_search
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2020-11-23 00:00:00.000000000 Z
+dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it
 email:
@@ -45,6 +31,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/syntax_search.gif
 - bin/console
 - bin/setup
 - exe/syntax_search
@@ -60,6 +47,7 @@ files:
 - lib/syntax_search/fyi.rb
 - lib/syntax_search/parse_blocks_from_indent_line.rb
 - lib/syntax_search/version.rb
+- lib/syntax_search/who_dis_syntax_error.rb
 - syntax_search.gemspec
 homepage: https://github.com/zombocom/syntax_search.git
 licenses:
@@ -82,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Find syntax errors in your source in a snap