TAssertions::assertNotNull() - Code Metrics - Inspection of "deprecated Environment" - konecnyjakub/mytester - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 3cc3ad...47373b )

by Jakub
created 2020-10-01 17:05 UTC
TAssertions::assertNotNull() A

↳ Parent: TAssertions
Complexity

Conditions	2
Paths	2
Size

Total Lines	6
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	1
Metric	Value
cc	2
eloc	4
c	2
b	0
f	1
nc	2
nop	1
dl	0
loc	6
rs	10
<?php
declare(strict_types=1);

namespace MyTester;

trait TAssertions {
  /** @internal */
  protected int $taskCount = 0;
  /** @internal */
  protected bool $shouldFail = false;

  /**
   * Prints result of a test
   *
   * @internal
   */
  protected function testResult(string $text, bool $success = true): void {
    $this->incCounter();
    if($success) {
      return;
    }
    echo "Test $this->taskCount failed. $text\n";
  }

  /**
   * Increases task counter
   *
   * @internal
   */
  protected function incCounter(): void {
    $this->taskCount++;
    Environment::incCounter();
    /** @scrutinizer ignore-deprecated */ Environment::incCounter();
  }

  /**
   * Resets task counter
   *
   * @internal
   */
  protected function resetCounter(): void {
    $this->taskCount = 0;
    Environment::resetCounter();
    /** @scrutinizer ignore-deprecated */ Environment::resetCounter();
  }

  /**
   * @internal
   */
  public function getCounter(): int {
    return $this->taskCount;
  }

  /**
   * @param string|array $variable
   */
  protected function showStringOrArray($variable): string {
    return (is_string($variable) ? $variable : "(array)");
  }

  protected function isSuccess(bool $success): bool {
    if($this->shouldFail) {
      $success = !$success;
    }
    return $success;
  }
  
  /**
   * Tries an assertion
   *
   * @param mixed $code Assertion to try
   */
  protected function assert($code, string $failureText = ""): void {
    $success = $this->isSuccess($code == true);
    if(!$success) {
      $message = ($failureText === "") ? "Assertion \"$code\" is not true." : $failureText;
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Are both values same?
   *
   * @param mixed $expected
   * @param mixed $actual
   */
  protected function assertSame($expected, $actual): void {
    $success = $this->isSuccess($expected == $actual);
    if(!$success) {
      $message = "The value is not $expected but $actual.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Are not both values same?
   *
   * @param mixed $expected
   * @param mixed $actual
   */
  protected function assertNotSame($expected, $actual): void {
    $success = $this->isSuccess($expected !== $actual);
    if(!$success) {
      $message = "The value is $expected.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is $actual equal to true?
   */
  protected function assertTrue(bool $actual): void {
    $success = $this->isSuccess($actual);
    if(!$success) {
      $message = "The value is not true.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is the expression true?
   *
   * @param mixed $actual
   */
  protected function assertTruthy($actual): void {
    $success = $this->isSuccess($actual == true);
    if(!$success) {
      $message = "The expression is not true.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is $actual equal to false?
   */
  protected function assertFalse(bool $actual): void {
    $success = $this->isSuccess(!$actual);
    if(!$success) {
      $message = "The value is not false.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is the expression false?
   *
   * @param mixed $actual
   */
  protected function assertFalsey($actual): void {
    $success = $this->isSuccess($actual == false);
    if(!$success) {
      $message = "The expression is not false.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is the value null?
   *
   * @param mixed $actual
   */
  protected function assertNull($actual): void {
    $success = $this->isSuccess($actual == null);
    if(!$success) {
      $message = "The value is not null.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is not the value null?
   *
   * @param mixed $actual
   */
  protected function assertNotNull($actual): void {
    $success = $this->isSuccess($actual !== null);
    if(!$success) {
      $message = "The value is null.";
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Does $actual contain $needle?
   *
   * @param string|array $needle
   * @param string|array $actual
   */
  protected function assertContains($needle, $actual): void {
    if(!is_string($needle) && !is_array($needle)) {

      $this->testResult("The variable is not string or array.", false);
    } elseif(is_string($actual) && is_string($needle)) {
      $success = $this->isSuccess($needle !== "" && strpos($actual, $needle) !== false);
      if($success) {
        $this->testResult("");
      } else {
        $this->testResult("$needle is not in the variable.", false);
      }
    } elseif(is_array($actual)) {
      $success = $this->isSuccess(in_array($needle, $actual));
      if($success) {
        $this->testResult("");
      } else {
        $this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
      }
    } else {
      $this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
    }
  }

  /**
   * Does $actual not contain $needle?
   *
   * @param string|array $needle
   * @param string|array $actual
   */
  protected function assertNotContains($needle, $actual): void {
    if(!is_string($needle) && !is_array($needle)) {

      $this->testResult("The variable is not string or array.", false);
    } elseif(is_string($actual) && is_string($needle)) {
      $success = $this->isSuccess($needle === "" || strpos($actual, $needle) === false);
      if($success) {
        $this->testResult("");
      } else {
        $this->testResult("$needle is in the variable.", false);
      }
    } elseif(is_array($actual)) {
      $success = $this->isSuccess(!in_array($needle, $actual));
      if($success) {
        $this->testResult("");
      } else {
        $this->testResult($this->showStringOrArray($needle) . " is in the variable.", false);
      }
    } else {
      $this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
    }
  }

  /**
   * Does $value contain $count items?
   *
   * @param string|array|\Countable $value
   */
  protected function assertCount(int $count, $value): void {
    if(!is_array($value) && !$value instanceof \Countable) {
      $this->testResult("The variable is not array or countable object.", false);
      return;
    }
    $success = $this->isSuccess(count($value) === $count);
    if($success) {
      $this->testResult("");
    } else {
      $actual = count($value);
      $this->testResult("Count of the variable is $actual.", false);
    }
  }

  /**
   * Does $value not contain $count items?
   *
   * @param string|array|\Countable $value
   */
  protected function assertNotCount(int $count, $value): void {
    if(!is_array($value) && !$value instanceof \Countable) {
      $this->testResult("The variable is not array or countable object.", false);
      return;
    }
    $success = $this->isSuccess(count($value) !== $count);
    if($success) {
      $this->testResult("");
    } else {
      $actual = count($value);
      $this->testResult("Count of the variable is $actual.", false);
    }
  }

  /**
   * Is $value of type $type?
   *
   * @param string|object $type
   * @param mixed $value
   */
  protected function assertType($type, $value): void {
    if(!is_object($type) && !is_string($type)) {

      $this->testResult("Type must be string or object.", false);
      return;
    }
    if(in_array($type, ["array", "bool", "float", "int", "string", "null", "object", "resource",
      "scalar", "iterable", "callable", ], true)) {
      $success = $this->isSuccess(call_user_func("is_$type", $value));
      if(!$success) {
        $this->testResult("The variable is " . gettype($value) . ".", false);
      } else {
        $this->testResult("");
      }
      return;
    }
    $success = $this->isSuccess($value instanceof $type);
    if(!$success) {
      $actual = get_debug_type($value);
      $this->testResult("The variable is instance of $actual.", false);
    } else {
      $this->testResult("");
    }
  }
}
?>
konecnyjakub / mytester

Push — master ( 3cc3ad...47373b )

TAssertions::assertNotNull() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
