what_weve_got_here_is_an_error_to_communicate 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12af0343c9c23e6c0e1ac4b5d513417855dbfdea
-  data.tar.gz: 5ad485865fe4165c3962971c33b4e0e1610bd21b
+  metadata.gz: 4ca3047fc7ba0e7fb3e7a4fe8ca51b4f446d3eb7
+  data.tar.gz: ab9dfedf5db56ff643deca9372afb664f8bda1be
 SHA512:
-  metadata.gz: ddad810a03f2ad851f9107f6b4eb18a4c0c459da0f91284764507b3a19103d1c60df319a61a45f6cfc56a2b47f30e2e8d7ddc5a6859149cb6bb980ab9247b868
-  data.tar.gz: dd0986ce38c6b8902389aa43f3f4957ccee503575ce14a8fd9cc4cdde5a2591b56c70546ce4c88297449b7786a4210d99763c1e9a8d4471d4134291af77f835b
+  metadata.gz: 63d38ceee5ac2921c79ea3d4bf517770d75ceeabe96345dc50c33f59f17c822d6bbec08e30438df2af23d81f066b6dcd6d0cb16661259aa32d2409f5afbb259a
+  data.tar.gz: a898e22af4fd9c765a8c43cc15dcc818ca50a9271b0e82d532c285eb9ef1b94dcd262da82c132543fc63c995460c80137f6f3d65cd05f8dc920ef13f98bdcd82

data/Readme.md

@@ -7,7 +7,7 @@ Blog explaining the goal [here](http://blog.turing.io/2015/01/18/what-we-ve-got-
 
 A screenshot of the code rendering an `ArgumentError`.
 
-![screenshot](https://s3.amazonaws.com/josh.cheek/images/scratch/better-reuby-commandline-errors.png)
+![screenshot](https://s3.amazonaws.com/josh.cheek/images/scratch/error-to-communicate.png)
 
 
 This is still early and Rough
@@ -16,10 +16,11 @@ This is still early and Rough
 But I've been using it on its own test suite, and have to say it's compelling!
 
 
-Using this with RSpec or [MRspec](https://github.com/JoshCheek/mrspec)
-----------------------------------------------------------------------
+Using this with RSpec or Minitest
+---------------------------------
 
-Place this in your .rspec file :)
+Place this in your .rspec file to use with RSpec. Or just use [MRspec](https://github.com/JoshCheek/mrspec),
+which works with both RSpec and Minitest and requires no configuration :)
 
 ```
 --colour

data/lib/error_to_communicate/rspec_formatter.rb

@@ -3,6 +3,13 @@ require 'rspec/core/formatters/documentation_formatter'
 
 module ErrorToCommunicate
   class Heuristic::RSpecFailure < Heuristic
+    def self.fix_whitespace(str)
+      str = str.dup
+      str.sub! /\A\n*/, "" # remove leading newlines
+      str.sub! /\n*\Z/, "" # remove trailing newlines
+      str << "\n"          # one newline on the end
+    end
+
     attr_accessor :failure, :failure_number, :config
     attr_accessor :semantic_summary, :semantic_info
 
@@ -21,7 +28,7 @@ module ErrorToCommunicate
         # format it with our lib
         self.semantic_info =
           [:heuristic, [ # ":heuristic" is dumb, it's not a heuristic, it's an error message, Maybe we need a :section or something?
-            [:message, message.sub(/\A\n*/, "")],
+            [:message, self.class.fix_whitespace(message)],
             *backtrace.take(1).map { |loc|
               [:code, {location: loc, context: (-5..5), emphasis: :code}]
             }

data/lib/error_to_communicate/version.rb

@@ -1,3 +1,3 @@
 module ErrorToCommunicate
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/spec/rspec_formatter_spec.rb

@@ -129,7 +129,7 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
       expect(columns.map &:last).to eq [999, 'DESC']
     end
 
-    specify 'the info is the error message and first line from the backtrace with some context' 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,
@@ -138,7 +138,7 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
       heuristicname, ((messagename, message), (codename, codeattrs), *rest) = heuristic.semantic_info
       expect(heuristicname).to eq :heuristic
       expect(messagename  ).to eq :message
-      expect(message      ).to eq 'MESSAGE'
+      expect(message      ).to eq "MESSAGE\n"
       expect(codename     ).to eq :code
       expect(codeattrs[:location].path.to_s).to eq '/file'
       expect(codeattrs[:context]).to eq (-5..5)
@@ -155,7 +155,7 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
       heuristicname, ((messagename, message), *rest) = heuristic.semantic_info
       expect(heuristicname).to eq :heuristic
       expect(messagename  ).to eq :message
-      expect(message      ).to eq 'MESSAGE'
+      expect(message      ).to eq "MESSAGE\n"
       expect(rest).to be_empty
     end
   end
@@ -200,4 +200,37 @@ RSpec.describe ErrorToCommunicate::RSpecFormatter, rspec_formatter: true do
       expect(heuristic.semantic_info).to eq "SEMANTICINFO"
     end
   end
+
+  context 'fixing the message\'s whitespace' do
+    def fix_whitespace(str)
+      ErrorToCommunicate::Heuristic::RSpecFailure.fix_whitespace str
+    end
+
+    it 'removes leading newlines' do
+      expect(fix_whitespace "\na").to start_with "a"
+      expect(fix_whitespace "\n\n\na").to start_with "a"
+    end
+
+    it 'removes all but one trailing newline' do
+      expect(fix_whitespace "a\n").to start_with "a\n"
+      expect(fix_whitespace "a\n\n").to start_with "a\n"
+      expect(fix_whitespace "a\n\n\n").to start_with "a\n"
+    end
+
+    it 'adds a trailing newline if its missing' do
+      expect(fix_whitespace "a").to start_with "a\n"
+    end
+
+    it 'doesn\'t modify the original string' do
+      a = "\na"
+      b = "a"
+      c = "a\n\n"
+      d = "a\n"
+      [a, b, c, d].each { |s| fix_whitespace s }
+      expect(a).to eq "\na"
+      expect(b).to eq "a"
+      expect(c).to eq "a\n\n"
+      expect(d).to eq "a\n"
+    end
+  end
 end

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.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Josh Cheek
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge