Project Setup

Author: bajb

.gitignore

@@ -1,6 +1,3 @@
 composer.phar
+composer.lock
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock

README.md

@@ -1 +1,3 @@
-# mv
+# mv - Model View
+
+Recommended structure for frontend Model/View

composer.json

@@ -0,0 +1,22 @@
+{
+  "require": {
+    "packaged/safehtml": "^2.2",
+    "packaged/ui": "^1.7",
+    "packaged/context": "^1.0",
+    "packaged/helpers": "^1.0|^2.0"
+  },
+  "require-dev": {
+    "cubex/framework": "^4.17",
+    "phpunit/phpunit": "^9"
+  },
+  "autoload": {
+    "psr-4": {
+      "Cubex\\Mv\\": "src"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Cubex\\Mv\\Tests\\": "tests"
+    }
+  }
+}

src/AbstractView.php

@@ -0,0 +1,14 @@
+<?php
+namespace Cubex\Mv;
+
+abstract class AbstractView implements View
+{
+  protected ?Model $_model;
+
+  public function __construct(?Model $data) { $this->_model = $data; }
+
+  public function render(): string
+  {
+    return $this->produceSafeHTML()->getContent();
+  }
+}

src/ArrayModel.php

@@ -0,0 +1,43 @@
+<?php
+namespace Cubex\Mv;
+
+class ArrayModel extends ViewModel
+{
+  protected array $_data = [];
+
+  public function clear()
+  {
+    $this->_data = [];
+    return $this;
+  }
+
+  public function set(array $data = [])
+  {
+    $this->_data = $data;
+    return $this;
+  }
+
+  public function addItem($value, string $key = null)
+  {
+    if($key === null)
+    {
+      $this->_data[] = $value;
+    }
+    else
+    {
+      $this->_data[$key] = $value;
+    }
+    return $this;
+  }
+
+  public function getData()
+  {
+    return $this->_data;
+  }
+
+  public function jsonSerialize()
+  {
+    return $this->_data;
+  }
+
+}

src/JsonView.php

@@ -0,0 +1,43 @@
+<?php
+namespace Cubex\Mv;
+
+use Packaged\SafeHtml\SafeHtml;
+
+class JsonView extends AbstractView
+{
+  protected int $_flags = JSON_PRETTY_PRINT;
+
+  public function produceSafeHTML(): SafeHtml
+  {
+    return new SafeHtml($this->render());
+  }
+
+  /**
+   * @param int $flags
+   *
+   *                   Bitmask consisting of <b>JSON_HEX_QUOT</b>,
+   *                   <b>JSON_HEX_TAG</b>,
+   *                   <b>JSON_HEX_AMP</b>,
+   *                   <b>JSON_HEX_APOS</b>,
+   *                   <b>JSON_NUMERIC_CHECK</b>,
+   *                   <b>JSON_PRETTY_PRINT</b>,
+   *                   <b>JSON_UNESCAPED_SLASHES</b>,
+   *                   <b>JSON_FORCE_OBJECT</b>,
+   *                   <b>JSON_UNESCAPED_UNICODE</b>.
+   *                   <b>JSON_THROW_ON_ERROR</b> The behaviour of these
+   *                   constants is described on
+   *                   the JSON constants page.
+   *
+   * @return $this
+   */
+  public function setFlags(int $flags = 0)
+  {
+    $this->_flags = $flags;
+    return $this;
+  }
+
+  public function render(): string
+  {
+    return json_encode($this->_model, $this->_flags);
+  }
+}

src/Model.php

@@ -0,0 +1,6 @@
+<?php
+namespace Cubex\Mv;
+
+interface Model extends \JsonSerializable
+{
+}

src/View.php

@@ -0,0 +1,13 @@
+<?php
+namespace Cubex\Mv;
+
+use Packaged\SafeHtml\ISafeHtmlProducer;
+use Packaged\Ui\Renderable;
+
+/**
+ * A view must be constructed with a model
+ */
+interface View extends ISafeHtmlProducer, Renderable
+{
+  public function __construct(?Model $data);
+}

src/ViewModel.php

@@ -0,0 +1,31 @@
+<?php
+namespace Cubex\Mv;
+
+use Packaged\Context\ContextAware;
+use Packaged\Context\ContextAwareTrait;
+use Packaged\Helpers\Objects;
+
+class ViewModel implements Model, ContextAware
+{
+  use ContextAwareTrait;
+
+  public function jsonSerialize()
+  {
+    $values = Objects::propertyValues($this);
+    return empty($values) ? $this : $values;
+  }
+
+  public function createView(string $viewClass)
+  {
+    if(!class_exists($viewClass))
+    {
+      throw new \Exception("Invalid view class provided '$viewClass'");
+    }
+    $view = new $viewClass($this);
+    if($view instanceof ContextAware && $this->hasContext())
+    {
+      $view->setContext($this->getContext());
+    }
+    return $view;
+  }
+}

tests/JsonViewTest.php

@@ -0,0 +1,52 @@
+<?php
+namespace Cubex\Mv\Tests;
+
+use Cubex\Mv\ArrayModel;
+use Cubex\Mv\JsonView;
+use Cubex\Mv\Model;
+use Cubex\Mv\ViewModel;
+use PHPUnit\Framework\TestCase;
+
+class JsonViewTest extends TestCase
+{
+  /**
+   * @dataProvider viewResults
+   */
+  public function testResults($testName, $model, $flags, $expect)
+  {
+    $view = new JsonView($model);
+    if(is_int($flags))
+    {
+      $view->setFlags($flags);
+    }
+    self::assertEquals($expect, $view->render(), $testName . " - Render");
+    self::assertEquals($expect, $view->produceSafeHTML()->getContent(), $testName . " - SafeHtml");
+  }
+
+  public function viewResults()
+  {
+    return [
+      ["Null Check", null, null, "null"],
+      ["Simple Json", new JsonViewTestData(), 0, '{"a":"b"}'],
+      ["Empty", new ViewModel(), 0, '{}'],
+      ["Array", $this->_arrayModel(), 0, '["a","b","c"]'],
+    ];
+  }
+
+  protected function _arrayModel()
+  {
+    $model = new ArrayModel();
+    $model->addItem("a");
+    $model->addItem("b");
+    $model->addItem("c");
+    return $model;
+  }
+}
+
+class JsonViewTestData implements Model
+{
+  public function jsonSerialize()
+  {
+    return ["a" => "b"];
+  }
+}

tests/ViewModelTest.php

@@ -0,0 +1,23 @@
+<?php
+namespace Cubex\Mv\Tests;
+
+use Cubex\Mv\JsonView;
+use Cubex\Mv\ViewModel;
+use PHPUnit\Framework\TestCase;
+
+class ViewModelTest extends TestCase
+{
+  public function testViewCreation()
+  {
+    $model = new ViewModel();
+    $view = $model->createView(JsonView::class);
+    self::assertInstanceOf(JsonView::class, $view);
+  }
+
+  public function testInvalidClassViewCreation()
+  {
+    self::expectExceptionMessage("Invalid view class provided 'NotAValidClass'");
+    $model = new ViewModel();
+    $model->createView("NotAValidClass");
+  }
+}