Initial commit

Author: vkovic

.gitignore

@@ -0,0 +1,25 @@
+#
+# OS generated files and junk
+#
+
+.DS_Store
+.DS_Store?
+._*
+Thumbs.db
+Icon?
+.Trashes
+ehthumbs.db
+*.log
+
+#
+# PhpStorm
+#
+
+.idea
+
+#
+# Project
+#
+
+vendor
+composer.lock

.travis.yml

@@ -0,0 +1,14 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+
+before_script:
+  - composer self-update
+  - composer install --prefer-source --no-interaction
+  - composer dump-autoload
+
+script:
+  - vendor/bin/phpunit

LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Movor <https://movor.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# Laravel custom casts for models
+
+[![Build](https://travis-ci.org/movor/laravel-custom-casts.svg?branch=master)](https://travis-ci.org/movor/laravel-custom-casts)
+[![Downloads](https://poser.pugx.org/movor/laravel-custom-casts/downloads)](https://packagist.org/packages/movor/laravel-custom-casts)
+[![Stable](https://poser.pugx.org/movor/laravel-custom-casts/v/stable)](https://packagist.org/packages/movor/laravel-custom-casts)
+[![License](https://poser.pugx.org/movor/laravel-custom-casts/license)](https://packagist.org/packages/movor/laravel-custom-casts)
+
+Make your own custom cast for Laravel model.
+
+***
+
+## Compatibility
+
+The package is compatible with Laravel versions 5.5.* and 5.6.*

composer.json

@@ -0,0 +1,38 @@
+{
+  "name": "movor/laravel-custom-casts",
+  "description": "Make your own custom cast for Laravel model",
+  "keywords": [
+    "laravel",
+    "model",
+    "casts",
+    "cast",
+    "datatype"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Vladimir Ković",
+      "email": "vlada.kovic@gmail.com"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "Movor\\LaravelCustomCasts\\": "src/package"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Movor\\LaravelCustomCasts\\Test\\": "tests"
+    }
+  },
+  "require": {
+    "laravel/framework": "5.5.*|5.6.*"
+  },
+  "require-dev": {
+    "orchestra/testbench": "3.5.*|3.6.*",
+    "orchestra/database": "3.5.*|3.6.*"
+  },
+  "scripts": {
+    "test": "vendor/bin/phpunit"
+  }
+}

phpunit.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="LaravelCustomCasts Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/package/CustomCastableBase.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Movor\LaravelCustomCasts;
+
+use Illuminate\Database\Eloquent\Model;
+
+abstract class CustomCastableBase
+{
+    /**
+     * Model
+     *
+     * @var Model
+     */
+    protected $model;
+
+    /**
+     * Corresponding db field (model attribute name)
+     *
+     * @var string
+     */
+    protected $attribute;
+
+    /**
+     * Set model
+     *
+     * @param Model $model
+     */
+    public function setModel(Model $model)
+    {
+        $this->model = $model;
+    }
+
+    /**
+     * Set model field name which is going to be custom casted
+     *
+     * @param $attribute
+     */
+    public function setAttribute($attribute)
+    {
+        $this->attribute = $attribute;
+    }
+
+    /**
+     * Enforce implementation in child classes
+     *
+     * Intercept value passed to model under specified field ($attribute)
+     * and change it to our will
+     *
+     * @param mixed $value Default value passed to model attribute
+     *
+     * @return mixed
+     */
+    abstract public function castAttribute($value);
+}

src/package/CustomCastableTrait.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Movor\LaravelCustomCasts;
+
+trait CustomCastableTrait
+{
+    /**
+     * Each field which is going to be custom casted
+     * will have its own custom cast instance in this array
+     *
+     * @var array
+     */
+    protected $customCastObjects = [];
+
+    /**
+     * Boot trait
+     */
+    public static function bootCustomCastableTrait()
+    {
+        // Enable custom cast classes to listen to model events
+        \Event::listen('eloquent.*: ' . get_called_class(), function ($event, $data) {
+            $eventName = explode('.', explode(':', $event)[0])[1];
+
+            /** @var self $model */
+            $model = $data[0];
+
+            if (!isset($model->customCasts)) {
+                self::throwInvalidCustomCastException($model);
+            }
+
+            foreach ($model->customCasts as $key => $value) {
+                $customCastObject = $model->getCustomCastObject($key);
+
+                if (method_exists($customCastObject, $eventName)) {
+                    $customCastObject->$eventName();
+                }
+            }
+        });
+    }
+
+    /**
+     * Hook into setAttribute logic and enable our custom cast do the job.
+     *
+     * This method is will override method in HasAttributes trait.
+     *
+     * @param $attribute
+     * @param $value
+     *
+     * @throws \Exception
+     *
+     * @return mixed
+     */
+    public function setAttribute($attribute, $value)
+    {
+        if (// Handle defined mutators in object and
+            // prioritize them against custom castable
+            !$this->hasSetMutator($attribute) &&
+
+            // Check if there is custom casts for this attribute
+            isset($this->customCasts) && array_key_exists($attribute, $this->customCasts)
+        ) {
+            $customCastObject = $this->getCustomCastObject($attribute);
+
+            // Cast attribute according to logic from custom cast object
+            $this->attributes[$attribute] = $customCastObject->castAttribute($value);
+
+            return $this;
+        }
+
+        return parent::setAttribute($attribute, $value);
+    }
+
+    /**
+     * Lazy load custom cast object and return it
+     *
+     * @param $attribute
+     *
+     * @throws \Exception
+     *
+     * @return CustomCastableBase
+     */
+    protected function getCustomCastObject($attribute)
+    {
+        // Check if custom cast object already been set
+        if (isset($this->customCastObjects[$attribute])) {
+            return $this->customCastObjects[$attribute];
+        }
+
+        // Check if custom casts property exists for this attribute
+        if (isset($this->customCasts) && array_key_exists($attribute, $this->customCasts)) {
+            $customCastClass = $this->customCasts[$attribute];
+
+            // Make sure that defined custom cast class is correct
+            if (!is_subclass_of($customCastClass, CustomCastableBase::class)) {
+                $message = "Custom cast class for '$attribute' needs to be extended from ";
+                $message .= CustomCastableBase::class;
+
+                throw new \Exception($message);
+            }
+
+            $customCastObject = new $customCastClass($this, $attribute);
+            return $this->customCastObjects[$attribute] = $customCastObject;
+        }
+
+        self::throwInvalidCustomCastException($this);
+    }
+
+    /**
+     * @param $model
+     *
+     * @throws \Exception
+     */
+    public static function throwInvalidCustomCastException($model)
+    {
+        $trait = CustomCastableTrait::class;
+        $model = self::class;
+        $message = "Model class '$model' which uses '$trait' needs to have 'customCast' array property defined";
+
+        throw new \Exception($message);
+    }
+}