what_weve_got_here_is_an_error_to_communicate 0.0.1

data/spec/parse/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.shared_examples 'an exception parser' do |attributes|
+  let(:message)     { attributes.fetch :sample_message }
+  let(:explanation) { attributes.fetch :sample_explanation, message }
+
+  let :exception do
+    FakeException.new message:   message,
+                      backtrace: ["/Users/someone/a/b/c.rb:123:in `some_method_name'"]
+  end
+
+  it 'records the exception, class name, and explanation comes from the message' do
+    info = parse exception
+    expect(info.exception  ).to equal exception
+    expect(info.classname  ).to eq 'FakeException'
+    expect(info.explanation).to eq explanation
+  end
+
+  it 'records the backtrace locations' do
+    info = parse exception
+    expect(info.backtrace.map &:linenum).to eq [123]
+  end
+end

data/spec/parse/wrong_number_of_arguments_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'parse/spec_helper'
+require 'error_to_communicate/parse/wrong_number_of_arguments'
+
+RSpec.describe 'parsing wrong number of arguments', parse: true do
+  def parse(exception)
+    WhatWeveGotHereIsAnErrorToCommunicate::Parse::WrongNumberOfArguments.parse(exception)
+  end
+
+  it_behaves_like 'an exception parser',
+    sample_message:     "wrong number of arguments (1 for 0) (ArgumentError)",
+    sample_explanation: "Wrong number of arguments"
+
+  describe 'parse?' do
+    def will_parse?(exception)
+      WhatWeveGotHereIsAnErrorToCommunicate::Parse::WrongNumberOfArguments.parse?(exception)
+    end
+
+    def will_parse!(exception)
+      expect(will_parse? exception).to be_truthy
+    end
+
+    def wont_parse!(exception)
+      expect(will_parse? exception).to be_falsy
+    end
+
+    it 'is true when given an MRI style wrong number of arguments message' do
+      will_parse! ArgumentError.new "wrong number of arguments (1 for 0)"
+    end
+
+    it 'is true when given an RBX style wrong number of arguments message' do
+      will_parse! ArgumentError.new "method 'a': given 1, expected 0"
+    end
+
+    it 'is true when given an JRuby style wrong number of arguments message' do
+      will_parse! ArgumentError.new "wrong number of arguments calling `a` (1 for 0)"
+    end
+
+    it 'is true when given an MRI style wrong number of arguments message' do
+      will_parse! ArgumentError.new "wrong number of arguments (1 for 0)"
+    end
+
+    it 'is false for ArgumentErrors that are not "wrong number of arguments"' do
+      wont_parse!  ArgumentError.new "Some other kind of ArgumentError"
+    end
+
+    it 'is false when the message is contained within some other message (not overeager)' do
+      wont_parse! RSpec::Expectations::ExpectationNotMetError.new(<<-MESSAGE)
+       expected: "wrong number of arguments (1 for 0) (ArgumentError)"
+            got: "Wrong number of arguments"
+
+            (compared using ==)
+      MESSAGE
+    end
+  end
+
+  describe 'parse' do
+    let(:mri_message) { "wrong number of arguments (1 for 0)" }
+    let(:mri_parsed)  { parse FakeException.new(message: mri_message) }
+
+    let(:rbx_message) { "method 'a': given 1, expected 0" }
+    let(:rbx_parsed)  { parse FakeException.new(message: rbx_message) }
+
+    let(:jruby_message) { "wrong number of arguments calling `a` (1 for 0)" }
+    let(:jruby_parsed)  { parse FakeException.new(message: "wrong number of arguments calling `a` (1 for 0)") }
+
+    it 'extracts the number of arguments that were passed' do
+      expect(rbx_parsed.num_expected).to eq 0
+      expect(mri_parsed.num_expected).to eq 0
+    end
+
+    it 'extracts the number of arguments that were received' do
+      expect(rbx_parsed.num_received).to eq 1
+      expect(mri_parsed.num_received).to eq 1
+    end
+  end
+end

data/spec/rspec_formatter_spec.rb

@@ -0,0 +1,95 @@
+require 'stringio'
+require 'spec_helper'
+
+RSpec.describe ErrorToCommunicate::RSpecFormatter, formatter: true do
+  let(:substring_that_would_only_be_in_full_backtrace) { 'lib/rspec/core' }
+
+  def formatter_for(attributes)
+    outstream = attributes.fetch(:outstream) { StringIO.new }
+    described_class.new(outstream)
+  end
+
+  def new_formatter
+    formatter_for({})
+  end
+
+  # The interfaces mocked out here were taken from RSpec 3.2.2
+  # They're all private, but IDK how else to test it :/
+  def run_specs_against(formatter, *describe_args, &describe_block)
+    # Create the example group
+    # define some methods to decouple it from the global test suite
+    group = RSpec::Core::ExampleGroup.describe(*describe_args, &describe_block)
+    class << group
+      alias filtered_examples examples
+      def fail_fast?() false end
+    end
+
+    # The reporter calls into our formatter
+    reporter = RSpec::Core::Reporter.new(RSpec::Core::Configuration.new)
+
+    # Register the formatter for all notifications it would actually receive
+    registered_notifications = formatter.class.ancestors.flat_map do |ancestor|
+      RSpec::Core::Formatters::Loader.formatters.fetch(ancestor, [])
+    end
+    registered_notifications.each do |notification|
+      reporter.register_listener formatter, notification
+    end
+
+    # Fake out the runner
+    # ordering comes from: http://rspec.info/documentation/3.2/rspec-core/RSpec/Core/Formatters.html
+    reporter.start(expected_example_count=123)
+    group.run(reporter)
+    reporter.finish
+  end
+
+  def this_line_of_code
+    file, line = caller[0].split(":").take(2)
+    File.read(file).lines[line.to_i].strip
+  end
+
+  def get_printed(formatter)
+    # FIXME: hack until we get it respecting colour on/off
+    formatter.output.string.gsub(/\e\[\d+(;\d+)*?m/, '')
+  end
+
+  it 'uses our lib to print the details of failing examples.' do
+    formatter = new_formatter
+    context_around_failure = this_line_of_code
+    run_specs_against formatter do
+      example('will fail') { fail }
+    end
+    expect(get_printed formatter).to include context_around_failure
+
+    formatter = new_formatter
+    context_around_success = this_line_of_code
+    run_specs_against formatter do
+      example('will pass') { }
+    end
+    expect(get_printed formatter).to_not include context_around_success
+  end
+
+  it 'numbers the failure and prints the failure descriptions' do
+    formatter = new_formatter
+    run_specs_against formatter, 'GroupName' do
+      example('hello') { fail }
+      example('world') { fail }
+    end
+    expect(get_printed formatter).to match /1\)\s*GroupName\s*hello/
+    expect(get_printed formatter).to match /2\)\s*GroupName\s*world/
+  end
+
+  it 'respects the backtrace formatter (ie the --backtrace flag)' do
+    # only need to check a failing example to show it uses RSpec's backtrace formatter
+    formatter = new_formatter
+    run_specs_against(formatter) { example { fail } }
+    expect(get_printed formatter)
+      .to_not include substring_that_would_only_be_in_full_backtrace
+  end
+
+  it 'respects colour enabling/disabling' do
+    # https://github.com/rspec/rspec-core/blob/2a07aa92560cf6d4ae73ab04ff3b9b565451e83f/spec/rspec/core/formatters/console_codes_spec.rb#L35
+    # allow(RSpec.configuration).to receive(:color_enabled?) { true }
+    pending 'We don\'t yet have the ability to turn color printing on/off'
+    fail
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+class FakeException
+  attr_reader :message, :backtrace
+
+  def initialize(attributes)
+    @message   = attributes.fetch :message, 'default message'
+    @backtrace = attributes.fetch(:backtrace, [])
+  end
+
+  def exception
+    self
+  end
+end
+
+RSpec.configure do |config|
+  # Stop testing after first failure
+  config.fail_fast = true
+
+  # Don't define should/describe on Object
+  config.disable_monkey_patching!
+end

data/what_weve_got_here_is_an_error_to_communicate.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/error_to_communicate/version'
+Gem::Specification.new do |s|
+  s.name        = 'what_weve_got_here_is_an_error_to_communicate'
+  s.version     = WhatWeveGotHereIsAnErrorToCommunicate::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = "Readable, helpful error messages"
+  s.description = "Hooks into program lifecycle to display error messages to you in a helpufl way, with inlined code, colour, and helpful heuristics about what might be the cause."
+  s.authors     = ["Josh Cheek", "Ben Voss"]
+  s.email       = 'josh.cheek@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/JoshCheek/what-we-ve-got-here-is-an-error-to-communicate'
+
+  s.add_runtime_dependency 'coderay', '~> 1.1'
+
+  s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'haiti', '< 0.3',  '>= 0.2.0'
+  s.add_development_dependency 'pry',   '< 0.11', '>= 0.10.0'
+  s.add_development_dependency 'rake',  '~> 10.4'
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: what_weve_got_here_is_an_error_to_communicate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Cheek
+- Ben Voss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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
+  way, with inlined code, colour, and helpful heuristics about what might be the cause.
+email: josh.cheek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Rakefile
+- Readme.md
+- acceptance
+- experiments/formatting/5_potential_structure_dsls.rb
+- experiments/formatting/half_thoughtout_dsl_for_toplevel_structure_of_argument_error.rb
+- experiments/formatting/haml_like_structure.rb
+- experiments/formatting/other_structures
+- lib/error_to_communicate.rb
+- lib/error_to_communicate/at_exit.rb
+- lib/error_to_communicate/config.rb
+- lib/error_to_communicate/exception_info.rb
+- lib/error_to_communicate/format.rb
+- lib/error_to_communicate/format/terminal_helpers.rb
+- lib/error_to_communicate/parse/backtrace.rb
+- lib/error_to_communicate/parse/exception.rb
+- lib/error_to_communicate/parse/no_method_error.rb
+- lib/error_to_communicate/parse/registry.rb
+- lib/error_to_communicate/parse/wrong_number_of_arguments.rb
+- lib/error_to_communicate/rspec_formatter.rb
+- lib/error_to_communicate/version.rb
+- lib/what_weve_got_here_is_an_error_to_communicate.rb
+- screenshot.png
+- spec/acceptance/argument_error_spec.rb
+- spec/acceptance/exception_spec.rb
+- spec/acceptance/no_error_spec.rb
+- spec/acceptance/no_methood_error_spec.rb
+- spec/acceptance/spec_helper.rb
+- spec/parse/backtrace_spec.rb
+- spec/parse/exception_spec.rb
+- spec/parse/no_method_error_spec.rb
+- spec/parse/registered_parsers_spec.rb
+- spec/parse/spec_helper.rb
+- spec/parse/wrong_number_of_arguments_spec.rb
+- spec/rspec_formatter_spec.rb
+- spec/spec_helper.rb
+- what_weve_got_here_is_an_error_to_communicate.gemspec
+homepage: https://github.com/JoshCheek/what-we-ve-got-here-is-an-error-to-communicate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Readable, helpful error messages
+test_files: []
+has_rdoc: