File Coverage

blib/lib/Stancer/Role/Amount/Read.pm

Criterion	Covered	Total	%
statement	19	19	100.0
branch			n/a
condition			n/a
subroutine	8	8	100.0
pod			n/a
total	27	27	100.0

package Stancer::Role::Amount::Read;

use 5.020;
use strict;
use warnings;

# ABSTRACT: Amount read-only role
our $VERSION = '1.0.3'; # VERSION

use Stancer::Core::Types qw(Amount Maybe Currency);

use Moo::Role;

requires qw(_add_modified _attribute_builder);

use namespace::clean;


has amount => (
    is => 'rwp',
    isa => Maybe[Amount],
    builder => sub { $_[0]->_attribute_builder('amount') },
    lazy => 1,
    predicate => 1,
    trigger => sub { $_[0]->_add_modified('amount') },
);


has currency => (
    is => 'rwp',
    isa => Maybe[Currency],
    builder => sub { $_[0]->_attribute_builder('currency') },
    coerce => sub { defined $_[0] ? lc $_[0] : $_[0] },
    lazy => 1,
    predicate => 1,
    trigger => sub { $_[0]->_add_modified('currency') },
);

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Stancer::Role::Amount::Read - Amount read-only role

=head1 VERSION

version 1.0.3

=head1 ATTRIBUTES

=head2 C<amount>

Read-only integer.

Amount.

=head2 C<currency>

Read-only string.

Currency.

=head1 USAGE

=head2 Logging



We use the L<Log::Any> framework for logging events.
You may tell where it should log using any available L<Log::Any::Adapter> module.

For example, to log everything to a file you just have to add a line to your script, like this:
    #! /usr/bin/env perl
    use Log::Any::Adapter (File => '/var/log/payment.log');
    use Stancer::Role::Amount::Read;

You must import C<Log::Any::Adapter> before our libraries, to initialize the logger instance before use.

You can choose your log level on import directly:
    use Log::Any::Adapter (File => '/var/log/payment.log', log_level => 'info');

Read the L<Log::Any> documentation to know what other options you have.

=cut

=head1 SECURITY

=over

=item *

Never, never, NEVER register a card or a bank account number in your database.

=item *

Always uses HTTPS in card/SEPA in communication.

=item *

Our API will never give you a complete card/SEPA number, only the last four digits.
If you need to keep track, use these last four digit.

=back

=cut

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website
L<https://gitlab.com/wearestancer/library/lib-perl/-/issues> or by email to
L<[e-mail]|mailto:[e-mail]>.

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 AUTHOR

Joel Da Silva <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2024 by Stancer / Iliad78.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

=cut