Merge branch 'release/1.0.0-beta'

Author: ollieread

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0-beta] - 2020-03-03
+### Updated
+- Upgraded Laravel support to include 7.x 
+
+### Added
+- Add a user password validation rule
+- Base abstract operation class
+- Added castable for CarbonInterval and UUID
+
+### Changed
+- Moved the operations contract to a more sensible namespace
+
 ## [1.0.2-alpha] - 2020-01-19
 ### Changed
 - Disabled the query grammar override for now
@@ -18,7 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.0-alpha] - 2020-01-17
 - Initial release
 
-[Unreleased]: https://github.com/sprocketbox/laravel-toolkit/compare/v1.0.2-alpha...develop
+[Unreleased]: https://github.com/sprocketbox/laravel-toolkit/compare/v1.0.0-beta...develop
+[1.0.0-beta]: https://github.com/sprocketbox/laravel-toolkit/compare/v1.0.1-alpha...v1.0.0-beta
 [1.0.2-alpha]: https://github.com/sprocketbox/laravel-toolkit/compare/v1.0.1-alpha...v1.0.2-alpha
 [1.0.1-alpha]: https://github.com/sprocketbox/laravel-toolkit/compare/v1.0.0-alpha...v1.0.1-alpha
 [1.0.0-alpha]: https://github.com/sprocketbox/laravel-toolkit/releases/tag/v1.0.0-alpha

composer.json

@@ -26,9 +26,9 @@
   },
   "require": {
     "php": "^7.4",
-    "illuminate/routing": "^6.0",
-    "illuminate/database": "^6.0",
-    "illuminate/validation": "^6.0"
+    "illuminate/routing": "^6.0 || ^7.0",
+    "illuminate/database": "^6.0 || ^7.0",
+    "illuminate/validation": "^6.0 || ^7.0"
   },
   "extra": {
     "laravel": {

src/Database/Casts/IntervalCast.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Sprocketbox\Toolkit\Database\Casts;
+
+use Carbon\CarbonInterval;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+class IntervalCast implements CastsAttributes
+{
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string                              $key
+     * @param mixed                               $value
+     * @param array                               $attributes
+     *
+     * @return mixed|void
+     * @throws \Exception
+     */
+    public function get($model, string $key, $value, array $attributes): CarbonInterval
+    {
+        return new CarbonInterval($value);
+    }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string                              $key
+     * @param CarbonInterval                      $value
+     * @param array                               $attributes
+     *
+     * @return string
+     */
+    public function set($model, string $key, $value, array $attributes): string
+    {
+        return $value->spec();
+    }
+}

src/Database/Casts/UUIDCast.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Sprocketbox\Toolkit\Database\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\UuidInterface;
+
+class UUIDCast implements CastsAttributes
+{
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string                              $key
+     * @param string                              $value
+     * @param array                               $attributes
+     *
+     * @return \Ramsey\Uuid\UuidInterface
+     */
+    public function get($model, string $key, $value, array $attributes): UuidInterface
+    {
+        return Uuid::fromString($value);
+    }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string                              $key
+     * @param \Ramsey\Uuid\UuidInterface          $value
+     * @param array                               $attributes
+     *
+     * @return string
+     */
+    public function set($model, string $key, $value, array $attributes): string
+    {
+        return $value->toString();
+    }
+}

src/Http/Contracts/Operation.php renamed to src/Operations/Contracts/Operation.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Sprocketbox\Toolkit\Http\Contracts;
+namespace Sprocketbox\Toolkit\Operations\Contracts;
 
 /**
  * Interface Operation

src/Operations/Operation.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Sprocketbox\Toolkit\Operations;
+
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Support\Str;
+use InvalidArgumentException;
+
+abstract class Operation implements Contracts\Operation
+{
+    /**
+     * @return static
+     */
+    public static function start(): self
+    {
+        try {
+            return Container::getInstance()->make(__CLASS__, func_get_args());
+        } catch (BindingResolutionException $e) {
+            report($e);
+        }
+    }
+
+    /**
+     * Handle any calls to setters.
+     *
+     * Match the called setter name to a property name.
+     *
+     * @param $name
+     * @param $arguments
+     *
+     * @return self
+     */
+    public function __call($name, $arguments): self
+    {
+        // Error if there are no arguments provided
+        if (count($arguments) === 0) {
+            throw new InvalidArgumentException('Must provide a property value');
+        }
+
+        // If the property doesn't exist we're going to want to error
+        // There's no nice way to check if a property is actually accessible without using reflection
+        // which is overkill here, so we're going to let it error naturally
+        if (! property_exists($this, $name)) {
+            throw new InvalidArgumentException('Invalid operation property');
+        }
+
+        $this->$name = count($arguments) === 1 ? $arguments[0] : $arguments;
+
+        return $this;
+    }
+
+    /**
+     * Get an array of attributes using class properties, optionally skipping null entries.
+     *
+     * @param array<string>      $properties An array of properties to snake case and use as array keys
+     * @param bool|array<string> $skipIfNull True to skip null, false to not, or an array of properties to skip if null
+     *
+     * @return array
+     */
+    protected function getAttributes(array $properties, $skipIfNull = false): array
+    {
+        $attributes = [];
+
+        foreach ($properties as $property) {
+            $property = Str::camel($property);
+
+            if (! property_exists($this, $property)) {
+                throw new InvalidArgumentException(sprintf('Property %s on %s does not exist', self::class, $property));
+            }
+
+            if ($this->shouldSkip($property, $skipIfNull)) {
+                continue;
+            }
+
+            /** @noinspection NullCoalescingOperatorCanBeUsedInspection */
+            $attributes[Str::snake($property)] = isset($this->{$property}) ? $this->{$property} : null;
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * Check if the property should be skipped.
+     *
+     * @param string             $property
+     * @param bool|array<string> $skipIfNull
+     *
+     * @return bool
+     */
+    private function shouldSkip(string $property, $skipIfNull = false): bool
+    {
+        return (! isset($this->{$property}) && $this->{$property} === null)
+            && ($skipIfNull === true || (is_array($skipIfNull) && in_array($property, $skipIfNull, true)));
+    }
+}

src/Validators/Rules/Rules.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Sprocketbox\Toolkit\Validators\Rules;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Validation\Rules\Unique;
+
+class Rules
+{
+    /**
+     * @param \Illuminate\Database\Eloquent\Model|string $model
+     * @param string|null                                $column
+     *
+     * @return \Illuminate\Validation\Rules\Unique
+     */
+    public static function unique($model, ?string $column = null): Unique
+    {
+        $instance = $model instanceof Model ? $model : new $model;
+        $rule     = new Unique($instance->getTable(), $column ?? 'NULL');
+
+        if ($model instanceof Model) {
+            $rule->ignoreModel($model);
+        }
+
+        return $rule;
+    }
+
+    public static function password(?string $guard = null): UserPassword
+    {
+        return new UserPassword($guard);
+    }
+}

src/Validators/Rules/UserPassword.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Sprocketbox\Toolkit\Validators\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Hash;
+
+class UserPassword implements Rule
+{
+    /**
+     * @var string|null
+     */
+    protected ?string $guard;
+
+    public function __construct(?string $guard = null)
+    {
+        $this->guard = $guard;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function passes($attribute, $value)
+    {
+        $user = Auth::guard($this->guard)->user();
+
+        if ($user !== null) {
+            return Hash::check($value, $user->getAuthPassword());
+        }
+
+        return false;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function message()
+    {
+        return 'validation.user_password';
+    }
+}