From: James Laver <jjl@baozi.config>
Date: Thu, 29 Jul 2010 15:22:33 +0000 (+0100)
Subject: Renamed exception -> Class::MOP::Exception
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=9258c246edd457657cf48dc0e82c0d8ac068a2c7;p=gitmo%2FClass-MOP.git

Renamed exception -> Class::MOP::Exception
---

diff --git a/lib/Class/MOP/Exception.pm b/lib/Class/MOP/Exception.pm
new file mode 100644
index 0000000..0110155
--- /dev/null
+++ b/lib/Class/MOP/Exception.pm
@@ -0,0 +1,91 @@
+package Class::MOP::Exception;
+
+use strict;
+use warnings;
+
+use overload '""' => \&to_string;
+
+use Devel::StackTrace;
+
+# use Moose; ## Haha, if only.
+
+##### ACCESSORS #####
+sub message { shift->{message}; }
+sub stacktrace { shift->{stacktrace}; }
+
+# Builder for stacktrace
+sub _build_stacktrace {
+    shift->{stacktrace} = Devel::StackTrace->new(ignore_class => __PACKAGE__);
+}
+
+# Stringification
+sub to_string {
+    my ($self) = @_;
+    my $first = 1;
+    my @lines;
+    while (my $frame = $self->{stacktrace}->next_frame) {
+        if ($first) {
+            $first = 0;
+            # message at foo.pl line 1
+            push @lines, sprintf("%s at %s line %s", $self->message, $frame->filename, $frame->line);
+        } else {
+            my @args = map { ref $_ ? "$_" : "'$_'" } $frame->args;
+            # main::foo called at foo.pl line 1
+            push @lines, sprintf("\t%s(%s) called at %s line %s", $frame->subroutine, join(", ", @args), $frame->filename, $frame->line);
+        }
+    }
+    join("\n", @lines);
+}
+
+# Constructor
+sub new {
+    my ($class, %kwargs) = @_;
+    $class = ref $class if ref $class; # Also take another exception object, if we must.
+    my $message = $kwargs{message} || ''; # Default to no error message
+    
+    # Construction
+    my $self = bless {message => $message}, $class;
+    $self->_build_stacktrace;
+    
+    $self;
+}
+
+1;
+__END__
+
+=head1 DESCRIPTION
+
+exception - Simple exception class with Stack Trace for Class::MOP
+
+=head1 SYNOPSIS
+
+ use exception;
+ sub foo { bar(@_) }
+ sub bar { baz(@_) }
+ sub baz { die(exception->new(message => "Invalid length")) unless @_ == 2}
+
+=head1 METHODS
+
+=head2 message
+
+Returns the exception message
+
+=head2 stacktrace
+
+Returns the Devel::StackTrace object the exception built
+
+=head2 to_string (also the auto-stringify method)
+
+Returns a Carp::confess-alike formatted stack trace / error string.
+
+=head1 CONSTRUCTOR ARGS
+
+=head2 message
+
+You may pass in the exception message, designed to be a simple explanation of what went wrong.
+
+=head1 AUTHOR
+
+James Laver L<lt>cpan at jameslaver dot comL<gt>
+
+=cut
\ No newline at end of file
diff --git a/lib/exception.pm b/lib/exception.pm
deleted file mode 100644
index 8109d0c..0000000
--- a/lib/exception.pm
+++ /dev/null
@@ -1,54 +0,0 @@
-package exception;
-
-use strict;
-use warnings;
-
-use overload '""' => \&to_string;
-
-use Devel::StackTrace;
-
-# use Moose; ## Haha, if only.
-
-##### ACCESSORS #####
-sub message { shift->{message}; }
-sub stacktrace { shift->{stacktrace}; }
-
-# Builder for stacktrace
-sub _build_stacktrace {
-    shift->{stacktrace} = Devel::StackTrace->new(ignore_class => __PACKAGE__);
-}
-
-# Stringification
-sub to_string {
-    my ($self) = @_;
-    my $first = 1;
-    my @lines;
-    while (my $frame = $self->{stacktrace}->next_frame) {
-        if ($first) {
-            $first = 0;
-            # message at foo.pl line 1
-            push @lines, sprintf("%s at %s line %s", $self->message, $frame->filename, $frame->line);
-        } else {
-            my @args = map { ref $_ ? "$_" : "'$_'" } $frame->args;
-            # main::foo called at foo.pl line 1
-            push @lines, sprintf("\t%s(%s) called at %s line %s", $frame->subroutine, join(", ", @args), $frame->filename, $frame->line);
-        }
-    }
-    join("\n", @lines);
-}
-
-# Constructor
-sub new {
-    my ($class, %kwargs) = @_;
-    $class = ref $class if ref $class; # Also take another exception object, if we must.
-    my $message = $kwargs{message} || ''; # Default to no error message
-    
-    # Construction
-    my $self = bless {message => $message}, $class;
-    $self->_build_stacktrace;
-    
-    $self;
-}
-
-1;
-__END__
\ No newline at end of file
diff --git a/t/316_exceptions.t b/t/316_exceptions.t
index c14872b..3449f8a 100644
--- a/t/316_exceptions.t
+++ b/t/316_exceptions.t
@@ -5,7 +5,7 @@ use Test::More;
 
 {
     package Foo;
-    use exception;
+    use Class::MOP::Exception;
     
     sub new {
         bless {}, 'Foo';
@@ -13,14 +13,14 @@ use Test::More;
     
     sub except {
         shift;
-        exception->new(@_);
+        Class::MOP::Exception->new(@_);
     }
     
 }
 
 {
     package Bar;
-    use exception;
+    use Class::MOP::Exception;
     
     sub one {
         two(@_);
@@ -31,7 +31,7 @@ use Test::More;
     }
     
     sub three {
-        exception->new(@_);
+        Class::MOP::Exception->new(@_);
     }
 }
 
@@ -49,7 +49,7 @@ use Test::More;
 
 ################################################## BASIC TESTS ###################
 
-    isa_ok($_,'exception',"type check") for ($f1,$f2,$f3,$b1,$b2,$b3);
+    isa_ok($_,'Class::MOP::Exception',"type check") for ($f1,$f2,$f3,$b1,$b2,$b3);
     isa_ok($_->stacktrace, 'Devel::StackTrace',"stacktraces are stacktraces") for ($f1,$f2,$f3,$b1,$b2,$b3);
     ok(!ref $_->message,"messages are strings") for ($f1,$f2,$f3,$b1,$b2,$b3);
     is($_->message,'bar', "correct messages") for ($f1,$b1);