what_weve_got_here_is_an_error_to_communicate 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzJkODUwYWU1ZGNiZGU2YjdmY2IyMzhlYmZkN2E4NzczMjZlMmYwOA==
-  data.tar.gz: !binary |-
-    ODY5NzA5MDJiNWEzOWM2OGUwZmI1NDcwOTk0YjIxYTc2MzIyYjVkYw==
+SHA1:
+  metadata.gz: f9ff0e4e8188c71874623d5b7f91c3b1628c733c
+  data.tar.gz: aa5acc32a411201dc00d52ebf551b533a36d85fc
 SHA512:
-  metadata.gz: !binary |-
-    ZTQ1YWQzYzA4Y2JlYTkzNmY5ODlmMjEyMjdiYTlmMjc2MmRmMWVhZmJjYWRi
-    MTU3ZGNkODY2NThhMmQ4Yzc2MmE4ODliODRmY2NiNTZhYjUwNDA5N2QxMGVl
-    NmM3YjUzNWZkMjk4ZWQ2MTA0NTA2OWJhMDYyNjg5MjU5NDc5YTA=
-  data.tar.gz: !binary |-
-    YzQzZjBkZjhjNzgyNjEzM2JiN2RiZWQ4ZjU1ZGJiZjAzNTFlNTU1ZDUwNWZl
-    ZDRkYzc4YmEzYTcxMzViZWM2NGVkYjI3YTUxMWIyNjA5Y2JhNWYyYjg1NGVh
-    ZmEyYTlkZmIxODA5NzY1NTBhMGM2YWY0NGZhN2RhM2I0YTc3YTQ=
+  metadata.gz: ad7c22761d89cce4c92264aadd62b3c1c1609d5713ed97c76d06d50cb6c7e5057b8856a3ac2240cb0f14122401cc51c10453bff5ff1f3385a1292cc1124205af
+  data.tar.gz: 67ced68e105811bb22d0a1382eced38ae2830e1c8ebcb06f62852aeb9c0bde436b654217b31c3641452b2a674eee06c2eb45b2a63741a1c8461373cdada82fae

data/lib/error_to_communicate/at_exit.rb

@@ -1,13 +1,23 @@
+require 'interception'
 require 'error_to_communicate'
 
+error_binding  = nil
+recording_code = lambda { |_exc, binding|
+  error_binding = binding
+}
+
+Interception.listen &recording_code
+
 # Deal with global deps and console knowledge here
 at_exit do
+  Interception.unlisten recording_code
   exception = $!
   config    = ErrorToCommunicate::Config.default
 
-  next unless config.accept? exception
+  next unless config.accept? exception, error_binding
+
+  heuristic = config.heuristic_for exception, error_binding
 
-  heuristic = config.heuristic_for exception
   formatted = config.format heuristic, Dir.pwd
   $stderr.puts formatted
 

data/lib/error_to_communicate/config.rb

@@ -50,15 +50,15 @@ module ErrorToCommunicate
       self.project     = Project.new root: root, loaded_features: loaded_features
     end
 
-    def accept?(exception)
-      return false unless ExceptionInfo.parseable? exception
-      einfo = ExceptionInfo.parse(exception)
+    def accept?(exception, binding)
+      return false unless ExceptionInfo.parseable? exception, binding
+      einfo = ExceptionInfo.parse(exception, binding)
       !blacklist.call(einfo) && !!heuristics.find { |h| h.for? einfo }
     end
 
-    def heuristic_for(exception)
-      accept?(exception) || raise(ArgumentError, "Asked for a heuristic on an object we don't accept: #{exception.inspect}")
-      einfo = ExceptionInfo.parse(exception)
+    def heuristic_for(exception, binding)
+      accept?(exception, binding) || raise(ArgumentError, "Asked for a heuristic on an object we don't accept: #{exception.inspect}")
+      einfo = ExceptionInfo.parse(exception, binding)
       heuristics.find { |heuristic| heuristic.for? einfo }
                 .new(einfo: einfo, project: project)
     end

data/lib/error_to_communicate/exception_info.rb

@@ -6,7 +6,7 @@ module ErrorToCommunicate
 end
 
 class ErrorToCommunicate::ExceptionInfo::Location
-  attr_accessor :path, :linenum, :label, :pred, :succ
+  attr_accessor :path, :linenum, :label, :pred, :succ, :binding
 
   def initialize(attributes)
     self.path    = Pathname.new attributes.fetch(:path)
@@ -14,17 +14,19 @@ class ErrorToCommunicate::ExceptionInfo::Location
     self.label   = attributes.fetch :label
     self.pred    = attributes.fetch :pred, nil
     self.succ    = attributes.fetch :succ, nil
+    self.binding = attributes.fetch :binding
   end
 
   # What if the line doesn't match for some reason?
   # Raise an exception?
   # Use some reasonable default? (is there one?)
-  def self.parse(line)
+  def self.parse(line, binding)
     line =~ /^(.*?):(\d+):in `(.*?)'$/ # Are ^ and $ sufficient? Should be \A and (\Z or \z)?
     ErrorToCommunicate::ExceptionInfo::Location.new(
       path:    ($1||""),
       linenum: ($2||"-1").to_i,
       label:   ($3||line),
+      binding: binding
     )
   end
 
@@ -55,6 +57,7 @@ class ErrorToCommunicate::ExceptionInfo
   attr_accessor :classname
   attr_accessor :message
   attr_accessor :backtrace
+  attr_accessor :binding
 
   def initialize(attributes)
     self.exception = attributes.fetch :exception, nil
@@ -74,22 +77,22 @@ class ErrorToCommunicate::ExceptionInfo
     @exception
   end
 
-  def self.parseable?(exception)
+  def self.parseable?(exception, binding)
     exception.respond_to?(:message) && exception.respond_to?(:backtrace)
   end
 
-  def self.parse(exception)
+  def self.parse(exception, binding)
     return exception if exception.kind_of? self
     new exception: exception,
         classname: exception.class.name,
         message:   exception.message,
-        backtrace: parse_backtrace(exception.backtrace)
+        backtrace: parse_backtrace(exception.backtrace, binding)
   end
 
-  def self.parse_backtrace(backtrace)
+  def self.parse_backtrace(backtrace, binding)
     # Really, there are better methods, e.g. backtrace_locations,
     # but they're unevenly implemented across versions and implementations
-    backtrace = (backtrace||[]).map { |line| Location.parse line }
+    backtrace = (backtrace||[]).map { |line| Location.parse line, binding }
     backtrace.each_cons(2) { |crnt, pred| crnt.pred, pred.succ = pred, crnt }
     backtrace
   end

data/lib/error_to_communicate/format_terminal.rb

@@ -38,7 +38,12 @@ module ErrorToCommunicate
       when Array        then semantic_content.map { |c| format c }.join
       when :summary     then format([:separator]) + format(content)
       when :heuristic   then format([:separator]) + format(content)
-      when :backtrace   then format([:separator]) + format(content)
+      when :backtrace   then
+        if content.any?
+          format([:separator]) + format(content)
+        else
+          format([:separator]) + format([:message, "No backtrace available"]) # TODO: Not tested, I hit this with capybara, when RSpec filtered everything out of the backtrace
+        end
       when :separator   then theme.separator_line
       when :columns     then theme.columns     [content, *rest].map { |c| format c }
       when :classname   then theme.classname   format content

data/lib/error_to_communicate/heuristic/no_method_error.rb

@@ -1,4 +1,6 @@
+require 'rouge'
 require 'error_to_communicate/heuristic'
+require 'error_to_communicate/levenshtein'
 
 module ErrorToCommunicate
   class Heuristic
@@ -25,8 +27,57 @@ module ErrorToCommunicate
         ]
       end
 
+      def semantic_explanation
+        if misspelling?
+          "You called the method `#{undefined_method_name}' on `#{name_of_ivar}', which is nil\nPossible misspelling of `#{closest_name}'"
+        else
+          super
+        end
+      end
+
       private
 
+      # FIXME:
+      # Needs to be able to deal with situations like
+      # the line number being within a multiline expression
+      def name_of_ivar
+        return @name_of_ivar if defined? @name_of_ivar
+        file = File.read(einfo.backtrace.first.path)
+        line = file.lines.to_a[einfo.backtrace.first.linenum-1]
+
+        tokens = Rouge::Lexers::Ruby.lex(line).to_a
+        index  = tokens.index { |token, text| text == undefined_method_name }
+
+        while 0 <= index
+          token, text = tokens[index]
+          break if token.qualname == "Name.Variable.Instance"
+          index -= 1
+        end
+
+        @name_of_ivar = if index == -1
+          nil
+        else
+          token, text = tokens[index]
+          text
+        end
+      end
+
+      def existing_ivars
+        # TODO: this should get pushed into the location
+        binding = einfo.backtrace[0].binding
+        return [] unless binding
+        binding.eval('self').instance_variables
+      end
+
+      def misspelling?
+        name_of_ivar && closest_name &&
+          Levenshtein.call(closest_name, name_of_ivar) <= 2
+      end
+
+      def closest_name
+        @closest_name ||= existing_ivars.min_by { |varname| Levenshtein.call varname, name_of_ivar }
+      end
+
       def self.parse_undefined_name(message)
         message[/`(.*)'/, 1]
       end

data/lib/error_to_communicate/heuristic/syntax_error.rb

@@ -20,7 +20,8 @@ module ErrorToCommunicate
                                path:    reported_file,
                                linenum: reported_line,
                                label:   "unexpected #{unexpected}, expected: #{expected}",
-                               pred:    backtrace[0]
+                               pred:    backtrace[0],
+                               binding: nil
       end
 
       def semantic_info

data/lib/error_to_communicate/levenshtein.rb

@@ -0,0 +1,34 @@
+module ErrorToCommunicate
+  class Levenshtein
+    def self.call(target, actual)
+      new(target, actual).distance
+    end
+
+    attr_accessor :target, :actual, :memoized
+    def initialize(target, actual)
+      self.target   = target
+      self.actual   = actual
+      self.memoized = {}
+    end
+
+    def distance
+      @distance ||= call target.length, actual.length
+    end
+
+    def call(target_length, actual_length)
+      memoized[[target_length, actual_length]] ||=
+        if target_length.zero?
+          actual_length
+        elsif actual_length.zero?
+          target_length
+        elsif target[target_length - 1] == actual[actual_length - 1]
+          call(target_length - 1, actual_length - 1)
+        else
+          [ call(target_length    , actual_length - 1),
+            call(target_length - 1, actual_length    ),
+            call(target_length - 1, actual_length - 1),
+          ].min + 1
+        end
+    end
+  end
+end

data/lib/error_to_communicate/rspec_formatter.rb

@@ -1,3 +1,4 @@
+require 'interception'
 require 'error_to_communicate'
 require 'rspec/core/formatters/documentation_formatter'
 
@@ -17,10 +18,11 @@ module ErrorToCommunicate
       self.failure_number = attributes.fetch :failure_number
       self.failure        = attributes.fetch :failure
       self.config         = attributes.fetch :config
+      binding             = attributes.fetch :binding
 
       # initialize the heuristic
-      ExceptionInfo.parse(failure.exception).tap do |einfo|
-        einfo.backtrace = ExceptionInfo.parse_backtrace failure.formatted_backtrace
+      ExceptionInfo.parse(failure.exception, binding).tap do |einfo|
+        einfo.backtrace = ExceptionInfo.parse_backtrace failure.formatted_backtrace, binding
         super einfo: einfo, project: config.project
       end
 
@@ -41,7 +43,7 @@ module ErrorToCommunicate
               [:classname, failure.description]]]] # TODO: not classname
       else
         # wrap the heuristic that would otherwise be chosen
-        heuristic             = config.heuristic_for einfo
+        heuristic             = config.heuristic_for einfo, binding
         self.semantic_info    = heuristic.semantic_info
         self.semantic_summary =
           [:summary, [
@@ -60,8 +62,18 @@ module ErrorToCommunicate
     end
   end
 
+  module ExceptionRecorder
+    extend self
+    def record_exception_bindings(config)
+      config.around do |spec|
+        Thread.current[:e2c_last_binding_seen] = nil
+        Interception.listen(spec) { |_exc, binding| Thread.current[:e2c_last_binding_seen] ||= binding }
+      end
+    end
+    ::RSpec.configure { |config| record_exception_bindings config }
+  end
 
-  class RSpecFormatter < RSpec::Core::Formatters::DocumentationFormatter
+  class RSpecFormatter < ::RSpec::Core::Formatters::DocumentationFormatter
     # Register for notifications from our parent classes
     #   http://rspec.info/documentation/3.2/rspec-core/RSpec/Core/Formatters.html
     #
@@ -71,6 +83,22 @@ module ErrorToCommunicate
     #     }
     RSpec::Core::Formatters.register self
 
+    def initialize(*)
+      @num_failures = 0
+      super
+    end
+
+    def example_failed(failure_notification)
+      super
+      # we must create it here, because it won't have access to the callstack later
+      example = failure_notification.example
+      example.metadata[:heuristic] = Heuristic::RSpecFailure.new \
+        config:         Config.default, # E2C heuristic, not RSpec's
+        failure:        failure_notification,
+        failure_number: (@num_failures += 1),
+        binding:        Thread.current[:e2c_last_binding_seen]
+    end
+
     # Use ErrorToCommunicate to print error info
     # rather than default DocumentationFormatter.
     #
@@ -82,11 +110,8 @@ module ErrorToCommunicate
     #        but we can't currently turn colour off in our output
     def dump_failures(notification)
       output.puts "\nFailures:\n"
-      notification.failure_notifications.each.with_index(1) do |failure, failure_number|
-        heuristic = Heuristic::RSpecFailure.new \
-          config:         Config.default,
-          failure:        failure,
-          failure_number: failure_number
+      notification.failure_notifications.each do |notification|
+        heuristic = notification.example.metadata.fetch :heuristic
         formatted = Config.default.format heuristic, Dir.pwd
         output.puts formatted.chomp.gsub(/^/, '  ')
       end

data/lib/error_to_communicate/version.rb

@@ -1,3 +1,3 @@
 module ErrorToCommunicate
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/spec/acceptance/unexpected_nil_spec.rb

@@ -0,0 +1,44 @@
+require 'acceptance/spec_helper'
+
+RSpec.context 'Exception', acceptance: true do
+  it 'Prints heuristics' do
+    write_file 'misspelled_ivar.rb', <<-BODY
+      require "what_weve_got_here_is_an_error_to_communicate"
+      User  = Struct.new :name
+
+      class Email
+        def initialize(user)
+          @user = user
+        end
+
+        def body
+          "Dear, \#{@uesr.name}, <3 <3 <3"
+        end
+      end
+
+      Email.new(User.new 'Jorge').body
+    BODY
+
+    invocation = ruby 'misspelled_ivar.rb'
+    stderr     = strip_color invocation.stderr
+
+    # sanity
+    expect(invocation.stdout).to     eq ''
+    expect(invocation.exitstatus).to eq 1
+
+    # error: It prints the exception class and prints the message
+    expect(stderr).to match /NoMethodError/
+    expect(stderr).to match /You called the method `name' on `@uesr', which is nil/
+
+    # Suggests a fix
+    expect(stderr).to match /possible misspelling of `@user'/i
+
+    # Shows where the method was called
+    expect(stderr).to include '"Dear, #{@uesr.name}, <3 <3 <3"'
+
+    # MAYBE: shows where the correctly spelled variable was set
+
+    # typical backtrace
+    expect(stderr).to include 'misspelled_ivar.rb:10'
+  end
+end

data/spec/config_spec.rb

@@ -20,11 +20,13 @@ RSpec.describe 'configuration', config: true do
 
   # helper methods
   def yes_accept!(config, ex)
-    expect(config.accept? ex).to eq true
+    binding = nil
+    expect(config.accept? ex, binding).to eq true
   end
 
   def no_accept!(config, ex)
-    expect(config.accept? ex).to eq false
+    binding = nil
+    expect(config.accept? ex, binding).to eq false
   end
 
   def config_for(attrs)
@@ -72,18 +74,20 @@ RSpec.describe 'configuration', config: true do
   end
 
   describe 'finding the heuristic for an exception' do
-    it 'raises an ArgumentError if given an acception that it won\'t accept' do
+    it 'raises an ArgumentError if given an ecception that it won\'t accept' do
       config = config_for blacklist:  allow_none, heuristics: [match_all]
-      expect { config.heuristic_for "not an error" }
+      binding = nil
+      expect { config.heuristic_for "not an error", binding }
         .to raise_error ArgumentError, /"not an error"/
     end
 
     it 'finds the first heuristic that is willing to accept it' do
+      binding = nil
       config = config_for blacklist:  allow_all,
                           heuristics: [match_no_method_error, match_all]
       exception = capture { sdfsdfsdf() }
-      expect(config.heuristic_for exception).to     be_a_kind_of match_no_method_error
-      expect(config.heuristic_for exception).to_not be_a_kind_of match_all
+      expect(config.heuristic_for exception, binding).to     be_a_kind_of match_no_method_error
+      expect(config.heuristic_for exception, binding).to_not be_a_kind_of match_all
     end
   end
 
@@ -92,11 +96,12 @@ RSpec.describe 'configuration', config: true do
 
     describe 'blacklist' do
       it 'doesn\'t accept a SystemExit' do
+        binding = nil
         system_exit = capture { exit 1 }
-        expect(default_config.accept? system_exit).to eq false
+        expect(default_config.accept? system_exit, binding).to eq false
 
         generic_exception = capture { raise }
-        expect(default_config.accept? generic_exception).to eq true
+        expect(default_config.accept? generic_exception, binding).to eq true
       end
     end
 

data/spec/heuristic/no_method_error_spec.rb

@@ -22,4 +22,54 @@ RSpec.describe 'Heuristic for a NoMethodError', heuristic: true do
     extracts_method_name! '<', "undefined method `<' for nil:NilClass"
     extracts_method_name! "ab `c' d", "undefined method `ab `c' d' for main:Object"
   end
+
+  describe 'on nil' do
+    describe 'for an instance variable' do
+      it 'suggest a closely spelled variable name if one exists' do
+        @abcd = 123
+        err = nil
+        begin
+          @abce.even?
+        rescue NoMethodError => no_method_error
+          err = no_method_error
+        end
+
+        heuristic = heuristic_class.new project: build_default_project,
+                                        einfo:   einfo_for(err, binding)
+        expect(heuristic.semantic_explanation).to match /@abcd/
+        expect(heuristic.semantic_explanation).to match /@abce/
+        expect(heuristic.semantic_explanation).to match /spell/
+      end
+
+      it 'does not suggest a misspelling when there is no spelled variable' do
+        @abcd = 123
+        err = nil
+        begin
+          @ablol.even?
+        rescue NoMethodError => no_method_error
+          err = no_method_error
+        end
+
+        heuristic = heuristic_class.new project: build_default_project,
+                                        einfo:   einfo_for(err, binding)
+        expect(heuristic.semantic_explanation).to_not match /spell/
+        expect(heuristic.semantic_explanation).to_not match /@abcd/
+      end
+
+      it 'doesn\'t suggest this when there is no binding provided' do
+        @abcd = 123
+        err = nil
+        begin
+          @abce.even?
+        rescue NoMethodError => no_method_error
+          err = no_method_error
+        end
+
+        heuristic = heuristic_class.new project: build_default_project,
+                                        einfo:   einfo_for(err, nil)
+        expect(heuristic.semantic_explanation).to_not match /spell/
+        expect(heuristic.semantic_explanation).to_not match /@abcd/
+      end
+    end
+  end
 end

data/spec/heuristic/spec_helper.rb

@@ -10,7 +10,8 @@ module HeuristicSpecHelpers
 
   def heuristic_for(attributes={})
     heuristic_class.new project: build_default_project(attributes),
-                        einfo:   einfo_for(FakeException.new attributes)
+                        einfo:   einfo_for(FakeException.new(attributes),
+                                           attributes[:binding])
   end
 
   def build_default_project(attributes={})

data/spec/heuristic/wrong_number_of_arguments_spec.rb

@@ -78,7 +78,7 @@ RSpec.describe 'heuristics for the WrongNumberOfArguments', heuristic: true do
                         context:   (-5..5),
                         emphasis: :code,
                         location: ErrorToCommunicate::ExceptionInfo::Location.new(
-                                    path: '/a', linenum: 1, label: 'b'
+                                    path: '/a', linenum: 1, label: 'b', binding: nil
                                   )
   end
 

data/spec/heuristic_spec.rb

@@ -4,7 +4,7 @@ require 'heuristic/spec_helper'
 
 RSpec.describe 'Heuristic', heuristic: true do
   let(:einfo)    { ErrorToCommunicate::ExceptionInfo.new classname: 'the classname', message: 'the message', backtrace: [
-                     ErrorToCommunicate::ExceptionInfo::Location.new(path: 'file', linenum: 12, label: 'a')
+                     ErrorToCommunicate::ExceptionInfo::Location.new(path: 'file', linenum: 12, label: 'a', binding: nil)
                    ]
                  }
   let(:subclass) { Class.new ErrorToCommunicate::Heuristic }

data/spec/levenshtein_spec.rb

@@ -0,0 +1,64 @@
+require 'error_to_communicate/levenshtein'
+
+RSpec.describe ErrorToCommunicate::Levenshtein do
+  def assert_distance(distance, target, actual)
+    expect(described_class.call target, actual).to eq distance
+  end
+
+  specify 'count one distance for each substitution' do
+    assert_distance 1, "kitten", "sitten" # "s" for "k"
+    assert_distance 1, "sitten", "sittin" # "i" for "e"
+    assert_distance 2, "sitten", "sitxin" # "i" for "e", and "x" for "t"
+  end
+
+  example 'count one distance for each addition' do
+    assert_distance 1, "sittin", "sitting" # "g"
+    assert_distance 2, "sitin",  "sitting"  # "t", and "g"
+    assert_distance 2, "cat",    "catch"    # "ch"
+  end
+
+  example 'count one distance for each deletion' do
+    assert_distance 1, "sitting", "sittin" # "g"
+    assert_distance 2, "sitting", "sitin"  # "t", and "g"
+    assert_distance 2, "catch",   "cat"    # "ch"
+  end
+
+  example 'add the various numbers' do
+    # add "a" at beginning
+    # delete "h" from end
+    # swap "X" to "d"
+    assert_distance 3, "abcdefg", "bcXefgh"
+  end
+
+  describe 'some edge cases' do
+    [ ['--a', 'a', 2],
+      ['a', '--a', 2],
+      ['-a-', 'a', 2],
+      ['a', '-a-', 2],
+      ['---', 'a', 3],
+      ['a', '---', 3],
+      ['aaa', 'bbb', 3],
+      ['bbb', 'aaa', 3],
+    ].each do |s1, s2, distance|
+      example "distance(#{s1.inspect}, #{s2.inspect}) # => #{distance.inspect}" do
+        assert_distance distance, s1, s2
+      end
+    end
+  end
+
+  specify 'it is not crazy stupid slow' do
+    # When comparing "aaa", "bbb",
+    # This algorithm compares 94 pairs of strings.
+    # When those pairs are uniqued, there are only 16 left,
+    # so it is doing 78 redundant steps.
+    #
+    # At length 4 ("aaaa", "bbbb"), it does 481 comparisons instead of 25
+    # At length 5, 2524 instead of 36
+    # At length 10, 12_146_179 instead of 121, and it took 52.585554 seconds
+    n = 100
+    start = Time.now
+    assert_distance n, "a"*n, "b"*n
+    time = Time.now - start
+    expect(time).to be < 1
+  end
+end

data/spec/parsing_exception_info_spec.rb

@@ -63,7 +63,8 @@ RSpec.describe 'Parsing exceptions to ExceptionInfo', einfo: true do
     # it 'records the relative filepath if it cannot fild the file'
 
     def assert_parses_line(line, assertions)
-      parsed = ErrorToCommunicate::ExceptionInfo::Location.parse(line)
+      binding = nil
+      parsed = ErrorToCommunicate::ExceptionInfo::Location.parse(line, binding)
       assertions.each do |method_name, expected|
         expected = Pathname.new expected if method_name == :path
         actual   = parsed.__send__ method_name
@@ -85,11 +86,14 @@ RSpec.describe 'Parsing exceptions to ExceptionInfo', einfo: true do
 
     context 'fake backtraces (eg RSpec renders text in the `formatted_backtrace` to get it to print messages there)' do
       it 'has an empty path, linenum of -1, the entire string is the label' do
-        a, b, c = parsed = ErrorToCommunicate::ExceptionInfo.parse_backtrace([
-          "/Users/josh/.gem/ruby/2.1.1/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:29:in `block in autorun'",
-          "",
-          "  Showing full backtrace because every line was filtered out.",
-        ])
+        binding = nil
+        a, b, c = parsed = ErrorToCommunicate::ExceptionInfo.parse_backtrace(
+          [ "/Users/josh/.gem/ruby/2.1.1/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:29:in `block in autorun'",
+            "",
+            "  Showing full backtrace because every line was filtered out.",
+          ],
+          binding
+        )
 
         expect(parsed.map(&:path).map(&:to_s)).to eq [
           "/Users/josh/.gem/ruby/2.1.1/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb",
@@ -158,6 +162,7 @@ RSpec.describe 'Parsing exceptions to ExceptionInfo', einfo: true do
 
   describe 'ExceptionInfo::Location' do
     def location_for(attrs)
+      attrs[:binding] ||= nil
       ErrorToCommunicate::ExceptionInfo::Location.new attrs
     end
 

data/spec/rspec_formatter_spec.rb

@@ -122,7 +122,8 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
       heuristic = ErrorToCommunicate::Heuristic::RSpecFailure.new \
         config:         ErrorToCommunicate::Config.default,
         failure:        failure_for(description: 'DESC', type: :assertion),
-        failure_number: 999
+        failure_number: 999,
+        binding:        binding
       summaryname, ((columnsname, *columns)) = heuristic.semantic_summary
       expect(summaryname).to eq :summary
       expect(columnsname).to eq :columns
@@ -132,9 +133,10 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
     specify 'the info is the formatted error message and first line from the backtrace with some context' do
       config    = ErrorToCommunicate::Config.new
       heuristic = ErrorToCommunicate::Heuristic::RSpecFailure.new \
-        config:   ErrorToCommunicate::Config.default,
-        failure: failure_for(type: :assertion, message: 'MESSAGE', formatted_backtrace: ["/file:123:in `method'"]),
-        failure_number: 999
+        config:         ErrorToCommunicate::Config.default,
+        failure:        failure_for(type: :assertion, message: 'MESSAGE', formatted_backtrace: ["/file:123:in `method'"]),
+        failure_number: 999,
+        binding:        binding
       heuristicname, ((messagename, message), (codename, codeattrs), *rest) = heuristic.semantic_info
       expect(heuristicname).to eq :heuristic
       expect(messagename  ).to eq :message
@@ -151,7 +153,8 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
       heuristic = ErrorToCommunicate::Heuristic::RSpecFailure.new \
         config:         ErrorToCommunicate::Config.default,
         failure_number: 999,
-        failure:        failure_for(type: :assertion, message: 'MESSAGE', formatted_backtrace: [])
+        failure:        failure_for(type: :assertion, message: 'MESSAGE', formatted_backtrace: []),
+        binding:        binding
       heuristicname, ((messagename, message), *rest) = heuristic.semantic_info
       expect(heuristicname).to eq :heuristic
       expect(messagename  ).to eq :message
@@ -180,7 +183,8 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
         failure: failure_for(message:     "wrong number of arguments (1 for 0)",
                              description: 'DESC',
                              type:        :argument_error),
-        failure_number: 999
+        failure_number: 999,
+        binding:        binding
       summaryname, ((columnsname, *columns)) = heuristic.semantic_summary
       expect(summaryname).to eq :summary
       expect(columnsname).to eq :columns
@@ -193,12 +197,34 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
         .to receive(:semantic_info).and_return("SEMANTICINFO")
 
       heuristic = ErrorToCommunicate::Heuristic::RSpecFailure.new \
-        config:  ErrorToCommunicate::Config.new,
-        failure: failure_for(message: "wrong number of arguments (1 for 0)", type: :argument_error),
-        failure_number: 999
+        config:         ErrorToCommunicate::Config.new,
+        failure:        failure_for(message: "wrong number of arguments (1 for 0)", type: :argument_error),
+        failure_number: 999,
+        binding:        binding
 
       expect(heuristic.semantic_info).to eq "SEMANTICINFO"
     end
+
+    it 'provides the bindings needed for some of the advanced analysis' do
+      formatter = new_formatter
+      context_around_failure = this_line_of_code
+      run_specs_against formatter do
+        example('suggests better name1') {
+          @abc = 123
+          @abd.even? # misspelled
+        }
+        example('suggests better name2') {
+          @lol = 123
+          @lul.even? # misspelled
+        }
+      end
+
+
+      # Sigh the above whitespace is important, or it can pass because the assertion is in the code displayed for context
+      # It's stupid, I know
+      expect(get_printed formatter).to include "Possible misspelling of `@lol'"
+      expect(get_printed formatter).to include "Possible misspelling of `@abc'"
+    end
   end
 
   context 'fixing the message\'s whitespace' do

data/spec/spec_helper.rb

@@ -12,8 +12,8 @@ class FakeException
 end
 
 module SpecHelpers
-  def einfo_for(exception)
-    ErrorToCommunicate::ExceptionInfo.parse exception
+  def einfo_for(exception, binding=nil)
+    ErrorToCommunicate::ExceptionInfo.parse exception, binding
   end
 
   def trap_warnings

data/what_weve_got_here_is_an_error_to_communicate.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/JoshCheek/what-we-ve-got-here-is-an-error-to-communicate'
 
   s.add_runtime_dependency 'rouge', '~> 1.8', '!= 1.9.1'
-  # s.add_runtime_dependency 'interception',      '~> 0.5'
-  # s.add_runtime_dependency 'binding_of_caller', '~> 0.7.2'
+  s.add_runtime_dependency 'interception',      '~> 0.5'
+  s.add_runtime_dependency 'binding_of_caller', '~> 0.7.2'
 
   s.add_development_dependency 'rspec', '~> 3.2'
   s.add_development_dependency 'haiti', '< 0.3',  '>= 0.2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: what_weve_got_here_is_an_error_to_communicate
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Josh Cheek
@@ -9,94 +9,122 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 1.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: interception
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: haiti
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.3'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.3'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.11'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '0.11'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
 description: Hooks into program lifecycle to display error messages to you in a helpufl
@@ -106,9 +134,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Rakefile
 - Readme.md
@@ -129,6 +157,7 @@ files:
 - lib/error_to_communicate/heuristic/no_method_error.rb
 - lib/error_to_communicate/heuristic/syntax_error.rb
 - lib/error_to_communicate/heuristic/wrong_number_of_arguments.rb
+- lib/error_to_communicate/levenshtein.rb
 - lib/error_to_communicate/project.rb
 - lib/error_to_communicate/rspec_formatter.rb
 - lib/error_to_communicate/theme.rb
@@ -144,6 +173,7 @@ files:
 - spec/acceptance/short_and_long_require_spec.rb
 - spec/acceptance/spec_helper.rb
 - spec/acceptance/syntax_error_spec.rb
+- spec/acceptance/unexpected_nil_spec.rb
 - spec/acceptance/wrong_number_of_arguments_spec.rb
 - spec/config_spec.rb
 - spec/heuristic/exception_spec.rb
@@ -152,6 +182,7 @@ files:
 - spec/heuristic/spec_helper.rb
 - spec/heuristic/wrong_number_of_arguments_spec.rb
 - spec/heuristic_spec.rb
+- spec/levenshtein_spec.rb
 - spec/parsing_exception_info_spec.rb
 - spec/rspec_formatter_spec.rb
 - spec/spec_helper.rb
@@ -166,17 +197,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Readable, helpful error messages