Added autoloader to reduce complexity; fix phpcs issues #828

mikeschinkel · 2017-12-08T07:41:34Z

@westonruter As I started working on a refactoring as per here I found myself struggling with the complexity of all the classes and making sure they were all loaded in the correct order. So I went out on a limb and implemented a simple, fast classmap autoloader and removed all the now-unnecessary require_once() calls throughout the plugin. I am really hoping you will see this as a plus and accept it, and then I can move forward with the next step of refactor as in the issue above.

While I was at it PhpStorm pointed out several errors and oversights and I created an individual commit for each of those, but the first commit has everything needed for and related to the autoloader.

…_load_classes() and amp_load_fasterimage_classes(), created /include/templates/ directory for template-related classes, and Options Manager out of the views subdirectory.

…) does not accept a 2nd parameter.

westonruter

@mikeschinkel Thanks, I think this makes sense. A few changes needed before merging.

westonruter · 2017-12-08T16:16:42Z

.gitmodules

-[submodule "dev-lib"]
-	path = dev-lib
-	url = https://github.com/xwp/wp-dev-lib.git
-	branch = master


This file needs to be restored.

I deleted it because it was blocking my ability to commit and I thought my pull request would not have included the deletion. I am not exactly sure what I was doing wrong or how to fix it (I gave up on submodules long ago as I always had issues with them.)

Is there any chance that you can accept the pull request after I fix everything else, and then restore manually?

The lack of the submodule is causing Travis CI to fail: https://travis-ci.org/Automattic/amp-wp/jobs/313361694#L186

So it needs to be restored before we merge the PR so that the automated tests and checks can be performed.

What is the error you're having?

Let me see if I can figure it out.

I was using SourceTree to allow me to make partial commits of files and it said I needed the submodule but was locked in the dialog and would not let me exit. When I deleted the file SourceTree recognized the change and immediately commit my changes.

I will try reverting this commit and see if I can get things to work from the command line. If I have an issue I will let you know otherwise I will resolve it and we can just move forward.

westonruter · 2017-12-08T16:19:36Z

autoloader.php

+	 *
+	 * @return AMP_Autoloader
+	 */
+	public static function instance() {


There aren't any singletons in this plugin, so I think static methods should be used instead for consistency.

Funny, I debated using static but assumed you'd prefer instances. :-)

Normally I'd prefer non-singleton instances, but given most classes are just being used as namespaces with static methods, using static here again seems to be most in keeping with everything else.

Updated to use static methods.

westonruter · 2017-12-08T16:19:52Z

autoloader.php

+	public static function register() {
+		static $registered = false;
+		if ( ! $registered ) {
+			spl_autoload_register( [ static::instance(), '_autoload' ] );


Syntax error in PHP 5.2

5.2? :-o
Fixed.

Yeah. Currently the plugin supports PHP 5.2: https://github.com/Automattic/amp-wp/blob/eeb502b28807c1be80e59937fab6112e406b204b/.travis.yml#L45-L47

westonruter · 2017-12-08T16:20:12Z

autoloader.php

+AMP_Autoloader::register();
+
+
+


Extra linebreaks at end of file.

westonruter · 2017-12-08T16:21:06Z

includes/admin/functions.php

@@ -106,6 +106,11 @@ function amp_add_options_menu() {
 }
 add_action( 'wp_loaded', 'amp_add_options_menu' );

+/**


Missing function description, param description, and return description. We've also been adding @since tags.

I do not understand that function's parameter well enough to fully document so I backed out the partial PHPDoc I had added.

westonruter · 2017-12-08T16:21:16Z

includes/amp-helper-functions.php

@@ -1,5 +1,10 @@
 <?php

+/**


Missing function description, param description, and return description. We've also been adding @since tags.

Your requests to document this caused me to go down the rabbit hole for the past (far too many) hours. Every time I would document something it would cause PhpStorm to flag something else as being "off", so I ended up documented all of the sanitizers.

Note I found a few places that would throw errors, e.g. DOMNode $nodes using methods that are only on DOMElement so I added a variable of logic to ensure errors are not thrown during the normal course of usage when WP_DEBUG is set to true. One such example is I added the following in several places:

if ( ! $node instanceof DOMElement ) { return; }

I hope that was okay...

The node type checks are probably a good idea, as I can see that clearly some of the situations would result in text nodes being used as elements. It looks like some of the instances you added would never result in a non-element being iterated (e.g. $this->dom->getElementsByTagName( self::$tag );) but it doesn't hurt.

westonruter · 2017-12-08T16:21:45Z

includes/sanitizers/class-amp-tag-and-attribute-sanitizer.php

@@ -73,6 +71,9 @@ public function sanitize() {
 		}
 	}

+	/**


Missing function description, param description. We've also been adding @since tags.

Documented.

…re else is using the leading underscore convention for private methods.

…ew-clarity-develop

westonruter · 2017-12-10T06:58:08Z

We kinda opened a can of worms here because now there are many PHPCS violations being reported, because of the various files being touched, and wp-dev-lib will only report PHPCS errors surrounding actual patches. The PHPCS issues need to be fixed at some point anyway, but I don't know if now is the time.

I am noticing, however, one PHPUnit failure that must be fixed:

There was 1 failure:

1) AMP_Iframe_Converter_Test::test__args__placeholder
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'<amp-iframe src="https://example.com/video/132886713" width="500" height="281" sandbox="allow-scripts allow-same-origin" sizes="(min-width: 500px) 500px, 100vw" class="amp-wp-enforced-sizes"><div placeholder="" class="amp-wp-iframe-placeholder"></div></amp-iframe>'
+'<amp-iframe src="https://example.com/video/132886713" width="500" height="281" sandbox="allow-scripts allow-same-origin" sizes="(min-width: 500px) 500px, 100vw" class="amp-wp-enforced-sizes"><div placeholder="" class="amp-wp-enforced-sizes" src="https://example.com/video/132886713" width="500" height="281" sandbox="allow-scripts allow-same-origin" sizes="(min-width: 500px) 500px, 100vw"></div></amp-iframe>'

.../amp/tests/test-amp-iframe-sanitizer.php:167

mikeschinkel · 2017-12-10T22:14:47Z

@westonruter I have been trying to recreate a local PHPUnit setup to run the tests locally and while I've gotten past numerous issues I've found a roadblock on this error message:

"Unable to locate wordpress-tests-lib"

It appears to be requiring an includes/functions.php if it can find the appropriate directory but I don't know what functions.php is suppose to contain.

Google is failing me to find the right solution to this. I'm sure I could power through it given enough time but I am hoping you can make me more productive and help me know how to solve this one.

Help?

westonruter · 2017-12-10T22:26:21Z

@mikeschinkel Yeah, there's a couple options here.

For one, you can add the following to your .bash_profile:

export WP_TESTS_DIR=~/path/to/wordpress-develop/tests/phpunit/

That assumes you have a fully up-and-running wordpress-develop core unit tests on the machine.

Otherwise, you can just run the unit tests inside of VVV. You can see that it has this out of the box: https://github.com/Varying-Vagrant-Vagrants/VVV/blob/5b4ee4b/config/bash_profile#L29-L33

mikeschinkel · 2017-12-11T00:28:45Z

@westonruter Thanks. That got me past that roadblock.

However the next roadblock is trying to use either PHPUnit 4.8 or 5.7. With PHPUnit 4.8.9 and PHP 5.3 I get failures at:

Parse error: syntax error, unexpected '[' in /.../plugins/amp-wp/vendor/doctrine/instantiator/src/Doctrine/Instantiator/Instantiator.php on line 45

Clearly I have a later version of doctrine/instantiator but since my composer.json does not reference it directly I have no clue how to correct this.

With PHPUnit 5.7.9 and PHP 5.6 I get failures at:

PHP Warning: Unsupported declare 'strict_types' in /.../plugins/amp-wp/vendor/sebastian/global-state/src/Snapshot.php on line 11

When I switch to PHPUnit 6.5.4 and PHP 7.0.17 I can get tests to run, but there are more than one tests failed. Should I work through all the failures using PHP 7.x?

mikeschinkel · 2017-12-11T02:10:22Z

@westonruter Good news! I was about to get all 501 tests to pass, at least with PHPUnit 6.5.4 and PHP 7.0. I'll have a commit very soon.

…breaking unit tests.)

westonruter · 2017-12-11T04:58:48Z

In order to get testing working I needed to add a composer.json. Any reason for me not to include that in the PR?

By did you need to add Composer to get it to work? In any case, it makes sense to include. I think it could look like https://github.com/WordPress/better-code-editing/blob/master/composer.json

…ia raw $dom->saveXML().

mikeschinkel · 2017-12-11T05:11:04Z

@westonruter Yes, because I was trying to use PhpStorm to run the tests (as it provides such a nice interface) and for some reason PhpStorm would not recognize the .phar; it would only recognize when I pointed to the Composer-generated autoload.php.

I added one without "dist" — for obvious reasons — and I omitted a version number because I have found adding one makes it difficult for the person wanting to use a specific version when the Git tag does not exactly match the version in the composer.json file; kind of a "man with two watches" problem.

…e() in AMP_DOM_Utils.

…g tests work correctly.

…yet and thus is causing the build to fail.

… build. (Methinks we would need to update the composer.json file for each Travis build to support the proper version of PHP?)

… build as is.

mikeschinkel · 2017-12-11T07:06:44Z

@westonruter Finally! What a rabbit hole that was. :-)

Let me know if you have an issues otherwise I will start working on how to implement a full theme in AMP and run the ideas by you either in issue #827 or via a new pull request.

… in autoloader

westonruter · 2017-12-11T19:38:30Z

includes/sanitizers/class-amp-style-sanitizer.php

 	public function get_styles() {
+		if ( ! $this->did_convert_elements ) {


Why this if $this->styles is already an array()?

Consistency. But to your point I guess it is not needed.

mikeschinkel · 2017-12-11T21:18:07Z

Woohoo! :-D

…ns-class-hierarchy" This reverts commit c5237e6, reversing changes made to 41af096. Fixes merge conflicts introduced by #810 and #828.

Issue introduced in #828 via 5c1fa20

mikeschinkel added 7 commits December 8, 2017 02:29

Added classmap autoloader, removed all require_once(), deprecated amp…

8346524

…_load_classes() and amp_load_fasterimage_classes(), created /include/templates/ directory for template-related classes, and Options Manager out of the views subdirectory.

Remove duplicated array index.

5c1fa20

Initialize array that is used by may not have been initialized.

33c0ebf

Removed unused variables.

08bac6b

Removed 2nd parameter to remove_shortcode() because remove_shortcode(…

e5c1a8c

…) does not accept a 2nd parameter.

Added some PHPDoc for methods.

8b267ef

Added PHPDoc so PhpStorm will not flag as an error.

8b34e24

mikeschinkel changed the title ~~Add autoloader to reduce complexity~~ Added autoloader to reduce complexity Dec 8, 2017

westonruter requested changes Dec 8, 2017

View reviewed changes

westonruter and others added 15 commits December 9, 2017 01:58

Add dev-lib

b54243b

Remove partial PHPDoc header.

38cccab

Restructure autoloader to use static methods.

f13c385

Document the sanitizers

03c126b

Documented AMP DOM Utils.

fdd1c74

Updating reference to dev-lib

48c492e

Documented PHPDoc header for amp_get_permalink()

1a0b53c

Renamed _build_placeholder() back to build_placeholder() since no whe…

fb10624

…re else is using the leading underscore convention for private methods.

Remove errant tick mark.

19b6f04

Revert string concatenation style change.

b1ee243

Revert regex syntax style change.

010dad4

Add class AMP_Rule_Spec in its own file.

8fad986

Merge branch 'develop' of https://github.com/Automattic/amp-wp into n…

241e866

…ew-clarity-develop

Fix autoloader file refs and PHP 5.2 compat

38992ed

Fix phpcs

5fcbc2b

Stop <amg-audio> sanitizer from including a contained "\n" (and thus …

2105af0

…breaking unit tests.)

mikeschinkel added 2 commits December 11, 2017 00:01

Ensure that content if retrieved via get_content_from_dom() and not v…

6000b50

…ia raw $dom->saveXML().

Added a composer.json.

6e0c13b

mikeschinkel added 7 commits December 11, 2017 00:17

Handle "no body" in AMP_DOM_Utils::get_content_from_dom()

bd97046

Split get_content_from_dom() in to by adding get_content_from_dom_nod…

215a27b

…e() in AMP_DOM_Utils.

Use the new AMP_DOM_Utils::get_content_from_dom_node() to make failin…

85a46ba

…g tests work correctly.

Remove "repositories" from composer.json because it is not merged in …

de7f617

…yet and thus is causing the build to fail.

Had to remove require: php>=5.2 because it appears to be breaking the…

5d1157f

… build. (Methinks we would need to update the composer.json file for each Travis build to support the proper version of PHP?)

Ugh. Have to go with minimal composer.json because it is breaking the…

42c0600

… build as is.

Need a commit to trigger a rebuild given that one of them timed out...

47edc2f

Merge branch 'develop' of github.com:Automattic/amp-wp into develop

3e15941

westonruter mentioned this pull request Dec 11, 2017

#804 Update Allowed Tags And Attributes #823

Merged

ThierryA mentioned this pull request Dec 11, 2017

#796 Move AMP Customizer into main Customizer #819

Merged

3 tasks

Include test/stubs in autoloader; remove unused absolute path support…

f5b2d2f

… in autoloader

westonruter reviewed Dec 11, 2017

View reviewed changes

Fix phpcs issues in modified files

8b416f9

westonruter approved these changes Dec 11, 2017

View reviewed changes

Fix phpcs issues in AMP_Post_Template

575ac66

westonruter changed the title ~~Added autoloader to reduce complexity~~ Added autoloader to reduce complexity; clean phpcs issues Dec 11, 2017

westonruter changed the title ~~Added autoloader to reduce complexity; clean phpcs issues~~ Added autoloader to reduce complexity; fix phpcs issues Dec 11, 2017

westonruter merged commit b94b10b into ampproject:develop Dec 11, 2017

westonruter added this to the v0.6 milestone Dec 13, 2017

westonruter mentioned this pull request Jan 13, 2018

Revert #725: Abstract notion of AMP Actions #858

Merged

westonruter added a commit that referenced this pull request Jan 19, 2018

Remove erroneous additional allowance of script[type=text/javascript]

91ef386

Issue introduced in #828 via 5c1fa20

westonruter mentioned this pull request Jan 19, 2018

Remove erroneous additional allowance of script[type=text/javascript] #884

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added autoloader to reduce complexity; fix phpcs issues #828

Added autoloader to reduce complexity; fix phpcs issues #828

mikeschinkel commented Dec 8, 2017 •

edited

Loading

westonruter left a comment

westonruter Dec 8, 2017

mikeschinkel Dec 8, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 8, 2017 •

edited

Loading

westonruter Dec 8, 2017

mikeschinkel Dec 8, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 9, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 8, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 9, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 8, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 9, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 9, 2017

westonruter Dec 10, 2017

westonruter Dec 8, 2017

mikeschinkel Dec 9, 2017

westonruter commented Dec 10, 2017

mikeschinkel commented Dec 10, 2017 •

edited

Loading

westonruter commented Dec 10, 2017

mikeschinkel commented Dec 11, 2017 •

edited

Loading

mikeschinkel commented Dec 11, 2017

westonruter commented Dec 11, 2017

mikeschinkel commented Dec 11, 2017

mikeschinkel commented Dec 11, 2017

westonruter Dec 11, 2017

mikeschinkel Dec 11, 2017

mikeschinkel commented Dec 11, 2017

@@ @@ -73,6 +71,9 @@ public function sanitize() { @@
               		}
               	}
+              	/**

		public function get_styles() {
		if ( ! $this->did_convert_elements ) {

		AMP_Autoloader::register();

Added autoloader to reduce complexity; fix phpcs issues #828

Added autoloader to reduce complexity; fix phpcs issues #828

Conversation

mikeschinkel commented Dec 8, 2017 • edited Loading

westonruter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikeschinkel Dec 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter commented Dec 10, 2017

mikeschinkel commented Dec 10, 2017 • edited Loading

westonruter commented Dec 10, 2017

mikeschinkel commented Dec 11, 2017 • edited Loading

mikeschinkel commented Dec 11, 2017

westonruter commented Dec 11, 2017

mikeschinkel commented Dec 11, 2017

mikeschinkel commented Dec 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikeschinkel commented Dec 11, 2017

mikeschinkel commented Dec 8, 2017 •

edited

Loading

mikeschinkel Dec 8, 2017 •

edited

Loading

mikeschinkel commented Dec 10, 2017 •

edited

Loading

mikeschinkel commented Dec 11, 2017 •

edited

Loading