define_exception 0.0.2 → 0.0.3

data/lib/define_exception.rb

@@ -1,73 +1,20 @@
-# = Introduction
-#
 # Simple mixin that provides a way of defining custom exception classes
 # with default messages that dries up your code.
 #
-# = The Problem of Laborious Exception Class Definitions
-#
-# Typically you would write the following in your code to define a custom exception
-#
-#    class MyError < RuntimeError; end #nodoc
-#
-# This seems simple enough until you have to raise it many times throughout your code
-# and have to provide an error message:
-#
-#    raise( MyError, 'You shall not do what you just did' )
-#
-# It gets harder when you get tired of writing the same message to the <i>raise</i> command.
-# You can define a hash constant to keep track of common error messages:
-#
-#    ERRORS = { :myerror => 'You shall not do what you just did', ... }
+# = Class Methods
 #
-# and then reference it
+# <tt>define_exception</tt>( <i>ExceptionName</i>, <i>'Default Error Message'</i> )
 #
-#    raise( MyError, ERRORS[:myerror] )
+# The exception name can either be a <i>string</i> or a <i>symbol</i>.  If it is a <i>string</i>
+# then the name will be as provided.  In the <i>symbol</i> case if the symbol is mixed case the
+# result exception name will be as provided.  You also have the option of using underscores and having
+# the method automatically generate the mixed case exception name:
 #
-# but this just doesn't seem very rubyish.  You can also define the message when you write
-# the custom exception class:
+#     define_exception 'MyError', 'The Default Message'
+#     define_exception :AnotherError, 'Another Default Message'
+#     define_exception :worst_error, 'Worst Default Message'
 #
-#    class MyError < RuntimeError
-#      def message
-#        'You shall not do what you just did' )
-#      end
-#    end
-#
-# The problem is that this always uses this message even when overridden in <i>raise</i>
-#
-#    raise( MyError, 'Use this instead' ) # <= 'You shall not do what you just did'
-#
-# The real solution for you class is to override the constructor:
-#
-#    class MyError < RuntimeError
-#      def intialize( message = nil )
-#        super( message || 'Default Error Message' )
-#      end
-#    end
-#
-#    raise MyError                      # <= 'Default Error Message'
-#    raise MyError, 'Not the Default'   # <= 'Not the Default'
-#
-# = A Better Way
-#
-# Though this accomplishes the goal it is laborious to write all this code especially
-# as the number of custom exception definitions grow.  A better solution would be to make
-# a class method available that simply handles creating the exception for use automatically
-# thus drying up our code:
-#
-#    class TestMe
-#      define_exception 'MyError', 'The Default Message'
-#      define_exception 'AnotherError', 'Another Default Message'
-#      define_exception 'WorstError', 'Worst Default Message'
-#      ...
-#      def tester( args )
-#        raise MyError unless ...
-#        raise AnotherError unless ...
-#      end
-#
-#      def worst( args )
-#        raise( WorstError, 'You really messed up' ) unless ...
-#      end
-#    end
+# Any of the above methods will work.
 #
 # = Usage
 #
@@ -82,7 +29,7 @@
 #    include DefineException
 #
 #    class Test
-#      define_exception 'TestMe', 'this is the default message'
+#      define_exception :test_me, 'this is the default message'
 #
 #      def test
 #        raise TestMe
@@ -105,7 +52,7 @@
 #
 # running the above example would correctly produce
 #
-#    wes:~/Define-Exception> ruby test.rb
+#    wes:~/define_exception/examples> ruby sample.rb
 #    this is the default message
 #    test.rb:14:in `test2': You shall not do that again (Test::TestMe)
 #        from test.rb:26
@@ -115,13 +62,17 @@
 # Author:: Wes Bailey, wes@verticalresponse.com
 # License:: Ruby License
 
+class String
+  def lame_camel_case
+    /_/.match( self ) ? self.to_s.split( '_' ).inject( '' ) { |s,v| s << v.capitalize } : self
+  end
+end
+
 module DefineException
   module ClassMethods
-    def define_exception( exception_name, default_message = 'Application Error Occurred' )
-      exception_name = exception_name.to_s.split( '_' ).inject( '' ) { |s,v| s << v.capitalize } if /\_/.match( exception_name.to_s )
-
+    def define_exception( exception, default_message = 'Application Error Occurred', ancestor = 'RuntimeError' )
       class_eval <<-EOD
-        class #{exception_name} < RuntimeError
+        class #{exception.to_s.lame_camel_case} < #{ancestor.to_s.lame_camel_case}
           def initialize( message = nil )
             super( message || "#{default_message}" )
           end
@@ -132,7 +83,6 @@ module DefineException
 
   class << self
     def included( base )
-      #base.extend( self )
       base.extend( ClassMethods )
     end
   end

data/test/define_exception_spec.rb

@@ -6,34 +6,78 @@ require 'spec/test/unit'
 
 include DefineException
 
+@@message = 'This is the default @@message'
+
 describe "Define Exception" do
-  it "should enable a class to define a custom exception" do
-    MESSAGE = 'This is the default message'
+  it "should enable a class to define a custom exception using a string" do
 
     class TestDefineException
-      define_exception 'TestException', MESSAGE
+      define_exception 'TestException', @@message
 
       def test
         raise TestException
       end
     end
 
+    tde = TestDefineException.new
+
     lambda {
-      tde = TestDefineException.new
       tde.test
-    }.should raise_error( TestDefineException::TestException, MESSAGE )
+    }.should raise_error( TestDefineException::TestException, @@message )
+  end
 
+  it "should enable a class to define a custom exception using a symbol" do
     class AnotherTest
-      define_exception :another_exception, MESSAGE
+      define_exception :AnotherException, @@message
     
       def test
         raise AnotherException
       end
     end
 
+    at = AnotherTest.new
+
     lambda {
-      tde = AnotherTest.new
-      tde.test
-    }.should raise_error( AnotherTest::AnotherException, MESSAGE )
+      at.test
+    }.should raise_error( AnotherTest::AnotherException, @@message )
+  end
+
+  it "should enable a class to define a custom exception using a symbol converted to camel case" do
+    class YetAnotherTest
+      define_exception :yet_another_exception, @@message
+    
+      def test
+        raise YetAnotherException
+      end
+    end
+
+    yat = YetAnotherTest.new
+
+    lambda {
+      yat.test
+    }.should raise_error( YetAnotherTest::YetAnotherException, @@message )
+  end
+
+  it "should enable a class to define a custom exception subclassing off of a different exception than RuntimeError" do
+    class AnyAncestorTest
+      define_exception 'MyArgException', @@message, 'ArgumentError'
+    
+      def test
+        raise MyArgException
+      end
+    end
+
+    mae = AnyAncestorTest.new
+    lambda {
+      mae.test
+    }.should raise_error( AnyAncestorTest::MyArgException, @@message )
+
+    begin
+        mae.test
+    rescue AnyAncestorTest::MyArgException => e
+      e.is_a?( Exception ).should == true
+      e.is_a?( StandardError ).should == true
+      e.is_a?( ArgumentError ).should == true
+    end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: define_exception
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Wes Bailey
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-24 00:00:00 -07:00
+date: 2010-05-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,8 +29,11 @@ extra_rdoc_files: []
 
 files: 
 - lib/define_exception.rb
+- test/define_exception_spec.rb
 has_rdoc: true
 homepage: http://github.com/wbailey/define_exception
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -36,23 +45,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A simple way of defining exceptions for use in your ruby classes
 test_files: 
 - test/define_exception_spec.rb