NAME

App::Kit::Obj::Str - string utility object

VERSION

This document describes App::Kit::Obj::Str version 0.1

SYNOPSIS

    my $str = App::Kit::Obj::Str->new();
    $str->char_count(…)

DESCRIPTION

string utility object

INTERFACE

new()

Returns the object. takes one optional attribute, “prefix”.

“prefix” is intended to be used as your app’s prefix string (e.g. a database's table names).

The default is “appkit”.

Currently it must be between 1 and 6 characters and the characters can only be A-Z, a-z, 0-9.

char_count()

Lazy wrapper of String::UnicodeUTF8’s char_count().

bytes_size()

Lazy wrapper of String::UnicodeUTF8’s bytes_size().

prefix()

Get/Set the prefix attribute.

portable_crlf()

Returns a portable CRLF. (i.e. \r\n is not portable)

zero_but_true()

Returns a zero-but-true string.

rand()

Returns a random string.

1st arg is the number of items (default 32).

2nd arg is the array ref of items (default 0 .. 9 and upper and lower case a-z)

Lazy wrapper of wrapper Data::Rand’s rand_data_string().

yaml_to_ref()

Lazy wrapper of YAML::Syck’s Load().

ref_to_yaml()

Lazy wrapper of YAML::Syck’s Dump().

json_to_ref()

Lazy wrapper of JSON::Syck’s Load().

ref_to_json()

Lazy wrapper of JSON::Syck’s Dump().

ref_to_jsonp()

Like ref_to_json() but pads it. The function name defaults to “jsonp_callback” but can be given as a second argument.

return()’s if you give it a function name with anything besides [0-9a-zA-Z_].

trim()

Takes a string (unicode or utf8 bytes)

and returns a version of it with all unicode whitespace (except space and non-break-space), invisible, and control characters removed and also leading and trailing space/non-break-space removed

A second boolean argument (default false) will collapse multiple space/non-break-space sequences down to a single space.

sha512()

Lazy wrapper of Digest::SHA’s sha512_hex().

epoch()

Takes no arguments, returns the current epoch.

attrs()

Take a hashref of attributes to stringify. There will be a leading space (to avoid extra space in output/logic in template use).

If the value is undef then only the name is output (e.g. for HTML5-osh boolean attributes). The values are HTML escaped.

If order matters build them from multiple calls in the order you want.

    $str->attrs({class=>"foo bar", required=>undef}) # ' class="foo bar" required'

Takes a second optional argument that is a lookup hashref of attributes to ignore.

    $str->attrs({class=>"foo bar", required=>undef}, {class=>1}) # ' required'

escape_html()

Lazy wrapper of HTML::Escape’s escape_html().

DIAGNOSTICS

Setting the prefix to an invalid value can result in an error that is descriptive of the problem.

CONFIGURATION AND ENVIRONMENT

Requires no configuration files or environment variables.

DEPENDENCIES

String::UnicodeUTF8

Data::Rand

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-app-kit@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Daniel Muey <http://drmuey.com/cpan_contact.pl>

LICENCE AND COPYRIGHT

Copyright (c) 2013, Daniel Muey <http://drmuey.com/cpan_contact.pl>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.