class FractionTest in Fraction 8

Provides tests for the Fraction class.

@group Fraction

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\fraction\Unit\FractionTest

File

tests/src/Unit/FractionTest.php, line 13

Namespace

Drupal\Tests\fraction\Unit

class FractionTest extends UnitTestCase {

  /**
   * Returns a Fraction object from a a numerator and denominator.
   *
   * This method should be identical to the fraction() function in
   * fraction.module.
   *
   * @param $numerator
   *   The fraction's numerator.
   * @param $denominator
   *   The fraction's denominator.
   *
   * @return \Drupal\fraction\Fraction
   *   Returns a $this->fraction object.
   */
  protected function fraction($numerator = 0, $denominator = 1) {
    return new Fraction($numerator, $denominator);
  }

  /**
   * Test the Fraction class and it's methods.
   */
  public function testFraction() {

    // Test creation of a fraction.
    $fraction = $this
      ->fraction(1, 2);
    $numerator = $fraction
      ->getNumerator();
    $denominator = $fraction
      ->getDenominator();
    $message = 'A fraction of 1/2 should return a numerator of 1.';
    $this
      ->assertEquals($numerator, '1', $message);
    $message = 'A fraction of 1/2 should return a denominator of 2.';
    $this
      ->assertEquals($denominator, '2', $message);

    // Test creation of an empty fraction.
    $fraction = $this
      ->fraction();
    $numerator = $fraction
      ->getNumerator();
    $denominator = $fraction
      ->getDenominator();
    $message = 'An empty fraction should return a numerator of 0.';
    $this
      ->assertEquals($numerator, '0', $message);
    $message = 'An empty fraction should return a denominator of 1.';
    $this
      ->assertEquals($denominator, '1', $message);

    // Test returning a fraction as a string.
    $result = $this
      ->fraction(1, 2)
      ->toString();
    $message = 'A fraction with a numerator of 1 and a denominator of 2 should return a string of "1/2".';
    $this
      ->assertEquals($result, '1/2', $message);

    // Test returning a fraction as a string with a different separator.
    $result = $this
      ->fraction(1, 2)
      ->toString(':');
    $message = 'A fraction with a numerator of 1 and a denominator of 2 should return a string of "1:2" (when a colon separator is specified).';
    $this
      ->assertEquals($result, '1:2', $message);

    // Test division by zero.
    $result = $this
      ->fraction(1, 0)
      ->toString();
    $message = 'A fraction of 1/0 should return 0/1 (avoid division by zero).';
    $this
      ->assertEquals($result, '0/1', $message);

    // Test normalization of negative fractions.
    $result = $this
      ->fraction(-1, 2)
      ->toString();
    $message = 'A fraction of -1/2 should normalize to -1/2.';
    $this
      ->assertEquals($result, '-1/2', $message);
    $result = $this
      ->fraction(1, -2)
      ->toString();
    $message = 'A fraction of 1/-2 should normalize to -1/2.';
    $this
      ->assertEquals($result, '-1/2', $message);
    $result = $this
      ->fraction(-1, -2)
      ->toString();
    $message = 'A fraction of -1/-2 should normalize to 1/2.';
    $this
      ->assertEquals($result, '1/2', $message);

    // Test converting a fraction to a decimal.
    $result = $this
      ->fraction(1, 2)
      ->toDecimal(1);
    $message = 'A fraction of 1/2 should return a decimal of 0.5 (with precision 1)';
    $this
      ->assertEquals($result, '0.5', $message);

    // Test decimal precision (rounding up).
    $result = $this
      ->fraction(1, 2)
      ->toDecimal(0);
    $message = 'A fraction of 1/2 with no precision should round to 1.';
    $this
      ->assertEquals($result, '1', $message);

    // Test decimal precision (rounding down).
    $result = $this
      ->fraction(2, 5)
      ->toDecimal(0);
    $message = 'A fraction of 2/5 with no precision should round to 0.';
    $this
      ->assertEquals($result, '0', $message);

    // Test automatic precision for base-10 denominator.
    $result = $this
      ->fraction(1, 1000)
      ->toDecimal(2, TRUE);
    $message = 'A fraction of 1/1000 with precision 2 and auto-precision enabled should round to 0.001.';
    $this
      ->assertEquals($result, '0.001', $message);

    // Test automatic precision for denominator of 1.
    $result = $this
      ->fraction(3, 1)
      ->toDecimal(0, TRUE);
    $message = 'A fraction of 3/1 should return a decimal of 3 (with precision 0, auto_precision)';
    $this
      ->assertEquals($result, '3', $message);

    // Test automatic precision for non-base-10 denominator.
    $result = $this
      ->fraction(1, 2)
      ->toDecimal(0, TRUE);
    $message = 'A fraction of 1/2 should return a decimal of 0.5 (with precision 0, auto_precision)';
    $this
      ->assertEquals($result, '0.5', $message);

    // Test creation of a fraction from a decimal.
    $result = Fraction::createFromDecimal(0.5)
      ->toString();
    $message = 'The createFromDecimal() method should create a fraction of 5/10 from a decimal of 0.5.';
    $this
      ->assertEquals($result, '5/10', $message);

    // Test creation of a fraction from a decimal (old constructor).
    $result = $this
      ->fraction()
      ->fromDecimal(0.5)
      ->toString();
    $message = 'The fromDecimal() method should create a fraction of 5/10 from a decimal of 0.5.';
    $this
      ->assertEquals($result, '5/10', $message);

    // Test calculation of greatest common divisor.
    $result = $this
      ->fraction(5, 10)
      ->gcd();
    $message = 'The greatest common divisor of 1/2 is 5.';
    $this
      ->assertEquals($result, '5', $message);

    // Test reduction of a fraction to its simplest form.
    $result = $this
      ->fraction(5, 10)
      ->reduce()
      ->toString();
    $message = 'A fraction of 5/10 should be reducible to 1/2.';
    $this
      ->assertEquals($result, '1/2', $message);

    // Test fraction addition.
    $result = $this
      ->fraction(1, 2)
      ->add($this
      ->fraction(1, 3))
      ->toString();
    $message = '1/2 + 1/3 = 5/6';
    $this
      ->assertEquals($result, '5/6', $message);

    // Test fraction subtraction.
    $result = $this
      ->fraction(2, 3)
      ->subtract($this
      ->fraction(1, 7))
      ->toString();
    $message = '2/3 - 1/7 = 11/21';
    $this
      ->assertEquals($result, '11/21', $message);

    // Test fraction multiplication.
    $result = $this
      ->fraction(2, 5)
      ->multiply($this
      ->fraction(1, 4))
      ->toString();
    $message = '2/5 * 1/4 = 2/20';
    $this
      ->assertEquals($result, '2/20', $message);

    // Test fraction division.
    $result = $this
      ->fraction(5, 7)
      ->divide($this
      ->fraction(1, 5))
      ->toString();
    $message = '5/7 / 1/5 = 25/7';
    $this
      ->assertEquals($result, '25/7', $message);

    // Test fraction reciprocation.
    $result = $this
      ->fraction(1, 2)
      ->reciprocate()
      ->toString();
    $message = 'The reciprocal of 1/2 is 2/1.';
    $this
      ->assertEquals($result, '2/1', $message);

    // Test that reciprocation of a zero numerator does not result in division
    // by zero.
    $result = $this
      ->fraction(0, 1)
      ->reciprocate()
      ->toString();
    $message = 'The reciprocal of 0/1 is 0/1 (avoid division by zero).';
    $this
      ->assertEquals($result, '0/1', $message);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FractionTest::fraction	protected	function	Returns a Fraction object from a a numerator and denominator.
FractionTest::testFraction	public	function	Test the Fraction class and it's methods.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUp	protected	function		340