syntax_search 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9efb5d44fe2c979f66237173d1bf7b215a1bcc8003b4a96cb595eabbcac606c6
-  data.tar.gz: 5757f68cdf7dace8980bb31b49a756b858fba8f7260156640621832374b4e635
+  metadata.gz: 739770be9259abf88e8ea3c7dc1223e279cc79ab35d907312b0cc268d00363ed
+  data.tar.gz: ca7fbab5999100db76c5758f3f920fc7f91872d678b028157761cd6b72e348d5
 SHA512:
-  metadata.gz: b9fb23706395a520d52af51ea2a441d972115d6cd85a9e4048d17424d0e7077e679cd23d6ec1a9f43f4fde1e6d29ab8670906dc27451b730f2dab4c5c753789f
-  data.tar.gz: 13209882976145efe8087a5c5d52e1980d5295c4b7ab51628dc92007f6b83900933fb2e08046bac7ccf118056289bba04f3f5597b70400c74c32969468e31409
+  metadata.gz: 60c1aea7c3f075f0486d85e72bc4761879efd09d5805c6581efa21765c78edd335f172094dcc961f77e00f1bf4e0867f8382b32e7d13e2de248085679e3728e6
+  data.tar.gz: adf40fe0011de00194eef22b5f4caa86196f0b8bf1439c8d48a7f3fbe465521ab04bf856f9cd20407dace52ab154cf1c27d0a519c00d15e862e6100322f2c4f2

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+scratch.rb
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,14 +1,5 @@
 ## HEAD (unreleased)
 
-## 0.1.2
+## 0.2.1
 
-- 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
-
-- Fire search on both unexpected end-of-input and unexected end (https://github.com/zombocom/syntax_search/pull/8)
-
-## 0.1.0
-
-- Initial release
+This gem is moved to the `dead_end` gem. Please use that instead

data/Gemfile

@@ -7,3 +7,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "stackprof"

data/Gemfile.lock

@@ -1,16 +1,14 @@
 PATH
   remote: .
   specs:
-    syntax_search (0.1.2)
-      parser
+    syntax_search (0.2.1)
+      dead_end (> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    dead_end (1.0.0)
     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)
@@ -25,6 +23,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    stackprof (0.2.16)
 
 PLATFORMS
   ruby
@@ -32,6 +31,7 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
+  stackprof
   syntax_search!
 
 BUNDLED WITH

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/exe/syntax_search

@@ -1,73 +1,8 @@
 #!/usr/bin/env ruby
 
-require 'pathname'
-require "optparse"
-require_relative "../lib/syntax_search.rb"
+warn "syntax_search gem is deprecated please use `dead_end` instead"
+warn
+warn "  $ gem install dead_end`"
+warn
 
-options = {}
-options[:terminal] = true
-options[:record_dir] = ENV["SYNTAX_SEARCH_RECORD_DIR"]
-
-parser = OptionParser.new do |opts|
-  opts.banner = <<~EOM
-    Usage: syntax_search <file> [options]
-
-    Parses a ruby source file and searches for syntax error(s) unexpected `end', expecting end-of-input.
-
-    Example:
-
-      $ syntax_search dog.rb
-
-      # ...
-
-      ```
-         1  require 'animals'
-         2
-      ❯ 10  defdog
-      ❯ 15  end
-      ❯ 16
-        20  def cat
-        22  end
-      ```
-
-    Env options:
-
-      SYNTAX_SEARCH_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)
-
-$stderr.puts "Record dir: #{options[:record_dir]}"  if options[:record_dir]
-
-SyntaxErrorSearch.call(
-  source: file.read,
-  filename: file.expand_path,
-  terminal: options[:terminal],
-  record_dir: options[:record_dir]
-)
+exit 1

data/lib/syntax_search/auto.rb

@@ -1,51 +1,7 @@
-require_relative "../syntax_search"
+warn "syntax_search gem is deprecated please use `dead_end` instead"
+warn
+warn "  $ gem install dead_end`"
+warn
 
-# Monkey patch kernel to ensure that all `require` calls call the same
-# method
-module Kernel
-  alias_method :original_require, :require
-  alias_method :original_require_relative, :require_relative
-  alias_method :original_load, :load
-
-  def load(file, wrap = false)
-    original_load(file)
-  rescue SyntaxError => e
-    SyntaxErrorSearch.handle_error(e)
-  end
-
-  def require(file)
-    original_require(file)
-  rescue SyntaxError => e
-    SyntaxErrorSearch.handle_error(e)
-  end
-
-  def require_relative(file)
-    if Pathname.new(file).absolute?
-      original_require file
-    else
-      original_require File.expand_path("../#{file}", caller_locations(1, 1)[0].absolute_path)
-    end
-  rescue SyntaxError => e
-    SyntaxErrorSearch.handle_error(e)
-  end
-end
-
-# I honestly have no idea why this Object delegation is needed
-# I keep staring at bootsnap and it doesn't have to do this
-# is there a bug in their implementation they haven't caught or
-# am I doing something different?
-class Object
-  private
-  def load(path, wrap = false)
-    Kernel.load(path, wrap)
-  rescue SyntaxError => e
-    SyntaxErrorSearch.handle_error(e)
-  end
-
-  def require(path)
-    Kernel.require(path)
-  rescue SyntaxError => e
-    SyntaxErrorSearch.handle_error(e)
-  end
-end
+require "dead_end"
 

data/syntax_search.gemspec

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'lib/syntax_search/version'
-
 Gem::Specification.new do |spec|
   spec.name          = "syntax_search"
-  spec.version       = SyntaxErrorSearch::VERSION
+  spec.version       = "0.2.1"
   spec.authors       = ["schneems"]
   spec.email         = ["richard.schneeman+foo@gmail.com"]
 
@@ -26,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "parser"
+  spec.add_dependency "dead_end",      "> 0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: syntax_search
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: dead_end
   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'
 description: When you get an "unexpected end" in your syntax this gem helps you find
@@ -45,18 +45,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/syntax_search.gif
 - bin/console
 - bin/setup
 - exe/syntax_search
-- lib/syntax_search.rb
 - lib/syntax_search/auto.rb
-- lib/syntax_search/code_block.rb
-- lib/syntax_search/code_frontier.rb
-- lib/syntax_search/code_line.rb
-- lib/syntax_search/code_search.rb
-- lib/syntax_search/display_invalid_blocks.rb
-- lib/syntax_search/fyi.rb
-- lib/syntax_search/version.rb
 - syntax_search.gemspec
 homepage: https://github.com/zombocom/syntax_search.git
 licenses:

data/lib/syntax_search.rb

@@ -1,156 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "syntax_search/version"
-
-require 'parser/current'
-require 'tmpdir'
-require 'stringio'
-require 'pathname'
-
-module SyntaxErrorSearch
-  class Error < StandardError; end
-  SEARCH_SOURCE_ON_ERROR_DEFAULT = true
-
-  def self.handle_error(e, search_source_on_error: SEARCH_SOURCE_ON_ERROR_DEFAULT)
-    raise e if !e.message.include?("end-of-input")
-
-    filename = e.message.split(":").first
-
-    $stderr.sync = true
-    $stderr.puts "Run `$ syntax_search #{filename}` for more options\n"
-
-    if search_source_on_error
-      self.call(
-        source: Pathname(filename).read,
-        filename: filename,
-        terminal: true,
-      )
-    end
-
-    $stderr.puts ""
-    $stderr.puts ""
-    raise e
-  end
-
-  def self.call(source: , filename: , terminal: false, record_dir: nil)
-    search = CodeSearch.new(source, record_dir: record_dir).call
-
-    blocks = search.invalid_blocks
-    DisplayInvalidBlocks.new(
-      blocks: blocks,
-      filename: filename,
-      terminal: terminal,
-      invalid_type: invalid_type(source),
-      io: $stderr
-    ).call
-  end
-
-  # Used for counting spaces
-  module SpaceCount
-    def self.indent(string)
-      string.split(/\S/).first&.length || 0
-    end
-  end
-
-  # This will tell you if the `code_lines` would be valid
-  # if you removed the `without_lines`. In short it's a
-  # way to detect if we've found the lines with syntax errors
-  # in our document yet.
-  #
-  #   code_lines = [
-  #     CodeLine.new(line: "def foo\n",   index: 0)
-  #     CodeLine.new(line: "  def bar\n", index: 1)
-  #     CodeLine.new(line: "end\n",       index: 2)
-  #   ]
-  #
-  #   SyntaxErrorSearch.valid_without?(
-  #     without_lines: code_lines[1],
-  #     code_lines: code_lines
-  #   )                                    # => true
-  #
-  #   SyntaxErrorSearch.valid?(code_lines) # => false
-  def self.valid_without?(without_lines: , code_lines:)
-    lines = code_lines - Array(without_lines).flatten
-
-    if lines.empty?
-      return true
-    else
-      return valid?(lines)
-    end
-  end
-
-  # Returns truthy if a given input source is valid syntax
-  #
-  #   SyntaxErrorSearch.valid?(<<~EOM) # => true
-  #     def foo
-  #     end
-  #   EOM
-  #
-  #   SyntaxErrorSearch.valid?(<<~EOM) # => false
-  #     def foo
-  #       def bar # Syntax error here
-  #     end
-  #   EOM
-  #
-  # You can also pass in an array of lines and they'll be
-  # joined before evaluating
-  #
-  #   SyntaxErrorSearch.valid?(
-  #     [
-  #       "def foo\n",
-  #       "end\n"
-  #     ]
-  #   ) # => true
-  #
-  #   SyntaxErrorSearch.valid?(
-  #     [
-  #       "def foo\n",
-  #       "  def bar\n", # Syntax error here
-  #       "end\n"
-  #     ]
-  #   ) # => false
-  #
-  # As an FYI the CodeLine class instances respond to `to_s`
-  # 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
-  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"
-require_relative "syntax_search/code_block"
-require_relative "syntax_search/code_frontier"
-require_relative "syntax_search/code_search"
-require_relative "syntax_search/display_invalid_blocks"