syntax_search 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66acadf6481512affd39e4a1fb691ed41a6be537a8a63801f71316863d30494d
-  data.tar.gz: 1bcb85706516cbe5c3f53a1ed48bf5215479672952fc62d2e3221c583e468b22
+  metadata.gz: 739770be9259abf88e8ea3c7dc1223e279cc79ab35d907312b0cc268d00363ed
+  data.tar.gz: ca7fbab5999100db76c5758f3f920fc7f91872d678b028157761cd6b72e348d5
 SHA512:
-  metadata.gz: 4e60777bd284d78436db8608f34d11b4b5aa8456bfe0c9507ddf3a0e3b97b902a2d00d1537433ed914c637a0729ccb253fc9047fb6db9e3b18a8cc8d0294ae06
-  data.tar.gz: 2fb1b35e70507f4b358be4b767cbf266c2d47c55efba1b77d7ca5f260cac4e77d519fc7439f55c78c5294c0c87240d15b4cab3721c8cfd580b518f5051b7cd0c
+  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,32 +1,5 @@
 ## HEAD (unreleased)
 
-## 0.2.0
+## 0.2.1
 
-- 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
-
-- Strip out heredocs in documents first (https://github.com/zombocom/syntax_search/pull/19)
-
-## 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)
-
-## 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
-
-- 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.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    syntax_search (0.2.0)
+    syntax_search (0.2.1)
+      dead_end (> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    dead_end (1.0.0)
     diff-lcs (1.4.4)
     rake (12.3.3)
     rspec (3.10.0)

data/exe/syntax_search

@@ -1,74 +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)
-options[:record_dir] = "tmp" if ENV["DEBUG"]
-
-$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"]
 
@@ -25,4 +23,6 @@ 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 "dead_end",      "> 0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: syntax_search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
-dependencies: []
+date: 2020-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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
   it
 email:
@@ -35,23 +49,7 @@ files:
 - bin/console
 - bin/setup
 - exe/syntax_search
-- lib/syntax_search.rb
-- lib/syntax_search/around_block_scan.rb
 - lib/syntax_search/auto.rb
-- lib/syntax_search/block_expand.rb
-- lib/syntax_search/capture_code_context.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_code_with_line_numbers.rb
-- lib/syntax_search/display_invalid_blocks.rb
-- lib/syntax_search/fyi.rb
-- lib/syntax_search/heredoc_block_parse.rb
-- lib/syntax_search/lex_all.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:

data/lib/syntax_search.rb

@@ -1,145 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "syntax_search/version"
-
-require 'tmpdir'
-require 'stringio'
-require 'pathname'
-require 'ripper'
-
-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,
-      code_lines: search.code_lines,
-      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
-
-  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
-  #     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)
-    !invalid?(source)
-  end
-
-
-  def self.invalid_type(source)
-    WhoDisSyntaxError.new(source).call.error_symbol
-  end
-end
-
-require_relative "syntax_search/code_line"
-require_relative "syntax_search/code_block"
-require_relative "syntax_search/code_frontier"
-require_relative "syntax_search/display_invalid_blocks"
-require_relative "syntax_search/around_block_scan"
-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"
-require_relative "syntax_search/heredoc_block_parse"
-require_relative "syntax_search/lex_all"

data/lib/syntax_search/around_block_scan.rb

@@ -1,193 +0,0 @@
-# frozen_string_literal: true
-#
-module SyntaxErrorSearch
-  # This class is useful for exploring contents before and after
-  # a block
-  #
-  # It searches above and below the passed in block to match for
-  # whatever criteria you give it:
-  #
-  # Example:
-  #
-  #   def dog
-  #     puts "bark"
-  #     puts "bark"
-  #   end
-  #
-  #   scan = AroundBlockScan.new(
-  #     code_lines: code_lines
-  #     block: CodeBlock.new(lines: code_lines[1])
-  #   )
-  #
-  #   scan.scan_while { true }
-  #
-  #   puts scan.before_index # => 0
-  #   puts scan.after_index # => 3
-  #
-  # Contents can also be filtered using AroundBlockScan#skip
-  #
-  # To grab the next surrounding indentation use AroundBlockScan#scan_adjacent_indent
-  class AroundBlockScan
-    def initialize(code_lines: , block:)
-      @code_lines = code_lines
-      @orig_before_index = block.lines.first.index
-      @orig_after_index = block.lines.last.index
-      @orig_indent = block.current_indent
-      @skip_array = []
-      @after_array = []
-      @before_array = []
-      @stop_after_kw = false
-    end
-
-    def skip(name)
-      @skip_array << name
-      self
-    end
-
-    def stop_after_kw
-      @stop_after_kw = true
-      self
-    end
-
-    def scan_while(&block)
-      stop_next = false
-
-      kw_count = 0
-      end_count = 0
-      @before_index = before_lines.reverse_each.take_while do |line|
-        next false if stop_next
-        next true if @skip_array.detect {|meth| line.send(meth) }
-
-        kw_count += 1 if line.is_kw?
-        end_count += 1 if line.is_end?
-        if @stop_after_kw && kw_count > end_count
-          stop_next = true
-        end
-
-        block.call(line)
-      end.reverse.first&.index
-
-      stop_next = false
-      kw_count = 0
-      end_count = 0
-      @after_index = after_lines.take_while do |line|
-        next false if stop_next
-        next true if @skip_array.detect {|meth| line.send(meth) }
-
-        kw_count += 1 if line.is_kw?
-        end_count += 1 if line.is_end?
-        if @stop_after_kw && end_count > kw_count
-          stop_next = true
-        end
-
-        block.call(line)
-      end.last&.index
-      self
-    end
-
-    def capture_neighbor_context
-      lines = []
-      kw_count = 0
-      end_count = 0
-      before_lines.reverse.each do |line|
-        next if line.empty?
-        break if line.indent < @orig_indent
-        next if line.indent != @orig_indent
-
-        kw_count += 1 if line.is_kw?
-        end_count += 1 if line.is_end?
-        if kw_count != 0 && kw_count == end_count
-          lines << line
-          break
-        end
-
-        lines << line
-      end
-
-      lines.reverse!
-
-      kw_count = 0
-      end_count = 0
-      after_lines.each do |line|
-        # puts "line: #{line.number} #{line.original_line}, indent: #{line.indent}, #{line.empty?} #{line.indent == @orig_indent}"
-
-        next if line.empty?
-        break if line.indent < @orig_indent
-        next if line.indent != @orig_indent
-
-        kw_count += 1 if line.is_kw?
-        end_count += 1 if line.is_end?
-        if kw_count != 0 && kw_count == end_count
-          lines << line
-          break
-        end
-
-        lines << line
-      end
-      lines.select! {|line| !line.is_comment? }
-
-      lines
-    end
-
-    def on_falling_indent
-      last_indent = @orig_indent
-      before_lines.reverse.each do |line|
-        next if line.empty?
-        if line.indent < last_indent
-          yield line
-          last_indent = line.indent
-        end
-      end
-
-      last_indent = @orig_indent
-      after_lines.each do |line|
-        next if line.empty?
-        if line.indent < last_indent
-          yield line
-          last_indent = line.indent
-        end
-      end
-    end
-
-    def scan_neighbors
-      self.scan_while {|line| line.not_empty? && line.indent >= @orig_indent }
-    end
-
-    def scan_adjacent_indent
-      before_indent = @code_lines[@orig_before_index.pred]&.indent || 0
-      after_indent = @code_lines[@orig_after_index.next]&.indent || 0
-
-      indent = [before_indent, after_indent].min
-      self.scan_while {|line| line.not_empty? && line.indent >= indent }
-
-      self
-    end
-
-    def start_at_next_line
-      before_index; after_index
-      @before_index -= 1
-      @after_index += 1
-      self
-    end
-
-    def code_block
-      CodeBlock.new(lines: @code_lines[before_index..after_index])
-    end
-
-    def before_index
-      @before_index ||= @orig_before_index
-    end
-
-    def after_index
-      @after_index ||= @orig_after_index
-    end
-
-    private def before_lines
-      @code_lines[0...@orig_before_index]
-    end
-
-    private def after_lines
-      @code_lines[@orig_after_index.next..-1]
-    end
-  end
-end