Merge pull request #8 from PHPFastCGI/application-factory

Created application factory class

Author: AndrewCarterUK

README.md

@@ -27,31 +27,20 @@ Below is an example of a simple 'Hello, World!' FastCGI application in PHP.
 // Include the composer autoloader
 require_once dirname(__FILE__) . '/../vendor/autoload.php';
 
-use PHPFastCGI\FastCGIDaemon\Command\DaemonRunCommand;
-use PHPFastCGI\FastCGIDaemon\DaemonFactory;
+use PHPFastCGI\FastCGIDaemon\ApplicationFactory;
 use Psr\Http\Message\ServerRequestInterface;
-use Symfony\Component\Console\Application;
 use Zend\Diactoros\Response\HtmlResponse;
 
-// Create the dependencies for the DaemonRunCommand
-
-// Dependency 1: The daemon factory
-$daemonFactory = new DaemonFactory();
-
-// Dependency 2: A simple kernel. This is the core of your application
+// A simple kernel. This is the core of your application
 $kernel = function (ServerRequestInterface $request) {
     return new HtmlResponse('<h1>Hello, World!</h1>');
 };
 
-// Create an instance of DaemonRunCommand using the daemon factory and the kernel
-$command = new DaemonRunCommand('run', 'Run a FastCGI daemon', $daemonFactory, $kernel);
-
-// Create a symfony console application and add the command
-$consoleApplication = new Application();
-$consoleApplication->add($command);
+// Create your Symfony console application using the factory
+$application = (new ApplicationFactory)->createApplication($kernel);
 
-// Run the symfony console application
-$consoleApplication->run();
+// Run the Symfony console application
+$application->run();
 ```
 
 If you wish to configure your FastCGI application to work with the apache web server, you can use the apache FastCGI module to process manage your application.

src/ApplicationFactory.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace PHPFastCGI\FastCGIDaemon;
+
+use PHPFastCGI\FastCGIDaemon\Command\DaemonRunCommand;
+use Symfony\Component\Console\Application;
+/**
+ * The default implementation of the ApplicationFactoryInterface.
+ */
+class ApplicationFactory implements ApplicationFactoryInterface
+{
+    /**
+     * @var DaemonFactoryInterface
+     */
+    protected $daemonFactory;
+
+    /**
+     * Constructor.
+     * 
+     * @param DaemonFactoryInterface $daemonFactory The factory to use to create daemons
+     */
+    public function __construct(DaemonFactoryInterface $daemonFactory = null)
+    {
+        $this->daemonFactory = $daemonFactory;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createApplication($kernel, $commandName = null, $commandDescription = null)
+    {
+        $command = $this->createCommand($kernel, $commandName, $commandDescription);
+
+        $application = new Application;
+        $application->add($command);
+
+        return $application;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createCommand($kernel, $commandName = null, $commandDescription = null)
+    {
+        return new DaemonRunCommand($kernel, $this->daemonFactory, $commandName, $commandDescription);
+    }
+}

src/ApplicationFactoryInterface.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace PHPFastCGI\FastCGIDaemon;
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Command\Command;
+
+/**
+ * Objects that implement the ApplicationFactoryInterface can be used to create
+ * Symfony console commands and applications.
+ */
+interface ApplicationFactoryInterface
+{
+    /**
+     * Create a Symfony console application
+     *
+     * @param KernelInterface|callable $kernel             The kernel to use
+     * @param string                   $commandName        The name of the daemon run command
+     * @param string                   $commandDescription The description of the daemon run command
+     *
+     * @return Application The Symfony console application
+     */
+    public function createApplication($kernel, $commandName = null, $commandDescription = null);
+
+    /**
+     * Create a Symfony console command
+     *
+     * @param KernelInterface|callable $kernel             The kernel to use
+     * @param string                   $commandName        The name of the daemon run command
+     * @param string                   $commandDescription The description of the daemon run command
+     *
+     * @return Command The Symfony console command
+     */
+    public function createCommand($kernel, $commandName = null, $commandDescription = null);
+}

src/Command/DaemonRunCommand.php

@@ -2,6 +2,7 @@
 
 namespace PHPFastCGI\FastCGIDaemon\Command;
 
+use PHPFastCGI\FastCGIDaemon\DaemonFactory;
 use PHPFastCGI\FastCGIDaemon\DaemonFactoryInterface;
 use PHPFastCGI\FastCGIDaemon\KernelInterface;
 use Symfony\Component\Console\Command\Command;
@@ -12,6 +13,9 @@
 
 class DaemonRunCommand extends Command
 {
+    const DEFAULT_NAME        = 'run';
+    const DEFAULT_DESCRIPTION = 'Run the FastCGI daemon';
+
     /**
      * @var DaemonFactoryInterface
      */
@@ -25,13 +29,17 @@ class DaemonRunCommand extends Command
     /**
      * Constructor.
      *
+     * @param KernelInterface|callable $kernel        The kernel to be given to the daemon
+     * @param DaemonFactoryInterface   $daemonFactory The factory to use to create the daemon
      * @param string                   $name          The name of the daemon run command
      * @param string                   $description   The description of the daemon run command
-     * @param DaemonFactoryInterface   $daemonFactory The factory to use to create the daemon
-     * @param KernelInterface|callable $kernel        The kernel to be given to the daemon
      */
-    public function __construct($name, $description, DaemonFactoryInterface $daemonFactory, $kernel)
+    public function __construct($kernel, DaemonFactoryInterface $daemonFactory = null, $name = null, $description = null)
     {
+        $daemonFactory = $daemonFactory ?: new DaemonFactory;
+        $name          = $name          ?: self::DEFAULT_NAME;
+        $description   = $description   ?: self::DEFAULT_DESCRIPTION;
+
         parent::__construct($name);
 
         $this

src/DaemonFactory.php

@@ -19,6 +19,10 @@ public function createDaemon($kernel)
     {
         $socket = fopen('php://fd/'.DaemonInterface::FCGI_LISTENSOCK_FILENO, 'r');
 
+        if (false === $socket) {
+            throw new \RuntimeException('Could not open FCGI_LISTENSOCK_FILENO');
+        }
+
         return $this->createDaemonFromStreamSocket($kernel, $socket);
     }
 
@@ -29,7 +33,12 @@ public function createDaemon($kernel)
      */
     public function createTcpDaemon($kernel, $port, $host = 'localhost')
     {
-        $socket = stream_socket_server('tcp://'.$host.':'.$port);
+        $address = 'tcp://'.$host.':'.$port;
+        $socket  = stream_socket_server($address);
+
+        if (false === $socket) {
+            throw new \RuntimeException('Could not create stream socket server on: '.$address);
+        }
 
         return $this->createDaemonFromStreamSocket($kernel, $socket);
     }

test/ApplicationFactoryTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PHPFastCGI\Test\FastCGIDaemon;
+
+use PHPFastCGI\FastCGIDaemon\ApplicationFactory;
+
+/**
+ * Tests the daemon.
+ */
+class ApplicationFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Tests that the factory can create a Symfony console application
+     */
+    public function testCreateApplication()
+    {
+        $applicationFactory = new ApplicationFactory;
+
+        $name        = 'foo';
+        $description = 'bar';
+
+        $application = $applicationFactory->createApplication(function () { }, $name, $description);
+
+        $this->assertInstanceOf('Symfony\\Component\\Console\\Application', $application);
+        $this->assertTrue($application->has($name));
+        $this->assertEquals($description, $application->get($name)->getDescription());
+    }
+}

test/Command/DaemonRunCommandTest.php

@@ -20,7 +20,7 @@ class DaemonRunCommandTest extends \PHPUnit_Framework_TestCase
      */
     public function testInvalidArgumentException()
     {
-        new DaemonRunCommand('name', 'description', new DaemonFactory(), 'not a callable function');
+        new DaemonRunCommand('not a callable function');
     }
 
     /**
@@ -29,7 +29,7 @@ public function testInvalidArgumentException()
      */
     public function testOptions()
     {
-        $command = new DaemonRunCommand('name', 'description', new DaemonFactory(), function () { });
+        $command = new DaemonRunCommand(function () { });
 
         $definition = $command->getDefinition();
 
@@ -48,7 +48,7 @@ public function testOptions()
      */
     public function testInvalidOptions()
     {
-        $command = new DaemonRunCommand('name', 'description', new DaemonFactory(), function () { });
+        $command = new DaemonRunCommand(function () { });
 
         $input  = new ArrayInput(['--host' => '_']);
         $output = new NullOutput();
@@ -103,7 +103,7 @@ public function testCreateDefaultDaemon()
             ->method('createDaemon')
             ->will($this->returnValue($mockDaemon));
 
-        $command = new DaemonRunCommand('name', 'description', $mockDaemonFactory, function () { });
+        $command = new DaemonRunCommand(function () { }, $mockDaemonFactory);
 
         $command->run($input, $output);
     }
@@ -130,7 +130,7 @@ public function testCreateTcpDaemonWithHost()
             ->with($this->equalTo($kernel), $this->equalTo($port), $this->equalTo($host))
             ->will($this->returnValue($mockDaemon));
 
-        $command = new DaemonRunCommand('name', 'description', $mockDaemonFactory, $kernel);
+        $command = new DaemonRunCommand($kernel, $mockDaemonFactory);
 
         $command->run($input, $output);
     }
@@ -156,7 +156,7 @@ public function testCreateTcpDaemonWithoutHost()
             ->with($this->equalTo($kernel), $this->equalTo($port), $this->equalTo('localhost'))
             ->will($this->returnValue($mockDaemon));
 
-        $command = new DaemonRunCommand('name', 'description', $mockDaemonFactory, $kernel);
+        $command = new DaemonRunCommand($kernel, $mockDaemonFactory);
 
         $command->run($input, $output);
     }

test/DaemonFactoryTest.php

@@ -6,7 +6,7 @@
 use PHPFastCGI\FastCGIDaemon\DaemonFactory;
 
 /**
- * Tests the daemon.
+ * Tests the daemon factory.
  */
 class DaemonFactoryTest extends \PHPUnit_Framework_TestCase
 {