Merge pull request #1048 from Automattic/add/css-tree-shaking

Add runtime CSS minification, !important replacement, and tree shaking

.travis.yml

@@ -39,6 +39,7 @@ matrix:
      env: WP_VERSION=trunk
 
 install:
+  - if [[ $DEV_LIB_SKIP =~ composer ]]; then composer install --no-dev; fi
   - nvm install 6 && nvm use 6
   - export DEV_LIB_PATH=dev-lib
   - source $DEV_LIB_PATH/travis.install.sh

Gruntfile.js

@@ -84,15 +84,21 @@ module.exports = function( grunt ) {
 				args: [ 'ls-files' ]
 			},
 			function( err, res ) {
+				var paths;
 				if ( err ) {
 					throw new Error( err.message );
 				}
 
+				paths = res.stdout.trim().split( /\n/ ).filter( function( file ) {
+					return ! /^(\.|bin|([^/]+)+\.(md|json|xml)|Gruntfile\.js|tests|wp-assets|dev-lib|readme\.md|composer\..*)/.test( file );
+				} );
+				paths.push( 'vendor/autoload.php' );
+				paths.push( 'vendor/composer/**' );
+				paths.push( 'vendor/sabberworm/php-css-parser/lib/**' );
+
 				grunt.config.set( 'copy', {
 					build: {
-						src: res.stdout.trim().split( /\n/ ).filter( function( file ) {
-							return ! /^(\.|bin|([^/]+)+\.(md|json|xml)|Gruntfile\.js|tests|wp-assets|dev-lib|readme\.md|composer\..*)/.test( file );
-						} ),
+						src: paths,
 						dest: 'build',
 						expand: true
 					}

amp.php

@@ -21,15 +21,32 @@
 function _amp_print_php_version_admin_notice() {
 	?>
 	<div class="notice notice-error">
-			<p><?php esc_html_e( 'The AMP plugin requires PHP 5.3+. Please contact your host to update your PHP version.', 'amp' ); ?></p>
-		</div>
+		<p><?php esc_html_e( 'The AMP plugin requires PHP 5.3+. Please contact your host to update your PHP version.', 'amp' ); ?></p>
+	</div>
 	<?php
 }
-if ( version_compare( phpversion(), '5.3', '<' ) ) {
+if ( version_compare( phpversion(), '5.3.2', '<' ) ) {
 	add_action( 'admin_notices', '_amp_print_php_version_admin_notice' );
 	return;
 }
 
+/**
+ * Print admin notice when composer install has not been performed.
+ *
+ * @since 1.0
+ */
+function _amp_print_composer_install_admin_notice() {
+	?>
+	<div class="notice notice-error">
+		<p><?php esc_html_e( 'You appear to be running the AMP plugin from source. Please do `composer install` to finish installation.', 'amp' ); ?></p>
+	</div>
+	<?php
+}
+if ( ! file_exists( __DIR__ . '/vendor/autoload.php' ) || ! file_exists( __DIR__ . '/vendor/sabberworm/php-css-parser' ) ) {
+	add_action( 'admin_notices', '_amp_print_composer_install_admin_notice' );
+	return;
+}
+
 define( 'AMP__FILE__', __FILE__ );
 define( 'AMP__DIR__', dirname( __FILE__ ) );
 define( 'AMP__VERSION', '1.0-alpha' );
@@ -42,6 +59,12 @@ function _amp_print_php_version_admin_notice() {
 require_once AMP__DIR__ . '/includes/admin/functions.php';
 
 register_activation_hook( __FILE__, 'amp_activate' );
+
+/**
+ * Handle activation of plugin.
+ *
+ * @since 0.2
+ */
 function amp_activate() {
 	amp_after_setup_theme();
 	if ( ! did_action( 'amp_init' ) ) {
@@ -51,8 +74,14 @@ function amp_activate() {
 }
 
 register_deactivation_hook( __FILE__, 'amp_deactivate' );
+
+/**
+ * Handle deactivation of plugin.
+ *
+ * @since 0.2
+ */
 function amp_deactivate() {
-	// We need to manually remove the amp endpoint
+	// We need to manually remove the amp endpoint.
 	global $wp_rewrite;
 	foreach ( $wp_rewrite->endpoints as $index => $endpoint ) {
 		if ( amp_get_slug() === $endpoint[1] ) {
@@ -130,8 +159,16 @@ function amp_init() {
 	add_action( 'wp', 'amp_maybe_add_actions' );
 }
 
-// Make sure the `amp` query var has an explicit value.
-// Avoids issues when filtering the deprecated `query_string` hook.
+/**
+ * Make sure the `amp` query var has an explicit value.
+ *
+ * This avoids issues when filtering the deprecated `query_string` hook.
+ *
+ * @since 0.3.3
+ *
+ * @param array $query_vars Query vars.
+ * @return array Query vars.
+ */
 function amp_force_query_var_value( $query_vars ) {
 	if ( isset( $query_vars[ amp_get_slug() ] ) && '' === $query_vars[ amp_get_slug() ] ) {
 		$query_vars[ amp_get_slug() ] = 1;
@@ -250,20 +287,41 @@ function amp_is_canonical() {
 	return false;
 }
 
+/**
+ * Load classes.
+ *
+ * @since 0.2
+ * @deprecated As of 0.6 since autoloading is now employed.
+ */
 function amp_load_classes() {
 	_deprecated_function( __FUNCTION__, '0.6' );
 }
 
+/**
+ * Add frontend actions.
+ *
+ * @since 0.2
+ */
 function amp_add_frontend_actions() {
 	require_once AMP__DIR__ . '/includes/amp-frontend-actions.php';
 }
 
+/**
+ * Add post template actions.
+ *
+ * @since 0.2
+ */
 function amp_add_post_template_actions() {
 	require_once AMP__DIR__ . '/includes/amp-post-template-actions.php';
 	require_once AMP__DIR__ . '/includes/amp-post-template-functions.php';
 	amp_post_template_init_hooks();
 }
 
+/**
+ * Add action to do post template rendering at template_redirect action.
+ *
+ * @since 0.2
+ */
 function amp_prepare_render() {
 	add_action( 'template_redirect', 'amp_render' );
 }

bin/amphtml-update.py

@@ -356,12 +356,37 @@ def GetTagSpec(tag_spec, attr_lists):
 		for (field_descriptor, field_value) in tag_spec.cdata.ListFields():
 			if isinstance(field_value, (unicode, str, bool, int)):
 				cdata_dict[ field_descriptor.name ] = field_value
-			else:
-				if hasattr( field_value, '_values' ):
-					cdata_dict[ field_descriptor.name ] = {}
-					for _value in field_value._values:
-						for (key,val) in _value.ListFields():
-							cdata_dict[ field_descriptor.name ][ key.name ] = val
+			elif hasattr( field_value, '_values' ):
+				cdata_dict[ field_descriptor.name ] = {}
+				for _value in field_value._values:
+					for (key,val) in _value.ListFields():
+						cdata_dict[ field_descriptor.name ][ key.name ] = val
+			elif 'css_spec' == field_descriptor.name:
+				css_spec = {}
+
+				css_spec['allowed_at_rules'] = []
+				for at_rule_spec in field_value.at_rule_spec:
+					if '$DEFAULT' == at_rule_spec.name:
+						continue
+					css_spec['allowed_at_rules'].append( at_rule_spec.name )
+
+				for css_spec_field_name in ( 'allowed_declarations', 'font_url_spec', 'image_url_spec', 'validate_keyframes' ):
+					if not hasattr( field_value, css_spec_field_name ):
+						continue
+					css_spec_field_value = getattr( field_value, css_spec_field_name )
+					if isinstance(css_spec_field_value, (list, collections.Sequence, google.protobuf.internal.containers.RepeatedScalarFieldContainer)):
+						css_spec[ css_spec_field_name ] = [ val for val in css_spec_field_value ]
+					elif hasattr( css_spec_field_value, 'ListFields' ):
+						css_spec[ css_spec_field_name ] = {}
+						for (css_spec_field_item_descriptor, css_spec_field_item_value) in getattr( field_value, css_spec_field_name ).ListFields():
+							if isinstance(css_spec_field_item_value, (list, collections.Sequence, google.protobuf.internal.containers.RepeatedScalarFieldContainer)):
+								css_spec[ css_spec_field_name ][ css_spec_field_item_descriptor.name ] = [ val for val in css_spec_field_item_value ]
+							else:
+								css_spec[ css_spec_field_name ][ css_spec_field_item_descriptor.name ] = css_spec_field_item_value
+					else:
+						css_spec[ css_spec_field_name ] = css_spec_field_value
+
+				cdata_dict['css_spec'] = css_spec
 		if len( cdata_dict ) > 0:
 			tag_spec_dict['cdata'] = cdata_dict
 

composer.json

@@ -5,6 +5,15 @@
     "type": "wordpress-plugin",
     "license": "GPL-2.0",
     "version": "1.0.0",
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/xwp/PHP-CSS-Parser"
+        }
+    ],
+    "require": {
+        "sabberworm/php-css-parser": "dev-master"
+    },
     "require-dev": {
         "wp-coding-standards/wpcs": "^0.14.0",
         "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4",

contributing.md

@@ -2,11 +2,22 @@
 
 Thanks for taking the time to contribute!
 
-To clone this repository
-``` bash
-$ git clone --recursive [email protected]:Automattic/amp-wp.git
+To start, clone this repository into your WordPress install being used for development:
+
+```bash
+cd wp-content/plugins && git clone --recursive [email protected]:Automattic/amp-wp.git amp
 ```
 
+If you happened to have cloned without `--recursive` previously, please do `git submodule update --init` to ensure the [dev-lib](https://github.com/xwp/wp-dev-lib/) submodule is available for development.
+
+Lastly, to get the plugin running in your WordPress install, run `composer install` and then activate the plugin via the WordPress dashboard or `wp plugin activate amp`.
+
+To install the `pre-commit` hook, do `bash dev-lib/install-pre-commit-hook.sh`.
+
+Note that pull requests will be checked against [WordPress-Coding-Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) with PHPCS, and for JavaScript linting is done with ESLint and (for now) JSCS and JSHint.
+
+To run the Grunt commands, please first `npm install -g grunt-cli` and then `npm install`.
+
 ## Updating Allowed Tags And Attributes
 
 The file `class-amp-allowed-tags-generated.php` has the AMP specification's allowed tags and attributes. It's used in sanitization.
@@ -72,6 +83,7 @@ When you push a commit to your PR, Travis CI will run the PHPUnit tests and snif
 
 Contributors who want to make a new release, follow these steps:
 
+0. Do `grunt build` and install the `amp.zip` onto a normal WordPress install running a stable release build; do smoke test to ensure it works.
 1. Bump plugin versions in `package.json` (×1), `package-lock.json` (×1, just do `npm install` first), `composer.json` (×1), and in `amp.php` (×2: the metadata block in the header and also the `AMP__VERSION` constant).
 2. Add changelog entry to readme.
 3. Merge release branch into `master`.