SoftDeletedInDatabase.php

TLDR

The SoftDeletedInDatabase class is a PHPUnit constraint that checks if a soft deleted row exists in a database table. It is used to validate if a record has been soft deleted using Laravel's soft delete feature.

Classes

SoftDeletedInDatabase

The SoftDeletedInDatabase class extends the PHPUnit\Framework\Constraint\Constraint class. It has the following properties:

• show (integer): The number of records that will be shown in the console in case of failure.
• database (Illuminate\Database\Connection): The database connection.
• data (array): The data that will be used to narrow the search in the database table.
• deletedAtColumn (string): The name of the column that indicates soft deletion has occurred.

The class has the following methods:

• __construct(Connection $database, array $data, string $deletedAtColumn): Constructs a new instance of the constraint.
• matches($table): bool: Checks if the data is found in the given table.
• failureDescription($table): string: Returns the description of the failure.
• getAdditionalInfo($table): Gets additional info about the records found in the database table.
• toString(): string: Returns a string representation of the object.

<?php

namespace Illuminate\Testing\Constraints;

use Illuminate\Database\Connection;
use PHPUnit\Framework\Constraint\Constraint;

class SoftDeletedInDatabase extends Constraint
{
    /**
     * Number of records that will be shown in the console in case of failure.
     *
     * @var int
     */
    protected $show = 3;

    /**
     * The database connection.
     *
     * @var \Illuminate\Database\Connection
     */
    protected $database;

    /**
     * The data that will be used to narrow the search in the database table.
     *
     * @var array
     */
    protected $data;

    /**
     * The name of the column that indicates soft deletion has occurred.
     *
     * @var string
     */
    protected $deletedAtColumn;

    /**
     * Create a new constraint instance.
     *
     * @param  \Illuminate\Database\Connection  $database
     * @param  array  $data
     * @param  string  $deletedAtColumn
     * @return void
     */
    public function __construct(Connection $database, array $data, string $deletedAtColumn)
    {
        $this->data = $data;

        $this->database = $database;

        $this->deletedAtColumn = $deletedAtColumn;
    }

    /**
     * Check if the data is found in the given table.
     *
     * @param  string  $table
     * @return bool
     */
    public function matches($table): bool
    {
        return $this->database->table($table)
                ->where($this->data)
                ->whereNotNull($this->deletedAtColumn)
                ->count() > 0;
    }

    /**
     * Get the description of the failure.
     *
     * @param  string  $table
     * @return string
     */
    public function failureDescription($table): string
    {
        return sprintf(
            "any soft deleted row in the table [%s] matches the attributes %s.\n\n%s",
            $table, $this->toString(), $this->getAdditionalInfo($table)
        );
    }

    /**
     * Get additional info about the records found in the database table.
     *
     * @param  string  $table
     * @return string
     */
    protected function getAdditionalInfo($table)
    {
        $query = $this->database->table($table);

        $results = $query->limit($this->show)->get();

        if ($results->isEmpty()) {
            return 'The table is empty';
        }

        $description = 'Found: '.json_encode($results, JSON_PRETTY_PRINT);

        if ($query->count() > $this->show) {
            $description .= sprintf(' and %s others', $query->count() - $this->show);
        }

        return $description;
    }

    /**
     * Get a string representation of the object.
     *
     * @return string
     */
    public function toString(): string
    {
        return json_encode($this->data);
    }
}