humanist-errors 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 535f22988ed6f96ecdc7df5cdece3c1978776fa7
-  data.tar.gz: 2bcb8212ef5fa42751a9501bbdb0ef21aa1ba888
+  metadata.gz: b5eeb0edb25690acd18d5bf9d3a952a7923a0b35
+  data.tar.gz: 7aa50ca45ba9097de3000de1173c317a6cd6d117
 SHA512:
-  metadata.gz: ea00f3c78f4f9a6394e402436fef3fdd75a7911d1eb0695880cc995d5f339afb8e9e4748f2dc9f5648720de4b588c4237542cc2885f9fd9c42e59fa213c1ef1f
-  data.tar.gz: 12e944d575cb50e4d17f6aaa613f026b3918904f483a95efc7bfdb0c134f95e7362673f4c940813a16d771d4cef4bcd01bafcd89d79269ac403809dc634bcdfc
+  metadata.gz: 2c990c48eb6660e1184bc30f66fa47ad1066db7b30e4b16c8fdd1ef591c7c7d39d0786fc4dfa3cb1ed5301a60e11c019309b77f0a60b600a9f7523657d0e3884
+  data.tar.gz: 02d6c3d956fa6a0fd99e03535e0094956d8893a4b71425d4a05eec9da289220d0eee16692e47f4716d0357cfb406379ad144048bf312457e40267afdb4e07add

data/README.md

@@ -1,19 +1,18 @@
 [![Code Climate](https://codeclimate.com/github/bgreg/humanist-errors/badges/gpa.svg)](https://codeclimate.com/github/bgreg/humanist-errors)[![Test Coverage](https://codeclimate.com/github/bgreg/humanist-errors/badges/coverage.svg)](https://codeclimate.com/github/bgreg/humanist-errors)[![Build Status](https://travis-ci.org/bgreg/humanist-errors.svg?branch=master)](https://travis-ci.org/bgreg/humanist-errors)
 
-# Humanist::Errors
+# Error messages for Humans.
 
 [![Join the chat at https://gitter.im/bgreg/humanist-errors](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bgreg/humanist-errors?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Humanist errors is a system for extending ruby exception messages. 
+Humanist errors is a system for extending ruby exception messages.
 It will prepend the standard output with text defined in the humanist errors dictionary.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'humanist-errors'
-```
+	gem 'humanist-errors'
+
 
 And then execute:
 
@@ -23,15 +22,26 @@ Or install it yourself as:
 
     $ gem install humanist-errors
 
+
 ## Usage
 
-Include humanist errors in your project, and when ever you want better errors wrap your code like this: 
+Require the library and monkey file
+
+	require humanist_errors
+	require humanist_errors/monkey
+
+If you want to only want to see new errors in an isolated area
 
-```ruby 
+	include HumanistErrors
+
+Then your code in a human block:
+
+```ruby
 with_human_errors do
-  #...
+  #....
 end
 ```
+
 This gem is intended for use in development and test environments only.
 
 ## Contributing
@@ -44,10 +54,10 @@ This gem is intended for use in development and test environments only.
 
 
 ## TODO
-1) fill out tests for search.rb 
+1) add more errors to error_map
+
+##### High level exception tree:
 
-High level exception tree:
-----
 ```ruby
 Exception
   NoMethodError

data/dictionaries/humanist_errors.en.yml

@@ -3,10 +3,10 @@
   :open_quote: "It looks like you typed an open quote near the end of the file."
   :string_formatter: "% string formatter requires a string argument on the left, and a format argument on the right"
   :missing_argument: "You indicated that you wanted to send another argument, but we did not see anything."
-  :missing_block_closer: "a block or method was started, but you forgot to add 'end'"
+  :missing_block_closer: "A block was started, but you forgot to add 'end'. Ruby tries to match every `do` with an `end`, but it reached the end of the file and a matching 'end' token was not found.  To fix this, review all the 'do..end' pairs."
 
 :no_method_error:
-  :undefined_method_for_nil: "Most likely you forgot to define the variable, or it was turned to nil along the way."
+  :undefined_method_for_nil: "You defined a variable with good intentions, then along the way, something turned it to nil."
 
 :name_error:
   :undefined_word: "You typed a random string that wasn't defined. It is not a method or variable in this class, or it's ancestors"

data/dictionaries/humanist_errors.oops.yml

@@ -0,0 +1,15 @@
+:syntax_error:
+  :unexpected_semi_colon: "oops"
+  :open_quote: "oop"
+  :string_formatter: "oop"
+  :missing_argument: "oops"
+  :missing_block_closer: "oops"
+
+:no_method_error:
+  :undefined_method_for_nil: "oops"
+
+:name_error:
+  :undefined_word: "oops"
+
+:zero_division_error:
+  :divide_by_zero: "oops"

data/lib/humanist_errors/exception_extensions.rb

@@ -1,17 +1,15 @@
 module HumanistErrors
   module ExceptionExtensions
     def to_s
-      searcher = Search.run(self.class, super)
-      if searcher.found_error == :no_result
+      error = Search.run(self.class, super)
+      if :no_result == error
         super
       else
         color = Color.new
-        "\n#{STARTING_TOKEN}"+
-        "\t#{color.cyan(searcher.found_error)}\n"+
-        "#{ENDING_TOKEN}" +
-        super
+        "\n\n#{STARTING_TOKEN}" \
+        " #{color.cyan(error)}\n" \
+        "#{ENDING_TOKEN}\n" + super
       end
     end
   end
 end
-

data/lib/humanist_errors/monkey.rb

@@ -1 +1 @@
-::Exception.send(:prepend, HumanistErrors::ExceptionExtensions) 
+::Exception.__send__(:prepend, HumanistErrors::ExceptionExtensions)

data/lib/humanist_errors/regex_hash.rb

@@ -3,7 +3,7 @@ module HumanistErrors
     def [](value)
       result = self.select { |k| k =~ value }
       if result.empty?
-        raise NotImplementedError, "Could not find Ruby message in dictionary: #{value}"
+        :no_result
       else
         result.shift[1]
       end

data/lib/humanist_errors/search.rb

@@ -1,12 +1,9 @@
 module HumanistErrors
   class Search
-    attr_accessor :found_error
-    attr_accessor :error_object, :ruby_error_message
 
     def self.run(error_object, ruby_error_message)
       searcher = new(error_object, ruby_error_message)
-      searcher.found_error = searcher.find
-      searcher
+      searcher.find
     end
 
     def initialize(error_object, ruby_error_message)
@@ -21,7 +18,10 @@ module HumanistErrors
     end
 
     private
+    attr_reader :error_object, :ruby_error_message, :found_error
 
+    # turn a CamelCase word into an underscored
+    # symbol to make it nice for hash keys.
     def keyify(error)
       error.to_s
         .gsub(/::/, '__')
@@ -33,4 +33,3 @@ module HumanistErrors
     end
   end
 end
-

data/lib/humanist_errors/version.rb

@@ -1,3 +1,3 @@
 module HumanistErrors
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/test/regex_hash_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class RegexHashTest < Minitest::Test
+  include HumanistErrorsSupport
 
   def test_a_regex_search_happens_on_key_send
     magic_string_hash = HumanistErrors::RegexHash[/findme/ => "hurray!"]
@@ -9,7 +10,6 @@ class RegexHashTest < Minitest::Test
 
   def test_a_failure_when_key_is_not_found
     magic_string_hash = HumanistErrors::RegexHash[/findme/ => "hurray!"]
-    error = assert_raises(NotImplementedError) { magic_string_hash['1'] }
-    assert(error.message.include?("Could not find Ruby message in dictionary: 1"))
+    assert_no_result(magic_string_hash['1'])
   end
 end

data/test/search_test.rb

@@ -2,17 +2,17 @@ require 'test_helper'
 
 class SearchTest < Minitest::Test
   def test_finds_a_human_error
-    searcher = HumanistErrors::Search.run(
+    error = HumanistErrors::Search.run(
       NameError,
      "NameError: undefined local variable or method `asdf' for main:Object"
     )
     expected_result =  HumanistErrors::MESSAGE_DICTIONARY[:name_error][:undefined_word]
-    assert(searcher.found_error == expected_result, "#{searcher.found_error.inspect} does not equal: #{expected_result.inspect}")
+    assert(error == expected_result, "#{error.inspect} does not equal: #{expected_result.inspect}")
   end
 
   class DefinatelyNotARealException; end
   def test_cannot_find_a_error_message
-    searcher = HumanistErrors::Search.run(DefinatelyNotARealException, "blah blah blah")
-    assert(searcher.found_error == :no_result, "#{searcher.found_error.inspect} does not equal: :no_result")
+    error = HumanistErrors::Search.run(DefinatelyNotARealException, "blah blah blah")
+    assert(error == :no_result, "#{error.inspect} does not equal: :no_result")
   end
 end

data/test/test_helper.rb

@@ -14,6 +14,10 @@ module HumanistErrorsSupport
     assert(message != :no_result, "no result was found")
   end
 
+  def assert_no_result(message)
+    assert(message == :no_result, "no result was found")
+  end
+
   def assert_error_map(ruby_error, exception_symbol, error_symbol)
     result = HumanistErrors::ERROR_MAPPER[exception_symbol][ruby_error]
     assert_result(result)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humanist-errors
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Greg McGuirk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-20 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,6 +54,7 @@ files:
 - README.md
 - Rakefile
 - dictionaries/humanist_errors.en.yml
+- dictionaries/humanist_errors.oops.yml
 - humanist-errors.gemspec
 - lib/humanist_errors.rb
 - lib/humanist_errors/colors.rb