verbose_hash_fetch 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order random

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in verbose_hash_fetch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 iain
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# VerboseHashFetch
+
+This gem monkey patches `Hash#fetch` so that KeyErrors show the contents of the
+hash in which the key wasn't found.
+
+## Example
+
+We are taught to use `Hash#fetch` instead of `Hash#[]`, so that we don't get
+unexpected `nil`s floating around in our code. `Hash#fetch` will raise an
+exception when the key isn't found, right where you tried to access it. Rather
+fail early then have a nil pop up somewhere else!
+
+But there is one thing that annoys me. Say you're writing this code:
+
+``` ruby
+def hello(options)
+  name = options.fetch(:name)
+  puts "Hello, #{name}!"
+end
+```
+
+Now, you're calling this method, passing in some params that you got from
+somewhere else:
+
+``` ruby
+hello(params)
+# => key not found: :name (KeyError)
+```
+
+Blast! Now I have to see why `params` doesn't have the key `:name` in it. Did I
+misspel it somewhere? Was the name parameter a String instead of a Symbol?
+
+What shall I do: put a `puts` in the code? Should I `raise params.inspect`,
+should I launch a debugger, or should I stare at the code long enough to
+see the mistake?
+
+All these options suck. Just have `verbose_hash_fetch` loaded, and you'll
+see the contents of the hash appear in the error itself!
+
+``` ruby
+require 'verbose_hash_fetch'
+
+hello(params)
+# => key not found: :name in Hash: {:naem=>"Avdi"} (KeyError)
+```
+
+No more guessing, no more retrying. See it when it happens!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'verbose_hash_fetch'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install verbose_hash_fetch
+```
+
+## Usage
+
+If you have `verbose_hash_fetch` in your Gemfile, and you're using Rails, then
+you don't need to do anything.
+
+If you need to load it manually:
+
+``` ruby
+require 'verbose_hash_fetch'
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+
+## Credits
+
+I was complaining on Twitter, so [Roel van Dijk](http://twitter.com/rdvdijk)
+made it and put it in a Gist. I just converted it into a gem.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/verbose_hash_fetch.rb

@@ -0,0 +1,24 @@
+class KeyError
+  attr_accessor :hash
+
+  def to_s
+    if hash
+      "#{super} in #{hash.class}: #{hash.inspect}"
+    else
+      super
+    end
+  end
+end
+
+class Hash
+
+  alias_method :_fetch, :fetch
+
+  def fetch(*args, &block)
+    _fetch *args, &block
+  rescue KeyError => key_error
+    key_error.hash = self
+    raise
+  end
+
+end

data/spec/verbose_hash_fetch_spec.rb

@@ -0,0 +1,47 @@
+require 'verbose_hash_fetch'
+
+describe "VerboseHashFetch" do
+
+  let(:hash) { { :foo => "bar" } }
+
+  context "with one argument" do
+
+    it "fetches an existing key" do
+      hash.fetch(:foo).should eq "bar"
+    end
+
+    it "raises a KeyError for non existing keys" do
+      expect { hash.fetch(:bar) }.to raise_error(KeyError)
+    end
+
+    it "raises a KeyError with self.inspect in the message" do
+      expect { hash.fetch(:bar) }.to raise_error("key not found: :bar in Hash: {:foo=>\"bar\"}")
+    end
+
+  end
+
+  context "with two arguments" do
+
+    it "fetches the existing value" do
+      hash.fetch(:foo, "default").should eq "bar"
+    end
+
+    it "uses the 2nd argument when key not found" do
+      hash.fetch(:bar, "default").should eq "default"
+    end
+
+  end
+
+  context "with a block" do
+
+    it "fetches the existing value" do
+      hash.fetch(:foo) { "default" }.should eq "bar"
+    end
+
+    it "evaluates the block when key not found" do
+      hash.fetch(:bar) { |k| "default #{k}" }.should eq "default bar"
+    end
+
+  end
+
+end

data/verbose_hash_fetch.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "verbose_hash_fetch"
+  gem.version       = '0.0.1'
+  gem.authors       = ["iain"]
+  gem.email         = ["iain@iain.nl"]
+  gem.description   = %q{Monkey patches Hash#fetch to also show the entire hash in the error}
+  gem.summary       = %q{Monkey patches Hash#fetch to also show the entire hash in the error}
+  gem.homepage      = "https://github.com/iain/verbose_hash_fetch"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: verbose_hash_fetch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Monkey patches Hash#fetch to also show the entire hash in the error
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/verbose_hash_fetch.rb
+- spec/verbose_hash_fetch_spec.rb
+- verbose_hash_fetch.gemspec
+homepage: https://github.com/iain/verbose_hash_fetch
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Monkey patches Hash#fetch to also show the entire hash in the error
+test_files:
+- spec/verbose_hash_fetch_spec.rb