Merge pull request #34 from stellarwp/bugfix/table-collection-type-errors

BUGFIX: Collection Filter Iterators

Author: defunctl

.gitignore

@@ -1,3 +1,4 @@
+.idea/
 files/
 repo/
 vendor/

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file. This projec
 
 ## [unreleased] Unreleased
 
+
+## [1.1.7] 2024-06-05
+
+* Fix - `Collection::get_by_group()` now properly works with a single string group name.
+* Fix - `Group_FilterIterator::count()` now properly returns the filtered count and not the base iterator count.
+* Fix - `Needs_Update_FilterIterator::count()` now properly returns the filtered count and not the base iterator count.
+* Fix - Use proper PSR namespacing for tests.
+* Tests - code clean up and file name standardization.
+
+## [1.1.3] 2023-04-04
+
 * Feature - Added `Table::has_foreign_key()` method.
 
 ## [1.1.2] 2022-11-2

composer.json

@@ -39,7 +39,10 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "StellarWP\\Schema\\Tests\\": "tests/_support/Helper/",
+      "StellarWP\\Schema\\Tests\\": [
+        "tests/_support/Helper/",
+        "tests/wpunit/"
+      ],
       "StellarWP\\Schema\\Tests\\Traits\\": "tests/_support/Traits/"
     }
   },

src/Schema/Tables/Collection.php

@@ -75,7 +75,7 @@ public function get( string $key ): Schema_Interface {
 	 * @return Filters\Group_FilterIterator
 	 */
 	public function get_by_group( $groups, $iterator = null ): Filters\Group_FilterIterator {
-		return new Filters\Group_FilterIterator( $groups, $iterator ?: $this );
+		return new Filters\Group_FilterIterator( (array) $groups, $iterator ?: $this );
 	}
 
 	/**

src/Schema/Tables/Filters/Group_FilterIterator.php

@@ -2,28 +2,34 @@
 
 namespace StellarWP\Schema\Tables\Filters;
 
-class Group_FilterIterator extends \FilterIterator implements \Countable {
+use CallbackFilterIterator;
+use Countable;
+use FilterIterator;
+use Iterator;
+
+class Group_FilterIterator extends FilterIterator implements Countable {
+
 	/**
 	 * Groups to filter.
 	 *
 	 * @since 1.0.0
 	 *
 	 * @var array<string>
 	 */
-	private $groups = [];
+	private $groups;
 
 	/**
 	 * Constructor.
 	 *
 	 * @since 1.0.0
 	 *
 	 * @param array<string> $groups Paths to filter.
-	 * @param \Iterator $iterator Iterator to filter.
+	 * @param Iterator $iterator Iterator to filter.
 	 */
-	public function __construct( array $groups, \Iterator $iterator ) {
+	public function __construct( array $groups, Iterator $iterator ) {
 		parent::__construct( $iterator );
 
-		$this->groups = (array) $groups;
+		$this->groups = $groups;
 	}
 
 	/**
@@ -39,6 +45,8 @@ public function accept(): bool {
 	 * @inheritDoc
 	 */
 	public function count(): int {
-		return iterator_count( $this->getInnerIterator() );
+		return iterator_count( new CallbackFilterIterator( $this->getInnerIterator(), function (): bool {
+			return $this->accept();
+		} ) );
 	}
 }

src/Schema/Tables/Filters/Needs_Update_FilterIterator.php

@@ -2,7 +2,11 @@
 
 namespace StellarWP\Schema\Tables\Filters;
 
-class Needs_Update_FilterIterator extends \FilterIterator implements \Countable {
+use CallbackFilterIterator;
+use Countable;
+use FilterIterator;
+
+class Needs_Update_FilterIterator extends FilterIterator implements Countable {
 	/**
 	 * @inheritDoc
 	 */
@@ -16,6 +20,8 @@ public function accept(): bool {
 	 * @inheritDoc
 	 */
 	public function count(): int {
-		return iterator_count( $this->getInnerIterator() );
+		return iterator_count( new CallbackFilterIterator( $this->getInnerIterator(), function (): bool {
+			return $this->accept();
+		} ) );
 	}
 }

tests/_support/Helper/SchemaTestCase.php

@@ -2,16 +2,15 @@
 
 namespace StellarWP\Schema\Tests;
 
-use lucatume\DI52\App;
-use StellarWP\Schema\Tests\Container;
+use Codeception\Test\Unit;
 use StellarWP\Schema\Config;
 use StellarWP\DB\DB;
 use StellarWP\Schema\Schema;
 
-class SchemaTestCase extends \Codeception\Test\Unit {
+class SchemaTestCase extends Unit {
 	protected $backupGlobals = false;
 
-	public function setUp() {
+	protected function setUp() {
 		// before
 		parent::setUp();
 

tests/_support/Traits/Table_Fixtures.php

@@ -4,6 +4,7 @@
 
 use StellarWP\Schema\Activation;
 use StellarWP\Schema\Builder;
+use StellarWP\Schema\Config;
 use StellarWP\Schema\Fields\Contracts\Field;
 use StellarWP\Schema\Tables\Contracts\Table;
 
@@ -109,6 +110,36 @@ protected function get_definition() {
 		return $table;
 	}
 
+	/**
+	 * Get a fake table to verify its creation.
+	 */
+	public function get_simple_table_alt_group(): Table {
+		return new class extends Table {
+			const SCHEMA_VERSION = '1.0.0';
+
+			protected static $base_table_name = 'simple-alt';
+			protected static $group = 'test';
+			protected static $schema_slug = 'bork-simple-alt';
+			protected static $uid_column = 'id';
+
+			protected function get_definition(): string {
+				global $wpdb;
+				$table_name      = self::table_name();
+				$charset_collate = $wpdb->get_charset_collate();
+
+				return "
+					CREATE TABLE `$table_name` (
+						`id` int(11) UNSIGNED NOT NULL AUTO_INCREMENT,
+						`name` varchar(25) NOT NULL,
+						`slug` varchar(25) NOT NULL,
+						PRIMARY KEY (`id`),
+						KEY `slug` (`slug`)
+					) $charset_collate;
+				";
+			}
+		};
+	}
+
 	/**
 	 * Get a fake table to verify its creation.
 	 */

tests/wpunit/BuilderTest.php

@@ -1,11 +1,10 @@
 <?php
 
-namespace StellarWP\Schema\Tests\Builder;
+namespace StellarWP\Schema\Tests;
 
 use StellarWP\Schema\Tables\Contracts\Schema_Interface as Table_Schema_Interface;
 use StellarWP\Schema\Register;
 use StellarWP\Schema\Schema;
-use StellarWP\Schema\Tests\SchemaTestCase;
 use StellarWP\Schema\Tests\Traits\Table_Fixtures;
 
 class BuilderTest extends SchemaTestCase {

tests/wpunit/Full_ActivationTest.php tests/wpunit/FullActivationTest.phptests/wpunit/Full_ActivationTest.php renamed to tests/wpunit/FullActivationTest.php

@@ -1,14 +1,12 @@
 <?php
+
 namespace StellarWP\Schema\Tests;
 
-use lucatume\DI52\App;
 use StellarWP\Schema\Builder;
 use StellarWP\Schema\Config;
 use StellarWP\Schema\Register;
-use StellarWP\Schema\Tests\SchemaTestCase;
-use StellarWP\Schema\Tests\Traits;
 
-class Full_ActivationTest extends SchemaTestCase {
+class FullActivationTest extends SchemaTestCase {
 	use Traits\Table_Fixtures;
 
 	/**