Upgrade to modern PHP

.gitignore

@@ -1,3 +1,4 @@
 vendor/*
 *.lock
 index.php
+.phpunit.result.cache

README.md

@@ -45,11 +45,16 @@ $voucher = new Voucher(['code' => 'ALAN-COLE-CODE', 'claimed_by' => '', 'claimed
 print $voucher; // "ALAN-COLE-CODE"
 ```
 
-Any value passed on voucher creation can be get and set using `get()` and `set()` on the voucher.
+Any value passed on voucher creation can be get and set using magic getters and setters
 
 ```php
-$voucher->set('owner', 'Alan');
-echo $voucher->get('owner'); // Alan
+$voucher->setOwner('alan')
+echo $voucher->getOwner() // Alan
+
+$voucher->setIsClaimed(true);
+if($voucher->getIsClaimed() === true) {
+    // Sorry dave I can't do that.
+}
 ```
 
 ### Model

composer.json

@@ -6,5 +6,9 @@
         "psr-4": {
             "Vouchers\\": "src/Vouchers"
         }
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^10.0",
+        "phpstan/phpstan": "^1.10"
     }
 }

src/Vouchers/Bag.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers;
 
@@ -46,7 +46,7 @@ public function __construct(\Vouchers\Voucher\Model $model = null)
      *
      * @return void
      */
-    public function fill($number = 0)
+    public function fill($number = 0) :void
     {
         for ($i = 0; $i < $number; $i++) {
             $this->add(new Voucher());
@@ -77,7 +77,7 @@ public function pick(callable $callback = null)
      *
      * @return Voucher $voucher
      */
-    public function pickWithCallback(callable $callback)
+    public function pickWithCallback(callable $callback) :Voucher
     {
         foreach ($this->values as $voucher) {
             if ($callback($voucher)) {
@@ -96,7 +96,7 @@ public function pickWithCallback(callable $callback)
      *
      * @return void
      */
-    public function map(array $data, callable $callback)
+    public function map(array $data, callable $callback) :void
     {
         foreach ($data as $item) {
             $result = $callback($item);
@@ -114,7 +114,7 @@ public function map(array $data, callable $callback)
      *
      * @return bool
      */
-    public function pickValid()
+    public function pickValid() :Voucher
     {
         $voucher = null;
         foreach ($this->values as $value) {
@@ -144,7 +144,7 @@ public function pickValid()
      *
      * @return bool
      */
-    public function validate($code)
+    public function validate($code) :bool
     {
         foreach ($this->validators as $rule) {
             $callback = $rule['callback'];
@@ -166,7 +166,7 @@ public function validate($code)
      *
      * @return void
      */
-    public function validator(callable $callback, $message = self::VALIDATION_MESSAGE)
+    public function validator(callable $callback, $message = self::VALIDATION_MESSAGE) :void
     {
         $rule = [
             'message'  => $message,
@@ -182,7 +182,7 @@ public function validator(callable $callback, $message = self::VALIDATION_MESSAG
      *
      * @return void
      */
-    public function add(Voucher $voucher)
+    public function add(Voucher $voucher) :void
     {
         if ($this->model) {
             $this->model->validate($voucher->toArray());
@@ -196,9 +196,9 @@ public function add(Voucher $voucher)
      *
      * @param string $code
      *
-     * @return string|Voucher
+     * @return bool|Voucher
      */
-    public function find($code)
+    public function find($code) :bool|Voucher
     {
         foreach ($this->values as $key => $voucher) {
             if ($code == (string) $voucher) {

src/Vouchers/Bag/Collection.php

@@ -1,8 +1,10 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers\Bag;
 
-class Collection implements \Iterator
+use Iterator;
+
+class Collection implements Iterator
 {
     /**
      * Holds all of our 'vouchers'.
@@ -16,31 +18,31 @@ class Collection implements \Iterator
      *
      * @return mixed
      */
-    public function current()
+    public function current() :mixed
     {
         return current($this->values);
     }
 
     /**
      * Returns the key of our current.
      */
-    public function key()
+    public function key() :mixed
     {
         return key($this->values);
     }
 
     /**
      * Moves array to next array item.
      */
-    public function next()
+    public function next() :void
     {
         return next($this->values);
     }
 
     /**
      * Reset the array.
      */
-    public function rewind()
+    public function rewind() :void
     {
         return reset($this->values);
     }
@@ -50,7 +52,7 @@ public function rewind()
      *
      * @return int
      */
-    public function count()
+    public function count() :int
     {
         return count($this->values);
     }
@@ -59,7 +61,7 @@ public function count()
      * Make sure the key is a real one
      * or loops will last forever.
      */
-    public function valid()
+    public function valid() :bool
     {
         $key = key($this->values);
 
@@ -71,7 +73,7 @@ public function valid()
      *
      * @return array
      */
-    public function toArray()
+    public function toArray() :array
     {
         $collection = [];
         foreach ($this->values as $value) {

src/Vouchers/Exceptions/ImmutableData.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers\Exceptions;
 

src/Vouchers/Exceptions/NoValidVouchers.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers\Exceptions;
 

src/Vouchers/Exceptions/ValidationCallbackFail.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers\Exceptions;
 

src/Vouchers/Exceptions/VoucherCodeInvalid.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers\Exceptions;
 

src/Vouchers/Exceptions/VoucherValidationFailed.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers\Exceptions;
 

src/Vouchers/Voucher.php

@@ -1,7 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Vouchers;
 
+use Vouchers\Voucher\Code\GeneratorInterface;
+
 class Voucher
 {
     /**
@@ -55,7 +57,7 @@ public function __construct(array $data = [], Voucher\Model $model = null)
      *
      * @return void
      */
-    private function parseData(array $data = [], Voucher\Model $model = null)
+    private function parseData(array $data = [], Voucher\Model $model = null) :void
     {
         // Validate Model
         if ($model) {
@@ -73,7 +75,7 @@ private function parseData(array $data = [], Voucher\Model $model = null)
      *
      * @return void
      */
-    private function setArrayAsData(array $data)
+    private function setArrayAsData(array $data) :void
     {
         $this->data = array_merge($data, $this->data);
     }
@@ -83,7 +85,7 @@ private function setArrayAsData(array $data)
      *
      * @return void
      */
-    private function generateVoucherCodeIfEmpty()
+    private function generateVoucherCodeIfEmpty() :void
     {
         $this->data[self::VOUCHER_CODE_KEY] = isset($this->data[self::VOUCHER_CODE_KEY]) ?
             $this->data[self::VOUCHER_CODE_KEY] :
@@ -98,7 +100,7 @@ private function generateVoucherCodeIfEmpty()
      *
      * @return void
      */
-    private function processDataWithModel(array $data, Voucher\Model $model)
+    private function processDataWithModel(array $data, Voucher\Model $model) :void
     {
         $model->validate($data);
         $this->data = array_merge($this->data, $data);
@@ -124,7 +126,7 @@ private function processDataWithModel(array $data, Voucher\Model $model)
      *
      * @return string
      */
-    public function generate()
+    public function generate() :string
     {
         $generator = new $this->generator();
 
@@ -138,7 +140,7 @@ public function generate()
      *
      * @return mixed
      */
-    public function get($key)
+    public function get($key) :?string
     {
         return array_key_exists($key, $this->data) ? $this->data[$key] : null;
     }
@@ -151,7 +153,7 @@ public function get($key)
      *
      * @return mixed $value
      */
-    public function set($key, $value)
+    public function set($key, $value) :?string
     {
         if (in_array($key, $this->immutable)) {
             throw new \Vouchers\Exceptions\ImmutableData();
@@ -165,9 +167,9 @@ public function set($key, $value)
     /**
      * Static function to get generator class.
      *
-     * @return string
+     * @return GeneratorInterface
      */
-    public function getGenerator()
+    public function getGenerator() :GeneratorInterface
     {
         return $this->generator;
     }
@@ -179,7 +181,7 @@ public function getGenerator()
      *
      * @return void
      */
-    public function addImmutableKey($key)
+    public function addImmutableKey($key) :void
     {
         array_push($this->immutable, $key);
     }
@@ -189,7 +191,7 @@ public function addImmutableKey($key)
      *
      * @return string
      */
-    public function __toString()
+    public function __toString() :string
     {
         return $this->data[self::VOUCHER_CODE_KEY];
     }
@@ -199,8 +201,57 @@ public function __toString()
      *
      * @return array
      */
-    public function toArray()
+    public function toArray() :array
     {
         return $this->data;
     }
+
+    /**
+     * Add a magic call to get and set.
+     * 
+     * @param string $method
+     * @param array  $args
+     * 
+     * @return mixed
+     */
+    public function __call($method, $args)
+    {
+        # if we start with get
+        if (substr($method, 0, 3) == 'get') {
+            $key = lcfirst(substr($method, 3));
+
+            # split the key at its capital letters
+            $key = preg_split('/(?=[a-Z])/', $key);
+
+            # join the key with underscores
+            $key_string = "";
+            foreach($key as $k => $v) {
+                $key_string .= $v;
+                if($k < count($key) - 1) {
+                    $key_string .= "_";
+                }
+            }
+
+            return $this->get($key_string);
+        } 
+
+        # if we start with set
+        if (substr($method, 0, 3) == 'set') {
+            $key = lcfirst(substr($method, 3));
+
+            # split the key at its capital letters
+            $key = preg_split('/(?=[a-Z])/', $key);
+
+            # join the key with underscores
+            $key_string = "";
+            foreach ($key as $k => $v) {
+                $key_string .= $v;
+                if ($k < count($key) - 1) {
+                    $key_string .= "_";
+                }
+            }
+
+            return $this->set($key_string, $args[0]);
+        }
+    }
 }