Merge pull request #6 from iamalnewkirk/release-202

Release v2.02

Author: iamalnewkirk

CHANGES

@@ -1,6 +1,12 @@
 Changelog for Data-Object-Exception
 
-2.01 2020-02-17T05:23:10
+2.02 2020-03-14T23:15:07
+ - Added release updates
+ - Support setting all attributes using "throw"
+ - Document attributes
+
+2.01 2020-02-17T05:23:11
+ - Built release version 2.01
  - Added release updates
  - Re-releasing to the CPAN
 

Makefile.PL

@@ -29,7 +29,7 @@ my %WriteMakefileArgs = (
  "strict" => 0,
  "warnings" => 0
  },
- "VERSION" => "2.01",
+ "VERSION" => "2.02",
  "test" => {
  "TESTS" => "t/*.t"
  }

README

@@ -43,6 +43,28 @@ SCENARIOS
 
  The package allows objects to be instantiated with key-value arguments.
 
+ATTRIBUTES
+
+ This package has the following attributes:
+
+ context
+
+ context(Any)
+
+ This attribute is read-only, accepts (Any) values, and is optional.
+
+ id
+
+ id(Str)
+
+ This attribute is read-only, accepts (Str) values, and is optional.
+
+ message
+
+ message(Str)
+
+ This attribute is read-only, accepts (Str) values, and is optional.
+
 METHODS
 
  This package implements the following methods:
@@ -63,18 +85,34 @@ METHODS
 
  throw
 
- throw(Str $class, Any $context, Maybe[Number] $offset) : Any
+ throw(Tuple[Str, Str] | Str $message, Any $context, Maybe[Number] $offset) : Any
 
- The throw method throws an error with message.
+ The throw method throws an error with message (and optionally, an ID).
 
  throw example #1
 
  use Data::Object::Exception;
 
+ my $exception = Data::Object::Exception->new;
+ 
+ $exception->throw('Oops!')
+
+ throw example #2
+
+ use Data::Object::Exception;
+ 
  my $exception = Data::Object::Exception->new('Oops!');
 
  $exception->throw
 
+ throw example #3
+
+ use Data::Object::Exception;
+ 
+ my $exception = Data::Object::Exception->new;
+ 
+ $exception->throw(['E001', 'Oops!'])
+
  trace
 
  trace(Int $offset, $Int $limit) : Object

README.md

@@ -43,6 +43,28 @@ The package allows objects to be instantiated with a single argument.
 
 The package allows objects to be instantiated with key-value arguments.
 
+# ATTRIBUTES
+
+This package has the following attributes:
+
+## context
+
+ context(Any)
+
+This attribute is read-only, accepts `(Any)` values, and is optional.
+
+## id
+
+ id(Str)
+
+This attribute is read-only, accepts `(Str)` values, and is optional.
+
+## message
+
+ message(Str)
+
+This attribute is read-only, accepts `(Str)` values, and is optional.
+
 # METHODS
 
 This package implements the following methods:
@@ -63,18 +85,34 @@ The explain method returns an error message with stack trace.
 
 ## throw
 
- throw(Str $class, Any $context, Maybe[Number] $offset) : Any
+ throw(Tuple[Str, Str] | Str $message, Any $context, Maybe[Number] $offset) : Any
 
-The throw method throws an error with message.
+The throw method throws an error with message (and optionally, an ID).
 
 - throw example #1
 
   use Data::Object::Exception;
 
+  my $exception = Data::Object::Exception->new;
+
+  $exception->throw('Oops!')
+
+- throw example #2
+
+  use Data::Object::Exception;
+
   my $exception = Data::Object::Exception->new('Oops!');
 
   $exception->throw
 
+- throw example #3
+
+  use Data::Object::Exception;
+
+  my $exception = Data::Object::Exception->new;
+
+  $exception->throw(['E001', 'Oops!'])
+
 ## trace
 
  trace(Int $offset, $Int $limit) : Object

VERSION

@@ -1 +1 @@
-2.01
+2.02

lib/Data/Object/Exception.pm

@@ -64,19 +64,23 @@ fun BUILDARGS($class, @args) {
 # FUNCTIONS
 
 fun throw($self, $message, $context, $offset) {
- my $class = ref $self || $self;
-
  my $id;
- my $frames;
+
+ my $class = ref $self || $self;
 
  my $args = {};
 
+ if (ref $message eq 'ARRAY') {
+ ($id, $message) = @$message;
+ }
+
  if (ref $self) {
  for my $name (keys %$self) {
  $args->{$name} = $self->{$name};
  }
  }
 
+ $args->{id} = $id if $id;
  $args->{message} = $message if $message;
  $args->{context} = $context if $context;
 

lib/Data/Object/Exception.pod

@@ -60,6 +60,36 @@ The package allows objects to be instantiated with key-value arguments.
 
 =cut
 
+=head1 ATTRIBUTES
+
+This package has the following attributes:
+
+=cut
+
+=head2 context
+
+ context(Any)
+
+This attribute is read-only, accepts C<(Any)> values, and is optional.
+
+=cut
+
+=head2 id
+
+ id(Str)
+
+This attribute is read-only, accepts C<(Str)> values, and is optional.
+
+=cut
+
+=head2 message
+
+ message(Str)
+
+This attribute is read-only, accepts C<(Str)> values, and is optional.
+
+=cut
+
 =head1 METHODS
 
 This package implements the following methods:
@@ -88,22 +118,46 @@ The explain method returns an error message with stack trace.
 
 =head2 throw
 
- throw(Str $class, Any $context, Maybe[Number] $offset) : Any
+ throw(Tuple[Str, Str] | Str $message, Any $context, Maybe[Number] $offset) : Any
 
-The throw method throws an error with message.
+The throw method throws an error with message (and optionally, an ID).
 
 =over 4
 
 =item throw example #1
 
  use Data::Object::Exception;
 
+ my $exception = Data::Object::Exception->new;
+
+ $exception->throw('Oops!')
+
+=back
+
+=over 4
+
+=item throw example #2
+
+ use Data::Object::Exception;
+
  my $exception = Data::Object::Exception->new('Oops!');
 
  $exception->throw
 
 =back
 
+=over 4
+
+=item throw example #3
+
+ use Data::Object::Exception;
+
+ my $exception = Data::Object::Exception->new;
+
+ $exception->throw(['E001', 'Oops!'])
+
+=back
+
 =cut
 
 =head2 trace

t/Data_Object_Exception.t

@@ -27,6 +27,14 @@ method: trace
 
 =cut
 
+=attributes
+
+id: ro, opt, Str
+context: ro, opt, Any
+message: ro, opt, Str
+
+=cut
+
 =synopsis
 
  use Data::Object::Exception;
@@ -74,20 +82,36 @@ The package allows objects to be instantiated with key-value arguments.
 
 =method throw
 
-The throw method throws an error with message.
+The throw method throws an error with message (and optionally, an ID).
 
 =signature throw
 
-throw(Str $class, Any $context, Maybe[Number] $offset) : Any
+throw(Tuple[Str, Str] | Str $message, Any $context, Maybe[Number] $offset) : Any
 
 =example-1 throw
 
  use Data::Object::Exception;
 
+ my $exception = Data::Object::Exception->new;
+
+ $exception->throw('Oops!')
+
+=example-2 throw
+
+ use Data::Object::Exception;
+
  my $exception = Data::Object::Exception->new('Oops!');
 
  $exception->throw
 
+=example-3 throw
+
+ use Data::Object::Exception;
+
+ my $exception = Data::Object::Exception->new;
+
+ $exception->throw(['E001', 'Oops!'])
+
 =cut
 
 =method explain
@@ -196,6 +220,34 @@ $subs->example(-1, 'throw', 'method', fun($tryable) {
  $result
 });
 
+$subs->example(-2, 'throw', 'method', fun($tryable) {
+ $tryable->default(fun($caught) {
+ $caught
+ });
+ ok my $result = $tryable->result;
+ ok $result->isa('Data::Object::Exception');
+ ok !length $result->id;
+ ok !length $result->context;
+ ok length $result->frames;
+ is $result->message, 'Oops!';
+
+ $result
+});
+
+$subs->example(-3, 'throw', 'method', fun($tryable) {
+ $tryable->default(fun($caught) {
+ $caught
+ });
+ ok my $result = $tryable->result;
+ ok $result->isa('Data::Object::Exception');
+ is $result->id, 'E001';
+ ok !length $result->context;
+ ok length $result->frames;
+ is $result->message, 'Oops!';
+
+ $result
+});
+
 $subs->example(-1, 'explain', 'method', fun($tryable) {
  ok my $result = $tryable->result;