/ 
Data-Sah-0.916
River stage three • 431 direct dependents • 689 total dependents
/ Data::Sah::Manual::Extending

NAME

Data::Sah::Manual::Extending - Extending Data::Sah

VERSION

This document describes version 0.916 of Data::Sah::Manual::Extending (from Perl distribution Data-Sah), released on 2024-02-16.

DESCRIPTION

This document explains the various ways of extending Data::Sah.

ADDING A NEW CLAUSE

Example: Add an is_palindrome clause to str.

  • Create a distribution called Data-Sah-TypeX-str-is_palindrome

  • In lib/Data/Sah/TypeX/str/is_palindrome.pm, write:

    package Data::Sah::TypeX::str::is_palindrome;
use Data::Sah::Util::Compiler qw(add_clause add_translation_path);

add_clause("str", "is_palindrome",
    definition => {
    },
    handlers => {
        perl => sub {
            ...
        },
        js => sub {
            ...
        },
        human => sub {
            ...
        },
    },
);

  • Provide translation of messages

    For example, for Indonesian, in lib/Data/Sah/Lang/id_ID/TypeX/str/is_palindrome.pm write:

    package Data::Sah::Lang::id_ID::TypeX::str::is_palindrome:
...

    Add more language files as necessary.

CREATING A NEW TYPE

Example: complex number.

  • Create distribution Data-Sah-Type-complex

  • In lib/Data/Sah/Type/complex.pm write:

    package Data::Sah::Type::complex;

use Moo::Role;
use Data::Sah::Util::Role 'has_clause';
with 'Data::Sah::Type::Comparable';
with 'Data::Sah::Type::Sortable';

...

1;

  • In lib/Data/Sah/Compiler/perl/TH/complex.pm write:

    XXX

  • In lib/Data/Sah/Compiler/js/TH/complex.pm write:

    XXX

  • In lib/Data/Sah/Compiler/human/TH/complex.pm write:

    XXX

  • Provide translation of messages

    For example, for Indonesian, in lib/Data/Sah/Lang/id_ID/Type/complex.pm write:

    package Data::Sah::Lang::id_ID::TypeX::str::is_palindrome:
...

    Add more language files as necessary.

ADDING A NEW FUNCTION

XXX

CREATING A NEW FUNCTION SET

XXX

CREATING A NEW COMPILER

Take a look at one of the existing compilers like Data::Sah::Compiler::perl or Data::Sah::Compiler::human.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Sah.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah.

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, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 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=Data-Sah

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.