Implement casting to Decimal in DecimalObjectCast trait

Author: AJenbo

Diff for: src/DecimalObjectCast.php

@@ -8,26 +8,104 @@
  * "decimal" cast uses `number_format`, but we can utilize the `toFixed` method
  * provided by Decimal\Decimal to prepare the value.
  *
- * This trait does not provide a cast from string to Decimal; this should be
- * done manually using an accessor like `getPriceAttribute`, which should return
- * a new Decimal\Decimal using the precision of the column in the database.
+ * This trait extends the default behavior by allowing the precision and scale
+ * of the decimal value to be specified via the attribute's casting definition.
+ * For example, `decimal:2:8` would cast the attribute to a Decimal with 2 digits
+ * of scale and 8 digits of precision.
  */
 trait DecimalObjectCast
 {
     /**
-     * Return a decimal as string to be written to the database.
+     * Get all of the current attributes on the model for an insert operation.
      *
-     * @see \Illuminate\Database\Eloquent\Concerns\HasAttributes::asDecimal
+     * @return array<mixed>
+     */
+    protected function getAttributesForInsert()
+    {
+        $attributes = parent::getAttributes();
+
+        foreach ($attributes as $key => $value) {
+            if ($value instanceof Decimal) {
+                $attributes[$key] = $this->toString($key, $value);
+            }
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * Determine if the new and old values for a given key are equivalent.
      *
-     * @param  Decimal  $value
-     * @param  int      $decimals
+     * @param string $key
      *
-     * @return \Decimal\Decimal
+     * @return bool
      */
-    protected function asDecimal($value, $decimals)
+    public function originalIsEquivalent($key)
+    {
+        $castTypeIsDecimal = false;
+        $casts = $this->getCasts();
+        if (array_key_exists($key, $casts)) {
+            $castTypeIsDecimal = $this->isDecimalCast($casts[$key]);
+        }
+
+        $attribute = $this->attributes[$key] ?? null;
+        $original = $this->original[$key] ?? null;
+
+        if (!$castTypeIsDecimal && !$attribute instanceof Decimal && !$original instanceof Decimal) {
+            return parent::originalIsEquivalent($key);
+        }
+
+        if ($attribute instanceof Decimal) {
+            $attribute = $this->toString($key, $attribute);
+        }
+        if ($original instanceof Decimal) {
+            $original = $this->toString($key, $original);
+        }
+
+        return $attribute === $original;
+    }
+
+    private function toString(string $key, Decimal $value): string
     {
-        assert($value instanceof Decimal);
-        
-        return $value->toFixed($decimals, $commas = false, PHP_ROUND_HALF_UP);
+        $casts = $this->getCasts();
+        if (!array_key_exists($key, $casts)) {
+            return (string)$value;
+        }
+
+        $castType = $casts[$key];
+        if (!$this->isDecimalCast($castType)) {
+            return $value;
+        }
+
+        $decimals = explode(':', $castType)[1];
+
+        return $value->toFixed($decimals, false, PHP_ROUND_HALF_UP);
+    }
+
+    /**
+     * Cast an attribute to a native PHP type.
+     *
+     * @see \Illuminate\Database\Eloquent\Concerns\HasAttributes::castAttribute
+     *
+     * @param string $key
+     * @param mixed  $value Raw value
+     *
+     * @return mixed Transformed value
+     */
+    protected function castAttribute($key, $value)
+    {
+        if ($value !== null) {
+            $casts = $this->getCasts();
+            if (array_key_exists($key, $casts)) {
+                $castType = $casts[$key];
+                if ($this->isDecimalCast($castType)) {
+                    $precision = explode(':', $castType)[2] ?? Decimal::DEFAULT_PRECISION;
+
+                    return new Decimal($value, $precision);
+                }
+            }
+        }
+
+        return parent::castAttribute($key, $value);
     }
 }