Fix issue where conical frustum is subtracted instead of added

DeBoerTool · Aug 16, 2019 · 0713a8f · 0713a8f
1 parent b7f2650
commit 0713a8f
Show file tree

Hide file tree

Showing 17 changed files with 68 additions and 41 deletions.
diff --git a/src/Common/Abstracts/AbstractSolid.php b/src/Common/Abstracts/AbstractSolid.php
@@ -19,7 +19,10 @@
 
 abstract class AbstractSolid implements Solid
 {
-    /** @var ConverterInterface */
+    /**
+     * @var ConverterInterface
+     * @psalm-suppress PropertyNotSetInConstructor
+     */
     protected $converter;
 
     public function setConverter (?ConverterInterface $converter): void

diff --git a/src/Common/Abstracts/AbstractVolumetricUnit.php b/src/Common/Abstracts/AbstractVolumetricUnit.php
@@ -2,20 +2,17 @@
 
 namespace Dbt\Volumes\Common\Abstracts;
 
-use Dbt\Volumes\Common\Interfaces\LinearUnit as LinearUnitInterface;
-use Dbt\Volumes\Common\Interfaces\VolumetricUnit as UnitInterface;
+use Dbt\Volumes\Common\Interfaces\LinearUnit;
+use Dbt\Volumes\Common\Interfaces\VolumetricUnit;
 
-abstract class AbstractVolumetricUnit implements UnitInterface
+abstract class AbstractVolumetricUnit implements VolumetricUnit
 {
     /** @var string */
     protected $postfix = '';
 
     /** @var string */
     protected $name = '';
 
-    /** @var string */
-    protected $base = '';
-
     public function postfix (): string
     {
         return $this->postfix;
@@ -31,8 +28,5 @@ public function __toString (): string
         return $this->postfix();
     }
 
-    public function getBaseLinearUnit (): LinearUnitInterface
-    {
-        return new $this->base;
-    }
+    abstract public function getBaseLinearUnit (): LinearUnit;
 }
diff --git a/src/Common/Exceptions/NoConversionFound.php b/src/Common/Exceptions/NoConversionFound.php
@@ -6,6 +6,7 @@
 
 class NoConversionFound extends Exception
 {
+    /** @var string */
     public static $format = 'No conversion found for %s to %s';
 
     public static function of (string $from, string $to): self

diff --git a/src/Common/Interfaces/AngularDim.php b/src/Common/Interfaces/AngularDim.php
@@ -5,11 +5,6 @@
 interface AngularDim extends Dim
 {
     public function unit (): AngularUnit;
-
-    /**
-     * @param \Dbt\Volumes\Common\Interfaces\AngularUnit|null $unit
-     * @return \Dbt\Volumes\Common\Interfaces\AngularDim
-     */
     public function of (float $value, $unit);
     public function max (float $value): AngularDim;
 }
diff --git a/src/Common/Interfaces/Dim.php b/src/Common/Interfaces/Dim.php
@@ -6,10 +6,15 @@ interface Dim
 {
     public function value (): float;
     public function hasSameUnit (Dim $dim): bool;
+
+    /**
+     * @param \Dbt\Volumes\Common\Interfaces\VolumetricUnit|\Dbt\Volumes\Common\Interfaces\LinearUnit|\Dbt\Volumes\Common\Interfaces\AngularUnit $unit
+     * @return \Dbt\Volumes\Common\Interfaces\VolumetricDim|\Dbt\Volumes\Common\Interfaces\LinearDim|\Dbt\Volumes\Common\Interfaces\AngularDim
+     */
     public function of (float $value, $unit);
 
     /**
-     * @return \Dbt\Volumes\Common\Interfaces\VolumetricUnit|\Dbt\Volumes\Common\Interfaces\LinearUnit
+     * @return \Dbt\Volumes\Common\Interfaces\VolumetricUnit|\Dbt\Volumes\Common\Interfaces\LinearUnit|\Dbt\Volumes\Common\Interfaces\AngularUnit
      */
     public function unit ();
 }
diff --git a/src/Common/Interfaces/LinearDim.php b/src/Common/Interfaces/LinearDim.php
@@ -7,12 +7,8 @@ interface LinearDim extends Dim
     public function unit (): LinearUnit;
     public function times (float $multiplier): LinearDim;
     public function minus (LinearDim $dim): LinearDim;
+    public function plus (LinearDim $dim): LinearDim;
     public function max (float $value): LinearDim;
     public function lessThan (LinearDim $dim): bool;
-
-    /**
-     * @param \Dbt\Volumes\Common\Interfaces\LinearUnit|null $unit
-     * @return \Dbt\Volumes\Common\Interfaces\LinearDim
-     */
     public function of (float $value, $unit);
 }
diff --git a/src/Common/Interfaces/VolumetricDim.php b/src/Common/Interfaces/VolumetricDim.php
@@ -7,10 +7,5 @@ interface VolumetricDim extends Dim
     public function unit (): VolumetricUnit;
     public function times (float $multiplier): VolumetricDim;
     public function plus (VolumetricDim $addend): VolumetricDim;
-
-    /**
-     * @param \Dbt\Volumes\Common\Interfaces\VolumetricUnit|null $unit
-     * @return \Dbt\Volumes\Common\Interfaces\VolumetricDim
-     */
     public function of (float $value, $unit);
 }
diff --git a/src/Composite.php b/src/Composite.php
@@ -10,8 +10,11 @@
 class Composite extends AbstractSolid implements Model
 {
     /** @var \Dbt\Volumes\Common\Interfaces\Solid[] */
-    private $items;
+    private $items = [];
 
+    /**
+     * @param Solid|Solid[] $solids
+     */
     public function __construct ($solids, Converter $converter = null)
     {
         $this->setConverter($converter);

diff --git a/src/ConicalFrustumWithAngle.php b/src/ConicalFrustumWithAngle.php
@@ -26,6 +26,6 @@ public function __construct (
         $opposite = new Line(tan($angle->value()), $this->baseLinearUnit());
 
         /** @var RadialDim $bottom */
-        $this->bottom = $this->top->minus($opposite);
+        $this->bottom = $this->top->plus($opposite);
     }
 }
diff --git a/src/Converters/Conversions.php b/src/Converters/Conversions.php
@@ -33,12 +33,12 @@ public static function listing (): array
             'radian' => [
                 'degree' => function (float $value): float {
                     return $value * (180 / pi());
-                }
+                },
             ],
             'degree' => [
                 'radian' => function (float $value): float {
                     return $value * (pi() / 180);
-                }
+                },
             ],
             'none' => [
                 'inch' => function (float $value): float {

diff --git a/src/Dimensions/Line.php b/src/Dimensions/Line.php
@@ -65,6 +65,13 @@ public function minus (LinearDim $dim): LinearDim
         return $this->of($this->value() - $dim->value());
     }
 
+    public function plus (LinearDim $dim): LinearDim
+    {
+        $this->assertSameUnit($dim);
+
+        return $this->of($this->value() + $dim->value());
+    }
+
     /*
      * Comparison
      */

diff --git a/src/Units/CubicInch.php b/src/Units/CubicInch.php
@@ -3,6 +3,7 @@
 namespace Dbt\Volumes\Units;
 
 use Dbt\Volumes\Common\Abstracts\AbstractVolumetricUnit;
+use Dbt\Volumes\Common\Interfaces\LinearUnit;
 
 class CubicInch extends AbstractVolumetricUnit
 {
@@ -12,6 +13,8 @@ class CubicInch extends AbstractVolumetricUnit
     /** @var string */
     protected $name = 'cubic inch';
 
-    /** @var string */
-    protected $base = Inch::class;
+    public function getBaseLinearUnit (): LinearUnit
+    {
+        return new Inch();
+    }
 }
diff --git a/src/Units/CubicMillimeter.php b/src/Units/CubicMillimeter.php
@@ -3,6 +3,7 @@
 namespace Dbt\Volumes\Units;
 
 use Dbt\Volumes\Common\Abstracts\AbstractVolumetricUnit;
+use Dbt\Volumes\Common\Interfaces\LinearUnit;
 
 class CubicMillimeter extends AbstractVolumetricUnit
 {
@@ -12,6 +13,8 @@ class CubicMillimeter extends AbstractVolumetricUnit
     /** @var string */
     protected $name = 'cubic millimeter';
 
-    /** @var string */
-    protected $base = Millimeter::class;
+    public function getBaseLinearUnit (): LinearUnit
+    {
+        return new Millimeter();
+    }
 }
diff --git a/tests/ConicalFrustumWithAngleTest.php b/tests/ConicalFrustumWithAngleTest.php
@@ -19,7 +19,7 @@ public function calculating_the_volume ()
         $height = new Line(2, $unit);
         $angle = new Angle(3, $unit);
         /** @var \Dbt\Volumes\Common\Interfaces\RadialDim $bottom */
-        $bottom = $top->minus(new Radius(tan(3), $unit));
+        $bottom = $top->plus(new Radius(tan(3), $unit));
 
         $shape1 = new ConicalFrustum($top, $bottom, $height);
         $shape2 = new ConicalFrustumWithAngle($top, $height, $angle);

diff --git a/tests/Dimensions/AngleTest.php b/tests/Dimensions/AngleTest.php
@@ -3,11 +3,8 @@
 namespace Dbt\Volumes\Tests\Dimensions;
 
 use Dbt\Volumes\Dimensions\Angle;
-use Dbt\Volumes\Dimensions\Line;
 use Dbt\Volumes\Tests\UnitTestCase;
 use Dbt\Volumes\Units\Degree;
-use Dbt\Volumes\Units\Inch;
-use Dbt\Volumes\Units\Millimeter;
 use Dbt\Volumes\Units\None;
 use Dbt\Volumes\Units\Radian;
 

diff --git a/tests/Dimensions/LineTest.php b/tests/Dimensions/LineTest.php
@@ -114,4 +114,31 @@ public function failing_to_compare ()
 
         $vo1->lessThan($vo2);
     }
+
+    /** @test */
+    public function adding_immutably ()
+    {
+        $value1 = (float) rand(1, 99999);
+        $value2 = (float) rand(1, 99999);
+        $expected = $value1 + $value2;
+        $unit = new None();
+
+        $vo1 = new Line($value1, $unit);
+        $vo2 = new Line($value2, $unit);
+
+        $this->assertSame($expected, $vo1->plus($vo2)->value());
+        $this->assertNotSame($vo1, $vo1->plus($vo2));
+        $this->assertNotSame($vo2, $vo1->plus($vo2));
+    }
+
+    /** @test */
+    public function failing_to_add ()
+    {
+        $this->expectException(WrongUnit::class);
+
+        $vo1 = new Line(1.0, new Inch());
+        $vo2 = new Line(2.0, new Millimeter());
+
+        $vo1->plus($vo2);
+    }
 }
diff --git a/tests/Dimensions/VolumeTest.php b/tests/Dimensions/VolumeTest.php
@@ -5,9 +5,7 @@
 use Dbt\Volumes\Common\Exceptions\WrongUnit;
 use Dbt\Volumes\Dimensions\Volume;
 use Dbt\Volumes\Tests\UnitTestCase;
-use Dbt\Volumes\Units\CubicInch;
 use Dbt\Volumes\Units\CubicMillimeter;
-use Dbt\Volumes\Units\Inch;
 use Dbt\Volumes\Units\None;
 
 class VolumeTest extends UnitTestCase