humanist-errors 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5eeb0edb25690acd18d5bf9d3a952a7923a0b35
-  data.tar.gz: 7aa50ca45ba9097de3000de1173c317a6cd6d117
+  metadata.gz: bbf346aeb9290ca662aa37a4c5f0815fe30a95c6
+  data.tar.gz: deb0fbba11bfeb7ea38fd644129b8b0a6400699e
 SHA512:
-  metadata.gz: 2c990c48eb6660e1184bc30f66fa47ad1066db7b30e4b16c8fdd1ef591c7c7d39d0786fc4dfa3cb1ed5301a60e11c019309b77f0a60b600a9f7523657d0e3884
-  data.tar.gz: 02d6c3d956fa6a0fd99e03535e0094956d8893a4b71425d4a05eec9da289220d0eee16692e47f4716d0357cfb406379ad144048bf312457e40267afdb4e07add
+  metadata.gz: eb0f5cf17010946944916589e897f5d70cc99b82f28b4e2634b90141e3813c70f4376c3766c229bc30dc088e2c987d9642ba99adb3c067ef8aaedb32ac6addab
+  data.tar.gz: fc528cada09c47f49084adff41fd5c47d8baa20158fac93d079e0d6ac159a4b3e22319c7e7048fc4eb45ca33244176a4a088245fdf73ab7d54ef39e8f3ba2de3

data/README.md

@@ -4,8 +4,14 @@
 
 [![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.
-It will prepend the standard output with text defined in the humanist errors dictionary.
+Humanist errors is a system for extending ruby exception messages.  It will prepend the standard output with text
+defined in the humanist errors dictionary that hopefully explains what is going on a little better.
+
+Some examples:
+
+![img](https://cloud.githubusercontent.com/assets/3711139/11139081/9ed4493a-897f-11e5-8589-79a4e5930c94.png)
+![img](https://cloud.githubusercontent.com/assets/3711139/11139050/3ccefb40-897f-11e5-8024-9062ce4787bf.png)
+
 
 ## Installation
 
@@ -25,64 +31,43 @@ Or install it yourself as:
 
 ## Usage
 
+You can use humanist errors globally in your project, or only around specific pieces of code.
+To use globally:
+
 Require the library and monkey file
 
-	require humanist_errors
-	require humanist_errors/monkey
+	require 'humanist_errors'
+	require 'humanist_errors/monkey'
+
+Thats it! Now when ruby tries to evaluate an error like when you say: `1/0` you will see a new error message.
+
+
+If you only want to see new errors in an isolated area you can include the library and execute
+your code inside a special code block.
+
+1. Add these require statements to your file:
 
-If you want to only want to see new errors in an isolated area
+  `require 'humanist_errors'`
 
-	include HumanistErrors
+  `require 'humanist_errors/monkey'`
 
-Then your code in a human block:
+2. Include the humanist errors module:
 
+  `include HumanistErrors`
+
+3. Then your code in a human block:
 ```ruby
-with_human_errors do
-  #....
-end
+	with_human_errors do
+      		#....
+	end
 ```
 
 This gem is intended for use in development and test environments only.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/humanist-errors/fork )
+1. Fork it ( https://github.com/bgreg/humanist-errors/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
-
-
-## TODO
-1) add more errors to error_map
-
-##### High level exception tree:
-
-```ruby
-Exception
-  NoMethodError
-  ScriptError
-    LoadError
-    NotImplementedError
-    SyntaxError
-  SignalException
-    Interrupt
-  StandardError
-    ArgumentError
-    IOError
-      EOFError
-    IndexError
-    LocalJumpError
-    NameError
-      NoMethodError
-    RangeError
-      FloatDomainError
-    RuntimeError
-    SecurityError
-    SystemCallError
-    SystemStackError
-    ThreadError
-    ZeroDivisionError
-  SystemExit
-  fatal
-```

data/Rakefile

@@ -9,17 +9,28 @@ $LOAD_PATH.unshift(test) unless $LOAD_PATH.include?(test)
 task default: :test
 
 task :test do
-  Dir.glob(['./test/*_test.rb', './test/error_mapper/*_test.rb','./test/features/*_test.rb']).each { |file| require file}
+  Dir.glob([
+    './test/*_test.rb',
+    './test/error_mapper/*_test.rb',
+    './test/features/*_test.rb'
+  ]).each do |file|
+
+    require file
+  end
 end
 
 task :test_error_mapper do
-  Dir.glob('./test/error_mapper/*_test.rb').each { |file| require file}
+  Dir.glob('./test/error_mapper/*_test.rb').each { |file| require file }
 end
 
 task :test_features do
-  Dir.glob('./test/features/*_test.rb').each { |file| require file}
+  Dir.glob('./test/features/*_test.rb').each { |file| require file }
 end
 
 task :search_test do
   require './test/search_test.rb'
 end
+
+task :regex_test do
+  require './test/regex_hash_test.rb'
+end

data/dictionaries/humanist_errors.en.yml

@@ -4,13 +4,16 @@
   :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 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."
+  :t_identifier: "Ok, wow, I'm not sure what is going on here"
 
 :no_method_error:
   :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"
+  :undefined_word: "You typed a random string that wasn't defined. It is not a method or variable in this class, or its ancestors"
 
 :zero_division_error:
   :divide_by_zero: "Science has not figured out how to divide by zero yet. Damn you science!!!"
 
+:load_error:
+  :no_file: "You tried to load a file that doesn't exist - at least, not where you think it is!"

data/dictionaries/humanist_errors.oops.yml

@@ -1,7 +1,7 @@
 :syntax_error:
   :unexpected_semi_colon: "oops"
-  :open_quote: "oop"
-  :string_formatter: "oop"
+  :open_quote: "oops"
+  :string_formatter: "oops"
   :missing_argument: "oops"
   :missing_block_closer: "oops"
 

data/lib/humanist_errors.rb

@@ -3,12 +3,11 @@ require 'humanist_errors/version'
 require 'humanist_errors/exception_extensions'
 require 'humanist_errors/regex_hash'
 require 'humanist_errors/search'
-require 'humanist_errors/colors'
+require 'humanist_errors/color'
 
 module HumanistErrors
-  color = Color.new
-  STARTING_TOKEN     = color.green("Hi!\n")
-  ENDING_TOKEN       = color.green("Here's the error from Ruby: \n")
+  STARTING_TOKEN     = "Hi!\n"
+  ENDING_TOKEN       = "Here's the error from Ruby: \n"
   MESSAGE_DICTIONARY = YAML.load(File.read(File.expand_path('../../dictionaries/humanist_errors.en.yml', __FILE__)))
 
   def with_human_errors

data/lib/humanist_errors/color.rb

@@ -0,0 +1,20 @@
+module HumanistErrors
+  class Color
+    PREFIX  = '\033'
+    POSTFIX = '\033[0m'
+    COLORS  = {
+      black:   '[30m',
+      red:     '[31m',
+      green:   '[32m',
+      brown:   '[33m',
+      blue:    '[34m',
+      magenta: '[35m',
+      cyan:    '[36m',
+      gray:    '[37m',
+    }
+
+    def colorize_with(color, text)
+      "#{PREFIX}#{COLORS[color]}#{text}#{POSTFIX}"
+    end
+  end
+end

data/lib/humanist_errors/error_mapper.rb

@@ -6,6 +6,7 @@ module HumanistErrors
       /unterminated quoted string meets end of file/                 => MESSAGE_DICTIONARY[:syntax_error][:string_formatter],
       /syntax error, unexpected end-of-input, expecting keyword_end/ => MESSAGE_DICTIONARY[:syntax_error][:missing_block_closer],
       /syntax error, unexpected end-of-input/                        => MESSAGE_DICTIONARY[:syntax_error][:missing_argument],
+      /syntax error, unexpected tIDENTIFIER/                         => MESSAGE_DICTIONARY[:syntax_error][:t_identifier],
       /.*/                                                           => :no_result
     ],
     no_method_error: HumanistErrors::RegexHash[
@@ -19,6 +20,11 @@ module HumanistErrors
     zero_division_error: HumanistErrors::RegexHash[
       /divided by 0/ => MESSAGE_DICTIONARY[:zero_division_error][:divide_by_zero],
       /.*/           => :no_result
+    ],
+
+    load_error: HumanistErrors::RegexHash[
+      /no such file to load/ => MESSAGE_DICTIONARY[:load_error][:no_file],
+      /.*/                   => :no_result
     ]
   }
 end

data/lib/humanist_errors/exception_extensions.rb

@@ -6,9 +6,9 @@ module HumanistErrors
         super
       else
         color = Color.new
-        "\n\n#{STARTING_TOKEN}" \
-        " #{color.cyan(error)}\n" \
-        "#{ENDING_TOKEN}\n" + super
+        "\n\n#{color.colorize_with(:green, STARTING_TOKEN)}" \
+        " #{color.colorize_with(:cyan, error)}\n" \
+        "#{color.colorize_with(:green, ENDING_TOKEN)}\n" + super
       end
     end
   end

data/lib/humanist_errors/regex_hash.rb

@@ -1,11 +1,10 @@
 module HumanistErrors
   class RegexHash < Hash
     def [](value)
-      result = self.select { |k| k =~ value }
-      if result.empty?
-        :no_result
-      else
-        result.shift[1]
+      detect(-> { :no_result }) do |k,v|
+        if k =~ value
+          return v
+        end
       end
     end
   end

data/lib/humanist_errors/search.rb

@@ -13,15 +13,17 @@ module HumanistErrors
 
     def find
       error = keyify(error_object)
-      return :no_result unless ERROR_MAPPER.keys.include?(error)
+      return :no_result unless ERROR_MAPPER[error]
       ERROR_MAPPER[error][ruby_error_message]
     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.
+    # Basically the same as ActiveSupport#underscore
     def keyify(error)
       error.to_s
         .gsub(/::/, '__')

data/lib/humanist_errors/version.rb

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

data/test/backlog/load_error_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
 
 class LoadErrorTest < Minitest::Test
+  include HumanistErrorsSupport
 end
 

data/test/color_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class ColorTest < Minitest::Test
+  def colors
+    { black:   '[30m',
+      red:     '[31m',
+      green:   '[32m',
+      brown:   '[33m',
+      blue:    '[34m',
+      magenta: '[35m',
+      cyan:    '[36m',
+      gray:    '[37m', }
+  end
+
+  def colorizer
+    @colorizer ||= HumanistErrors::Color.new
+  end
+
+  def test_wraps_given_string_with_color
+    test_string   = "Test"
+
+    colors.each do |color_name, code|
+      assert_equal(
+        colorizer.colorize_with(color_name, test_string),
+        "\\033#{code}#{test_string}\\033[0m")
+    end
+  end
+end

data/test/error_mapper/load_error_test.rb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+class LoadErrorTest < Minitest::Test
+  include HumanistErrorsSupport
+
+  def test_message_for_missing_file
+    assert_error_map("no such file to load", :load_error, :no_file)
+  end
+end

data/test/error_mapper/syntax_error_test.rb

@@ -8,7 +8,7 @@ class SyntaxErrorTest < Minitest::Test
   end
 
   def test_message_for_unterminated_string_meets_end_of_file
-     assert_error_map("unterminated string meets end of file", :syntax_error,  :open_quote)
+    assert_error_map("unterminated string meets end of file", :syntax_error,  :open_quote)
   end
 
   def test_message_for_single_percent_sign

data/test/features/syntax_error_test.rb

@@ -7,15 +7,27 @@ class SyntaxErrorTest < Minitest::Test
     assert_match(expected_message, error_message)
   end
 
-  def test_messge_for_missing_end
+  def test_message_for_missing_end
     error_message = human_fork(SyntaxError) do
       eval(
         " def stuff
-            opps = 'I did it again'
+            oops = 'I did it again'
         "
       )
     end
     expected_message = HumanistErrors::MESSAGE_DICTIONARY[:syntax_error][:missing_block_closer]
     assert_match(expected_message, error_message)
   end
+
+  def test_message_for_unexpected_identifier
+    error_message = human_fork(SyntaxError) do
+      eval %q(
+        one = 1
+        two = 2
+        product = one * two _2
+      )
+    end
+    expected_message = HumanistErrors::MESSAGE_DICTIONARY[:syntax_error][:t_identifier]
+    assert_match(expected_message, error_message)
+  end
 end

data/test/monkey_test.rb

@@ -2,4 +2,3 @@ require 'test_helper'
 
 class MonkeyTest < Minitest::Test
 end
-

data/test/search_test.rb

@@ -10,9 +10,10 @@ class SearchTest < Minitest::Test
     assert(error == expected_result, "#{error.inspect} does not equal: #{expected_result.inspect}")
   end
 
-  class DefinatelyNotARealException; end
+  class DefinitelyNotARealException; end
+
   def test_cannot_find_a_error_message
-    error = HumanistErrors::Search.run(DefinatelyNotARealException, "blah blah blah")
+    error = HumanistErrors::Search.run(DefinitelyNotARealException, "blah blah blah")
     assert(error == :no_result, "#{error.inspect} does not equal: :no_result")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humanist-errors
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Greg McGuirk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,7 +57,7 @@ files:
 - dictionaries/humanist_errors.oops.yml
 - humanist-errors.gemspec
 - lib/humanist_errors.rb
-- lib/humanist_errors/colors.rb
+- lib/humanist_errors/color.rb
 - lib/humanist_errors/error_mapper.rb
 - lib/humanist_errors/exception_extensions.rb
 - lib/humanist_errors/monkey.rb
@@ -88,6 +88,8 @@ files:
 - test/backlog/system_stack_error_test.rb
 - test/backlog/thread_error_test.rb
 - test/backlog/zero_division_error_test.rb
+- test/color_test.rb
+- test/error_mapper/load_error_test.rb
 - test/error_mapper/name_error_test.rb
 - test/error_mapper/no_method_error_test.rb
 - test/error_mapper/syntax_error_test.rb
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: More readable and friendly errors, for humans.
@@ -146,6 +148,8 @@ test_files:
 - test/backlog/system_stack_error_test.rb
 - test/backlog/thread_error_test.rb
 - test/backlog/zero_division_error_test.rb
+- test/color_test.rb
+- test/error_mapper/load_error_test.rb
 - test/error_mapper/name_error_test.rb
 - test/error_mapper/no_method_error_test.rb
 - test/error_mapper/syntax_error_test.rb

data/lib/humanist_errors/colors.rb

@@ -1,37 +0,0 @@
-module HumanistErrors
-  class Color
-
-    def black(string)
-      "\033[30m#{string}\033[0m"
-    end
-
-    def red(string)
-      "\033[31m#{string}\033[0m"
-    end
-
-    def green(string)
-      "\033[32m#{string}\033[0m"
-    end
-
-    def brown(string)
-      "\033[33m#{string}\033[0m"
-    end
-
-    def blue(string)
-      "\033[34m#{string}\033[0m"
-    end
-
-    def magenta(string)
-      "\033[35m#{string}\033[0m"
-    end
-
-    def cyan(string)
-      "\033[36m#{string}\033[0m"
-    end
-
-    def gray(string)
-      "\033[37m#{string}\033[0m"
-    end
-
-  end
-end