Porting examples from existing tests

- https://github.com/zombocom/dead_end/blob/622dfddda92e27235425dd5a370618c5257731e8/spec/unit/code_search_spec.rb



```
22 examples, 9 failures

Failed examples:

rspec ./spec/integration/dead_end_spec.rb:208 # Integration tests that don't spawn a process (like using the cli) missing `do` highlights more than `end` simple
rspec ./spec/integration/dead_end_spec.rb:239 # Integration tests that don't spawn a process (like using the cli) missing `do` highlights more than `end`, with internal contents
rspec ./spec/integration/dead_end_spec.rb:302 # Integration tests that don't spawn a process (like using the cli) squished do regression
rspec ./spec/integration/dead_end_spec.rb:400 # Integration tests that don't spawn a process (like using the cli) handles no spaces between blocks
rspec ./spec/integration/dead_end_spec.rb:447 # Integration tests that don't spawn a process (like using the cli) Format Code blocks real world example
rspec ./spec/integration/dead_end_spec.rb:492 # Integration tests that don't spawn a process (like using the cli) returns syntax error in outer block without inner block
rspec ./spec/integration/dead_end_spec.rb:514 # Integration tests that don't spawn a process (like using the cli) finds multiple syntax errors
rspec ./spec/integration/dead_end_spec.rb:547 # Integration tests that don't spawn a process (like using the cli) finds a naked end
rspec ./spec/integration/dead_end_spec.rb:565 # Integration tests that don't spawn a process (like using the cli) handles mismatched |
```


Failing tests need to be investigated. Most are variations on a missing keyword but present end. Next I want to group related failures together in the file so I can understand which might have competing requirements/properties.

The other thing that seems difficult is that this sometimes identifies one syntax error as several which the old algorithm never did.

Author: schneems

spec/integration/dead_end_spec.rb

@@ -34,6 +34,7 @@ module DeadEnd
       EOM
     end
 
+
     it "re-checks all block code, not just what's visible issues/95" do
       file = fixtures_dir.join("ruby_buildpack.rb.txt")
       io = StringIO.new
@@ -275,5 +276,329 @@ def bark
            19  end
       EOM
     end
+
+    it "works with valid code" do
+      source = <<~'EOM'
+        class OH
+          def hello
+          end
+          def hai
+          end
+        end
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+      out = io.string
+
+      expect(out).to include(<<~EOM)
+        Syntax OK
+      EOM
+    end
+
+    it "squished do regression" do
+      source = <<~'EOM'
+        def call
+          trydo
+            @options = CommandLineParser.new.parse
+            options.requires.each { |r| require!(r) }
+            load_global_config_if_exists
+            options.loads.each { |file| load(file) }
+            @user_source_code = ARGV.join(' ')
+            @user_source_code = 'self' if @user_source_code == ''
+            @callable = create_callable
+            init_rexe_context
+            init_parser_and_formatters
+            # This is where the user's source code will be executed; the action will in turn call `execute`.
+            lookup_action(options.input_mode).call unless options.noop
+            output_log_entry
+          end # one
+        end # two
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+      out = io.string
+
+      expect(out).to eq(<<~'EOM'.indent(2))
+        1  def call
+      ❯ 2    trydo
+      ❯ 15   end # one
+        16 end
+      EOM
+    end
+
+    it "handles mismatched }" do
+      source = <<~EOM
+        class Blerg
+          Foo.call do {
+          puts lol
+          class Foo
+          end # two
+        end # three
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+          1  class Blerg
+        ❯ 2    Foo.call do {
+          4    class Foo
+          5    end # two
+          6  end # three
+      EOM
+    end
+
+    it "handles no spaces between blocks and trailing slash" do
+      source = <<~'EOM'
+        require "rails_helper"
+        RSpec.describe Foo, type: :model do
+          describe "#bar" do
+            context "context" do
+              it "foos the bar with a foo and then bazes the foo with a bar to"\
+                "fooify the barred bar" do
+                travel_to DateTime.new(2020, 10, 1, 10, 0, 0) do
+                  foo = build(:foo)
+                end
+              end
+            end
+          end
+          describe "#baz?" do
+            context "baz has barred the foo" do
+              it "returns true" do # <== HERE
+            end
+          end
+        end
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+           2  RSpec.describe Foo, type: :model do
+          13    describe "#baz?" do
+        ❯ 14      context "baz has barred the foo" do
+          16      end
+          17    end
+          18  end
+      EOM
+    end
+
+    it "handles no spaces between blocks" do
+      source = <<~'EOM'
+        context "foo bar" do
+          it "bars the foo" do
+            travel_to DateTime.new(2020, 10, 1, 10, 0, 0) do
+            end
+          end
+        end
+        context "test" do
+          it "should" do
+        end
+      EOM
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+          7  context "test" do
+        ❯ 8    it "should" do
+          9  end
+      EOM
+    end
+
+    it "finds hanging def in this project" do
+      source = fixtures_dir.join("this_project_extra_def.rb.txt").read
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+           1  module SyntaxErrorSearch
+           3    class DisplayInvalidBlocks
+          17      def call
+          34      end
+        ❯ 36      def filename
+          38      def code_with_filename
+          45      end
+          63    end
+          64  end
+      EOM
+    end
+
+    it "Format Code blocks real world example" do
+      source = <<~'EOM'
+        require 'rails_helper'
+        RSpec.describe AclassNameHere, type: :worker do
+          describe "thing" do
+            context "when" do
+              let(:thing) { stuff }
+              let(:another_thing) { moarstuff }
+              subject { foo.new.perform(foo.id, true) }
+              it "stuff" do
+                subject
+                expect(foo.foo.foo).to eq(true)
+              end
+            end
+          end # line 16 accidental end, but valid block
+            context "stuff" do
+              let(:thing) { create(:foo, foo: stuff) }
+              let(:another_thing) { create(:stuff) }
+              subject { described_class.new.perform(foo.id, false) }
+              it "more stuff" do
+                subject
+                expect(foo.foo.foo).to eq(false)
+              end
+            end
+          end # mismatched due to 16
+        end
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+            1  require 'rails_helper'
+            2
+            3  RSpec.describe AclassNameHere, type: :worker do
+         ❯  4    describe "thing" do
+         ❯ 16    end # line 16 accidental end, but valid block
+         ❯ 30    end # mismatched due to 16
+           31  end
+      EOM
+    end
+
+    it "returns syntax error in outer block without inner block" do
+      source = <<~'EOM'
+        Foo.call
+          def foo
+            puts "lol"
+            puts "lol"
+          end # one
+        end # two
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+          1  Foo.call
+        ❯ 6  end # two
+      EOM
+    end
+
+    it "finds multiple syntax errors" do
+      source = <<~'EOM'
+        describe "hi" do
+          Foo.call
+          end
+        end
+        it "blerg" do
+          Bar.call
+          end
+        end
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+          1  describe "hi" do
+        ❯ 2    Foo.call
+        ❯ 3    end
+          4  end
+      EOM
+
+      expect(io.string).to include(<<~'EOM')
+          5  it "blerg" do
+        ❯ 6    Bar.call
+        ❯ 7    end
+          8  end
+      EOM
+    end
+
+    it "finds a naked end" do
+      source = <<~'EOM'
+        def foo
+          end # one
+        end # two
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+        ❯ end # one
+      EOM
+    end
+
+    it "handles mismatched |" do
+      source = <<~EOM
+        class Blerg
+          Foo.call do |a
+          end # one
+          puts lol
+          class Foo
+          end # two
+        end # three
+      EOM
+
+      io = StringIO.new
+      DeadEnd.call(
+        io: io,
+        source: source
+      )
+
+      expect(io.string).to include(<<~'EOM')
+        Unmatched `|', missing `|' ?
+        Unmatched keyword, missing `end' ?
+
+          1  class Blerg
+        ❯ 2    Foo.call do |a
+          5    class Foo
+          6    end # two
+          7  end # three
+        Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?
+
+          1  class Blerg
+        ❯ 3    end # one
+          5    class Foo
+          6    end # two
+          7  end # three
+      EOM
+
+      raise("this should be one failure, not two")
+    end
+
   end
 end