First commit

mnapoli · mnapoli · commit d41aeff67600 · 2016-01-03T13:22:17.000+01:00
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -0,0 +1,2 @@
+coverage_clover: clover.xml
+json_path: coveralls-upload.json
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,10 @@
+# .gitattributes
+tests/ export-ignore
+.coveralls.yml export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+phpunit.xml.dist export-ignore
+
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+/vendor/
+/composer.lock
+/.puli/
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,25 @@
+language: php
+
+php:
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - hhvm
+
+matrix:
+  include:
+    - php: 5.4
+      env: dependencies=lowest
+
+before_script:
+  - if [[ "$TRAVIS_PHP_VERSION" == '5.6' ]]; then composer require satooshi/php-coveralls:dev-master -n ; fi
+  - if [[ "$TRAVIS_PHP_VERSION" != '5.6' ]]; then composer install -n ; fi
+  - if [ "$dependencies" = "lowest" ]; then composer update --prefer-lowest --prefer-stable -n; fi;
+
+script:
+  - if [[ "$TRAVIS_PHP_VERSION" == '5.6' ]]; then vendor/bin/phpunit --coverage-clover clover.xml ; fi
+  - if [[ "$TRAVIS_PHP_VERSION" != '5.6' ]]; then vendor/bin/phpunit ; fi
+
+after_script:
+  - if [[ "$TRAVIS_PHP_VERSION" == '5.6' ]]; then php vendor/bin/coveralls -v ; fi
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing
+
+First of all, **thank you** for contributing!
+
+Here are a few rules to follow in order to ease code reviews and merging:
+
+- follow [PSR-1](http://www.php-fig.org/psr/1/) and [PSR-2](http://www.php-fig.org/psr/2/)
+- run the test suite
+- write (or update) unit tests when applicable
+- write documentation for new features
+- use [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+
+One may ask you to [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) too. This is used to "clean" your pull request before merging it (we don't want commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
+
+When creating your pull request on GitHub, please write a description which gives the context and/or explains why you are creating it.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Matthieu Napoli
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# PHP-DI application kernel
+
+Kernel for applications built with [PHP-DI](http://php-di.org) and [Puli](http://puli.io) with built-in support for PHP-DI modules.
+
+[![Build Status](https://img.shields.io/travis/PHP-DI/Kernel.svg?style=flat-square)](https://travis-ci.org/PHP-DI/Kernel)
+[![Coverage Status](https://img.shields.io/coveralls/PHP-DI/Kernel/master.svg?style=flat-square)](https://coveralls.io/r/PHP-DI/Kernel?branch=master)
+
+## Introduction
+
+TODO
+
+## Installation
+
+```
+composer require php-di/kernel
+```
+
+Requirements:
+
+- PHP 5.5 or greater
+- [Puli CLI tool](http://docs.puli.io/en/latest/installation.html#installing-the-puli-cli)
+
+## Usage
+
+TODO
diff --git a/composer.json b/composer.json
@@ -0,0 +1,28 @@
+{
+    "name": "php-di/kernel",
+    "description": "Kernel for PHP-DI applications",
+    "keywords": ["php-di", "application", "kernel"],
+    "homepage": "http://php-di.org",
+    "license": "MIT",
+    "type": "library",
+    "autoload": {
+        "psr-4": {
+            "DI\\Kernel\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "DI\\Kernel\\Test\\": "tests/"
+        }
+    },
+    "require": {
+        "php": "^5.5|^7.0",
+        "php-di/php-di": "^5.2",
+        "doctrine/cache": "^1.4",
+        "puli/repository": "^1.0.0-beta8@beta",
+        "puli/discovery": "^1.0.0-beta8@beta"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.0"
+    }
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<phpunit colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         bootstrap="./vendor/autoload.php">
+
+    <testsuites>
+        <testsuite name="Test suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+
+</phpunit>
diff --git a/puli.json b/puli.json
@@ -0,0 +1,8 @@
+{
+    "version": "1.0",
+    "binding-types": {
+        "php-di/configuration": {
+            "description": "PHP-DI configuration file"
+        }
+    }
+}
diff --git a/src/Kernel.php b/src/Kernel.php
@@ -0,0 +1,98 @@
+<?php
+
+namespace DI\Kernel;
+
+use DI\Cache\ArrayCache;
+use DI\Container;
+use DI\ContainerBuilder;
+use Doctrine\Common\Cache\Cache;
+use Puli\Discovery\Api\Binding\Binding;
+use Puli\Discovery\Api\Discovery;
+use Puli\Discovery\Binding\ResourceBinding;
+use Puli\Repository\Api\ResourceRepository;
+use Puli\Repository\Resource\FileResource;
+
+/**
+ * Application kernel.
+ *
+ * @author Matthieu Napoli <matthieu@mnapoli.fr>
+ */
+class Kernel
+{
+    /**
+     * Name of the binding for PHP-DI configuration files in Puli.
+     *
+     * @see http://docs.puli.io/en/latest/discovery/introduction.html
+     */
+    const PULI_BINDING_NAME = 'php-di/configuration';
+
+    /**
+     * Configure and create a container using all configuration files registered under
+     * the `php-di/configuration` binding type in Puli.
+     *
+     * @return Container
+     */
+    public function createContainer()
+    {
+        if (!defined('PULI_FACTORY_CLASS')) {
+            throw new \RuntimeException('Puli is not installed');
+        }
+
+        // Create Puli objects
+        $factoryClass = PULI_FACTORY_CLASS;
+        $factory = new $factoryClass();
+        /** @var ResourceRepository $repository */
+        $repository = $factory->createRepository();
+        /** @var Discovery $discovery */
+        $discovery = $factory->createDiscovery($repository);
+
+        $containerBuilder = new ContainerBuilder();
+
+        $cache = $this->getContainerCache();
+        if ($cache) {
+            $containerBuilder->setDefinitionCache($cache);
+        }
+
+        // Discover and load all configuration files registered under `php-di/configuration` in Puli
+        $bindings = $discovery->findBindings(self::PULI_BINDING_NAME);
+        $bindings = array_filter($bindings, function (Binding $binding) {
+            return $binding instanceof ResourceBinding;
+        });
+        /** @var ResourceBinding[] $bindings */
+        foreach ($bindings as $binding) {
+            foreach ($binding->getResources() as $resource) {
+                if (!$resource instanceof FileResource) {
+                    throw new \RuntimeException(sprintf('Cannot load "%s": only file resources are supported', $resource->getName()));
+                }
+                $containerBuilder->addDefinitions($resource->getFilesystemPath());
+            }
+        }
+
+        // Puli objects
+        $containerBuilder->addDefinitions([
+            ResourceRepository::class => $repository,
+            Discovery::class => $discovery,
+        ]);
+
+        $this->configureContainerBuilder($containerBuilder);
+
+        return $containerBuilder->build();
+    }
+
+    /**
+     * Override this method to configure the cache to use for container definitions.
+     *
+     * @return Cache|null
+     */
+    protected function getContainerCache()
+    {
+        return new ArrayCache();
+    }
+
+    /**
+     * Override this method to customize the container builder before it is used.
+     */
+    protected function configureContainerBuilder(ContainerBuilder $containerBuilder)
+    {
+    }
+}
diff --git a/tests/Fixture/PuliFactoryClass.php b/tests/Fixture/PuliFactoryClass.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace DI\Kernel\Test\Fixture;
+
+use Puli\Discovery\InMemoryDiscovery;
+use Puli\Repository\InMemoryRepository;
+
+class PuliFactoryClass
+{
+    /**
+     * @var InMemoryRepository
+     */
+    public static $repository;
+
+    /**
+     * @var InMemoryDiscovery
+     */
+    public static $discovery;
+
+    public function createRepository()
+    {
+        return self::$repository;
+    }
+
+    public function createDiscovery()
+    {
+        return self::$discovery;
+    }
+}
diff --git a/tests/Fixture/config.php b/tests/Fixture/config.php
@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'foo' => 'bar',
+];
diff --git a/tests/KernelTest.php b/tests/KernelTest.php
@@ -0,0 +1,81 @@
+<?php
+
+namespace DI\Kernel\Test;
+
+use DI\Kernel\Kernel;
+use DI\Kernel\Test\Fixture\PuliFactoryClass;
+use Puli\Discovery\Api\Discovery;
+use Puli\Discovery\Api\Type\BindingType;
+use Puli\Discovery\Binding\ResourceBinding;
+use Puli\Discovery\InMemoryDiscovery;
+use Puli\Repository\Api\ResourceRepository;
+use Puli\Repository\InMemoryRepository;
+use Puli\Repository\Resource\FileResource;
+
+/**
+ * @covers \DI\Application\Kernel
+ */
+class KernelTest extends \PHPUnit_Framework_TestCase
+{
+    public function setUp()
+    {
+        if (!defined('PULI_FACTORY_CLASS')) {
+            define('PULI_FACTORY_CLASS', PuliFactoryClass::class);
+        }
+
+        PuliFactoryClass::$repository = new InMemoryRepository();
+        PuliFactoryClass::$discovery = new InMemoryDiscovery();
+    }
+
+    /**
+     * @test
+     */
+    public function creates_a_container()
+    {
+        $this->assertInstanceOf('DI\Container', (new Kernel)->createContainer());
+    }
+
+    /**
+     * @test
+     */
+    public function registers_puli_repository()
+    {
+        $container = (new Kernel)->createContainer();
+        $this->assertInstanceOf(ResourceRepository::class, $container->get(ResourceRepository::class));
+    }
+
+    /**
+     * @test
+     */
+    public function registers_puli_discovery()
+    {
+        $container = (new Kernel)->createContainer();
+        $this->assertInstanceOf(Discovery::class, $container->get(Discovery::class));
+    }
+
+    /**
+     * @test
+     */
+    public function registers_module_configuration_files()
+    {
+        $this->createPuliResource('/blog/config.php', __DIR__ . '/Fixture/config.php');
+        $this->bindPuliResource('/blog/config.php', Kernel::PULI_BINDING_NAME);
+
+        $container = (new Kernel)->createContainer();
+        $this->assertEquals('bar', $container->get('foo'));
+    }
+
+    private function createPuliResource($path, $file)
+    {
+        PuliFactoryClass::$repository->add($path, new FileResource($file));
+    }
+
+    private function bindPuliResource($path, $bindingName)
+    {
+        PuliFactoryClass::$discovery->addBindingType(new BindingType($bindingName));
+
+        $binding = new ResourceBinding($path, $bindingName);
+        $binding->setRepository(PuliFactoryClass::$repository);
+        PuliFactoryClass::$discovery->addBinding($binding);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+coverage_clover: clover.xml`
	`2`	`+json_path: coveralls-upload.json`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/vendor/`
	`2`	`+/composer.lock`
	`3`	`+/.puli/`