NAME
Sah::Schema::business::id::mandiri::account_num - Mandiri account number
VERSION
This document describes version 0.002 of Sah::Schema::business::id::mandiri::account_num (from Perl distribution Sah-SchemaBundle-Business-ID-Mandiri), released on 2024-04-03.
SAH SCHEMA DEFINITION
[
"str"
,
{
prefilters
=> [
"Str::remove_nondigit"
,
"Business::ID::Mandiri::check_account_num"
,
],
},
]
Base type: str
Used prefilters: Str::remove_nondigit, Business::ID::Mandiri::check_account_num
SYNOPSIS
Sample data and validation results against this schema
""
# INVALID (Empty string)
123
# INVALID (Too short)
"006-00-1710201-7"
# valid, becomes "0060017102017"
Using with Data::Sah
To check data against this schema (requires Data::Sah):
my
$validator
= gen_validator(
"business::id::mandiri::account_num*"
);
say
$validator
->(
$data
) ?
"valid"
:
"INVALID!"
;
The above validator returns a boolean result (true if data is valid, false if otherwise). To return an error message string instead (empty string if data is valid, a non-empty error message otherwise):
my
$validator
= gen_validator(
"business::id::mandiri::account_num"
, {
return_type
=>
'str_errmsg'
});
my
$errmsg
=
$validator
->(
$data
);
# a sample valid data
$data
=
"006-00-1710201-7"
;
my
$errmsg
=
$validator
->(
$data
);
# => ""
# a sample invalid data
$data
=
""
;
my
$errmsg
=
$validator
->(
$data
);
# => "Account number must be 13 digits"
Often a schema has coercion rule or default value rules, so after validation the validated value will be different from the original. To return the validated (set-as-default, coerced, prefiltered) value:
my
$validator
= gen_validator(
"business::id::mandiri::account_num"
, {
return_type
=>
'str_errmsg+val'
});
my
$res
=
$validator
->(
$data
);
# [$errmsg, $validated_val]
# a sample valid data
$data
=
"006-00-1710201-7"
;
my
$res
=
$validator
->(
$data
);
# => ["","0060017102017"]
# a sample invalid data
$data
=
""
;
my
$res
=
$validator
->(
$data
);
# => ["Account number must be 13 digits",""]
Data::Sah can also create validator that returns a hash of detailed error message. Data::Sah can even create validator that targets other language, like JavaScript, from the same schema. Other things Data::Sah can do: show source code for validator, generate a validator code with debug comments and/or log statements, generate human text from schema. See its documentation for more details.
Using with Params::Sah
To validate function parameters against this schema (requires Params::Sah):
sub
myfunc {
my
@args
=
@_
;
state
$validator
= gen_validator(
"business::id::mandiri::account_num*"
);
$validator
->(\
@args
);
...
}
Using with Perinci::CmdLine::Lite
To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine (Perinci::CmdLine::Lite) to create a CLI:
# in lib/MyApp.pm
package
MyApp;
our
%SPEC
;
$SPEC
{myfunc} = {
v
=> 1.1,
summary
=>
'Routine to do blah ...'
,
args
=> {
arg1
=> {
summary
=>
'The blah blah argument'
,
schema
=> [
'business::id::mandiri::account_num*'
],
},
...
},
};
sub
myfunc {
my
%args
=
@_
;
...
}
1;
# in myapp.pl
package
main;
Perinci::CmdLine::Any->new(
url
=>
'/MyApp/myfunc'
)->run;
# in command-line
% ./myapp.pl --help
myapp - Routine to
do
blah ...
...
% ./myapp.pl --version
% ./myapp.pl --arg1 ...
Using on the CLI with validate-with-sah
To validate some data on the CLI, you can use validate-with-sah utility. Specify the schema as the first argument (encoded in Perl syntax) and the data to validate as the second argument (encoded in Perl syntax):
% validate-
with
-sah
'"business::id::mandiri::account_num*"'
'"data..."'
validate-with-sah
has several options for, e.g. validating multiple data, showing the generated validator code (Perl/JavaScript/etc), or loading schema/data from file. See its manpage for more details.
Using with Type::Tiny
To create a type constraint and type library from a schema (requires Type::Tiny as well as Type::FromSah):
package
My::Types {
__PACKAGE__->add_type(
sah2type(
'business::id::mandiri::account_num*'
,
name
=>
'BusinessIdMandiriAccountNum'
)
);
}
BusinessIdMandiriAccountNum->assert_valid(
$data
);
DESCRIPTION
Note that this schema only accepts 13-digit regular account number and not virtual account number.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-SchemaBundle-Business-ID-Mandiri.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-SchemaBundle-Business-ID-Mandiri.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-SchemaBundle-Business-ID-Mandiri
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.