Why not adopt me?

This distribution is up for adoption! If you're interested then please contact the PAUSE module admins via email.

NAME

POE::Component::JavaScript::Minifier - non-blocking wrapper around JavaScript::Minifier with URI fetching abilities

SYNOPSIS

    use strict;
    use warnings;

    use POE qw/Component::JavaScript::Minifier/;

    my $poco = POE::Component::JavaScript::Minifier->spawn;

    POE::Session->create( package_states => [ main => [qw(_start results)] ], );

    $poe_kernel->run;

    sub _start {
        $poco->minify(
                event   => 'results',
                uri     => 'http://zoffix.com/main.js',
                outfile => 'out.js',
            }
        );
    }

    sub results {
        if ( $_[ARG0]->{error} ) {
            print "Error: $_[ARG0]->{error}\n";
        }
        else {
            print "Minified JS: $_[ARG0]->{outfile}\n";
        }
        $poco->shutdown;
    }

Using event based interface is also possible of course.

DESCRIPTION

The module is a non-blocking wrapper around JavaScript::Minifier, which provides interface to strip useless spaces from JavaScript code. The wrapper also provides additional functionality to fetch JavaScript from URI.

CONSTRUCTOR

`spawn`

    my $poco = POE::Component::JavaScript::Minifier->spawn;

    POE::Component::JavaScript::Minifier->spawn(
        alias => 'mini',
        ua_args => { timeout => 30 },
        options => {
            debug => 1,
            trace => 1,
            # POE::Session arguments for the component
        },
        debug => 1, # output some debug info
    );

The spawn method returns a POE::Component::JavaScript::Minifier object. It takes a few arguments, all of which are optional. The possible arguments are as follows:

`alias`

    ->spawn( alias => 'mini' );

Optional. Specifies a POE Kernel alias for the component.

`ua_args`

    ->spawn( ua_args => { timeout => 30 }, );

Optional. Takes a hashref as an argument that will be directly dereferenced into LWP::UserAgent's constructor when uri argument in minify event/method is used as input. Defaults to: empty hashref.

`options`

    ->spawn(
        options => {
            trace => 1,
            default => 1,
        },
    );

Optional. A hashref of POE Session options to pass to the component's session.

`debug`

    ->spawn(
        debug => 1
    );

When set to a true value turns on output of debug messages. Defaults to: 0.

METHODS

`minify`

    $poco->minify( {
            event       => 'event_for_output',
            uri         => 'http://zoffix.com/main.js',
            outfile     => 'minified.js',
            _blah       => 'pooh!',
            session     => 'other',
        }
    );

Takes a hashref as an argument, does not return a sensible return value. See minify event's description for description and list of all accepted arguments.

`session_id`

    my $poco_id = $poco->session_id;

Takes no arguments. Returns component's session ID.

`shutdown`

    $poco->shutdown;

Takes no arguments. Shuts down the component.

ACCEPTED EVENTS

`minify`

    $poe_kernel->post( mini => minify => {
            event       => 'event_for_output',
            uri         => 'http://zoffix.com/main.js',
            outfile     => 'minified.js', # optional,
            copyright   => 'BSD License', # optional
            stripDebug  => 1,             # optional
            _blah       => 'pooh!',
            session     => 'other',
        }
    );

    # or

    $poe_kernel->post( mini => minify => {
            event       => 'event_for_output',
            infile      => 'in.js',
            outfile     => 'minified.js', # optional
            copyright   => 'BSD License', # optional
            stripDebug  => 1,             # optional
            _blah       => 'pooh!',
            session     => 'other',
        }
    );

    # or

    $poe_kernel->post( mini => minify => {
            event       => 'event_for_output',
            in          => 'var x = 2;',
            outfile     => 'minified.js', # optional
            copyright   => 'BSD License', # optional
            stripDebug  => 1,             # optional
            _blah       => 'pooh!',
            session     => 'other',
        }
    );

Instructs the component to strip useless spaces from JavaScript code. Takes a hashref as an argument, the possible keys/value of that hashref are as follows:

`event`

    { event => 'results_event', }

Mandatory. Specifies the name of the event to emit when results are ready. See OUTPUT section for more information.

`in`

    { in => 'var x = 2;' }

Optional. One of the methods to give input. Takes a string with JavaScript code to "minify" as an argument.

`uri`

    { uri => 'http://zoffix.com/main.js' }

Optional. One of the methods to give input. Takes a URI as a value that will be fetched and serve as JavaScript code to "minify".

`infile`

    { infile => 'in.js' }

Optional. One of the methods to give input. Takes a filename as an argument. The file will be opened and the filehandle will be given to minify() function of JavaScript::Minifier to serve as JavaScript code to "minify".

`outfile`

    { outfile => 'minified.js' }

Optional. When specified, the "minified" JavaScript code will be written to the file, filename of which you specify in outfile argument. Note: file will be created if does not exist and completely destroyed without a warning if it does exist. If not specified the minified JavaScript code will be passed to the output event handler (see below).

`copyright` and `stripDebug`

    {
        copyright   => 'BSD License',
        stripDebug  => 1,
    }

Both are optional. Function exactly the same as they do in minify() sub of JavaScript::Minifier. See documentation for JavaScript::Minifier for more information.

`session`

    { session => 'other' }

    { session => $other_session_reference }

    { session => $other_session_ID }

Optional. Takes either an alias, reference or an ID of an alternative session to send output to.

user defined

    {
        _user    => 'random',
        _another => 'more',
    }

Optional. Any keys starting with _ (underscore) will not affect the component and will be passed back in the result intact.

`shutdown`

    $poe_kernel->post( mini => 'shutdown' );

Takes no arguments. Tells the component to shut itself down.

OUTPUT

    $VAR1 = {
        'out' => 'var x=2;',
        'in' => 'var x = 2;',
        '_blah' => 'foos'
    };

The event handler set up to handle the event which you've specified in the event argument to minify() method/event will recieve input in the $_[ARG0] in a form of a hashref. The possible keys/value of that hashref are as follows:

`out`

    { 'out' => 'var x=2;', }

Unless outfile was specified as an argument to minify event/method, the out key will be present and its value will be minified JavaScript code.

`error`

    { 'error' => 'infile error [No such file or directory]' }

If an error occured, the error key will be present and its value will be description of an error. The error could be errors during opening input or output files as well as network errors when uri argument was given to minify event/method.

`in`, `uri` and `infile`

    { 'in' => 'var x = 2;', }

Depending on how you are giving the input to minify event/method, the key you specify in minify event/method will be present in the output.

`copyright` and `stripDebug`

    {
        'copyright'  => 'BSD License',
        'stripDebug' => 1,
    }

If you specified copyright or stripDebug options to minify() event/method, the values you specified will be intact in the output.

user defined

    { '_blah' => 'foos' }

Any arguments beginning with _ (underscore) passed into the minify() event/method will be present intact in the result.

AUTHOR

'Zoffix, <'zoffix at cpan.org'> (http://zoffix.com/, http://haslayout.net/, http://zofdesign.com/)

BUGS

Please report any bugs or feature requests to bug-poe-component-javascript-minifier at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-JavaScript-Minifier. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc POE::Component::JavaScript::Minifier

You can also look for information at:

RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-JavaScript-Minifier
AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/POE-Component-JavaScript-Minifier
CPAN Ratings

http://cpanratings.perl.org/d/POE-Component-JavaScript-Minifier
Search CPAN

http://search.cpan.org/dist/POE-Component-JavaScript-Minifier

COPYRIGHT & LICENSE

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

To install POE::Component::JavaScript::Minifier, copy and paste the appropriate command in to your terminal.

cpanm

cpanm POE::Component::JavaScript::Minifier

CPAN shell

perl -MCPAN -e shell
install POE::Component::JavaScript::Minifier

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

Why not adopt me?

NAME

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

spawn

alias

ua_args

options

debug

METHODS

minify

session_id

shutdown

ACCEPTED EVENTS

minify

event

in

uri

infile

outfile

copyright and stripDebug

session

user defined

shutdown

OUTPUT

out

error

in, uri and infile

copyright and stripDebug

user defined

SEE ALSO

AUTHOR

BUGS

SUPPORT

COPYRIGHT & LICENSE

Module Install Instructions

`spawn`

`alias`

`ua_args`

`options`

`debug`

`minify`

`session_id`

`shutdown`

`minify`

`event`

`in`

`uri`

`infile`

`outfile`

`copyright` and `stripDebug`

`session`

`shutdown`

`out`

`error`

`in`, `uri` and `infile`

`copyright` and `stripDebug`