File: README

package info (click to toggle)
libmojolicious-plugin-assetpack-perl 1.39-1
  • links: PTS
  • area: main
  • in suites:
  • size: 1,808 kB
  • ctags: 126
  • sloc: perl: 1,387; makefile: 2; sh: 2
file content (254 lines) | stat: -rw-r--r-- 7,573 bytes parent folder | download
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
NAME
    Mojolicious::Plugin::AssetPack - Compress and convert css, less, sass,
    javascript and coffeescript files

VERSION
    1.39

SYNOPSIS
  Application
      use Mojolicious::Lite;

      # Load plugin and pipes in the right order
      plugin AssetPack => {
        pipes => [qw(Less Sass Css CoffeeScript Riotjs JavaScript Combine)]
      };

      # define asset
      app->asset->process(
        # virtual name of the asset
        "app.css" => (

          # source files used to create the asset
          "sass/bar.scss",
          "https://github.com/Dogfalo/materialize/blob/master/sass/materialize.scss",
        )
      );

  Template
      <html>
        <head>
          %= asset "app.css"
        </head>
        <body><%= content %></body>
      </html>

FOR EXISTING USERS
    Are you already using AssetPack? You can still do so without any change.
    This new version was written to make it easier to maintain and also
    easier to extend. The new code will be "activated" by loadind this
    plugin with a list of pipes:

      $app->plugin(AssetPack => {pipes => [...]});

    The old API require Mojolicious::Plugin::AssetPack::Backcompat to be
    installed.

DESCRIPTION
    Mojolicious::Plugin::AssetPack is Mojolicious plugin for processing
    static assets. The idea is that JavaScript and CSS files should be
    served as one minified file to save bandwidth and roundtrip time to the
    server.

    There are many external tools for doing this, but integrating them with
    Mojolicious can be a struggle: You want to serve the source files
    directly while developing, but a minified version in production. This
    assetpack plugin will handle all of that automatically for you.

    The actual processing is delegated to "pipe objects". Please see "Pipes"
    in Mojolicious::Plugin::AssetPack::Guides::Tutorial for a complete list.

GUIDES
    * Mojolicious::Plugin::AssetPack::Guides::Tutorial

      The tutorial will give an introduction to how AssetPack can be used.

    * Mojolicious::Plugin::AssetPack::Guides::Cookbook

      The cookbook has various receipes on how to cook with AssetPack.

ENVIRONMENT
    It is possible to set environment variables to change the behavior of
    AssetPack:

    * MOJO_ASSETPACK_DEBUG

      Set this environment variable to get more debug to STDERR. Currently
      you can set it to a value between 0 and 3, where 3 provides the most
      debug.

    * MOJO_ASSETPACK_LAZY

      Set this environment variable if you want to delay processing the
      assets until they are requested. This can be very useful while
      developing when the assets are changed frequently.

OPTIONAL MODULES
    There are some optional modules you might want to install:

    * CSS::Minifier::XS

      Used by Mojolicious::Plugin::AssetPack::Pipe::Css.

    * CSS::Sass

      Used by Mojolicious::Plugin::AssetPack::Pipe::Sass.

    * IO::Socket::SSL

      Required if you want to download assets served over SSL.

    * JavaScript::Minifier::XS

      Used by Mojolicious::Plugin::AssetPack::Pipe::JavaScript.

HELPERS
  asset
      $self = $app->asset;
      $self = $c->asset;
      $bytestream = $c->asset($topic, @args);
      $bytestream = $c->asset("app.css", media => "print");

    "asset()" is the main entry point to this plugin. It can either be used
    to access the Mojolicious::Plugin::AssetPack instance or as a tag
    helper.

    The helper name "asset" can be customized by specifying "helper" when
    registering the plugin.

    See Mojolicious::Plugin::AssetPack::Guides::Tutorial for more details.

ATTRIBUTES
  minify
      $bool = $self->minify;
      $self = $self->minify($bool);

    Set this to true to combine and minify the assets. Defaults to false if
    "mode" in Mojolicious is "development" and true otherwise.

    See "Application mode" in
    Mojolicious::Plugin::AssetPack::Guides::Tutorial for more details.

  route
      $route = $self->route;
      $self = $self->route($route);

    A Mojolicious::Routes::Route object used to serve assets. The default
    route responds to HEAD and GET requests and calls serve_asset() on
    "store" to serve the asset.

    The default route will be built and added to the application when
    "process" is called the first time.

    See "ASSETS FROM CUSTOM DOMAIN" in
    Mojolicious::Plugin::AssetPack::Guides::Cookbook for an example on how
    to customize this route.

  store
      $obj = $self->store;
      $self = $self->store(Mojolicious::Plugin::AssetPack::Store->new);

    Holds a Mojolicious::Plugin::AssetPack::Store object used to locate,
    store and serve assets.

  tag_for
      $self = $self->tag_for(sub { my ($asset, $c, \%args, @attrs) = @_; });
      $code = $self->tag_for;

    Holds a sub reference that returns a Mojo::Bytestream object containing
    the markup required to render an asset.

    $asset is a Mojolicious::Plugin::AssetPack::Asset object, $c is an
    Mojolicious::Controller object and @attrs can contain a list of HTML
    attributes. %args currently contains:

    *   base_url

        See "ASSETS FROM CUSTOM DOMAIN" in
        Mojolicious::Plugin::AssetPack::Guides::Cookbook.

    *   topic

        Name of the current topic.

  ua
      $ua = $self->ua;

    Holds a Mojo::UserAgent which can be used to fetch assets either from
    local application or from remote web servers.

METHODS
  pipe
      $obj = $self->pipe($name);
      $obj = $self->pipe("Css");

    Will return a registered pipe by $name or "undef" if none could be
    found.

  process
      $self = $self->process($topic => @assets);
      $self = $self->process($definition_file);

    Used to process assets. A $definition_file can be used to define $topic
    and @assets in a seperate file. See "Process assets" in
    Mojolicious::Plugin::AssetPack::Guides::Tutorial for more details.

    $definition_file defaults to "assetpack.def".

  processed
      $collection = $self->processed($topic);

    Can be used to retrieve a Mojo::Collection object, with zero or more
    Mojolicious::Plugin::AssetPack::Asset objects. Returns undef if $topic
    is not defined with "process".

  register
      $self->register($app, \%config);

    Used to register the plugin in the application. %config can contain:

    * helper

      Name of the helper to add to the application. Default is "asset".

    * pipes

      This argument is mandatory and need to contain a complete list of
      pipes that is needed. Example:

        $app->plugin(AssetPack => {pipes => [qw(Sass Css Combine)]);

      See "Pipes" in Mojolicious::Plugin::AssetPack::Guides::Tutorial for a
      complete list of available pipes.

    * proxy

      A hash of proxy settings. Set this to 0 to disable proxy detection.
      Currently only "no_proxy" is supported, which will set which requests
      that should bypass the proxy (if any proxy is detected). Default is to
      bypass all requests to localhost.

      See "detect" in Mojo::UserAgent::Proxy for more infomation.

SEE ALSO
    "GUIDES", Mojolicious::Plugin::AssetPack::Asset,
    Mojolicious::Plugin::AssetPack::Pipe and
    Mojolicious::Plugin::AssetPack::Store.

COPYRIGHT AND LICENSE
    Copyright (C) 2014, Jan Henning Thorsen

    This program is free software, you can redistribute it and/or modify it
    under the terms of the Artistic License version 2.0.

AUTHOR
    Jan Henning Thorsen - "jhthorsen@cpan.org"

    Alexander Rymasheusky

    Mark Grimes - "mgrimes@cpan.org"

    Per Edin - "info@peredin.com"

    Viktor Turskyi