=================================
Rule ``php_unit_dedicate_assert``
=================================

PHPUnit assertions like ``assertInternalType``, ``assertFileExists``, should be
used over ``assertTrue``.

.. warning:: Using this rule is risky.

   Fixer could be risky if one is overriding PHPUnit's native methods.

Configuration
-------------

``functions``
~~~~~~~~~~~~~

.. warning:: This option is deprecated and will be removed on next major version. Use option ``target`` instead.

List of assertions to fix (overrides ``target``).

Allowed values: a subset of ``['array_key_exists', 'empty', 'file_exists', 'is_array', 'is_bool', 'is_callable', 'is_double', 'is_float', 'is_infinite', 'is_int', 'is_integer', 'is_long', 'is_nan', 'is_null', 'is_numeric', 'is_object', 'is_real', 'is_resource', 'is_scalar', 'is_string']``, ``null``

Default value: ``null``

``target``
~~~~~~~~~~

Target version of PHPUnit.

Allowed values: ``'3.0'``, ``'3.5'``, ``'5.0'``, ``'5.6'``, ``'newest'``

Default value: ``'5.0'``

Examples
--------

Example #1
~~~~~~~~~~

*Default* configuration.

.. code-block:: diff

   --- Original
   +++ New
   @@ -3,7 +3,7 @@
    {
        public function testSomeTest()
        {
   -        $this->assertTrue(is_float( $a), "my message");
   -        $this->assertTrue(is_nan($a));
   +        $this->assertInternalType('float', $a, "my message");
   +        $this->assertNan($a);
        }
    }

Example #2
~~~~~~~~~~

With configuration: ``['target' => '5.6']``.

.. code-block:: diff

   --- Original
   +++ New
   @@ -3,8 +3,8 @@
    {
        public function testSomeTest()
        {
   -        $this->assertTrue(is_dir($a));
   -        $this->assertTrue(is_writable($a));
   -        $this->assertTrue(is_readable($a));
   +        $this->assertDirectoryExists($a);
   +        $this->assertIsWritable($a);
   +        $this->assertIsReadable($a);
        }
    }

Rule sets
---------

The rule is part of the following rule sets:

@PHPUnit30Migration:risky
  Using the ``@PHPUnit30Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '3.0']``

@PHPUnit32Migration:risky
  Using the ``@PHPUnit32Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '3.0']``

@PHPUnit35Migration:risky
  Using the ``@PHPUnit35Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '3.5']``

@PHPUnit43Migration:risky
  Using the ``@PHPUnit43Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '3.5']``

@PHPUnit48Migration:risky
  Using the ``@PHPUnit48Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '3.5']``

@PHPUnit50Migration:risky
  Using the ``@PHPUnit50Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the default config.

@PHPUnit52Migration:risky
  Using the ``@PHPUnit52Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the default config.

@PHPUnit54Migration:risky
  Using the ``@PHPUnit54Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the default config.

@PHPUnit55Migration:risky
  Using the ``@PHPUnit55Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the default config.

@PHPUnit56Migration:risky
  Using the ``@PHPUnit56Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '5.6']``

@PHPUnit57Migration:risky
  Using the ``@PHPUnit57Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '5.6']``

@PHPUnit60Migration:risky
  Using the ``@PHPUnit60Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '5.6']``

@PHPUnit75Migration:risky
  Using the ``@PHPUnit75Migration:risky`` rule set will enable the ``php_unit_dedicate_assert`` rule with the config below:

  ``['target' => '5.6']``
