Merge pull request #6 from karriereat/feature/remove-template-data

remove demo data and add StateManager

Author: fetzi

config/mocky.php

@@ -10,10 +10,15 @@
 
 Mocky is a simple API mocking solution written in PHP based on the [Slim Framework](https://www.slimframework.com/).
 
-## Creating a new mocky API
+## Installation
+You can either create a new mock api by using the `mocky-template` as a starting point
+```
+composer create-project karriere/mocky-template /destination/path
+```
 
+or add mocky as a dependency to your project.
 ```
-composer create-project karriere/mocky /destination/path
+composer require karriere/mocky
 ```
 
 ## Configuration

example/mocks/users/list-users.json

@@ -2,7 +2,6 @@
 
 namespace Karriere\Mocky;
 
-use Karriere\Mocky\Models\State;
 use Karriere\Mocky\Router\MockyRouter;
 use Karriere\Mocky\Router\TestRouter;
 use Slim\App;
@@ -38,7 +37,7 @@ public function __construct(Configuration $config)
             $scope = reset($scope);
         }
 
-        $state = State::load($scope);
+        $state = (new StateManager($config))->load($scope);
 
         (new TestRouter($this->config->directory))->setup($this->app, $state);
         (new MockyRouter($this->config->directory))->setup($this->app, $state);

example/mocks/users/single-user.json

@@ -2,38 +2,34 @@
 
 namespace Karriere\Mocky\Models;
 
+use Karriere\Mocky\Path;
+
 class State
 {
-    const STATE_PATH = __DIR__.'/../../state/';
-
+    /**
+     * @var string
+     */
+    private $statePath;
+
+    /**
+     * @var string
+     */
     private $activeTest;
 
+    /**
+     * @var array
+     */
     private $testRoutes = [];
-    private $testScope;
-
-    public static function load($scope)
-    {
-        $state = self::create('', $scope);
-
-        if (file_exists(self::STATE_PATH.$scope.'.state')) {
-            $state = unserialize(file_get_contents(self::STATE_PATH.$scope.'.state'));
-        }
-
-        return $state;
-    }
 
-    public static function store($state)
-    {
-        file_put_contents(self::STATE_PATH.$state->testScope.'.state', serialize($state));
-    }
+    /**
+     * @var string
+     */
+    private $testScope;
 
-    private static function create($testName, $testScope)
+    public function __construct($statePath, $scope)
     {
-        $instance = new self();
-        $instance->activeTest = $testName;
-        $instance->testScope = $testScope;
-
-        return $instance;
+        $this->statePath = $statePath;
+        $this->testScope = $scope;
     }
 
     public function getActiveTest()
@@ -46,7 +42,7 @@ public function setActiveTest($testName, $testScope)
         $this->activeTest = $testName;
         $this->testScope = $testScope;
         $this->testRoutes = [];
-        self::store($this);
+        $this->store();
     }
 
     public function getIteration($route)
@@ -59,8 +55,14 @@ public function getIteration($route)
 
         $this->testRoutes[$route] = $iteration + 1;
 
-        self::store($this);
+        $this->store();
 
         return $iteration;
     }
+
+    private function store()
+    {
+        $file = Path::join($this->statePath, $this->testScope.'.state');
+        file_put_contents($file, serialize($this));
+    }
 }

example/tests/user-simple.json

@@ -0,0 +1,41 @@
+<?php
+
+namespace Karriere\Mocky;
+
+use Karriere\Mocky\Models\State;
+
+class StateManager
+{
+    /**
+     * @var Configuration
+     */
+    private $configuration;
+
+    public function __construct(Configuration $configuration)
+    {
+        $this->configuration = $configuration;
+
+        $this->initializeStateDirectory();
+    }
+
+    public function load($scope)
+    {
+        $statePath = $this->configuration->statePath;
+        $stateFile = Path::join($statePath, $scope.'.state');
+
+        if (file_exists($stateFile)) {
+            $state = unserialize(file_get_contents($stateFile));
+        } else {
+            $state = new State($statePath, $scope);
+        }
+
+        return $state;
+    }
+
+    private function initializeStateDirectory()
+    {
+        if (!file_exists($this->configuration->statePath)) {
+            mkdir($this->configuration->statePath);
+        }
+    }
+}