Update README.md and now 'render()' method will thrown 'LogicException' if response instance not been set

closes #5

Signed-off-by: Fery Wardiyanto <[email protected]>

Author: feryardiant

README.md

@@ -36,7 +36,7 @@ $container->register(new \Projek\Slim\PlatesProvider);
 
 // Option 2, using Closure
 $container['view'] = function ($c) {
-    $settings = [
+    $view = new \Projek\Slim\Plates([
         // Path to view directory (default: null)
         'directory' => 'path/to/views',
         // Path to asset directory (default: null)
@@ -45,24 +45,24 @@ $container['view'] = function ($c) {
         'fileExtension' => 'tpl',
         // Template extension (default: false) see: http://platesphp.com/extensions/asset/
         'timestampInFilename' => false,
-    ];
-    $view = new \Projek\Slim\Plates($settings);
+    ]);
 
     // Set \Psr\Http\Message\ResponseInterface object
-    // Or you can optionaly pass `$c['response']` in `__construct` second parameter
-    $view->setResponse($c['response']);
+    // Or you can optionaly pass `$c->get('response')` in `__construct` second parameter
+    $view->setResponse($c->get('response'));
 
     // Instantiate and add Slim specific extension
-    $view->loadExtension(
-        new Projek\Slim\PlatesExtension($c['router'], $c['request']->getUri())
-    );
+    $view->loadExtension(new Projek\Slim\PlatesExtension(
+        $c->get('router'),
+        $c->get('request')->getUri()
+    ));
 
     return $view;
 };
 
 // Define named route
 $app->get('/hello/{name}', function ($request, $response, $args) {
-    return $this->view->render($response, 'profile', [
+    return $this->view->render('profile', [
         'name' => $args['name']
     ]);
 })->setName('profile');
@@ -71,7 +71,9 @@ $app->get('/hello/{name}', function ($request, $response, $args) {
 $app->run();
 ```
 
-**NOTE**: if you are using _option 1_ please make sure you already have `$container['settings']['view']` in your configuration file.
+**NOTE**:
+* If you are using _option 1_ please make sure you already have `$container['settings']['view']` in your configuration file.
+* `Plates::setResponse()` is required to use `Plates::render()` otherwise `\LogicException` will thrown.
 
 ## Custom functions
 

src/Plates.php

@@ -88,6 +88,7 @@ public function loadExtension(ExtensionInterface $extension)
      * @param  string  $directory
      * @param  boolean $fallback
      * @return \League\Plates\Engine
+     * @throws \LogicException
      */
     public function addFolder($name, $directory, $fallback = false)
     {
@@ -100,6 +101,7 @@ public function addFolder($name, $directory, $fallback = false)
      * @param  array         $data
      * @param  null|string[] $templates
      * @return \League\Plates\Engine
+     * @throws \LogicException
      */
     public function addData(array $data, $templates = null)
     {
@@ -112,6 +114,7 @@ public function addData(array $data, $templates = null)
      * @param  string   $name
      * @param  callable $callback
      * @return \League\Plates\Engine
+     * @throws \LogicException
      */
     public function registerFunction($name, $callback)
     {
@@ -137,9 +140,16 @@ public function setResponse(ResponseInterface $response)
      * @param  string   $name
      * @param  string[] $data
      * @return \Psr\Http\Message\ResponseInterface
+     * @throws \LogicException
      */
     public function render($name, array $data = [])
     {
+        if (! isset($this->response)) {
+            throw new \LogicException(
+                sprintf('Invalid %s object instance', ResponseInterface::class)
+            );
+        }
+
         return $this->response->write($this->plates->render($name, $data));
     }
 }

tests/PlatesTest.php

@@ -40,4 +40,14 @@ public function testRender()
 
         $this->assertInstanceOf(ResponseInterface::class, $response);
     }
+
+    /**
+     * @expectedException \LogicException
+     */
+    public function testInvalidResponseObj()
+    {
+        $response = $this->view->render('example', [
+            'name' => 'Fery'
+        ]);
+    }
 }