Introducing Assetic (NYPHP)

Introducing Assetic Asset Management for PHP 5.3 March 1, 2011

@kriswallsmith• Symfony Guru at• Symfony core team member• Doctrine contributor• 10+ years experience with PHP and web development• Open source evangelist and international speaker

OpenSky connects you with innovators,trendsetters and tastemakers.You choose the ones you like and each week they invite you to their private online sales.

ShopOpenSky.com• PHP 5.3 + Symfony2• MongoDB + Doctrine MongoDB ODM• MySQL + Doctrine2 ORM• Less CSS• jQuery

Agenda• !(straw man)• Assetic• Twig, Symfony2 integration

If you haven’t optimized yourfrontend, you haven’t optimized

A poorly optimized frontend can destroy UX

…and SEOhttp://googlewebmastercentral.blogspot.com/2010/04/using-site-speed-in-web-search-ranking.html

Get your assets in line.

Asset Management

Lots of awesome tools:

Lots of awesome tools:• CoffeeScript • Packer• Compass Framework • SASS• CSSEmbed • Sprockets• Google Closure Compiler • Stylus• JSMin • YUI Compressor• LESS

The ones written in PHP…

This is a difﬁcult problem

Assetic makes it easy

Enough talk

# /path/to/web/js/core.php$core = new FileAsset(/path/to/jquery.js);$core->load();header(Content-Type: text/javascript);echo $core->dump();

# /path/to/web/js/core.php$core = new AssetCollection(array( new FileAsset(/path/to/jquery.js), new GlobAsset(/path/to/js/core/*.js),));$core->load();header(Content-Type: text/javascript);echo $core->dump();

# /path/to/web/js/core.php$core = new AssetCollection(array( new FileAsset(/path/to/jquery.js), new GlobAsset(/path/to/js/core/*.js),));$core->load();many ﬁles into one == fewer HTTP requests Mergeheader(Content-Type: text/javascript);echo $core->dump();

# /path/to/web/js/core.php$core = new AssetCollection(array( new FileAsset(/path/to/jquery.js), new GlobAsset(/path/to/js/core/*.js),), array( new YuiCompressorJsFilter(/path/to/yui.jar),));$core->load();header(Content-Type: text/javascript);echo $core->dump();

# /path/to/web/js/core.php$core = new AssetCollection(array( new FileAsset(/path/to/jquery.js), new GlobAsset(/path/to/js/core/*.js),), array( new YuiCompressorJsFilter(/path/to/yui.jar),));$core->load(); Compress the merged asset == less data over the wireheader(Content-Type: text/javascript);echo $core->dump();

Assetic isAssets & Filters

Inspired by Python’s webassets https://github.com/miracle2k/webassets

Assets have lazy, mutable content

Filters act on asset contents during “load” and “dump”

Assets can be gathered in collections

A collection is an asset

FilterAsset

FilterFilterAsset

Load Filter Filter Asset

FilterFilterAsset Dump

FilterFilterAsset

Asset CollectionFilter FilterFilter FilterAsset Asset

Asset Collection Filter Filter Asset Collection AssetFilter FilterFilter FilterAsset Asset Filter Filter Asset

# /path/to/web/css/styles.php$styles = new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter()));header(Content-Type: text/css);echo $styles->dump();

# /path/to/web/css/styles.php$styles = new AssetCollection(array( new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter()) ), new FileAsset(/path/to/more.css),));header(Content-Type: text/css);echo $styles->dump();

# /path/to/web/css/styles.php$styles = new AssetCollection(array( new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter()) ), new FileAsset(/path/to/more.css),), array( new YuiCompressorCss(/path/to/yui.jar),));header(Content-Type: text/css);echo $styles->dump();

# /path/to/web/css/styles.php$styles = new AssetCollection(array( new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter()) ), new FileAsset(/path/to/more.css),), array( new YuiCompressorCss(/path/to/yui.jar),)); Lazy! The ﬁlesystem isnt touched until nowheader(Content-Type: text/css);echo $styles->dump();

Basic Asset Classes• AssetCollection• AssetReference• FileAsset• GlobAsset• StringAsset

Core Filter Classes• CallablesFilter • SassScssFilter• CoffeeScriptFilter • SprocketsFilter• CssRewriteFilter • StylusFilter• GoogleClosureCompilerApiFilter • YuiCssCompressorFilter• GoogleClosureCompilerJarFilter • YuiJsCompressorFilter• LessFilter • More to come…• SassSassFilter

Asset Manager

$am = new AssetManager();$am->set(jquery, new FileAsset(/path/to/jquery.js));

$plugin = new AssetCollection(array( new AssetReference($am, jquery), new FileAsset(/path/to/jquery.plugin.js),));

$core = new AssetCollection(array( $jquery, $plugin1, $plugin2,));header(text/javascript);echo $core->dump();

jQuery will only be included once $core = new AssetCollection(array( $jquery, $plugin1, $plugin2, )); header(text/javascript); echo $core->dump();

Filter Manager

$yui = new YuiCompressorJs();$yui->setNomunge(true);$fm = new FilterManager();$fm->set(yui_js, $yui);

$jquery = new FileAsset(/path/to/core.js);$jquery->ensureFilter($fm->get(yui_js));$core = new AssetCollection(array( $jquery, new GlobAsset(/path/to/js/core/*.js),));$core->ensureFilter($fm->get(yui_js));

jQuery will only be compressed once $jquery = new FileAsset(/path/to/core.js); $jquery->ensureFilter($fm->get(yui_js)); $core = new AssetCollection(array( $jquery, new GlobAsset(/path/to/js/core/*.js), )); $core->ensureFilter($fm->get(yui_js));

Asset Factory

# /path/to/asset_factory.php$fm = new FilterManager();$fm->set(coffee, new CoffeeScriptFilter());$fm->set(closure, new GoogleClosureCompilerApi());$factory = new AssetFactory(/path/to/web);$factory->setFilterManager($fm);

include /path/to/asset_factory.php;$asset = $factory->createAsset( array(js/src/*.coffee), array(coffee, closure));header(Content-Type: text/javascript);echo $asset->dump();

Debug Mode

Debugging compressed Javascript sucks

Mark ﬁlters for omissionin debug mode using a “?”

// new AssetFactory(/path/to/web, true);include /path/to/asset_factory.php;$asset = $factory->createAsset( array(js/src/*.coffee), array(coffee, closure));header(Content-Type: text/javascript);echo $asset->dump();

// new AssetFactory(/path/to/web, true);include /path/to/asset_factory.php;$asset = $factory->createAsset( array(js/src/*.coffee), array(coffee, ?closure));header(Content-Type: text/javascript);echo $asset->dump();

// new AssetFactory(/path/to/web, false);include /path/to/asset_factory.php;$asset = $factory->createAsset( array(js/src/*.coffee), array(coffee, ?closure), array(debug => true));header(Content-Type: text/javascript);echo $asset->dump();

Factory Workers

Everything passes through the workers’ hands

$worker = new EnsureFilterWorker( /.css$/, // the output pattern $fm->get(yui_css) // the filter);$factory = new AssetFactory(/path/to/web);$factory->addWorker($worker);// compressed$factory->createAsset(css/sass/*, sass, array( output => css/*.css,));

Good: Basic Caching

# /path/to/web/css/styles.php$styles = new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter()));echo $styles->dump();

# /path/to/web/css/styles.php$styles = new AssetCache(new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter())), new FilesystemCache(/path/to/cache));echo $styles->dump();

# /path/to/web/css/styles.php$styles = new AssetCache(new AssetCollection( array(new FileAsset(/path/to/main.sass)), array(new SassFilter())), new FilesystemCache(/path/to/cache)); Run the ﬁlters once and cache the contentecho $styles->dump();

Better: HTTP Caching

// $core = new AssetCache(...$mtime = gmdate(D, d M y H:i:s, $core->getLastModified()). GMT;if ($mtime == $_SERVER[HTTP_IF_MODIFIED_SINCE]) { header(HTTP/1.0 304 Not Modified); exit();}header(Content-Type: text/javascript);header(Last-Modified: .$mtime);echo $core->dump();

Best: Static Assets

# /path/to/scripts/dump_assets.php$am = new AssetManager();$am->set(foo, $foo);// etc...$writer = new AssetWriter(/path/to/web);$writer->writeManagerAssets($am);

Best-est:Content Distribution Network

new AssetWriter(s3://my-bucket)

new AssetWriter(s3://my-bucket) A CloudFront S3 bucket

Not Lazy Enough?

Asset Formulae and the Lazy Asset Manager

$asset = $factory->createAsset( array(js/src/*.coffee), array(coffee, ?closure), array(output => js/*.js));

$formula = array( array(js/src/*.coffee), array(coffee, ?closure), array(output => js/*.js));

$am = new LazyAssetManager($factory);$am->setFormula(core_js, $formula);header(Content-Type: text/javascript);echo $am->get(core_js)->dump();

This will make more sense in a few minutes…

Thought…Assets are a part of the view layer and should be deﬁned there.

<?php foreach (assetic_javascripts( array(js/core.js, js/more.js), array(?yui_js)) as $url): ?><script src="<?php echo $url ?>"></script><?php endforeach; ?>

# config/assetic.phprequire_once /path/to/assetic/functions.php;assetic_init($factory);

Issue…Assets deﬁned in the view layermust actually exist somewhere

Option Bad...Lazily dump assets to the web directory

Option Good…Eagerly dump assets to the web directory

Formula Loaders

$loader = new FunctionCallsFormulaLoader();$resource = new DirectoryResource( /path/to/templates, /.php$/);$formulae = $loader->load($resource);

$am = new LazyAssetManager($factory);$am->setLoader(php, $loader);$am->addResource($resource, php);$writer = new AssetWriter(/path/to/web);$writer->writeManagerAssets($am);

$am = new LazyAssetManager($factory);$am->setLoader(php, $loader);$am->addResource($resource, php); Expensive every time$writer = new AssetWriter(/path/to/web);$writer->writeManagerAssets($am);

$cache = new ConfigCache(/path/to/cache);$loader = new CachedFormulaLoader( $loader, $cache, $debug);

Twig Integration

$twig->addExtension(new AsseticExtension($factory));

{% assetic js/*.coffee, filter=coffee %}<script src="{{ asset_url }}"></script>{% endassetic %}

{% assetic js/*.coffee, filter=coffee %}<script src="{{ asset_url }}"></script>{% endassetic %}

{% assetic js/*.coffee, filter=coffee, output=js/*.js %}<script src="{{ asset_url }}"></script>{% endassetic %}

{% assetic js/*.coffee, filter=coffee, output=js/*.js %}<script src="{{ asset_url }}"></script>{% endassetic %}

{% assetic js/*.coffee, filter=coffee,?closure, output=js/*.js, name=core_js %}<script src="{{ asset_url }}"></script>{% endassetic %}

AsseticBundle Symfony2 integration

{% assetic filter=scss,?yui_css, output=css/all.css, @MainBundle/Resources/sass/main.scss, @AnotherBundle/Resources/sass/more.scss %}<link href="{{ asset_url }}" rel="stylesheet" />{% endassetic %}

{% assetic filter=scss,?yui_css, output=css/all.css, @MainBundle/Resources/sass/main.scss, debug=true, @AnotherBundle/Resources/sass/more.scss %}<link href="{{ asset_url }}" rel="stylesheet" />{% endassetic %}

Each "leaf" asset is referenced individually<link href="css/all_part1.css" rel="stylesheet" /><link href="css/all_part2.css" rel="stylesheet" />

Conﬁguration

assetic: debug: %kernel.debug% use_controller: %kernel.debug% read_from: %kernel.root_dir%/../web write_to: s3://mybucket

{# when use_controller=true #}<script src="{{ path(assetic_foo) }}"...

# routing_dev.yml_assetic: resource: . type: assetic

{# when use_controller=false #}<script src="{{ asset(js/core.js) }}"></script>

{# when use_controller=false #}<script src="{{ asset(js/core.js) }}"></script> Lots for free

The Symfony2 Assets Helper• Multiple asset domains• Cache buster

framework: templating: assets_version: 1.2.3 assets_base_urls: - http://assets1.domain.com - http://assets2.domain.com - http://assets3.domain.com - http://assets4.domain.com

assetic:dump

$ php app/console assetic:dump web/

$ php app/console assetic:dump s3://my-bucket

assetic:dump --watch Dump static assets in the background as you develop

Questions?http://github.com/kriswallsmith/assetic

http://blog.candycane.jp	1208
http://linyo.ws	15
http://webcache.googleusercontent.com	5
http://www.sfexception.com	2

Introducing Assetic (NYPHP)

by Kris Wallsmith

Accessibility

Categories

Upload Details

Usage Rights

4 Embeds 1,230

Statistics

Introducing Assetic (NYPHP) Presentation Transcript