Merge pull request #653 from cakephp/issue-558

Make DebugKitTransport a better proxy

Author: markstory

phpcs.xml.dist

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<ruleset name="CakePHP Core">
+ <rule ref="./vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml">
+    <!-- Exclude unwanted sniffs -->
+    <exclude name="Generic.Commenting.Todo.TaskFound"/> <!-- Excluded during 3.next development -->
+ </rule>
+
+ <!-- Necessary for class aliases used for backwards compat -->
+ <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
+  <severity>0</severity>
+ </rule>
+</ruleset>

src/Mailer/Transport/DebugKitTransport.php

@@ -81,4 +81,61 @@ public function send(Email $email)
 
         return $result;
     }
+
+    /**
+     * Proxy unknown methods to the wrapped object
+     *
+     * @param string $method The method to call
+     * @param array $args The args to call $method with.
+     * @return mixed
+     */
+    public function __call($method, array $args)
+    {
+        return call_user_func_array([$this->originalTransport, $method], $args);
+    }
+
+    /**
+     * Proxy property reads to the wrapped object
+     *
+     * @param string $name The property to read.
+     * @return mixed
+     */
+    public function __get($name)
+    {
+        return $this->originalTransport->{$name};
+    }
+
+    /**
+     * Proxy property changes to the wrapped object
+     *
+     * @param string $name The property to read.
+     * @param mixed $value The property value.
+     * @return mixed
+     */
+    public function __set($name, $value)
+    {
+        return $this->originalTransport->{$name} = $value;
+    }
+
+    /**
+     * Proxy property changes to the wrapped object
+     *
+     * @param string $name The property to read.
+     * @return bool
+     */
+    public function __isset($name)
+    {
+        return isset($this->originalTransport->{$name});
+    }
+
+    /**
+     * Proxy property changes to the wrapped object
+     *
+     * @param string $name The property to delete.
+     * @return void
+     */
+    public function __unset($name)
+    {
+        unset($this->originalTransport->{$name});
+    }
 }

tests/TestCase/Mailer/Transport/DebugKitTransportTest.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace DebugKit\Test\TestCase\Mailer\Transport;
+
+use Cake\Mailer\AbstractTransport;
+use Cake\Mailer\Email;
+use Cake\TestSuite\TestCase;
+use DebugKit\Mailer\Transport\DebugKitTransport;
+
+class DebugKitTransportTest extends TestCase
+{
+    public function setUp()
+    {
+        $this->log = new \ArrayObject();
+        $this->wrapped = $this->getMockBuilder(AbstractTransport::class)
+            ->setMethods(['send', 'customMethod'])
+            ->getMock();
+        $this->transport = new DebugKitTransport(
+            ['debugKitLog' => $this->log],
+            $this->wrapped
+        );
+    }
+
+    public function testPropertyProxies()
+    {
+        $this->wrapped->property = 'value';
+        $this->assertTrue(isset($this->transport->property));
+        $this->assertSame('value', $this->transport->property);
+
+        $this->transport->property = 'new value';
+        $this->assertSame('new value', $this->wrapped->property);
+        unset($this->transport->property);
+        $this->assertFalse(isset($this->wrapped->property));
+    }
+
+    public function testMethodProxy()
+    {
+        $this->wrapped->method('customMethod')
+            ->will($this->returnValue('bloop'));
+        $this->assertSame('bloop', $this->transport->customMethod());
+    }
+
+    public function testEmailCapture()
+    {
+        $email = new Email();
+        $email->setSubject('Testing 123')
+            ->setFrom('[email protected]')
+            ->setTo('[email protected]');
+        $this->transport->send($email);
+        $this->assertCount(1, $this->log);
+
+        $result = $this->log[0];
+        $this->assertArrayHasKey('headers', $result);
+        $this->assertArrayHasKey('message', $result);
+    }
+}