syntax_search 0.1.0

data/lib/syntax_search/code_line.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module SyntaxErrorSearch
+  # Represents a single line of code of a given source file
+  #
+  # This object contains metadata about the line such as
+  # amount of indentation. An if it is empty or not.
+  #
+  # While a given search for syntax errors is being performed
+  # state about the search can be stored in individual lines such
+  # as :valid or :invalid.
+  #
+  # Visibility of lines can be toggled on and off.
+  #
+  # Example:
+  #
+  #   line = CodeLine.new(line: "def foo\n", index: 0)
+  #   line.line_number => 1
+  #   line.empty? # => false
+  #   line.visible? # => true
+  #   line.mark_invisible
+  #   line.visible? # => false
+  #
+  # A CodeBlock is made of multiple CodeLines
+  #
+  # Marking a line as invisible indicates that it should not be used
+  # for syntax checks. It's essentially the same as commenting it out
+  #
+  # Marking a line as invisible also lets the overall program know
+  # that it should not check that area for syntax errors.
+  class CodeLine
+    attr_reader :line, :index, :indent
+
+    def initialize(line: , index:)
+      @original_line = line.freeze
+      @line = @original_line
+      @empty = line.strip.empty?
+      @index = index
+      @indent = SpaceCount.indent(line)
+      @status = nil # valid, invalid, unknown
+      @invalid = false
+    end
+
+    def mark_invalid
+      @invalid = true
+      self
+    end
+
+    def marked_invalid?
+      @invalid
+    end
+
+    def mark_invisible
+      @line = ""
+      self
+    end
+
+    def mark_visible
+      @line = @original_line
+      self
+    end
+
+    def visible?
+      !line.empty?
+    end
+
+    def hidden?
+      !visible?
+    end
+
+    def line_number
+      index + 1
+    end
+
+    def not_empty?
+      !empty?
+    end
+
+    def empty?
+      @empty
+    end
+
+    def to_s
+      self.line
+    end
+  end
+end

data/lib/syntax_search/code_search.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module SyntaxErrorSearch
+  # Searches code for a syntax error
+  #
+  # The bulk of the heavy lifting is done by the CodeFrontier
+  #
+  # The flow looks like this:
+  #
+  # ## Syntax error detection
+  #
+  # When the frontier holds the syntax error, we can stop searching
+  #
+  #
+  #   search = CodeSearch.new(<<~EOM)
+  #     def dog
+  #       def lol
+  #     end
+  #   EOM
+  #
+  #   search.call
+  #
+  #   search.invalid_blocks.map(&:to_s) # =>
+  #   # => ["def lol\n"]
+  #
+  #
+  class CodeSearch
+    private; attr_reader :frontier; public
+    public; attr_reader :invalid_blocks, :record_dir, :code_lines
+
+    def initialize(string, record_dir: ENV["SYNTAX_SEARCH_RECORD_DIR"])
+      if record_dir
+        @time = Time.now.strftime('%Y-%m-%d-%H-%M-%s-%N')
+        @record_dir = Pathname(record_dir).join(@time).tap {|p| p.mkpath }
+        @write_count = 0
+      end
+      @code_lines = string.lines.map.with_index do |line, i|
+        CodeLine.new(line: line, index: i)
+      end
+      @frontier = CodeFrontier.new(code_lines: @code_lines)
+      @invalid_blocks = []
+      @name_tick = Hash.new {|hash, k| hash[k] = 0 }
+      @tick = 0
+      @scan = IndentScan.new(code_lines: @code_lines)
+    end
+
+    def record(block:, name: "record")
+      return if !@record_dir
+      @name_tick[name] += 1
+      filename = "#{@write_count += 1}-#{name}-#{@name_tick[name]}.txt"
+      @record_dir.join(filename).open(mode: "a") do |f|
+        display = DisplayInvalidBlocks.new(
+          blocks: block,
+          terminal: false
+        )
+        f.write(display.indent display.code_with_lines)
+      end
+    end
+
+    def push_if_invalid(block, name: )
+      frontier.register(block)
+      record(block: block, name: name)
+
+      if block.valid?
+        block.lines.each(&:mark_invisible)
+        frontier << block
+      else
+        frontier << block
+      end
+    end
+
+    def add_invalid_blocks
+      max_indent = frontier.next_indent_line&.indent
+
+      while (line = frontier.next_indent_line) && (line.indent == max_indent)
+        neighbors = @scan.neighbors_from_top(frontier.next_indent_line)
+
+        @scan.each_neighbor_block(frontier.next_indent_line) do |block|
+          record(block: block, name: "add")
+          if block.valid?
+            block.lines.each(&:mark_invisible)
+          end
+        end
+
+        block = CodeBlock.new(lines: neighbors, code_lines: @code_lines)
+        push_if_invalid(block, name: "add")
+      end
+    end
+
+    def expand_invalid_block
+      block = frontier.pop
+      return unless block
+
+      block.expand_until_next_boundry
+      push_if_invalid(block, name: "expand")
+    end
+
+    def call
+      until frontier.holds_all_syntax_errors?
+        @tick += 1
+
+        if frontier.expand?
+          expand_invalid_block
+        else
+          add_invalid_blocks
+        end
+      end
+
+      @invalid_blocks.concat(frontier.detect_invalid_blocks )
+      @invalid_blocks.sort_by! {|block| block.starts_at }
+      self
+    end
+  end
+end

data/lib/syntax_search/display_invalid_blocks.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module SyntaxErrorSearch
+  # Used for formatting invalid blocks
+  class DisplayInvalidBlocks
+    attr_reader :filename
+
+    def initialize(blocks:, io: $stderr, filename: nil, terminal: false)
+      @terminal = terminal
+      @filename = filename
+      @io = io
+
+      @blocks = Array(blocks)
+      @lines = @blocks.map(&:lines).flatten
+      @code_lines = @blocks.first&.code_lines || []
+      @digit_count = @code_lines.last&.line_number.to_s.length
+
+      @invalid_line_hash = @lines.each_with_object({}) {|line, h| h[line] = true  }
+    end
+
+    def call
+      if @blocks.any?
+        found_invalid_blocks
+      else
+        @io.puts "Syntax OK"
+      end
+      self
+    end
+
+    private def no_invalid_blocks
+      @io.puts <<~EOM
+      EOM
+    end
+
+    private def found_invalid_blocks
+      @io.puts <<~EOM
+
+        SyntaxErrorSearch: A syntax error was 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
+
+      EOM
+      @io.puts("file: #{filename}") if filename
+      @io.puts <<~EOM
+        simplified:
+
+        #{indent(code_block)}
+      EOM
+    end
+
+    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
+
+    def terminal_end
+      "\e[0m"
+    end
+
+    def terminal_highlight
+      "\e[1;3m" # Bold, italics
+    end
+
+    def code_with_lines
+      @code_lines.map do |line|
+        next if line.hidden?
+
+        string = String.new("")
+        if @invalid_line_hash[line]
+          string << "❯ "
+        else
+          string << "  "
+        end
+
+        number = line.line_number.to_s.rjust(@digit_count)
+        string << number.to_s
+        if line.empty?
+          string << line.to_s
+        else
+          string << "  "
+          string << terminal_highlight if @terminal && @invalid_line_hash[line] # Bold, italics
+          string << line.to_s
+          string << terminal_end if @terminal
+        end
+        string
+      end.join
+    end
+  end
+end

data/lib/syntax_search/fyi.rb

@@ -0,0 +1,7 @@
+require_relative "../syntax_search"
+
+require_relative "auto.rb"
+
+SyntaxErrorSearch.send(:remove_const, :SEARCH_SOURCE_ON_ERROR_DEFAULT)
+SyntaxErrorSearch::SEARCH_SOURCE_ON_ERROR_DEFAULT = false
+

data/lib/syntax_search/version.rb

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

data/syntax_search.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/syntax_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "syntax_search"
+  spec.version       = SyntaxErrorSearch::VERSION
+  spec.authors       = ["schneems"]
+  spec.email         = ["richard.schneeman+foo@gmail.com"]
+
+  spec.summary       = %q{Find syntax errors in your source in a snap}
+  spec.description   = %q{When you get an "unexpected end" in your syntax this gem helps you find it}
+  spec.homepage      = "https://github.com/zombocom/syntax_search.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/zombocom/syntax_search.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "parser"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: syntax_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- schneems
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-10 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'
+description: When you get an "unexpected end" in your syntax this gem helps you find
+  it
+email:
+- richard.schneeman+foo@gmail.com
+executables:
+- syntax_search
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zombocom/syntax_search.git
+  source_code_uri: https://github.com/zombocom/syntax_search.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Find syntax errors in your source in a snap
+test_files: []