NAME

Data::Sah::Compiler::human - Compile Sah schema to human language

VERSION

This document describes version 0.26 of module Data::Sah::Compiler::human (in distribution Data-Sah), released on 2014-04-28.

SYNOPSIS

DESCRIPTION

This class is derived from Data::Sah::Compiler. It generates human language text.

ATTRIBUTES

METHODS

new() => OBJ

$c->compile(%args) => RESULT

Aside from base class' arguments, this class supports these arguments (suffix * denotes required argument):

• format => STR (default: inline_text)

  Format of text to generate. Either inline_text, inline_err_text, or markdown. Note that you can easily convert Markdown to HTML, there are libraries in Perl, JavaScript, etc to do that.

  Sample inline_text output:

  integer, must satisfy all of the following: (divisible by 3, at least 10)

  inline_err_text is just like inline_text, except geared towards producing an error message. Currently, instead of producing "integer" from schema "int", it produces "Input is not of type integer". The rest is identical.

  Sample markdown output:

  integer, must satisfy all of the following:
  
  * divisible by 3
  * at least 10

Compilation data

This subclass adds the following compilation data ($cd).

Keys which contain compilation state:

Keys which contain compilation result:

HOMEPAGE

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

SOURCE

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

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.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.