Merge pull request #1 from ajgarlag/symfony-bundle

Add Symfony Bundle

CHANGELOG.md

@@ -4,6 +4,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+### Added
+- Add Symfony Bundle
+
 ## 0.1.0 - 2016-03-09
 
 ### Added

README.md

@@ -51,6 +51,23 @@ Once registered, you can call the new `breakpoint` function:
 ```
 
 
+Symfony Bundle
+--------------
+
+If you want to use this extension in your Symfony application, you can enable the
+Symfony Bundle included in this package:
+
+```php
+// app/AppKernel.php
+if (in_array($this->getEnvironment(), array('dev', 'test'), true)) {
+    $bundles[] = new Ajgl\Twig\Extension\SymfonyBundle\AjglBreakpointTwigExtensionBundle();
+}
+```
+
+This bundle will register the twig extension automatically. So, once enabled, you
+can insert the `breakpoint` twig function in your templates.
+
+
 License
 -------
 

composer.json

@@ -22,8 +22,14 @@
         "php": ">=5.4.0",
         "twig/twig": "^1.14"
     },
+    "require-dev": {
+        "symfony/framework-bundle": "^2.3",
+        "symfony/twig-bundle": "^2.3"
+    },
     "suggest": {
-        "ext-xdebug": "The Xdebug extension is required for the breakpoint to work"
+        "ext-xdebug": "The Xdebug extension is required for the breakpoint to work",
+        "symfony/framework-bundle": "The framework bundle to integrate the extension into Symfony",
+        "symfony/twig-bundle": "The twig bundle to integrate the extension into Symfony"
     },
     "extra": {
         "branch-alias": {

src/SymfonyBundle/AjglBreakpointTwigExtensionBundle.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * AJGL Breakpoint Twig Extension Component
+ *
+ * Copyright (C) Antonio J. García Lagar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ajgl\Twig\Extension\SymfonyBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/**
+ * @author Antonio J. García Lagar <[email protected]>
+ */
+class AjglBreakpointTwigExtensionBundle extends Bundle
+{
+}

src/SymfonyBundle/DependencyInjection/AjglBreakpointTwigExtensionExtension.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * AJGL Breakpoint Twig Extension Component
+ *
+ * Copyright (C) Antonio J. García Lagar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ajgl\Twig\Extension\SymfonyBundle\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+
+/**
+ * @author Antonio J. García Lagar <[email protected]>
+ */
+class AjglBreakpointTwigExtensionExtension extends Extension
+{
+    public function load(array $config, ContainerBuilder $container)
+    {
+        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('twig.xml');
+    }
+}

src/SymfonyBundle/Resources/config/twig.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="ajgl_twig_extension.breakpoint" class="Ajgl\Twig\Extension\BreakpointExtension" public="false">
+            <tag name="twig.extension"/>
+        </service>
+    </services>
+
+</container>

tests/SymfonyBundle/DependencyInjection/AjglBreakpointTwigExtensionExtensionTest.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * AJGL Breakpoint Twig Extension Component
+ *
+ * Copyright (C) Antonio J. García Lagar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ajgl\Twig\Extension\Tests\SymfonyBundle\DependencyInjection;
+
+use Ajgl\Twig\Extension\SymfonyBundle\DependencyInjection\AjglBreakpointTwigExtensionExtension;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * @author Antonio J. García Lagar <[email protected]>
+ */
+class AjglBreakpointTwigExtensionExtensionTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var ContainerBuilder
+     */
+    protected $container;
+
+    /**
+     * @var AjglBreakpointTwigExtensionExtension
+     */
+    protected $extension;
+
+    protected function setUp()
+    {
+        $this->container = new ContainerBuilder();
+        $this->extension = new AjglBreakpointTwigExtensionExtension();
+    }
+
+    public function testTwigExtensionsDefinition()
+    {
+        $this->extension->load(array(), $this->container);
+        $this->assertTrue($this->container->hasDefinition('ajgl_twig_extension.breakpoint'));
+        $definition = $this->container->getDefinition('ajgl_twig_extension.breakpoint');
+        $this->assertSame(
+            'Ajgl\Twig\Extension\BreakpointExtension',
+            $definition->getClass()
+        );
+        $this->assertNotNull($definition->getTag('twig.extension'));
+    }
+}