integration package

Author: malkusch

.travis.yml

@@ -0,0 +1,29 @@
+language: php
+
+sudo: false
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+php:
+  - 7.0
+  - 5.6
+  - 5.5
+  - 5.4
+  - hhvm
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - php: hhvm
+
+install:
+  - 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,20 @@
+# PHP-Mock integration package
+
+This is a support package for PHP-Mock integration into other frameworks.
+You'll find these integrations:
+
+- [php-mock/phpunit](https://github.com/php-mock/phpunit) - PHPUnit integration
+
+- [php-mock/mockery](https://github.com/php-mock/mockery) - Mockery integration
+
+# License and authors
+
+This project is free and under the WTFPL.
+Responsable for this project is Markus Malkusch [email protected].
+
+## Donations
+
+If you like PHP-Mock and feel generous donate a few Bitcoins here:
+[1335STSwu9hST4vcMRppEPgENMHD2r1REK](bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK)
+
+[![Build Status](https://travis-ci.org/php-mock/integration.svg?branch=master)](https://travis-ci.org/php-mock/integration)

classes/MockDelegateFunction.tpl

@@ -0,0 +1,27 @@
+namespace {namespace};
+
+use malkusch\phpmock\functions\FunctionProvider;
+
+/**
+ * Function provider which delegates to a mockable MockDelegate.
+ *
+ * @author Markus Malkusch <markus@malkusch.de>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @internal
+ */
+abstract class MockDelegateFunction implements FunctionProvider
+{
+    
+    /**
+     * A mocked function will redirect its call to this method.
+     *
+     * @return mixed Returns the function output.
+     */
+    abstract public function delegate({signatureParameters});
+
+    public function getCallable()
+    {
+        return [$this, "delegate"];
+    }
+}

classes/MockDelegateFunctionBuilder.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace phpmock\integration;
+
+use malkusch\phpmock\ParameterBuilder;
+
+/**
+ * Defines a MockDelegateFunction.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @internal
+ */
+class MockDelegateFunctionBuilder
+{
+    
+    /**
+     * The delegation method name.
+     */
+    const METHOD = "delegate";
+    
+    /**
+     * @var int The instance counter.
+     */
+    private static $counter = 0;
+    
+    /**
+     * @var string The namespace of the build class.
+     */
+    private $namespace;
+    
+    /**
+     * @var \Text_Template The MockDelegateFunction template.
+     */
+    private $template;
+    
+    /**
+     * Instantiation.
+     */
+    public function __construct()
+    {
+        $this->template = new \Text_Template(__DIR__ . "/MockDelegateFunction.tpl");
+    }
+    
+    /**
+     * Builds a MockDelegateFunction for a function.
+     *
+     * @param string|null $functionName The mocked function.
+     *
+     * @SuppressWarnings(PHPMD)
+     */
+    public function build($functionName = null)
+    {
+        self::$counter++;
+        
+        $this->namespace = __NAMESPACE__ . self::$counter;
+        
+        $parameterBuilder = new ParameterBuilder();
+        $parameterBuilder->build($functionName);
+        
+        $data = [
+            "namespace" => $this->namespace,
+            "signatureParameters" => $parameterBuilder->getSignatureParameters(),
+        ];
+        $this->template->setVar($data, false);
+        $definition = $this->template->render();
+        
+        eval($definition);
+    }
+
+    /**
+     * Returns the fully qualified class name
+     *
+     * @return string The class name.
+     */
+    public function getFullyQualifiedClassName()
+    {
+        return "$this->namespace\\MockDelegateFunction";
+    }
+}

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "php-mock/integration",
+    "type": "library",
+    "description": "PHP-Mock can mock built-in PHP functions (e.g. time()). PHP-Mock relies on PHP's namespace fallback policy. No further extension is needed.",
+    "keywords": ["mock", "stub", "test double", "function", "test", "TDD", "BDD"],
+    "homepage": "https://github.com/php-mock/integration",
+    "license": "WTFPL",
+    "authors": [
+        {
+            "name": "Markus Malkusch",
+            "email": "[email protected]",
+            "homepage": "http://markus.malkusch.de",
+            "role": "Developer"
+        }
+    ],
+    "autoload": {
+        "psr-4": {"phpmock\\integration\\": "classes/"}
+    },
+    "require": {
+        "php": ">=5.4",
+        "php-mock/php-mock": "^0",
+        "phpunit/php-text-template": "^1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^4"
+    },
+    "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/MockDelegateFunctionBuilderTest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace phpmock\integration;
+
+/**
+ * Tests MockDelegateFunctionBuilder.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @see MockDelegateFunctionBuilder
+ */
+class MockDelegateFunctionBuilderTest extends \PHPUnit_Framework_TestCase
+{
+
+    /**
+     * Test build() defines a class.
+     *
+     * @test
+     */
+    public function testBuild()
+    {
+        $builder = new MockDelegateFunctionBuilder();
+        $builder->build();
+        $this->assertTrue(class_exists($builder->getFullyQualifiedClassName()));
+    }
+
+    /**
+     * Test build() would never create the same class name.
+     *
+     * @test
+     */
+    public function testSubsequentCallsProduceDifferentClasses()
+    {
+        $builder = new MockDelegateFunctionBuilder();
+
+        $builder->build();
+        $class1 = $builder->getFullyQualifiedClassName();
+
+        $builder->build();
+        $class2 = $builder->getFullyQualifiedClassName();
+        
+        $builder2 = new MockDelegateFunctionBuilder();
+        $builder2->build();
+        $class3 = $builder2->getFullyQualifiedClassName();
+        
+        $this->assertNotEquals($class1, $class2);
+        $this->assertNotEquals($class1, $class3);
+        $this->assertNotEquals($class2, $class3);
+    }
+}

tests/MockDelegateFunctionTest.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace phpmock\integration;
+
+/**
+ * Tests MockDelegateFunction.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @see MockDelegateFunction
+ */
+class MockDelegateFunctionTest extends \PHPUnit_Framework_TestCase
+{
+    
+    /**
+     * @var string The class name of a generated class.
+     */
+    private $className;
+    
+    protected function setUp()
+    {
+        parent::setUp();
+        
+        $builder = new MockDelegateFunctionBuilder();
+        $builder->build();
+        $this->className = $builder->getFullyQualifiedClassName();
+    }
+
+    /**
+     * Tests delegate() returns the mock's result.
+     *
+     * @test
+     */
+    public function testDelegateReturnsMockResult()
+    {
+        $expected = 3;
+        $mock     = $this->getMockForAbstractClass($this->className);
+        
+        $mock->expects($this->once())
+             ->method(MockDelegateFunctionBuilder::METHOD)
+             ->willReturn($expected);
+        
+        $result = call_user_func($mock->getCallable());
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * Tests delegate() forwards the arguments.
+     *
+     * @test
+     */
+    public function testDelegateForwardsArguments()
+    {
+        $mock = $this->getMockForAbstractClass($this->className);
+        
+        $mock->expects($this->once())
+             ->method(MockDelegateFunctionBuilder::METHOD)
+             ->with(1, 2);
+        
+        call_user_func($mock->getCallable(), 1, 2);
+    }
+}