File Coverage

blib/lib/String/JS.pm

Criterion	Covered	Total	%
statement	39	44	88.6
branch	13	14	92.8
condition			n/a
subroutine	8	8	100.0
pod	2	2	100.0
total	62	68	91.1

package String::JS;

our $DATE = '2014-07-25'; # DATE
our $VERSION = '0.02'; # VERSION

use 5.010001;
use strict;
use warnings;

use JSON;
my $json = JSON->new->allow_nonref;

use Exporter;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(
                       encode_js_string
                       decode_js_string
               );

my %esc = (
    "\n"   => "\\n",
    "\r"   => "\\r",
    "\x0b" => "\\v",
    "\t" => "\\t",
    "\b" => "\\b",
    "\f" => "\\f",
);

sub encode_js_string {
    my ($str, $mode) = @_;
    no warnings 'uninitialized'; # shut up warning when $str is undef
    if ($mode) {
        if ($mode == 1) {
            $str =~ s/([\\'])/\\$1/g;
            return qq('$str') unless $str =~ /[^\040-\176]/;  # fast exit
            $str =~ s/([\n\r\x0b\t\b\f])/$esc{$1}/g;
            $str =~ s/([\0-\037\177-\377])/sprintf('\\x%02x',ord($1))/eg;
            $str =~ s/([^\040-\176])/sprintf('\\u{%04x}',ord($1))/eg;
            return qq('$str');
        } elsif ($mode == 2) {
            $str =~ s/([\\'"])/\\\\$1/g;
            return qq('$str') unless $str =~ /[^\040-\176]/;  # fast exit
            $str =~ s/([\n\r\x0b\t\b\f])/\\$esc{$1}/g;
            $str =~ s/([\0-\037\177-\377])/sprintf('\\\\x%02x',ord($1))/eg;
            $str =~ s/([^\040-\176])/sprintf('\\\\u{%04x}',ord($1))/eg;
            return qq('$str');
        } else {
            die "Invalid mode, must be 0, 1, or 2";
        }
    } else {
        return $json->encode("$str");
    }
}

sub decode_js_string {
    my $str = shift;
    if ($str =~ /\A"/o) {
        $json->decode($str);
    } elsif ($str =~ /\A'/o) {
        die "Decoding JavaScript string with single quotes not yet implemented";
    } else {
        die "Invalid JavaScript string literal";
    }
}

1;
# ABSTRACT: Utilities for Javascript string literal representation

__END__

=pod

=encoding UTF-8

=head1 NAME

String::JS - Utilities for Javascript string literal representation

=head1 VERSION

This document describes version 0.02 of String::JS (from Perl distribution String-JS), released on 2014-07-25.

=head1 FUNCTIONS

=head2 encode_js_string($str[, $mode]) => STR

Encode Perl string C<$str> to its JavaScript literal representation using double
quotes (C<">). This is currently implemented using JSON encoding.

If C<$mode> is set to 1, will produce literal representation using single quotes
(C<'>) instead.

If C<$mode> is set to 2, will produce single-quoted JS string to be put inside a
double-quoted JS string literal, useful for producing for example jQuery
expression like:

 $("h2.contains('this is JS string inside another JS string')")

Will die on failure.

=head2 decode_js_string($js_str) => STR

Given a JavaScript string literal representation in C<$js_str>, decode to get
the value.

Currently implemented using JSON decoding of stringified C<$js_str>.

Currently does not support JavaScript string representation that uses single
quotes (C<'>).

Will die on failure.

=head1 SEE ALSO

L<JSON>

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/String-JS>.

=head1 SOURCE

Source repository is at L<https://github.com/sharyanto/perl-String-JS>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=String-JS>

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.

=head1 AUTHOR

Steven Haryanto <[e-mail]>

=head1 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.

=cut