readable_exceptions 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,76 @@
+# Overview
+
+Given a configured exception type and error context, returns a human readable error message.
+
+# Configure it
+
+Create your configuration file, readable_exceptions.yml.
+
+    "WallPostException":
+      wall_context: "We can not post to your wall"
+      friend_wall_context: "We can not post to your friends wall"
+
+    "WallPostException::IntermittentError":
+      wall_context: "We can not post to your wall right now. We'll try again later."
+
+WallPostException::IntermittentError is a child class of WallPostException.
+
+# Use it
+
+    ReadableExceptions.setup(File.dirname(__FILE__) + "/readable_exceptions.yml")
+
+    begin
+      post_to_wall()
+    rescue WallPostException => e
+      puts e.readable_message(:wall_context)  # puts "We can not post to your wall"
+    end
+
+    begin
+      post_to_friends_wall()
+    rescue WallPostException => e
+      puts e.readable_message(:friend_wall_context)  # puts "We can not post to your friends wall"
+    end
+
+    begin
+      post_to_wall()
+    rescue WallPostException::IntermittentError => e
+      puts e.readable_message(:wall_context)  # puts "We can not post to your wall right now. We'll try again later."
+    end
+
+    begin
+      post_to_friends_wall()
+    rescue WallPostException::IntermittentError => e
+      puts e.readable_message(:friend_wall_context)  # puts "We can not post to your friends wall"
+    end
+
+    begin
+      raise WallPostException, :wall_context
+    rescue StandardError => e
+      puts e.readable_message  # puts "We can not post to your wall"
+    end
+
+    begin
+      raise WallPostException, :friend_wall_context
+    rescue StandardError => e
+      puts e.readable_message  # puts "We can not post to your friends wall"
+    end
+
+    begin
+      raise WallPostException::IntermittentError, :wall_context
+    rescue StandardError => e
+      puts e.readable_message  # puts "We can not post to your wall right now. We'll try again later."
+    end
+
+    begin
+      raise WallPostException::IntermittentError, :friend_wall_context
+    rescue StandardError => e
+      puts e.readable_message  # puts "We can not post to your friends wall"
+    end
+
+    begin
+      raise UnconfiguredException, :wall_context
+    rescue StandardError => e
+      puts e.readable_message  # puts e.message
+    end
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/readable_exceptions.rb

@@ -0,0 +1,58 @@
+require "yaml"
+
+module ReadableExceptions
+
+  def self.setup(readable_msgs_file_path)
+    @@error_messages = parse_input(readable_msgs_file_path)
+
+    Exception.class_eval do
+      def readable_message(context = nil)
+        ::ReadableExceptions::readable_message(self, context)
+      end
+    end
+  end
+
+  def self.readable_message(exception, context = nil)
+    context ||= exception.message
+    return exception.message if ! valid_context?(context)
+
+    readable_message = message_for_context(exception.class, context)
+    return exception.message if readable_message.nil?
+
+    readable_message
+  end
+
+  private
+
+  def self.error_messages
+    @@error_messages
+  end
+
+  def self.parse_input(readable_msgs_file_path)
+    raise(ArgumentError, "Input file must be a readable") unless (File.readable?(readable_msgs_file_path) rescue false)
+
+    error_messages = (YAML::load(IO.read(readable_msgs_file_path))) rescue false
+    raise(ArgumentError, "Input file must be valid YAML") unless error_messages
+
+    error_messages
+  end
+  
+  def self.valid_context?(context)
+    context.kind_of?(Hash) && context.size == 1
+  end
+
+  def self.message_for_context(klass, context)
+    return nil if klass.nil?
+
+    context_key = context.first[0].to_s
+    sub_context_key = context.first[1].to_s
+    klass_name = klass.name.to_s
+
+    if error_messages.has_key?(context_key) && error_messages[context_key].has_key?(klass_name) && error_messages[context_key][klass_name].has_key?(sub_context_key)
+      return error_messages[context_key][klass_name][sub_context_key]
+    end
+
+    message_for_context(klass.superclass, context)
+  end
+
+end

data/lib/readable_exceptions/version.rb

@@ -0,0 +1,3 @@
+module ReadableExceptions
+  VERSION = "0.0.1"
+end

data/readable_exceptions.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "readable_exceptions/version"
+
+Gem::Specification.new do |s|
+  s.name        = "readable_exceptions"
+  s.version     = ReadableExceptions::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chad Krsek"]
+  s.email       = ["chad@contextoptional.com"]
+  s.homepage    = ""
+  s.summary     = %q{Easily configure human readable error messages for your exception classes, or for classses declared in libraries you use.}
+  s.description = %q{Easily configure human readable error messages for your exception classes, or for classses declared in libraries you use.}
+
+  s.rubyforge_project = "readable_exceptions"
+
+  s.add_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/example.yml

@@ -0,0 +1,12 @@
+foo:
+  "An::Exception":
+    input_context: "There has been an input failure"
+    output_context: "There has been an output failure"
+
+bar:
+  "Another::Exception":
+    print_context: "We can not print right now"
+    post_context: "We can not post right now"
+
+  "ChildException":
+    print_context: "We can print right now"

data/spec/readable_exceptions_spec.rb

@@ -0,0 +1,124 @@
+require "spec_helper"
+
+
+# Declare classes that appear in yml input files
+class An
+class Exception < Exception
+end
+end
+
+class Another
+class Exception < Exception
+end
+end
+
+class ChildException < Another::Exception
+end
+
+class YetAnother
+class Exception < Exception
+end
+end
+
+
+describe ReadableExceptions do
+
+  describe "should raise an exception when" do
+
+    it "input file is unreadable" do
+      lambda { ReadableExceptions.setup("") }.should raise_exception(ArgumentError)
+    end
+
+    it "input file is empty" do
+      lambda { ReadableExceptions.setup(File.dirname(__FILE__) + "/empty.yml") }.should raise_exception(ArgumentError)
+    end
+
+  end
+
+  describe "parses the input file" do
+
+    before :each do
+      ReadableExceptions.setup(File.dirname(__FILE__) + "/example.yml")
+    end
+
+    describe "returns the exception's message when" do
+
+      it "has no readable message context" do
+        e = An::Exception.new("test")
+        e.readable_message.should == "test"
+      end
+      
+      it "the exception type does not have a readable message defined" do
+        e = YetAnother::Exception.new("test")
+        e.readable_message(:unknown => :context).should == "test"
+      end
+
+      it "the exception has a readable message defined but not in this context" do
+        e = An::Exception.new("test")
+        e.readable_message(:foo => :context).should == "test"
+        e = An::Exception.new("test")
+        e.readable_message(:baz => :input_context).should == "test"        
+      end
+
+      it "neither the exception nor its parents have readable message defined for this context" do
+        e = ChildException.new("test")
+        e.readable_message(:unknown => :context).should == "test"
+      end
+
+    end
+
+    describe "returns the exception's readable message when" do
+
+      it "readable_message is called" do
+        An::Exception.new.readable_message.should == An::Exception.new.message
+        An::Exception.new.readable_message(:foo => :input_context).should == "There has been an input failure"
+        An::Exception.new.readable_message(:foo => :output_context).should == "There has been an output failure"
+        Another::Exception.new.readable_message(:bar => :print_context).should == "We can not print right now"
+        ChildException.new.readable_message(:bar => :print_context).should == "We can print right now"
+        Another::Exception.new.readable_message(:bar => :post_context).should == "We can not post right now"
+        ChildException.new.readable_message(:bar => :post_context).should == "We can not post right now"
+      end
+
+      it "an exception is instantiated with its message set to a readable message key" do
+        begin
+          raise An::Exception, :foo => :input_context
+        rescue Exception => e
+          e.readable_message.should == "There has been an input failure"
+        end
+
+        begin
+          raise An::Exception, :foo => :output_context
+        rescue Exception => e
+          e.readable_message.should == "There has been an output failure"
+        end
+
+        begin
+          raise Another::Exception, :bar => :print_context
+        rescue Exception => e
+          e.readable_message.should == "We can not print right now"
+        end
+
+        begin
+          raise ChildException, :bar => :print_context
+        rescue Exception => e
+          e.readable_message.should == "We can print right now"
+        end
+
+        begin
+          raise Another::Exception, :bar => :post_context
+        rescue Exception => e
+          e.readable_message.should == "We can not post right now"
+        end
+
+        begin
+          raise ChildException, :bar => :post_context
+        rescue Exception => e
+          e.readable_message.should == "We can not post right now"
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$:.push(File.dirname(__FILE__) + "/../lib/")
+require "readable_exceptions"

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: readable_exceptions
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chad Krsek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Easily configure human readable error messages for your exception classes, or for classses declared in libraries you use.
+email: 
+- chad@contextoptional.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/readable_exceptions.rb
+- lib/readable_exceptions/version.rb
+- readable_exceptions.gemspec
+- spec/empty.yml
+- spec/example.yml
+- spec/readable_exceptions_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: readable_exceptions
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily configure human readable error messages for your exception classes, or for classses declared in libraries you use.
+test_files: 
+- spec/empty.yml
+- spec/example.yml
+- spec/readable_exceptions_spec.rb
+- spec/spec_helper.rb