Merge pull request #96 from ltb-project/95-module-with-functions-to-check-for-mandatory-attributes

Add module for mandatory attributes check

Author: coudot

src/Ltb/Attributes.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Ltb;
+
+class Attributes {
+    public static function isMandatoryAttribute($config, $operation) {
+        if (!isset($config['mandatory']) || !is_array($config['mandatory'])) {
+            return false;
+        }
+
+        return in_array('all', $config['mandatory']) || in_array($operation, $config['mandatory']);
+    }
+
+    public static function mandatoryAttributeHasValue($value) {
+        if (is_array($value)) {
+            foreach ($value as $item) {
+                if ($item !== null && $item !== '') {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
+        return $value !== null && $value !== '';
+    }
+
+    public static function findMissingMandatoryAttributes($operation, $attributes_map, $entry_attributes, $items = null) {
+        $missing = array();
+
+        foreach ($attributes_map as $item => $config) {
+            if ($items !== null && !in_array($item, $items, true)) {
+                continue;
+            }
+
+            if (!self::isMandatoryAttribute($config, $operation)) {
+                continue;
+            }
+
+            $attribute = $config['attribute'] ?? null;
+            if (!$attribute || !self::mandatoryAttributeHasValue($entry_attributes[$attribute] ?? null)) {
+                $missing[] = $item;
+            }
+        }
+
+        return $missing;
+    }
+}

tests/Ltb/AttributesTest.php

@@ -0,0 +1,75 @@
+<?php
+
+require __DIR__ . '/../../vendor/autoload.php';
+use PHPUnit\Framework\TestCase;
+
+class MandatoryAttributesTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
+{
+    private function getAttributesMap()
+    {
+        return array(
+            'firstname' => array('attribute' => 'givenname', 'mandatory' => array('all')),
+            'lastname' => array('attribute' => 'sn', 'mandatory' => array('create')),
+            'fullname' => array('attribute' => 'cn', 'mandatory' => array('update')),
+            'title' => array('attribute' => 'title'),
+        );
+    }
+
+    public function testCreateRequiresMandatoryValues()
+    {
+        $missing = (new \Ltb\Attributes)->findMissingMandatoryAttributes(
+            'create',
+            $this->getAttributesMap(),
+            array(
+                'givenname' => array('Alice'),
+                'cn' => 'Alice Doe',
+            )
+        );
+
+        $this->assertSame(array('lastname'), $missing);
+    }
+
+    public function testCreateAcceptsMandatoryMacroValue()
+    {
+        $missing = (new \Ltb\Attributes)->findMissingMandatoryAttributes(
+            'create',
+            $this->getAttributesMap(),
+            array(
+                'givenname' => array('Alice'),
+                'sn' => 'Doe',
+            )
+        );
+
+        $this->assertSame(array(), $missing);
+    }
+
+    public function testUpdateChecksOnlyProposedMandatoryAttributes()
+    {
+        $missing = (new \Ltb\Attributes)->findMissingMandatoryAttributes(
+            'update',
+            $this->getAttributesMap(),
+            array(
+                'givenname' => array(),
+                'cn' => array(),
+            ),
+            array('fullname')
+        );
+
+        $this->assertSame(array('fullname'), $missing);
+    }
+
+    public function testUpdateIgnoresMandatoryAttributesNotProposedForChange()
+    {
+        $missing = (new \Ltb\Attributes)->findMissingMandatoryAttributes(
+            'update',
+            $this->getAttributesMap(),
+            array(
+                'givenname' => array(),
+                'cn' => array(),
+            ),
+            array('title')
+        );
+
+        $this->assertSame(array(), $missing);
+    }
+}