From 961019ef74517a3c6b861a17fa412b202b5b5345 Mon Sep 17 00:00:00 2001 From: Andrey Savchenko Date: Fri, 21 Dec 2018 15:45:47 +0200 Subject: [PATCH] Reorganized collector classes. --- CHANGELOG.md | 1 + config/psalm.xml | 6 +++--- src/Event/Hook_Event_Config_Interface.php | 4 +++- src/Formatter/Hook_Formatter.php | 2 +- src/Provider/Record_Provider.php | 16 ++++++++-------- .../{ => Collector}/Core_Load_Collector.php | 5 ++++- .../Hook_Collector.php} | 5 +++-- .../Http_Collector.php} | 5 +++-- .../Record_Collector_Interface.php | 4 +++- .../Sql_Collector.php} | 5 +++-- .../Stopwatch_Collector.php} | 5 +++-- tests/Record/CoreTest.php | 2 +- tests/Record/HookTest.php | 4 ++-- tests/Record/HttpTest.php | 4 ++-- tests/Record/SqlTest.php | 6 +++--- tests/Record/StopwatchTest.php | 6 +++--- 16 files changed, 46 insertions(+), 34 deletions(-) rename src/Record/{ => Collector}/Core_Load_Collector.php (89%) rename src/Record/{Hook_Record_Collector.php => Collector/Hook_Collector.php} (97%) rename src/Record/{Http_Record_Collector.php => Collector/Http_Collector.php} (94%) rename src/Record/{ => Collector}/Record_Collector_Interface.php (73%) rename src/Record/{Sql_Record_Collector.php => Collector/Sql_Collector.php} (95%) rename src/Record/{Stopwatch_Record_Collector.php => Collector/Stopwatch_Collector.php} (91%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 65922b4..54c687a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Changed - required PHP version to 7.1 +- organization and names for Record classes ### Deprecated - old format of hook events diff --git a/config/psalm.xml b/config/psalm.xml index 497d40c..b4ba3cf 100644 --- a/config/psalm.xml +++ b/config/psalm.xml @@ -26,17 +26,17 @@ - + - + - + diff --git a/src/Event/Hook_Event_Config_Interface.php b/src/Event/Hook_Event_Config_Interface.php index b0c8fd3..fdef3cb 100644 --- a/src/Event/Hook_Event_Config_Interface.php +++ b/src/Event/Hook_Event_Config_Interface.php @@ -3,13 +3,15 @@ declare( strict_types=1 ); namespace Rarst\Laps\Event; +use Rarst\Laps\Record\Collector\Hook_Collector; + /** * Interface to retrieve configuration array of hook events to track. */ interface Hook_Event_Config_Interface { /** - * @see Hook_Record_Collector::add_event() + * @see Hook_Collector::add_event() * * @return array[] */ diff --git a/src/Formatter/Hook_Formatter.php b/src/Formatter/Hook_Formatter.php index b75cdef..77058c9 100644 --- a/src/Formatter/Hook_Formatter.php +++ b/src/Formatter/Hook_Formatter.php @@ -32,7 +32,7 @@ class Hook_Formatter { $closure = new \ReflectionFunction( $callback ); $callback = 'closure from ' . $closure->getFileName() . '::' . $closure->getStartLine(); - if ( false !== strpos( $callback, 'Hook_Record_Collector' ) ) { + if ( false !== strpos( $callback, 'Hook_Collector' ) ) { continue; } } elseif ( is_object( $callback ) ) { diff --git a/src/Provider/Record_Provider.php b/src/Provider/Record_Provider.php index 03c23bb..e72a37a 100644 --- a/src/Provider/Record_Provider.php +++ b/src/Provider/Record_Provider.php @@ -6,11 +6,11 @@ namespace Rarst\Laps\Provider; use Pimple\Container; use Pimple\ServiceProviderInterface; use Rarst\Laps\Plugin; -use Rarst\Laps\Record\Core_Load_Collector; -use Rarst\Laps\Record\Hook_Record_Collector; -use Rarst\Laps\Record\Http_Record_Collector; -use Rarst\Laps\Record\Record_Collector_Interface; -use Rarst\Laps\Record\Sql_Record_Collector; +use Rarst\Laps\Record\Collector\Core_Load_Collector; +use Rarst\Laps\Record\Collector\Hook_Collector; +use Rarst\Laps\Record\Collector\Http_Collector; +use Rarst\Laps\Record\Collector\Record_Collector_Interface; +use Rarst\Laps\Record\Collector\Sql_Collector; use Symfony\Component\Stopwatch\Stopwatch; /** @@ -30,9 +30,9 @@ class Record_Provider implements ServiceProviderInterface, Bootable_Provider_Int $pimple['collectors'] = function ( Plugin $laps ): array { return [ 'core' => new Core_Load_Collector(), - 'hook' => new Hook_Record_Collector( $laps['stopwatch'], $laps['hook.events'] ), - 'http' => new Http_Record_Collector( $laps['stopwatch'] ), - 'sql' => new Sql_Record_Collector(), + 'hook' => new Hook_Collector( $laps['stopwatch'], $laps['hook.events'] ), + 'http' => new Http_Collector( $laps['stopwatch'] ), + 'sql' => new Sql_Collector(), ]; }; diff --git a/src/Record/Core_Load_Collector.php b/src/Record/Collector/Core_Load_Collector.php similarity index 89% rename from src/Record/Core_Load_Collector.php rename to src/Record/Collector/Core_Load_Collector.php index d946f3b..7076ee9 100644 --- a/src/Record/Core_Load_Collector.php +++ b/src/Record/Collector/Core_Load_Collector.php @@ -1,7 +1,10 @@ new Core_Events() ] ); + $collector = new Hook_Collector( $stopwatch, [ 'core' => new Core_Events() ] ); $this->assertTrue( $stopwatch->isStarted( 'Plugins Load' ) ); $this->assertTrue( has_action( 'after_setup_theme', [ $collector, 'after_setup_theme' ] ) ); diff --git a/tests/Record/HttpTest.php b/tests/Record/HttpTest.php index ad615ce..c66aae3 100644 --- a/tests/Record/HttpTest.php +++ b/tests/Record/HttpTest.php @@ -3,7 +3,7 @@ namespace Rarst\Laps\Tests\Record; use Brain\Monkey\Functions; -use Rarst\Laps\Record\Http_Record_Collector; +use Rarst\Laps\Record\Collector\Http_Collector; use Rarst\Laps\Tests\LapsTestCase; use Symfony\Component\Stopwatch\Stopwatch; @@ -16,7 +16,7 @@ class HttpTest extends LapsTestCase { $stopwatch = new Stopwatch(); $url = 'https://example.com/'; - $collector = new Http_Record_Collector( $stopwatch ); + $collector = new Http_Collector( $stopwatch ); $this->assertTrue( has_action( 'pre_http_request', [ $collector, 'pre_http_request' ] ) ); $this->assertTrue( has_action( 'http_api_debug', [ $collector, 'http_api_debug' ] ) ); diff --git a/tests/Record/SqlTest.php b/tests/Record/SqlTest.php index e42b5c3..89c9cf4 100644 --- a/tests/Record/SqlTest.php +++ b/tests/Record/SqlTest.php @@ -4,13 +4,13 @@ namespace Rarst\Laps\Tests\Record; use Brain\Monkey\Functions; use Rarst\Laps\Record\Record; -use Rarst\Laps\Record\Sql_Record_Collector; +use Rarst\Laps\Record\Collector\Sql_Collector; use Rarst\Laps\Tests\LapsTestCase; class SqlTest extends LapsTestCase { /** - * @covers \Rarst\Laps\Record\Sql_Record_Collector + * @covers \Rarst\Laps\Record\Collector\Sql_Collector */ public function testCollector() { @@ -22,7 +22,7 @@ class SqlTest extends LapsTestCase { } Functions\expect( 'wp_normalize_path' )->zeroOrMoreTimes()->andReturnFirstArg(); - $collector = new Sql_Record_Collector(); + $collector = new Sql_Collector(); $this->assertTrue( has_filter( 'query', [ $collector, 'query' ] ) ); diff --git a/tests/Record/StopwatchTest.php b/tests/Record/StopwatchTest.php index f8c6086..e36df26 100644 --- a/tests/Record/StopwatchTest.php +++ b/tests/Record/StopwatchTest.php @@ -3,7 +3,7 @@ namespace Rarst\Laps\Tests\Record; use Rarst\Laps\Record\Stopwatch_Record; -use Rarst\Laps\Record\Stopwatch_Record_Collector; +use Rarst\Laps\Record\Collector\Stopwatch_Collector; use Rarst\Laps\Tests\LapsTestCase; use Symfony\Component\Stopwatch\Stopwatch; use Symfony\Component\Stopwatch\StopwatchEvent; @@ -11,11 +11,11 @@ use Symfony\Component\Stopwatch\StopwatchEvent; class StopwatchTest extends LapsTestCase { /** - * @covers \Rarst\Laps\Record\Stopwatch_Record_Collector + * @covers \Rarst\Laps\Record\Collector\Stopwatch_Collector */ public function testCollector() { - $collector = new Stopwatch_Record_Collector( new Stopwatch() ); + $collector = new Stopwatch_Collector( new Stopwatch() ); $collector->start( 'Event', 'info' ); $collector->start( 'Not stopped', 'info' );