Merge pull request #31 from PhpGt/30-remove-store

Self-removal of SessionStore

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/php:7.1-cli
+      - image: circleci/php:7.2-cli
 
     working_directory: ~/repo
 
@@ -23,7 +23,7 @@ jobs:
           key: v1-dependencies-{{ checksum "composer.json" }}
 
       - run: mkdir test/unit/_junit
-      - run: vendor/bin/phpunit -c test/unit/phpunit.xml --log-junit test/unit/_junit/junit.xml -d memory_limit=512M
+      - run: vendor/bin/phpunit -c test/unit/phpunit.xml --log-junit test/unit/_junit/junit.xml --coverage-html ./test/unit/_coverage -d memory_limit=512M
 
       - store_test_results:
           path: test/unit/_junit

composer.json

@@ -4,7 +4,7 @@
 	"license": "MIT",
 
 	"require": {
-		"php": "^7.1"
+		"php": ">=7.2"
 	},
 	"require-dev": {
 		"phpunit/phpunit": "^8.0"

src/Session.php

@@ -1,7 +1,6 @@
 <?php
 namespace Gt\Session;
 
-use ArrayAccess;
 use SessionHandlerInterface;
 
 class Session {

src/SessionStore.php

@@ -10,10 +10,17 @@ class SessionStore {
 	protected $stores;
 	/** @var string[] */
 	protected $data;
-
-	public function __construct(string $name, Session $session) {
+	/** @var SessionStore */
+	protected $parentStore;
+
+	public function __construct(
+		string $name,
+		Session $session,
+		self $parentStore = null
+	) {
 		$this->name = $name;
 		$this->session = $session;
+		$this->parentStore = $parentStore;
 	}
 
 	public function setData(string $key, $value):void {
@@ -81,8 +88,7 @@ public function getStore(
 	}
 
 	public function setStore(
-		string $namespace,
-		SessionStore $newStore = null
+		string $namespace
 	):void {
 		$namespaceParts = explode(".", $namespace);
 		$store = $this;
@@ -96,7 +102,8 @@ public function setStore(
 			if (is_null($nextStore)) {
 				$nextStore = new SessionStore(
 					$storeName,
-					$this->session
+					$this->session,
+					$store
 				);
 				$store->stores[$storeName] = $nextStore;
 			}
@@ -169,7 +176,16 @@ public function contains(string $key):bool {
 		return $store->containsData($key);
 	}
 
-	public function remove(string $key):void {
+	public function remove(string $key = null):void {
+		if(is_null($key)) {
+			foreach($this->stores as $i => $childStore) {
+				unset($this->stores[$i]);
+			}
+
+			$this->parentStore->remove($this->name);
+			return;
+		}
+
 		$store = $this;
 		$lastDotPosition = strrpos($key, ".");
 

src/SessionStoreFactory.php

@@ -4,10 +4,13 @@
 class SessionStoreFactory {
 	public static function create(string $namespace, Session $session):SessionStore {
 		$namespaceParts = explode(".", $namespace);
-		$store = new SessionStore(array_shift($namespaceParts), $session);
+		$store = new SessionStore(
+			array_shift($namespaceParts),
+			$session
+		);
 
 		foreach($namespaceParts as $part) {
-			$innerStore = $store->createStore($part, $session);
+			$innerStore = $store->createStore($part);
 			$store = $innerStore;
 		}
 

test/unit/Helper/FunctionOverride/session_id.php

@@ -0,0 +1,6 @@
+<?php
+namespace Gt\Session;
+function session_id() {
+	\Gt\Session\Test\Helper\FunctionMocker::$mockCalls["session_id"] []= func_get_args();
+	return "TEST";
+}

test/unit/SessionStoreTest.php

@@ -3,21 +3,26 @@
 
 use Gt\Session\Handler;
 use Gt\Session\Session;
+use Gt\Session\SessionStore;
 use Gt\Session\Test\Helper\FunctionMocker;
 use Gt\Session\Test\Helper\DataProvider\KeyValuePairProvider;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use SessionHandler;
 
 class SessionStoreTest extends TestCase {
 	use KeyValuePairProvider;
 
-	public function setUp() {
+	public function setUp():void {
 		FunctionMocker::mock("session_start");
+		FunctionMocker::mock("session_id");
 	}
 
 	/**
 	 * @dataProvider data_randomKeyValuePairs
 	 */
 	public function testGetSetDotNotation(array $keyValuePairs):void {
+		/** @var MockObject|SessionHandler $handler */
 		$handler = $this->getMockBuilder(Handler::class)
 			->getMock();
 		$session = new Session($handler);
@@ -34,4 +39,28 @@ public function testGetSetDotNotation(array $keyValuePairs):void {
 			self::assertEquals($value, $session->get($fullKey));
 		}
 	}
+
+	public function testRemoveSelf():void {
+		/** @var MockObject|SessionHandler $handler */
+		$handler = $this->getMockBuilder(Handler::class)
+			->getMock();
+		$session = new Session($handler);
+
+		$leafStore = $session->getStore(
+			"gt.test.session.trunk.leaf",
+			true
+		);
+		$trunkStore = $session->getStore(
+			"gt.test.session.trunk"
+		);
+
+		$trunkStore->remove();
+
+		self::assertNull($session->getStore("gt.test.session.trunk"));
+		self::assertNull($session->getStore("gt.test.session.trunk.leaf"));
+		self::assertInstanceOf(
+			SessionStore::class,
+			$session->getStore("gt.test.session")
+		);
+	}
 }

test/unit/SessionTest.php

@@ -14,7 +14,7 @@ class SessionTest extends TestCase {
 	use StringProvider;
 	use ConfigProvider;
 
-	public function setUp() {
+	public function setUp():void {
 		FunctionMocker::mock("session_start");
 	}
 

test/unit/phpunit.xml

@@ -6,11 +6,6 @@
 		</testsuite>
 	</testsuites>
 
-	<logging>
-		<log type="coverage-text" target="php://stdout" showUncoveredFiles="true" />
-		<log type="coverage-html" target="./_coverage" charset="UTF-8" highlight="false" lowUpperBound="35" highLowerBound="70" />
-	</logging>
-
 	<filter>
 		<whitelist>
 			<directory suffix=".php">../../src</directory>