Initial commit

Author: pinepain

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+composer.lock

.travis.yml

@@ -0,0 +1,26 @@
+sudo: false
+
+language: php
+
+php:
+  - 7.0
+  - nightly
+
+matrix:
+  allow_failures:
+    - php: nightly
+
+env:
+  - PHP_WEAK_VERSION=master
+  - PHP_WEAK_VERSION=v0.1.0
+
+before_install:
+   - sh install_php_weak_ext.sh ${PHP_WEAK_VERSION}
+   - echo 'extension = weak.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/weak.ini
+
+before_script:
+  - composer self-update
+  - composer install
+
+script:
+  - vendor/bin/phpunit --coverage-text --configuration phpunit.xml

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 Bogdan Padalko <zaq178miami@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,55 @@
+# Weak-referenced data structures for PHP [![Build Status](https://travis-ci.org/pinepain/php-weak-lib.svg)](https://travis-ci.org/pinepain/php-weak-lib)
+
+This library base on [php-weak][php-weak-ext] PHP extension and provides various weak data types.
+
+Currently only weak version of [`SplObjectStorage`][php-SplObjectStorage] provided, which is basically a
+[`WeakMap`][js-WeakMap] in terms of ECMA 2015, but for PHP.
+
+## About:
+
+`Weak\SplObjectStorage` aims to be a simple drop-in replacement for SPL `SplObjectStorage` when you need to remove
+key (and it optional value) after key object GCed. This is useful when you want to organize some runtime caching or
+doing components integrations which converts one object into another and have to keep transformation table of one into
+another. But basically it is `WeakMap` or `WeakHashMap`, depends of what languages you are familiar with. If you don't
+set any value for object than it will be just a `WeakSet` for you.
+
+In short: when key object GCed, it will be removed from `Weak\SplObjectStorage`
+
+## Installation:
+
+`composer require pinepain/php-weak-lib`
+
+## Example:
+
+```php
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Weak\SplObjectStorage;
+
+$storage = new SplObjectStorage();
+
+$obj = new stdClass();
+$obj->obj = 'I am object';
+
+$inf = new stdClass();
+$inf->inf = 'I am info';
+
+$storage->attach($obj, $inf);
+
+var_dump($storage->count()); // 1
+
+// Let's destroy object
+$obj = null;
+
+var_dump($storage->count()); // 0
+```
+    
+## License
+
+[php-weak-lib](https://github.com/pinepain/php-weak-lib) PHP library is a free software licensed under the [MIT license](http://opensource.org/licenses/MIT).
+
+[php-weak-ext]: https://github.com/pinepain/php-weak
+[php-SplObjectStorage]: http://php.net/manual/en/class.splobjectstorage.php
+[js-WeakMap]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/WeakMap

composer.json

@@ -0,0 +1,40 @@
+{
+  "name": "pinepain/php-weak-lib",
+  "description": "Weak-referenced data structures for PHP",
+  "type": "library",
+  "license": "MIT",
+  "keywords": [
+    "php-weak",
+    "weak",
+    "reference",
+    "weakref",
+    "weakreference",
+    "weak data types",
+    "data structure"
+  ],
+  "authors": [
+    {
+      "name": "Bogdan Padalko",
+      "email": "pinepain@gmail.com",
+      "homepage": "https://github.com/pinepain"
+    }
+  ],
+  "require": {
+    "php": "~7.0",
+    "ext-weak": "~0.1.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^5.1",
+    "pinepain/php-weak-stubs": "~0.1.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Weak\\": "./src"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Weak\\Tests\\": "./tests"
+    }
+  }
+}

install_php_weak_ext.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -e
+
+echo Installing php-weak PHP extension ...
+
+
+PHP_WEAK_VERSION=$1
+
+cd $HOME
+
+if [ ! -d "$HOME/php-weak" ]; then
+  git clone https://github.com/pinepain/php-weak.git
+else
+  echo 'Using cached directory.';
+  cd $HOME/php-weak
+  git fetch
+fi
+
+cd $HOME/php-weak
+git checkout ${PHP_WEAK_VERSION}
+
+phpize --clean && phpize && ./configure && make
+
+make test
+make install

phpunit.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false">
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/HashedReference.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the pinepain/php-weak PHP extension.
+ *
+ * Copyright (c) 2016 Bogdan Padalko <zaq178miami@gmail.com>
+ *
+ * Licensed under the MIT license: http://opensource.org/licenses/MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code or visit http://opensource.org/licenses/MIT
+ */
+
+namespace Weak;
+
+
+class HashedReference extends Reference
+{
+    private $hash;
+
+    public function __construct($referent, callable $notify = null, callable $hash_function = null)
+    {
+        parent::__construct($referent, $notify);
+
+        //$this->hash = ($hash_function ?? 'spl_object_hash')($referent);
+
+        if ($hash_function) {
+            $this->hash = $hash_function($referent);
+        } else {
+            $this->hash = spl_object_hash($referent);
+        }
+    }
+
+    public function getHash() : string
+    {
+        return $this->hash;
+    }
+}

src/SplObjectStorage.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the pinepain/php-weak PHP extension.
+ *
+ * Copyright (c) 2016 Bogdan Padalko <zaq178miami@gmail.com>
+ *
+ * Licensed under the MIT license: http://opensource.org/licenses/MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code or visit http://opensource.org/licenses/MIT
+ */
+
+namespace Weak;
+
+class SplObjectStorage extends \SplObjectStorage
+{
+    /** {@inheritdoc} */
+    public function attach($object, $data = null)
+    {
+        $object = new HashedReference($object, [$this, 'detach'], 'spl_object_hash');
+
+        parent::attach($object, $data);
+    }
+
+    /** {@inheritdoc} */
+    public function current()
+    {
+        $current = parent::current();
+
+        if ($current) {
+            $current = $current->get();
+        }
+
+        return $current;
+    }
+
+    /** {@inheritdoc} */
+    public function getHash($object)
+    {
+        if ($object instanceof HashedReference) {
+            return $object->getHash();
+        }
+
+        return parent::getHash($object);
+    }
+}

tests/HashedReferenceTest.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the pinepain/php-weak PHP extension.
+ *
+ * Copyright (c) 2016 Bogdan Padalko <zaq178miami@gmail.com>
+ *
+ * Licensed under the MIT license: http://opensource.org/licenses/MIT
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code or visit http://opensource.org/licenses/MIT
+ */
+
+namespace Weak\Tests;
+
+use PHPUnit_Framework_TestCase;
+
+use Weak\HashedReference;
+
+use stdClass;
+
+class HashedReferenceTest extends PHPUnit_Framework_TestCase
+{
+    public function test()
+    {
+        $obj = new stdClass();
+        $obj_hash = 'test_hash';
+
+        $n = $this->getMock('stdClass', ['notify', 'hash']);
+
+        $n->expects($this->once())
+            ->method('notify');
+
+
+        $n->expects($this->once())
+            ->method('hash')
+            ->willReturn($obj_hash);
+
+        $notify = function () use (&$n) {
+            return $n->notify();
+        };
+
+        $hash = function () use (&$n) {
+            return $n->hash();
+        };
+
+        $wr = new HashedReference($obj, $notify, $hash);
+
+        $this->assertSame($obj, $wr->get());
+        $this->assertTrue($wr->valid());
+        $this->assertSame($obj_hash, $wr->getHash());
+
+        $obj = null;
+
+        $this->assertNull($wr->get());
+        $this->assertFalse($wr->valid());
+        $this->assertSame($obj_hash, $wr->getHash());
+    }
+}