Integrate PHP-Mock into Prophecy

Author: malkusch

.travis.yml

@@ -0,0 +1,37 @@
+language: php
+
+sudo: false
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+env:
+  - PROPHECY_VERSION=dev-master
+  - PROPHECY_VERSION=~1.5.0
+  - PROPHECY_VERSION=~1.4.0
+  - PROPHECY_VERSION=~1.3.0
+  - PROPHECY_VERSION=~1.2.0
+  - PROPHECY_VERSION=~1.1.0
+  - PROPHECY_VERSION=~1.0.0
+
+php:
+  - 7.0
+  - 5.6
+  - 5.5
+  - hhvm
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - php: hhvm
+
+install:
+  - composer require phpspec/prophecy :${PROPHECY_VERSION}
+  - composer require squizlabs/php_codesniffer
+  - composer require phpmd/phpmd
+
+script:
+  - vendor/bin/phpunit
+  - vendor/bin/phpcs --standard=PSR2 classes/ tests/
+  - vendor/bin/phpmd classes/ text cleancode,codesize,controversial,design,naming,unusedcode

LICENSE

@@ -0,0 +1,14 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <[email protected]>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+

README.md

@@ -0,0 +1,29 @@
+# Mock PHP built-in functions with Prophecy
+
+This package integrates the function mock library
+[PHP-Mock](https://github.com/php-mock/php-mock) with Prophecy.
+
+# Installation
+
+Use [Composer](https://getcomposer.org/):
+
+```sh
+composer require php-mock/php-mock-prophecy
+```
+
+# Usage
+
+TODO
+
+# License and authors
+
+This project is free and under the WTFPL.
+Responsable for this project is Markus Malkusch [email protected].
+
+## Donations
+
+If you like this project and feel generous donate a few Bitcoins here:
+[1335STSwu9hST4vcMRppEPgENMHD2r1REK](bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK)
+
+[![Build Status](https://travis-ci.org/php-mock/php-mock-prophecy.svg?branch=master)](https://travis-ci.org/php-mock/php-mock-prophecy)
+

classes/FunctionProphecy.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace phpmock\prophecy;
+
+use phpmock\integration\MockDelegateFunctionBuilder;
+use Prophecy\Prophet;
+use Prophecy\Prophecy\ProphecyInterface;
+use Prophecy\Prophecy\MethodProphecy;
+
+/**
+ * Function prophecy.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ */
+class FunctionProphecy implements ProphecyInterface
+{
+    
+    /**
+     * @var Prophet The prophet 
+     */
+    private $prophet;
+    
+    /**
+     * @var string The namespace.
+     */
+    private $namespace;
+    
+    /**
+     * @var Revelation[] The delegated prophecies.
+     */
+    private $revelations = [];
+    
+    /**
+     * Sets the prophet.
+     *
+     * @param string  $namespace The namespace.
+     * @param Prophet $prophet   The prophet.
+     * @internal
+     */
+    public function __construct($namespace, Prophet $prophet)
+    {
+        $this->prophet   = $prophet;
+        $this->namespace = $namespace;
+    }
+    
+    /**
+     * Creates a new function prophecy using specified function name and arguments.
+     *
+     * @param string $functionName The function name.
+     * @param array  $arguments    The arguments.
+     *
+     * @return MethodProphecy The function prophecy.
+     */
+    public function __call($functionName, array $arguments)
+    {
+        $delegateBuilder = new MockDelegateFunctionBuilder();
+        $delegateBuilder->build($functionName);
+        $prophecy = $this->prophet->prophesize($delegateBuilder->getFullyQualifiedClassName());
+        $this->revelations[] = new Revelation($this->namespace, $functionName, $prophecy);
+        return $prophecy->__call(MockDelegateFunctionBuilder::METHOD, $arguments);
+    }
+    
+    /**
+     * Reveals the function prophecies.
+     * 
+     * I.e. the prophesized functions will become effective.
+     */
+    public function reveal()
+    {
+        foreach ($this->revelations as $revelation) {
+            $revelation->reveal();
+        }
+    }
+}

classes/PHPProphet.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace phpmock\prophecy;
+
+use phpmock\MockRegistry;
+use Prophecy\Prophet;
+use Prophecy\Exception\Prediction\AggregateException;
+
+/**
+ * PHPProphet creates prophecies for functions. 
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ */
+class PHPProphet
+{
+
+    /**
+     * @var Prophet The prophet.
+     */
+    private $prophet;
+    
+    /**
+     * Sets an optional prophet.
+     * 
+     * @param Prophet $prophet The prophet.
+     */
+    public function __construct(Prophet $prophet = null)
+    {
+        $this->prophet = is_null($prophet) ? new Prophet() : $prophet;
+    }
+    
+    /**
+     * Creates a new function prophecy.
+     * 
+     * @param string $namespace The function namespace.
+     * 
+     * @return FunctionProphecy The function prophecy.
+     */
+    public function prophesize($namespace)
+    {
+        return new FunctionProphecy($namespace, $this->prophet);
+    }
+    
+    /**
+     * Checks all predictions defined by prophecies of this Prophet.
+     *
+     * It will also disable all previously revealed function prophecies.
+     * 
+     * @throws AggregateException If any prediction fails
+     */
+    public function checkPredictions()
+    {
+        MockRegistry::getInstance()->unregisterAll();
+        $this->prophet->checkPredictions();
+    }
+}

classes/Revelation.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace phpmock\prophecy;
+
+use phpmock\MockBuilder;
+use phpmock\integration\MockDelegateFunctionBuilder;
+use Prophecy\Prophecy\ProphecyInterface;
+
+/**
+ * The single function revelation.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @internal
+ */
+class Revelation implements ProphecyInterface
+{
+
+    /**
+     * @var string The function namespace.
+     */
+    private $namespace;
+
+    /**
+     * @var string The function name.
+     */
+    private $functionName;
+
+    /**
+     * @var ProphecyInterface The prophecy
+     */
+    private $prophecy;
+    
+    /**
+     * Setup the revelation.
+     * 
+     * @param String $namespace           The namespace.
+     * @param String $functionName        The function name.
+     * @param ProphecyInterface $prophecy The prophecy.
+     */
+    public function __construct($namespace, $functionName, ProphecyInterface $prophecy)
+    {
+        $this->namespace    = $namespace;
+        $this->functionName = $functionName;
+        $this->prophecy     = $prophecy;
+    }
+    
+    /**
+     * Reveals the function prophecy.
+     * 
+     * I.e. the prophesized function will become effective.
+     * 
+     * @return Mock The enabled function mock.
+     */
+    public function reveal()
+    {
+        $delegate = $this->prophecy->reveal();
+        $builder  = new MockBuilder();
+        $builder->setNamespace($this->namespace)
+                ->setName($this->functionName)
+                ->setFunction([$delegate, MockDelegateFunctionBuilder::METHOD]);
+        $mock = $builder->build();
+        $mock->enable();
+        return $mock;
+    }
+}

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "php-mock/php-mock-prophecy",
+    "type": "library",
+    "description": "Mock built-in PHP functions (e.g. time()) with Prophecy. This package relies on PHP's namespace fallback policy. No further extension is needed.",
+    "keywords": ["prophecy", "mock", "stub", "test double", "function", "test", "TDD", "BDD"],
+    "homepage": "https://github.com/php-mock/php-mock-prophecy",
+    "license": "WTFPL",
+    "authors": [
+        {
+            "name": "Markus Malkusch",
+            "email": "[email protected]",
+            "homepage": "http://markus.malkusch.de",
+            "role": "Developer"
+        }
+    ],
+    "autoload": {
+        "psr-4": {"phpmock\\prophecy\\": "classes/"}
+    },
+    "require": {
+        "php": ">=5.5",
+        "php-mock/php-mock-integration": "^1",
+        "phpspec/prophecy": "^1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5"
+    },
+    "archive": {
+        "exclude": ["/tests"]
+    }
+}

phpunit.xml

@@ -0,0 +1,8 @@
+<phpunit
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php">
+    <testsuite name="Unit tests">
+        <directory>tests/</directory>
+    </testsuite>
+</phpunit>

tests/PHPProphetTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace phpmock\prophecy;
+
+use phpmock\AbstractMockTest;
+use Prophecy\Argument;
+
+/**
+ * Tests PHPProphet.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @see PHPProphet
+ */
+class PHPProphetTest extends AbstractMockTest
+{
+    
+    /**
+     * @var PHPProphet The SUT. 
+     */
+    private $prophet;
+
+    protected function setup()
+    {
+        parent::setUp();
+
+        $this->prophet = new PHPProphet();
+    }
+
+    protected function disableMocks()
+    {
+        $this->prophet->checkPredictions();
+    }
+
+    protected function mockFunction($namespace, $functionName, callable $function)
+    {
+        $prophecy = $this->prophet->prophesize($namespace);
+        $prophecy->$functionName(Argument::cetera())->will(function(array $parameters) use ($function) {
+            return call_user_func_array($function, $parameters);
+        });
+        $prophecy->reveal();
+    }
+}