Pink-Crab / WPDB_Migrations

src/Log/Migration_Log.php

Spacing +7 added lines, -7 removed lines

@@ -87,10 +87,10 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return self
 	 */
-	public static function new_from_schema( Schema $schema ): self {
+	public static function new_from_schema(Schema $schema): self {
 		return new self(
 			$schema->get_table_name(),
-			self::compose_column_hash( $schema ),
+			self::compose_column_hash($schema),
 			false,
 			new DateTimeImmutable(),
 			new DateTimeImmutable()
@@ -103,10 +103,10 @@ 
 	 * @param \DateTimeImmutable|null $updated_on
 	 * @return self
 	 */
-	public function as_updated( Schema $schema, ?DateTimeImmutable $updated_on = null ): self {
+	public function as_updated(Schema $schema, ?DateTimeImmutable $updated_on = null): self {
 		return new self(
 			$this->table_name(),
-			self::compose_column_hash( $schema ),
+			self::compose_column_hash($schema),
 			$this->is_seeded(),
 			$this->created_on(),
 			$updated_on ?? new DateTimeImmutable()
@@ -119,7 +119,7 @@ 
 	 * @param \DateTimeImmutable|null $updated_on
 	 * @return self
 	 */
-	public function as_seeded( ?DateTimeImmutable $updated_on = null ): self {
+	public function as_seeded(?DateTimeImmutable $updated_on = null): self {
 		return new self(
 			$this->table_name(),
 			$this->schema_hash(),
@@ -135,7 +135,7 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return string
 	 */
-	public static function compose_column_hash( Schema $schema ): string {
+	public static function compose_column_hash(Schema $schema): string {
 		$export = array(
 			'name'         => $schema->get_table_name(),
 			'columns'      => $schema->get_columns(),
@@ -143,7 +143,7 @@ 
 			'foreign_keys' => $schema->get_foreign_keys(),
 		);
 
-		return md5( \serialize( $export ) ?: $schema->get_table_name() );  // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize, Serialised to preserve types
+		return md5(\serialize($export) ?: $schema->get_table_name()); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize, Serialised to preserve types
 	}
 
 	/** GETTERS */

src/Database_Migration.php

Spacing +4 added lines, -4 removed lines

@@ -53,8 +53,8 @@ 
 	 * @throws Exception If table name not defiend.
 	 */
 	public function __construct() {
-		$this->schema    = new Schema( $this->table_name, array( $this, 'schema' ) );
-		$this->seed_data = $this->seed( array() );
+		$this->schema    = new Schema($this->table_name, array($this, 'schema'));
+		$this->seed_data = $this->seed(array());
 	}
 
 	/**
@@ -63,7 +63,7 @@ 
 	 * @param Schema $schema_config
 	 * @return void
 	 */
-	abstract public function schema( Schema $schema_config ): void;
+	abstract public function schema(Schema $schema_config): void;
 
 	/**
 	 * Defines the data to be seeded.
@@ -71,7 +71,7 @@ 
 	 * @param array<string, mixed> $seeds
 	 * @return array<string, mixed>
 	 */
-	public function seed( array $seeds ): array {
+	public function seed(array $seeds): array {
 		return $seeds;
 	}
 

src/Migration_Exception.php

Spacing +6 added lines, -6 removed lines

@@ -36,9 +36,9 @@ 
 	 * @return Migration_Exception
 	 * @code 1
 	 */
-	public static function seed_column_doesnt_exist( string $column, string $table_name ): Migration_Exception {
+	public static function seed_column_doesnt_exist(string $column, string $table_name): Migration_Exception {
 		return new Migration_Exception(
-			\sprintf( 'Could not find column %s in %s schema definition', $column, $table_name ),
+			\sprintf('Could not find column %s in %s schema definition', $column, $table_name),
 			1
 		);
 	}
@@ -51,9 +51,9 @@ 
 	 * @return Migration_Exception
 	 * @code 2
 	 */
-	public static function failed_to_insert_seed( string $wpdb_error, string $table_name ): Migration_Exception {
+	public static function failed_to_insert_seed(string $wpdb_error, string $table_name): Migration_Exception {
 		return new Migration_Exception(
-			\sprintf( 'Could not insert seed into %s, failed with error: %s', $table_name, $wpdb_error ),
+			\sprintf('Could not insert seed into %s, failed with error: %s', $table_name, $wpdb_error),
 			2
 		);
 	}
@@ -65,9 +65,9 @@ 
 	 * @return Migration_Exception
 	 * @code 3
 	 */
-	public static function failed_to_drop_table( string $table_name ): Migration_Exception {
+	public static function failed_to_drop_table(string $table_name): Migration_Exception {
 		return new Migration_Exception(
-			\sprintf( 'Failed to drop %d', $table_name ),
+			\sprintf('Failed to drop %d', $table_name),
 			3
 		);
 	}

src/Migration_Seeder.php

Spacing +16 added lines, -16 removed lines

@@ -36,7 +36,7 @@ 
 	 */
 	protected $wpdb;
 
-	public function __construct( wpdb $wpdb ) {
+	public function __construct(wpdb $wpdb) {
 		$this->wpdb = $wpdb;
 	}
 
@@ -47,11 +47,11 @@ 
 	 * @param array<array<string, mixed>> $seed_data
 	 * @return array<string, int>
 	 */
-	public function seed( Schema $schema, array $seed_data ): array {
+	public function seed(Schema $schema, array $seed_data): array {
 		$results = array();
 
-		foreach ( $seed_data as $key => $seed ) {
-			$results[ $key ] = $this->insert_seed( $schema, $seed );
+		foreach ($seed_data as $key => $seed) {
+			$results[ $key ] = $this->insert_seed($schema, $seed);
 		}
 
 		return $results;
@@ -65,13 +65,13 @@ 
 	 * @return int The new row ID.
 	 * @throws Migration_Exception
 	 */
-	protected function insert_seed( Schema $schema, array $seed ): int {
+	protected function insert_seed(Schema $schema, array $seed): int {
 		// Get format for each column based on the type.
 		$format = array_map(
-			function( string $column_name ) use ( $schema ): string {
-				return $this->column_type( $schema, $column_name );
+			function(string $column_name) use ($schema): string {
+				return $this->column_type($schema, $column_name);
 			},
-			array_keys( $seed )
+			array_keys($seed)
 		);
 
 		$this->wpdb->insert(
@@ -81,8 +81,8 @@ 
 		);
 
 		// Check any errors inserting.
-		if ( $this->wpdb->last_error !== '' ) {
-			throw Migration_Exception::failed_to_insert_seed( $this->wpdb->last_error, $schema->get_table_name() );
+		if ($this->wpdb->last_error !== '') {
+			throw Migration_Exception::failed_to_insert_seed($this->wpdb->last_error, $schema->get_table_name());
 		}
 
 		return $this->wpdb->insert_id;
@@ -96,15 +96,15 @@ 
 	 * @return string
 	 * @throws Migration_Exception If a column cant be found.
 	 */
-	protected function column_type( Schema $schema, string $column ): string {
+	protected function column_type(Schema $schema, string $column): string {
 		$schema_columns = $schema->get_columns();
 
 		// If colum doesnt exist, thorw exception.
-		if ( ! array_key_exists( $column, $schema_columns ) ) {
-			throw Migration_Exception::seed_column_doesnt_exist( $column, $schema->get_table_name() );
+		if ( ! array_key_exists($column, $schema_columns)) {
+			throw Migration_Exception::seed_column_doesnt_exist($column, $schema->get_table_name());
 		}
 
-		return $this->column_type_format( $schema_columns[ $column ]->get_type() ?? '' );
+		return $this->column_type_format($schema_columns[ $column ]->get_type() ?? '');
 	}
 
 	/**
@@ -113,8 +113,8 @@ 
 	 * @param string $type
 	 * @return string
 	 */
-	protected function column_type_format( string $type ): string {
-		switch ( \strtoupper( $type ) ) {
+	protected function column_type_format(string $type): string {
+		switch (\strtoupper($type)) {
 			case 'CHAR':
 			case 'VARCHAR':
 			case 'BINARY':

src/Factory.php

Spacing +6 added lines, -6 removed lines

@@ -38,13 +38,13 @@ 
 	 * @param \wpdb|null $wpdb Can pass custom wpdb instance
 	 * @return Migration_Manager
 	 */
-	public static function manager_with_db_delta( ?string $option_key = null, ?\wpdb $wpdb = null ): Migration_Manager {
-		if ( $wpdb === null ) {
+	public static function manager_with_db_delta(?string $option_key = null, ?\wpdb $wpdb = null): Migration_Manager {
+		if ($wpdb === null) {
 			global $wpdb;
 		}
 
-		$builder = new Builder( new DB_Delta_Engine( $wpdb ) );
-		return new Migration_Manager( $builder, $wpdb, $option_key );
+		$builder = new Builder(new DB_Delta_Engine($wpdb));
+		return new Migration_Manager($builder, $wpdb, $option_key);
 	}
 
 	/**
@@ -55,7 +55,7 @@ 
 	 * @param string|null $option_key
 	 * @return \PinkCrab\DB_Migration\Log\Migration_Log_Manager
 	 */
-	public static function migration_log( ?string $option_key = null ): Migration_Log_Manager {
-		return new Migration_Log_Manager( $option_key );
+	public static function migration_log(?string $option_key = null): Migration_Log_Manager {
+		return new Migration_Log_Manager($option_key);
 	}
 }

src/Migration_Manager.php

Spacing +28 added lines, -28 removed lines

@@ -59,10 +59,10 @@ 
 	 */
 	protected $migration_log;
 
-	public function __construct( Builder $builder, wpdb $wpdb, ?string $migration_log_key = null ) {
+	public function __construct(Builder $builder, wpdb $wpdb, ?string $migration_log_key = null) {
 		$this->builder       = $builder;
 		$this->wpdb          = $wpdb;
-		$this->migration_log = new Migration_Log_Manager( $migration_log_key );
+		$this->migration_log = new Migration_Log_Manager($migration_log_key);
 
 	}
 
@@ -94,7 +94,7 @@ 
 	 * @param  \PinkCrab\DB_Migration\Database_Migration $migration
 	 * @return self
 	 */
-	public function add_migration( Database_Migration $migration ): self {
+	public function add_migration(Database_Migration $migration): self {
 		$this->migrations[ $migration->get_table_name() ] = $migration;
 		return $this;
 	}
@@ -114,22 +114,22 @@ 
 	 * @param string ...$excluded_table Table names to exclude.
 	 * @return self
 	 */
-	public function create_tables( string ...$excluded_table ): self {
+	public function create_tables(string ...$excluded_table): self {
 
 		// Remove excluded tables.
 		$to_create = array_filter(
 			$this->migrations,
-			function( Database_Migration $migration ) use ( $excluded_table ): bool {
-				return ! in_array( $migration->get_table_name(), $excluded_table, true )
-				&& $this->migration_log->can_migrate( $migration->get_schema() );
+			function(Database_Migration $migration) use ($excluded_table): bool {
+				return ! in_array($migration->get_table_name(), $excluded_table, true)
+				&& $this->migration_log->can_migrate($migration->get_schema());
 			}
 		);
 
 		// Upsert Tables.
-		foreach ( $to_create as $migration ) {
-			$result = $this->builder->create_table( $migration->get_schema() );
-			if ( $result === true ) {
-				$this->migration_log->upsert_migration( $migration->get_schema() );
+		foreach ($to_create as $migration) {
+			$result = $this->builder->create_table($migration->get_schema());
+			if ($result === true) {
+				$this->migration_log->upsert_migration($migration->get_schema());
 			}
 		}
 
@@ -143,23 +143,23 @@ 
 	 * @param string ...$excluded_table Table names to exclude.
 	 * @return self
 	 */
-	public function seed_tables( string ...$excluded_table ): self {
+	public function seed_tables(string ...$excluded_table): self {
 
 		// Remove excluded tables.
 		$to_seed = array_filter(
 			$this->migrations,
-			function( Database_Migration $migration ) use ( $excluded_table ): bool {
-				return ! in_array( $migration->get_table_name(), $excluded_table, true )
-				&& ! $this->migration_log->is_seeded( $migration->get_schema() );
+			function(Database_Migration $migration) use ($excluded_table): bool {
+				return ! in_array($migration->get_table_name(), $excluded_table, true)
+				&& ! $this->migration_log->is_seeded($migration->get_schema());
 			}
 		);
 
-		$seeder = new Migration_Seeder( $this->wpdb );
+		$seeder = new Migration_Seeder($this->wpdb);
 
-		foreach ( $to_seed as $migration ) {
-			$row = $seeder->seed( $migration->get_schema(), $migration->get_seeds() );
-			if ( count( $row ) !== 0 ) {
-				$this->migration_log->mark_table_seeded( $migration->get_schema() );
+		foreach ($to_seed as $migration) {
+			$row = $seeder->seed($migration->get_schema(), $migration->get_seeds());
+			if (count($row) !== 0) {
+				$this->migration_log->mark_table_seeded($migration->get_schema());
 			}
 		}
 
@@ -172,26 +172,26 @@ 
 	 * @param string ...$excluded_table Table names to exclude.
 	 * @return self
 	 */
-	public function drop_tables( string ...$excluded_table ): self {
+	public function drop_tables(string ...$excluded_table): self {
 		// Remove excluded tables.
 		$to_seed = array_filter(
 			$this->migrations,
-			function( Database_Migration $migration ) use ( $excluded_table ): bool {
-				return ! in_array( $migration->get_table_name(), $excluded_table, true );
+			function(Database_Migration $migration) use ($excluded_table): bool {
+				return ! in_array($migration->get_table_name(), $excluded_table, true);
 			}
 		);
 
-		foreach ( $to_seed as $migration ) {
+		foreach ($to_seed as $migration) {
 
-			$result = $this->builder->drop_table( $migration->get_schema() );
+			$result = $this->builder->drop_table($migration->get_schema());
 
 			// Throw exception if fails.
-			if ( $result === false ) {
-				throw Migration_Exception::failed_to_drop_table( $migration->get_table_name() );
+			if ($result === false) {
+				throw Migration_Exception::failed_to_drop_table($migration->get_table_name());
 			}
 
 			// Remove migration from log.
-			$this->migration_log->remove_migration( $migration->get_schema() );
+			$this->migration_log->remove_migration($migration->get_schema());
 		}
 
 		return $this;

src/Log/Migration_Log_Manager.php

Spacing +31 added lines, -31 removed lines

@@ -45,7 +45,7 @@ 
 	 */
 	protected $migration_details = array();
 
-	public function __construct( string $option_key = null ) {
+	public function __construct(string $option_key = null) {
 		$this->option_key = $option_key ?? 'pinkcrab_migration_log';
 		$this->set_migration_details();
 	}
@@ -57,19 +57,19 @@ 
 	 * @throws InvalidArgumentException If can not unserialize
 	 */
 	protected function set_migration_details(): void {
-		$migrations = get_option( $this->option_key, null );
+		$migrations = get_option($this->option_key, null);
 
-		if ( $migrations === null ) {
+		if ($migrations === null) {
 			return;
 		}
 
 		// Handle errors as exceptions.
 		set_error_handler( // phpcs:ignore
-			function ( int $errno, string $errstr ) { // phpcs:ignore
-				throw new InvalidArgumentException( 'Migration details as unserialize from options, failed to be decoded.' );
+			function(int $errno, string $errstr) { // phpcs:ignore
+				throw new InvalidArgumentException('Migration details as unserialize from options, failed to be decoded.');
 			}
 		);
-		$migrations = \unserialize( $migrations ); // phpcs:ignore
+		$migrations = \unserialize($migrations); // phpcs:ignore
 		restore_error_handler();
 
 		$this->migration_details = $migrations;
@@ -81,8 +81,8 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return boolean
 	 */
-	public function has_migration( Schema $schema ): bool {
-		return array_key_exists( $schema->get_table_name(), $this->migration_details );
+	public function has_migration(Schema $schema): bool {
+		return array_key_exists($schema->get_table_name(), $this->migration_details);
 	}
 
 	/**
@@ -90,8 +90,8 @@ 
 	 *
 	 * @return \PinkCrab\DB_Migration\Log\Migration_Log|null
 	 */
-	public function get_migration( Schema $schema ): ?Migration_Log {
-		return $this->has_migration( $schema )
+	public function get_migration(Schema $schema): ?Migration_Log {
+		return $this->has_migration($schema)
 			? $this->migration_details[ $schema->get_table_name() ]
 			: null;
 	}
@@ -102,8 +102,8 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return bool
 	 */
-	public function can_migrate( Schema $schema ): bool {
-		return ! $this->check_hash( $schema );
+	public function can_migrate(Schema $schema): bool {
+		return ! $this->check_hash($schema);
 	}
 
 	/**
@@ -112,8 +112,8 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return bool
 	 */
-	public function is_seeded( Schema $schema ): bool {
-		return $this->has_migration( $schema )
+	public function is_seeded(Schema $schema): bool {
+		return $this->has_migration($schema)
 		&& $this->migration_details[ $schema->get_table_name() ]->is_seeded();
 	}
 
@@ -123,15 +123,15 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return bool
 	 */
-	private function check_hash( Schema $schema ): bool {
+	private function check_hash(Schema $schema): bool {
 		// If table doesnt exist, return false;
-		if ( ! $this->has_migration( $schema ) ) {
+		if ( ! $this->has_migration($schema)) {
 			return false;
 		}
 
-		$schema_hash = Migration_Log::compose_column_hash( $schema );
+		$schema_hash = Migration_Log::compose_column_hash($schema);
 		$migration   = $this->migration_details[ $schema->get_table_name() ];
-		return strcmp( $schema_hash, $migration->schema_hash() ) === 0;
+		return strcmp($schema_hash, $migration->schema_hash()) === 0;
 	}
 
 	/**
@@ -145,20 +145,20 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return self
 	 */
-	public function upsert_migration( Schema $schema ): self {
+	public function upsert_migration(Schema $schema): self {
 		// Update if table exists and we have a new schema defined.
-		if ( $this->has_migration( $schema )
-		&& ! $this->check_hash( $schema ) ) {
+		if ($this->has_migration($schema)
+		&& ! $this->check_hash($schema)) {
 			$this->migration_details[ $schema->get_table_name() ] =
-				$this->migration_details[ $schema->get_table_name() ]->as_updated( $schema );
+				$this->migration_details[ $schema->get_table_name() ]->as_updated($schema);
 
 			$this->save();
 		}
 
 		// If a new hash.
-		if ( $this->has_migration( $schema ) === false ) {
+		if ($this->has_migration($schema) === false) {
 			$this->migration_details[ $schema->get_table_name() ] =
-				Migration_Log::new_from_schema( $schema );
+				Migration_Log::new_from_schema($schema);
 
 			$this->save();
 		}
@@ -172,9 +172,9 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return self
 	 */
-	public function remove_migration( Schema $schema ): self {
-		if ( $this->has_migration( $schema ) ) {
-			unset( $this->migration_details[ $schema->get_table_name() ] );
+	public function remove_migration(Schema $schema): self {
+		if ($this->has_migration($schema)) {
+			unset($this->migration_details[ $schema->get_table_name() ]);
 
 			$this->save();
 		}
@@ -187,8 +187,8 @@ 
 	 * @param \PinkCrab\Table_Builder\Schema $schema
 	 * @return self
 	 */
-	public function mark_table_seeded( Schema $schema ): self {
-		if ( ! $this->is_seeded( $schema ) ) {
+	public function mark_table_seeded(Schema $schema): self {
+		if ( ! $this->is_seeded($schema)) {
 			$this->migration_details[ $schema->get_table_name() ] =
 				$this->migration_details[ $schema->get_table_name() ]->as_seeded();
 
@@ -204,7 +204,7 @@ 
 	 * @return void
 	 */
 	protected function save(): void {
-		\update_option( $this->option_key, serialize( $this->migration_details ), false ); // phpcs:ignore
+		\update_option($this->option_key, serialize($this->migration_details), false); // phpcs:ignore
 	}
 
 	/**
@@ -222,6 +222,6 @@ 
 	 * @return void
 	 */
 	public function clear_log(): void {
-		\delete_option( $this->option_key );
+		\delete_option($this->option_key);
 	}
 }