NAME

Javascript::Closure - compress your javascript code using Google online service of Closure Compiler

VERSION

0.04

SYNOPSIS

    #nothing is imported by default
    use Javascript::Closure qw(minify :CONSTANTS); 

    #open a file
    open (FILE,'<','jscript.js') or die $!;
    my @lines = <FILE>;
    close FILE;
	
    #compress the code. most of the time it will be all you need!
    my $compressed   = minify(input=>join('',@lines));
    
    #output the result in another file
    open FILE,'>','closure-jscript.js' or die $!;
    print FILE $compressed;
    close FILE;

    #further settings:
    my $compressed = minify(input            => [$string,'http://www.domain.com/my.js',$string2,'http://www.domain2.com/my2.js'],
                            output_format    => XML,
                            output_info      => [STATISTICS,WARNINGS,COMPILED_CODE],
                            compilation_level=> SIMPLE_OPTIMIZATIONS,
							warning_level	 => VERBOSE
    );

DESCRIPTION

This package allows you to compress your javascript code by using the online service of Closure Compiler offered by Google via a REST API. See http://closure-compiler.appspot.com/ for further information.

MOTIVATION

Needed a package to encapsulate a coherent API for a future Javascript::Minifier::Any package.

ADVANTAGES

Gives you access to the closure compression algo with an unified API. It also gives you access to code analyze via errors, warnings and authorizing via statistics.

SUBROUTINE

minify

Takes an hash with the following parameters(parameters ended with * are optionals):

input

Specify the javascript source to be compressed/analysed. It can be either an url or a scalar.

You can also use an array reference containing multiple urls or raw source code.

Example:

    use Javascript::Closure qw(minify :CONSTANTS); 
	
    my $compressed   = minify(input=>$jscode);
    my $compressed   = minify(input=>'http://www.yourdomain.com/yourscript.js');    
    my $compressed   = minify(input=>['http://www.yourdomain.com/yourscript.js','http://www.yourdomain.com/yourscript2.js',$jscode]);

compilation_level

Specifies the algorithm use to compress the javascript code. You can specify them by using one of the following constants:

WHITESPACE_ONLY
SIMPLE_OPTIMIZATIONS (default)
ADVANCED_OPTIMIZATIONS

Example:

    use Javascript::Closure qw(minify :CONSTANTS); 
	
    my $compressed   = minify(input=>$jscode,compilation_level=>WHITESPACE_ONLY);

	#if you do not import the constants:
    my $compressed   = minify(input=>$jscode,compilation_level=>Javascript::Closure::WHITESPACE_ONLY);

See CONSTANTS section for further information about the algorithms.

output_info

Specify the informations you will get back from the service. it accepts either a scalar or an array reference. You can specify them by using the following constants:

COMPILED_CODE (default)
WARNINGS
ERRORS
STATISTICS

Example:

    use Javascript::Closure qw(minify :CONSTANTS); 
	
	#you just want to get the code analysed before compression
    my $warnings   = minify(input=>$jscode,output_info=>WARNINGS);

	#only the errors in your code
    my $errors   = minify(input=>$jscode,output_info=>ERRORS);

	#everything was ok so you want to compressed code and some statistics about the efficiency of the compresssion
    my $errors   = minify(input=>$jscode,output_info=>[COMPILED_CODE,STATISTICS]);
     
 - output_format

Specify the format of the response. It can be one of the following constants:

TEXT (default)
JSON
XML

Example:

    use Javascript::Closure qw(minify :CONSTANTS); 
	
	#the default
    my $warnings   = minify(input=>$jscode,output_format=>TEXT);

	#get back the response as XML
    my $errors   = minify(input=>$jscode,output_format=>XML);

	#get back the response as JSON
    my $errors   = minify(input=>$jscode,output_format=>JSON);

Specifying the format can be useful if you want not only the compiled code but warnings,errors or statistics. Though minify only returns the compressed version of the javascript code as a scalar,you can easily json-ify it to retrieve the information (you could do so with a corresponding XML module):

Example:

    use Javascript::Closure qw(minify :CONSTANTS); 
	use JSON;
	
	#the default
    my $output     = minify(input=>$jscode,output_format=>JSON,output_info=>[COMPILED_CODE,STATISTICS]);

	#change the raw string into perl structure
	my $response   = from_json($output);

	my $statistics = $response->{statistics};
	say $statistics->{originalSize};
	say $statistics->{compressedSize};

Javascript::Closure does not offer shortcuts access to errors,warnings or statistics for now. Might add a Javascript::Closure::Response::JSON to make thing even sweeter but access through an hash is certainly faster and the overhead of function call does not seem necessary...

warning_level

Specifies the amount of information you will get when you set the output_info to WARNINGS. You can specify them by using one of the following constants:

QUIETE
DEFAULT (default)
VERBOSE

Example:

    use Javascript::Closure qw(minify :CONSTANTS); 
	
    my $compressed   = minify(input            => $jscode,
                              compilation_level=> WHITESPACE_ONLY,
                              output_info      => [COMPILE_CODE,WARNINGS],
                              warning_level    => VERBOSE
    );

See CONSTANTS section for further information about the algorithms.

CONSTANTS

Each optional parameter to minify can be specified via constants. If you do not import the :CONSTANTS, you will have to write Javascript::Closure::NAME_OF_THE_CONSTANT;

compilation level related

- WHITESPACE_ONLY
  remove space and comments from javascript code.

- SIMPLE_OPTIMIZATIONS
  compress the code by renaming local variables

- ADVANCED_OPTIMIZATIONS
  compress all local variables, do some clever stripping down of the code (unused functions are removed) 
  but you need to setup external references to do it properly.

See http://code.google.com/intl/ja/closure/compiler/docs/api-tutorial3.html for further information.

output format related

- XML
  return the output in XML format with the information set with your output_info settings

- JSON
  return the output in JSON format with the information set with your output_info settings

- TEXT
  return the output in raw text format with the information set with your output_info settings

See http://code.google.com/intl/ja/closure/compiler/docs/api-ref.html#out for further information.

output info related

- COMPILED_CODE
  return only the raw compressed javascript source code.

- WARNINGS
  return any warnings found by the Closure Compiler (ie,code after a return statement)

- ERRORS
  return any errors in your javascript code found by the Closure Compiler

- STATISTICS
  return some statistics about the compilation process (original file size, compressed file size, time,etc)

See http://code.google.com/intl/ja/closure/compiler/docs/api-ref.html#output_info for further information.

warning level related

- QUIET

- DEFAULT

- VERBOSE

See http://code.google.com/intl/ja/closure/compiler/docs/api-ref.html#warn for further information.

PACKAGE PROPERTY

TIMEOUT

Set by default to 10s. You can modify it if you need too:

$Javascript::Closure::Timeout=15;

DIAGNOSTICS

croak

Fail to connect to http://closure-compiler.appspot.com/compile:...: The module could not connect and successfully compress your javascript. See the detail error to get a hint.
.... is not in:...: One of the optional parameter received a value that is not expected.

carp

The following url could not be fetched::...: The module could not connect to the url. See the detail error to get a hint.

TODO

optional parameters

none of the following optional parameters are supported:

- use_closure_library
- formatting
- output_file_name
- exclude_default_externs
- externs_url
- js_externs

CONFIGURATION AND ENVIRONMENT

none

DEPENDENCIES

LWP::UserAgent

INCOMPATIBILITIES

none

BUGS AND LIMITATIONS

If you do me the favor to _use_ this module and find a bug, please email me i will try to do my best to fix it (patches welcome)!

AUTHOR

shiriru <shiriru0111[arobas]hotmail.com>

LICENSE AND COPYRIGHT

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

4 POD Errors

The following errors were encountered while parsing the POD:

Around line 179:

You can't have =items (as at line 183) unless the first thing after the =over is an =item

Around line 318:

'=item' outside of any '=over'

Around line 375:

You forgot a '=back' before '=head1'

Around line 437:

'=item' outside of any '=over'

To install Javascript::Closure, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Javascript::Closure

CPAN shell

perl -MCPAN -e shell
install Javascript::Closure

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)

NAME

VERSION

SYNOPSIS

DESCRIPTION

MOTIVATION

ADVANTAGES

SUBROUTINE

minify

CONSTANTS

PACKAGE PROPERTY

TIMEOUT

DIAGNOSTICS

croak

carp

TODO

SEE ALSO

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

AUTHOR

LICENSE AND COPYRIGHT

Module Install Instructions