README and change names

Author: asika32764

README.md

@@ -7,7 +7,7 @@
 use Brick\Math\BigDecimal;
 use Brick\Math\RoundingMode;
 
-abstract class AbstractBasicConverter extends AbstractConverter
+abstract class AbstractBasicMeasurement extends AbstractMeasurement
 {
     public const int OPTION_KEEP_ZERO = 1 << 0;
 

src/AbstractBasicConverter.php src/AbstractBasicMeasurement.phpsrc/AbstractBasicConverter.php renamed to src/AbstractBasicMeasurement.php

@@ -4,6 +4,7 @@
 
 namespace Asika\UnitConverter;
 
+use Asika\UnitConverter\Concerns\CalculationTrait;
 use Brick\Math\BigDecimal;
 use Brick\Math\BigNumber;
 use Brick\Math\Exception\RoundingNecessaryException;
@@ -12,14 +13,16 @@
 /**
  * @formatter:off
  *
- * @psalm-type SerializeCallback = \Closure(AbstractConverter $remainder, array<string, BigDecimal> $sortedUnits): string
- * @psalm-type FormatterCallback = \Closure(BigDecimal $value, string $unit, AbstractConverter $converter): string
+ * @psalm-type SerializeCallback = \Closure(AbstractMeasurement $remainder, array<string, BigDecimal> $sortedUnits): string
+ * @psalm-type FormatterCallback = \Closure(BigDecimal $value, string $unit, AbstractMeasurement $converter): string
  * @psalm-type SuffixNormalizerCallback = \Closure(string $suffix, BigDecimal $value, string $unit,  $converter): string
  *
  * @formatter:on
  */
-abstract class AbstractConverter implements \Stringable
+abstract class AbstractMeasurement implements \Stringable
 {
+    use CalculationTrait;
+
     public BigDecimal $value {
         set(mixed $value) => $this->value = BigDecimal::of($value);
     }

src/AbstractConverter.php src/AbstractMeasurement.phpsrc/AbstractConverter.php renamed to src/AbstractMeasurement.php

@@ -24,7 +24,7 @@
  * @method BigDecimal toSquareAcres(?int $scale = null, RoundingMode $roundingMode = RoundingMode::DOWN)
  * @method BigDecimal toSquareHectares(?int $scale = null, RoundingMode $roundingMode = RoundingMode::DOWN)
  */
-class Area extends AbstractBasicConverter
+class Area extends AbstractBasicMeasurement
 {
     public const string UNIT_SQUARE_FEMTOMETERS = 'fm2';
     public const string UNIT_SQUARE_PICOMETERS = 'pm2';

src/Area.php

@@ -4,16 +4,16 @@
 
 namespace Asika\UnitConverter\Compound;
 
-use Asika\UnitConverter\AbstractConverter;
+use Asika\UnitConverter\AbstractMeasurement;
 use Brick\Math\BigDecimal;
 use Brick\Math\RoundingMode;
 
-abstract class AbstractCompoundConverter extends AbstractConverter
+abstract class AbstractCompoundMeasurement extends AbstractMeasurement
 {
-    abstract public AbstractConverter $measure {
+    abstract public AbstractMeasurement $measure {
         get;
     }
-    abstract public AbstractConverter $deno {
+    abstract public AbstractMeasurement $deno {
         get;
     }
 

…c/Compound/AbstractCompoundConverter.php …Compound/AbstractCompoundMeasurement.phpsrc/Compound/AbstractCompoundConverter.php renamed to src/Compound/AbstractCompoundMeasurement.php src/Compound/AbstractCompoundConverter.php renamed to src/Compound/AbstractCompoundMeasurement.php

@@ -4,11 +4,11 @@
 
 namespace Asika\UnitConverter\Compound;
 
-use Asika\UnitConverter\AbstractConverter;
+use Asika\UnitConverter\AbstractMeasurement;
 use Asika\UnitConverter\Duration;
 use Asika\UnitConverter\FileSize;
 
-class Bitrate extends AbstractCompoundConverter
+class Bitrate extends AbstractCompoundMeasurement
 {
     public const string UNIT_BITS_PER_SECOND = 'bits/s';
 
@@ -30,11 +30,11 @@ class Bitrate extends AbstractCompoundConverter
 
     public const string UNIT_TIBPS = 'Tibps';
 
-    public AbstractConverter $measure {
+    public AbstractMeasurement $measure {
         get => $this->measure ??= new FileSize();
     }
 
-    public AbstractConverter $deno {
+    public AbstractMeasurement $deno {
         get => $this->deno ??= new Duration()
             ->withShortUnitFormatters();
     }

src/Compound/Bitrate.php

@@ -4,11 +4,11 @@
 
 namespace Asika\UnitConverter\Compound;
 
-use Asika\UnitConverter\AbstractConverter;
+use Asika\UnitConverter\AbstractMeasurement;
 use Asika\UnitConverter\Duration;
 use Asika\UnitConverter\Length;
 
-class Speed extends AbstractCompoundConverter
+class Speed extends AbstractCompoundMeasurement
 {
     public const string UNIT_MPS = 'mps';
     public const string UNIT_KPH = 'kph';
@@ -19,7 +19,7 @@ class Speed extends AbstractCompoundConverter
 
     public string $defaultUnit = 'm/s';
 
-    public AbstractConverter $measure {
+    public AbstractMeasurement $measure {
         get => $this->measure ??= new Length();
     }
 
@@ -29,7 +29,7 @@ class Speed extends AbstractCompoundConverter
         self::UNIT_KNOTS => 0.514444444,
     ];
 
-    public AbstractConverter $deno {
+    public AbstractMeasurement $deno {
         get => $this->deno ??= new Duration()
             ->withShortUnitFormatters();
     }

src/Compound/Speed.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Asika\UnitConverter\Concerns;
+
+use Brick\Math\BigDecimal;
+use Brick\Math\BigNumber;
+use Brick\Math\RoundingMode;
+
+trait CalculationTrait
+{
+    public function plus(
+        BigNumber|int|float|string|self $that,
+        ?int $scale = null,
+        RoundingMode $roundingMode = RoundingMode::UNNECESSARY,
+    ): static {
+        $new = clone $this;
+        $new->value = $new->value->plus($this->preprocessThat($that, $scale, $roundingMode));
+
+        return $new;
+    }
+
+    public function minus(
+        BigNumber|int|float|string|self $that,
+        ?int $scale = null,
+        RoundingMode $roundingMode = RoundingMode::UNNECESSARY,
+    ): static {
+        $new = clone $this;
+        $new->value = $new->value->minus($this->preprocessThat($that, $scale, $roundingMode));
+
+        return $new;
+    }
+
+    public function multipliedBy(
+        BigNumber|int|float|string $that,
+    ): static {
+        $new = clone $this;
+        $new->value = $new->value->multipliedBy($that);
+
+        return $new;
+    }
+
+    public function dividedBy(
+        BigNumber|int|float|string|self $that,
+        ?int $scale = null,
+        RoundingMode $roundingMode = RoundingMode::UNNECESSARY
+    ): static {
+        $new = clone $this;
+        $new->value = $new->value->dividedBy($that, $scale, $roundingMode);
+
+        return $new;
+    }
+
+    private function preprocessThat(
+        BigNumber|int|float|string|self $that,
+        ?int $scale = null,
+        RoundingMode $roundingMode = RoundingMode::UNNECESSARY,
+    ): BigDecimal {
+        if ($that instanceof self) {
+            return $that->convertTo($this->unit, $scale, $roundingMode)->value;
+        }
+
+        return BigDecimal::of($that);
+    }
+}

src/Concerns/CalculationTrait.php

@@ -28,7 +28,7 @@
  * @method BigDecimal toYears(?int $scale = null, RoundingMode $roundingMode = RoundingMode::DOWN)
  */
 // phpcs:disable
-class Duration extends AbstractBasicConverter
+class Duration extends AbstractBasicMeasurement
 {
     use DurationCalendlyTrait;
 

src/Duration.php

@@ -25,7 +25,7 @@
  * @method BigDecimal toGigawattHours(?int $scale = null, RoundingMode $roundingMode = RoundingMode::DOWN)
  * @method BigDecimal toTerawattHours(?int $scale = null, RoundingMode $roundingMode = RoundingMode::DOWN)
  */
-class Energy extends AbstractBasicConverter
+class Energy extends AbstractBasicMeasurement
 {
     // The atom energy unit
     public const string UNIT_JOULE = 'j';