Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pokutuna/p5-text-xslate-bridge-typedeclaration
A Type Validator in Xslate
https://github.com/pokutuna/p5-text-xslate-bridge-typedeclaration
perl template type validation xslate
Last synced: about 2 months ago
JSON representation
A Type Validator in Xslate
- Host: GitHub
- URL: https://github.com/pokutuna/p5-text-xslate-bridge-typedeclaration
- Owner: pokutuna
- License: other
- Created: 2017-01-27T01:42:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-28T03:00:06.000Z (over 6 years ago)
- Last Synced: 2024-04-15T14:22:23.638Z (9 months ago)
- Topics: perl, template, type, validation, xslate
- Language: Perl
- Homepage: https://metacpan.org/pod/Text::Xslate::Bridge::TypeDeclaration
- Size: 71.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/pokutuna/p5-Text-Xslate-Bridge-TypeDeclaration) [](https://coveralls.io/r/pokutuna/p5-Text-Xslate-Bridge-TypeDeclaration?branch=master)
# NAME
Text::Xslate::Bridge::TypeDeclaration - A Type Validator in Xslate.
# SYNOPSIS
my $xslate = Text::Xslate->new(
module => [ 'Text::Xslate::Bridge::TypeDeclaration' ],
);
# @@ template.tx
# <:- declare(
# user => 'Some::Model::User',
# drink => 'Enum["Cocoa", "Cappuchino", "Tea"]'
# ) -:>
# <: user.name :> is drinking a cup of <: $drink :>.
# Success!
$xslate->render('template.tx', {
user => Some::Model::User->new(name => 'pokutuna'),
drink => 'Cocoa',
});
# Output:
# pokutuna is drinking a cup of Cocoa.
# A string 'Oil' is not a drink
$xslate->render('template.tx', {
user => Some::Model::User->new(name => 'pokutuna'),
drink => 'Oil',
});
# Output:
#
# Declaration mismatch for `drink`
# Value "Oil" did not pass type constraint "Enum["Cocoa", "Cappuchino", "Tea"]"
#
# pokutuna is drinking a cup of Oil.
# DESCRIPTION
Text::Xslate::Bridge::TypeDeclaration is a type validator module for [Text::Xslate](https://metacpan.org/pod/Text::Xslate) templates.
Type validation of this module is base on [Type::Tiny](https://metacpan.org/pod/Type::Tiny).
[Type::Tiny](https://metacpan.org/pod/Type::Tiny) type constraints are compatible with Moo, Moose and Mouse.
You can use this even if you do not use these type libraries.
If the library-based type is not found, treats as a class type of the name.
# DECLARATIONS
This module looks for a type name that was written in the template from [Text::Xslate::Bridge::TypeDeclaration::Registry](https://metacpan.org/pod/Text::Xslate::Bridge::TypeDeclaration::Registry) by default.
The following behaviors can be replaced by specifying the registry in `registry_class_name` option.
## Types::Standard
See [Types::Standard](https://metacpan.org/pod/Types::Standard).
- `declare(name => 'Str')`
- `declare(user_ids => 'ArrayRef[Int]')`
- `declare(person_hash => 'Dict[name => Str, age => Int]')`
## Class-Type
It will be treated as a class type when a type of the given name is not found.
- `declare(engine => 'Text::Xslate')`
- `declare(visitor => 'Maybe[My::Model::UserAccount]')`
## Hashref
Hashref is treated as `Dict[... slurpy Any]`.
This is a ** slurpy ** match. Less value is error. Extra values are ignored.
- `declare(account_summary => { name => 'Str', subscriber_count => 'Int', icon => 'My::Image' })`
- `declare(sidebar => { profile => { name => 'Str', followers => 'Int' }, recent_entries => 'ArrayRef[My::Entry]' })`
# OPTIONS
Text::Xslate->new(
module => [
'Text::Xslate::Bridge::TypeDeclaration' => [
# defaults
method => 'declare', # method name to export
validate => 1, # enable validation when truthy
print => 1, # enable printing errors to the output buffer when truthy
on_mismatch => 'die', # error handler ('die', 'warn' or 'none')
registry_class => undef, # package name for specifying Type::Registry
]
]
);
# APPENDIX
## Disable Validation on Production
Perhaps you want to disable validation in production to prevent spoiling performance on a [Plack](https://metacpan.org/pod/Plack) application.
Text::Xslate->new(
module => [
'Text::Xslate::Bridge::TypeDeclaration' => [
validate => $ENV{PLACK_ENV} ne 'production',
],
],
);
## Use `type-declaration-mismatch` class name
Highlight by css
.type-declaration-mismatch { color: crimson; }
Lint with [Test::WWW::Mechanize](https://metacpan.org/pod/Test::WWW::Mechanize)
# in subclass of Test::WWW::Mechanize
sub _lint_content_ok {
my ($self, $desc) = @_;
if (my $mismatch = $self->scrape_text_by_attr('class', 'type-declaration-mismatch')) {
$Test::Builder::Test->ok(0, $mismatch);
};
return $self->SUPER::_lint_content_ok($desc);
}
# SEE ALSO
[Text::Xslate](https://metacpan.org/pod/Text::Xslate), [Text::Xslate::Bridge](https://metacpan.org/pod/Text::Xslate::Bridge)
[Type::Tiny](https://metacpan.org/pod/Type::Tiny), [Types::Standard](https://metacpan.org/pod/Types::Standard), [Type::Registry](https://metacpan.org/pod/Type::Registry)
[Smart::Args](https://metacpan.org/pod/Smart::Args), [Test::WWW::Mechanize](https://metacpan.org/pod/Test::WWW::Mechanize)
# LICENSE
Copyright (C) pokutuna.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
# AUTHOR
pokutuna