Initial commit

Author: solocommand

.gitignore

@@ -46,3 +46,4 @@
 
 # Backup entities generated with doctrine:generate:entities command
 */Entity/*~
+.DS_Store

As3PostProcessBundle.php

@@ -0,0 +1,15 @@
+<?php
+namespace As3\PostProcessBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use As3\PostProcessBundle\DependencyInjection\Compiler;
+
+class As3PostProcessBundle extends Bundle
+{
+    public function build(ContainerBuilder $container)
+    {
+        $container->addCompilerPass(new Compiler\AddTasksCompilerPass());
+        $container->addCompilerPass(new Compiler\AddPluginsCompilerPass());
+    }
+}

DependencyInjection/Compiler/AddPluginsCompilerPass.php

@@ -0,0 +1,38 @@
+<?php
+namespace As3\PostProcessBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class AddPluginsCompilerPass implements CompilerPassInterface
+{
+    /**
+     * Adds tagged autoloaders to the manager service
+     *
+     * @param   ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $managerId = 'as3_post_process.task.manager';
+        if (!$container->hasDefinition($managerId)) {
+            return;
+        }
+        // Get the manager service definition
+        $definition = $container->getDefinition($managerId);
+
+        // Get the tagged plugins
+        $tag     = 'as3_post_process.plugin';
+        $plugins = $container->findTaggedServiceIds($tag);
+
+        foreach ($plugins as $id => $tagAttributes) {
+            foreach ($tagAttributes as $attributes) {
+                // Add the plugin to the manager service definition
+                $definition->addMethodCall(
+                    'addPlugin',
+                    [new Reference($id)]
+                );
+            }
+        }
+    }
+}

DependencyInjection/Compiler/AddTasksCompilerPass.php

@@ -0,0 +1,39 @@
+<?php
+namespace As3\PostProcessBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class AddTasksCompilerPass implements CompilerPassInterface
+{
+    /**
+     * Adds tagged autoloaders to the manager service
+     *
+     * @param   ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $managerId = 'as3_post_process.task.manager';
+        if (!$container->hasDefinition($managerId)) {
+            return;
+        }
+        // Get the manager service definition
+        $definition = $container->getDefinition($managerId);
+
+        // Get the tagged tasks
+        $tag   = 'as3_post_process.task';
+        $tasks = $container->findTaggedServiceIds($tag);
+
+        foreach ($tasks as $id => $tagAttributes) {
+            foreach ($tagAttributes as $attributes) {
+                // Add the task to the manager service definition
+                $priority = isset($attributes['priority']) ? $attributes['priority'] : 0;
+                $definition->addMethodCall(
+                    'addTask',
+                    [new Reference($id), $priority]
+                );
+            }
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace As3\PostProcessBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+/**
+ * This is the class that validates and merges configuration from your app/config files
+ *
+ * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
+ */
+class Configuration implements ConfigurationInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $rootNode = $treeBuilder->root('as3_post_process');
+        return $treeBuilder;
+    }
+}

DependencyInjection/CygnusPostProcessExtension.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace As3\PostProcessBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * This is the class that loads and manages your bundle configuration
+ *
+ * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
+ */
+class As3PostProcessExtension extends Extension
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        // Load bundle services
+        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('services.yml');
+    }
+}

Plugins/PluginInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace As3\PostProcessBundle\Plugins;
+
+use Symfony\Component\HttpKernel\Event\PostResponseEvent;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Defines structure for PostProcess plugins
+ *
+ * @author Josh Worden <solocommand@gmail.com>
+ */
+interface PluginInterface
+{
+    /**
+     * Fires before TaskManager registers shutdown functions for loaded tasks.
+     * Called by As3\PostProcessBundle\Task\TaskManager::execute()
+     *
+     * @param   PostResponseEvent   $event  The Symfony post response event
+     */
+    public function execute(PostResponseEvent $event);
+
+    /**
+     * Handles modification (filtering) of the response as needed.
+     * Called by As3\PostProcessBundle\Task\TaskManager::filterResponse() before returning the response.
+     *
+     * @param   Response            $event  The Symfony Response
+     */
+    public function filterResponse(Response $response);
+}

README.md

@@ -1,2 +1,28 @@
 # PostProcessBundle
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/as3io/As3ModlrBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/as3io/As3ModlrBundle/?branch=master) [![Build Status](https://travis-ci.org/as3io/As3ModlrBundle.svg?branch=master)](https://travis-ci.org/as3io/As3ModlrBundle) [![Packagist](https://img.shields.io/packagist/dt/as3/modlr-bundle.svg)](https://packagist.org/packages/as3/modlr-bundle) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/6d7d530c-f405-4815-847a-4f7ff82960c5/mini.png)](https://insight.sensiolabs.com/projects/6d7d530c-f405-4815-847a-4f7ff82960c5)
+
 Provides centralized support for executing callable code before Symfony framework termination
+
+## Installation
+
+### Install packages with Composer
+
+To install this bundle via composer, perform the following command: `composer require as3/post-process-bundle ^1.0`.
+
+### Register the Bundle
+
+Once installed, register the bundle in your `AppKernel.php`:
+```
+// app/AppKernel.php
+public function registerBundles()
+{
+    $bundles = array(
+        // ...
+        new As3\Bundle\PostProcessBundle\As3PostProcessBundle(),
+    );
+
+    // ...
+}
+```
+
+## Configuration

Resources/config/services.yml

@@ -0,0 +1,6 @@
+services:
+    as3_post_process.task.manager:
+        class: As3\PostProcessBundle\Task\TaskManager
+        tags:
+            - { name: kernel.event_listener, event: kernel.response, method: filterResponse, priority: -255 }
+            - { name: kernel.event_listener, event: kernel.terminate, method: execute, priority: 1 }

Task/TaskInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace As3\PostProcessBundle\Task;
+
+/**
+ * Interface for Tasks to be executed "post process" - after the response is sent
+ *
+ * @author Jacob Bare <jacob.bare@gmail.com>
+ */
+interface TaskInterface
+{
+    /**
+     * Runs the task/code
+     *
+     * @return self
+     */
+    public function run();
+}