From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

PERLER / Catalyst-View-JavaScript-0.995 / lib / Catalyst / View / JavaScript.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
—
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

              
package Catalyst::View::JavaScript;
our $VERSION = '0.995';
use warnings;
use strict;
use MRO::Compat;
use Carp;
use utf8;
use JavaScript::Minifier::XS qw(minify);
use base qw|Catalyst::View|;
__PACKAGE__->mk_accessors(
    qw(compress disable_if_debug stash key output _cache copyright));
sub new {
    my $self = shift->next::method(@_);
    my ( $c, $arguments ) = @_;
    my %config = (
        compress         => 1,
        stash            => 1,
        key              => "js",
        disable_if_debug => 1,
        %$arguments
    );
    for my $field ( keys %config ) {
        next if $field =~ /^catalyst/;
        if ( $self->can($field) ) {
            $self->$field( $config{$field} );
        }
        else {
            $c->log->warn("Unknown config parameter '$field'");
        }
    }
    return $self;
}
sub cache {
    my $self = shift;
    $self->_cache(@_);
    return $self;
}
sub process {
    my ( $self, $c ) = @_;
    my $data   = '';
    my $cached = 0;
    if ( $self->disable_if_debug && $c->debug ) {
        $self->_cache('');
        $self->compress(0);
    }
    if (   $self->_cache
        && $c->can('cache')
        && ( $data = $c->cache->get( $self->_cache ) ) )
    {
        $cached = 1;
    }
    elsif ( $self->output ) {
        $data = $c->res->output;
    }
    elsif ( $self->stash && $self->key ) {
        $data = $c->stash->{ $self->key };
    }
    unless ($cached) {
        $data = minify($data) if ( $self->compress );
        $data = "/* " . $self->copyright . " */\n" . $data
          if ( $self->copyright );
    }
    $c->res->content_type("text/javascript");
    $c->res->output($data);
    $c->cache->set( $self->_cache, $data )
      if ( $self->_cache && $c->can('cache') );
}
1;
__END__
=head1 NAME
Catalyst::View::JavaScript - Cache and/or compress JavaScript output
=head1 VERSION
version 0.995
=head1 SYNOPSIS
This module fetches JavaScript either from the stash or from C<< $c->output >>. 
By default the JavaScript code is read from C<< $c->stash->{js} >> and compressed.
The content type is set to C<text/javascript>.
B<By default this view will not compress and/or cache if your application is in the debug mode.>
=head1 METHODS
=head2 cache
If C<$c> is able to cache (i. e. C<< if $c->can('cache') >>) the value of C<cache> is used as key to cache the JavaScript output.
This method returns the view so you can invoke it like this:
  $c->detach( $c->view('JavaScript')->cache('unique-cache-key') );
=head2 compress
Set this to a true value to enable compression of the code. See L<JavaScript::Minifier::XS> for more information on how this minification works. Defaults to 1.
=head2 copyright
This string will be displayed on the top of the output enclosed in a commentary tag.
=head2 disable_if_debug
If you set the debug flag on your application caching and compressing is disabled. Defaults to 1.
=head2 output
If this is set to a true value this module fetches the JavaScript code from C<< $c->output >> and ignores the value of L</stash>. Defaults to 0.
=head2 key
This module looks in the stash for this value for JavaScript if L</stash> is enabled. Defaults to C<js>.
=head2 stash
Set this to a true value if the JavaScript code is on the stash. Set the stash value with L</key>. Defaults to C<1>.
=head1 AUTHOR
Moritz Onken, C<< <onken at netcubed.de> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-catalyst-view-javascript at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-View-JavaScript>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 COPYRIGHT & LICENSE
Copyright 2009 Moritz Onken, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut