File Coverage

lib/Neo4j/Error.pm

Criterion	Covered	Total	%
statement	72	72	100.0
branch	40	40	100.0
condition	36	36	100.0
subroutine	19	19	100.0
pod	12	12	100.0
total	179	179	100.0

use v5.10;
use strict;
use warnings;

package Neo4j::Error;
# ABSTRACT: Common Neo4j exception representations
$Neo4j::Error::VERSION = '0.01';

use List::Util 1.33 qw(first none);
use Module::Load qw(load);

my @SOURCES = qw( Server Network Internal Usage );
my @KEYS = qw(
	as_string
	category
	classification
	code
	is_retryable
	message
	raw
	related
	source
	title
	trace
);


sub _croak {
	require Carp;
	Carp::croak(@_);
}


sub new {
	my ($class, $source, $info, @extra) = @_;

	_croak "Call as instance method unsupported for %s->new()", __PACKAGE__ if ref $class ne '';
	_croak sprintf "Source param required for %s->new()", __PACKAGE__ unless $source && ref $source eq '';
	if ($class eq __PACKAGE__) {
		$class = first { $_ eq $source } @SOURCES;
		_croak sprintf "Source '%s' is unsupported for %s->new()", $source, __PACKAGE__ unless $class;
		$class = __PACKAGE__ . "::$class";
		load $class;
	}
	else {  # subclass
		_croak sprintf "Class %s fails to implement source()", $class unless $class->can('source');
		_croak sprintf "Ambiguous source %s for %s", $source, $class if $class->source ne $source;
	}

	if ($info && ref $info eq '') {
		$info = { as_string => '' . $info };
	}
	elsif (ref $info ne 'HASH') {
		_croak sprintf "Hashref or string required for %s->new()", $class;
	}
	_croak "Too many arguments for $class->new()" if @extra;

	my $self = bless {}, $class;
	$self->{$_} = $info->{$_} for @KEYS;

	require Devel::StackTrace;
	my $trace_config = $info->{trace} // {};
	$trace_config->{skip_frames}++;
	$trace_config->{message} //= $self->as_string;
	$self->{trace} = Devel::StackTrace->new(%$trace_config);

	return $self;
}


sub append_new {
	my ($self, $source, $related, @extra) = @_;

	_croak sprintf "Source param required for %s->append_new()", __PACKAGE__ unless $source && ref $source eq '';
	_croak sprintf "Ambiguous source %s for %s", $source, $self if ref $self eq '' && $self->can('source') && $self->source ne $source;

	if ($related && ref $related eq '') {
		$related = { as_string => '' . $related };
	}
	elsif (ref $related ne 'HASH') {
		_croak sprintf "Hashref or string required for %s->append_new()", __PACKAGE__;
	}

	my $class = ref $self eq '' ? $self : __PACKAGE__;
	$related->{trace}{skip_frames}++;
	$related = $class->new($source => $related, @extra);
	return $related if ref $self eq '';  # if called as class method, behave just like new()

	my $tail = $self;
	$tail = $tail->{related} while $tail->{related};
	$tail->{related} = $related;
	return $self;
}


sub as_string {
	my ($self) = @_;

	my $str = $self->{as_string};
	return $str if defined $str;

	my $code = $self->code;
	my $message = $self->message;
	$str = sprintf "%s: %s", $code, $message if $code && $message;
	$str = sprintf "%s %s", ref $self, $code if $code && ! $message;
	$str = sprintf "%s", $message if ! $code && $message;
	$str = $self->trace unless $str;  # last resort
	return $self->{as_string} = $str;
}


sub message { shift->{message} // '' }
sub code { shift->{code} // '' }
sub classification { '' }
sub category { '' }
sub title { '' }
sub is_retryable { !!0 }

sub related { shift->{related} }

sub raw { shift->{raw} }
sub trace { shift->{trace} }


1;

__END__