Added an optional flashmessage listener

DependencyInjection/Configuration.php

@@ -39,6 +39,13 @@ public function getConfigTreeBuilder()
                 ->scalarNode('spam_detector')->defaultValue('fos_message.noop_spam_detector')->cannotBeEmpty()->end()
                 ->scalarNode('twig_extension')->defaultValue('fos_message.twig_extension.default')->cannotBeEmpty()->end()
                 ->scalarNode('user_transformer')->defaultValue('fos_user.user_to_username_transformer')->cannotBeEmpty()->end()
+                ->arrayNode('flash_messages')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->booleanNode('enabled')->defaultFalse()->end()
+                        ->scalarNode('flash_key')->defaultValue('success')->cannotBeEmpty()->end()
+                    ->end()
+                ->end()    
                 ->arrayNode('search')
                     ->addDefaultsIfNotSet()
                     ->children()

DependencyInjection/FOSMessageExtension.php

@@ -65,5 +65,10 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->getDefinition('fos_message.recipients_data_transformer')
             ->replaceArgument(0, new Reference($config['user_transformer']));
+
+        if ($config['flash_messages']['enabled']) {
+            $container->setParameter('fos_message.flash_messages_key', $config['flash_messages']['flash_key']);
+            $loader->load('flash.xml');
+        }
     }
 }

EventListener/FlashListener.php

@@ -0,0 +1,92 @@
+<?php
+namespace FOS\MessageBundle\EventListener;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use FOS\MessageBundle\Event\FOSMessageEvents;
+use Symfony\Component\Translation\TranslatorInterface;
+use Symfony\Component\HttpFoundation\Session\Session;
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * The flash listener adds flash messages when certain message events occur
+ *
+ * @author Michiel Boeckaert <[email protected]>
+ */
+class FlashListener implements EventSubscriberInterface
+{
+    private static $successMessages = array(
+        FOSMessageEvents::POST_SEND => 'flash_post_send_success',
+        FOSMessageEvents::POST_DELETE => 'flash_thread_delete_success',
+        FOSMessageEvents::POST_UNDELETE => 'flash_thread_undelete_success',
+    );
+
+    /**
+     * Translator
+     *
+     * @var TranslatorInterface
+     */
+    protected $translator;
+
+    /**
+     * Session
+     *
+     * @var Session
+     */
+    protected $session;
+
+    /**
+     * The flash key
+     *
+     * @var string
+     */
+    protected $key;
+
+    /**
+     * Constructor.
+     *
+     * @param Session             $session    The current session
+     * @param TranslatorInterface $translator A translator instance
+     * @param string              $key        The flash key
+     */
+    public function __construct(Session $session, TranslatorInterface $translator, $key)
+    {
+        $this->session = $session;
+        $this->translator = $translator;
+        $this->key = $key;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+         return array(
+             FOSMessageEvents::POST_SEND => 'addSuccessFlash',
+             FOSMessageEvents::POST_DELETE => 'addSuccessFlash',
+             FOSMessageEvents::POST_UNDELETE => 'addSuccessFlash'
+         );
+    }
+
+    /**
+     * Adds a flashmessage to the session
+     *
+     * @param Event $event The current event
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function addSuccessFlash(Event $event)
+    {
+        $eventName = $event->getname();
+
+        if (!isset(self::$successMessages[$eventName])) {
+            throw new \InvalidArgumentException('This event does not correspond to a known flash message');
+        }
+
+        $this->session->getFlashBag()->add($this->key, $this->trans(self::$successMessages[$eventName]));
+    }
+
+    private function trans($message, array $params = array())
+    {
+        return $this->translator->trans($message, $params, 'FOSMessageBundle');
+    }
+}

Resources/config/flash.xml

@@ -0,0 +1,22 @@
+<?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">
+
+    <parameters>
+        <parameter key="fos_message.flash_listener.class">FOS\MessageBundle\EventListener\FlashListener</parameter>
+    </parameters>
+
+    <services>
+
+         <service id="fos_message.flash_listener" class="%fos_message.flash_listener.class%">
+            <argument type="service" id="session" />
+            <argument type="service" id="translator" />
+            <argument>%fos_message.flash_messages_key%</argument>
+            <tag name="kernel.event_subscriber" />
+        </service>
+
+    </services>
+
+</container>

Resources/doc/99-config-reference.md

@@ -37,4 +37,7 @@ fos_message:
         type:               fos_message.reply_form.type         # See FormType\ReplyMessageFormType
         handler:            fos_message.reply_form.handler      # See FormHandler\ReplyMessageFormHandler
         name:               message
+    flash_messages: # Optional show flash messages (http://symfony.com/doc/current/book/controller.html#flash-messages)
+        enabled: # Boolean defaults to false, set to true to enable flash messages
+        flash_key: # Optional string, name of the flash key defaults to success
 ```

Resources/translations/FOSMessageBundle.en.yml

@@ -22,3 +22,7 @@ by:             By %sender%
 no_thread:      There is no thread to show
 delete:         Delete
 undelete:       Undelete
+
+flash_post_send_success: Your message has been sent
+flash_thread_delete_success: The thread has been deleted
+flash_thread_undelete_success: The thread has been restored

Resources/translations/FOSMessageBundle.nl.yml

@@ -21,3 +21,7 @@ on:             Op %date%
 by:             Door %sender%
 no_thread:      Geen onderwerpen gevonden
 delete:         Verwijder
+
+flash_post_send_success: Jouw bericht werd succesvol verzonden
+flash_thread_delete_success: Onderwerp werd verwijderd
+flash_thread_undelete_success: Onderwerp niet langer verwijderd

Tests/DependencyInjection/FOSMessageExtensionTest.php

@@ -0,0 +1,152 @@
+<?php
+
+namespace FOS\MessageBundle\Tests\DependencyInjection;
+
+use FOS\MessageBundle\DependencyInjection\FOSMessageExtension;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Yaml\Parser;
+
+class FOSMessageExtensionTest extends \PHPUnit_Framework_TestCase
+{
+
+    /** @var ContainerBuilder */
+    protected $containerBuilder;
+
+    /**
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     */
+    public function testMessageLoadThrowsExceptionUnlessDbDriverSet()
+    {
+        $loader = new FOSMessageExtension();
+        $config = $this->getEmptyConfig();
+        unset($config['db_driver']);
+        $loader->load(array($config), new ContainerBuilder());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     */
+    public function testMessageLoadThrowsExceptionUnlessThreadClassSet()
+    {
+        $loader = new FOSMessageExtension();
+        $config = $this->getEmptyConfig();
+        unset($config['thread_class']);
+        $loader->load(array($config), new ContainerBuilder());
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     */
+    public function testMessageLoadThrowsExceptionUnlessMessageClassSet()
+    {
+        $loader = new FOSMessageExtension();
+        $config = $this->getEmptyConfig();
+        unset($config['message_class']);
+        $loader->load(array($config), new ContainerBuilder());
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Invalid db driver "foo"
+     */
+    public function testUnsupportedDbDriverThrowsException()
+    {
+        $loader = new FOSMessageExtension();
+        $config = $this->getEmptyConfig();
+        $config['db_driver'] = "foo";
+        $loader->load(array($config), new ContainerBuilder());
+    }
+
+    public function testFlashesAreDisabledByDefault()
+    {
+        $this->createEmptyConfiguration();
+        $this->assertNotHasDefinition('fos_message.flash_listener');
+    }
+
+    public function testUserEnablesFlashes()
+    {
+        $this->containerBuilder = new ContainerBuilder();
+        $loader = new FOSMessageExtension();
+        $config = $this->getEmptyConfigWithFlashesEnabled();
+        $loader->load(array($config), $this->containerBuilder);
+
+        $this->assertHasDefinition('fos_message.flash_listener');
+        $this->assertParameter('success', 'fos_message.flash_messages_key');
+    }
+
+    protected function createEmptyConfiguration()
+    {
+        $this->containerBuilder = new ContainerBuilder();
+        $loader = new FOSMessageExtension();
+        $config = $this->getEmptyConfig();
+        $loader->load(array($config), $this->containerBuilder);
+        $this->assertTrue($this->containerBuilder instanceof ContainerBuilder);
+    }
+
+    /**
+     * gets an empty config
+     *
+     * @return array
+     */
+    protected function getEmptyConfig()
+    {
+        $yaml = <<<EOF
+db_driver: mongodb
+thread_class: Acme\MyBundle\Entity\Thread
+message_class: Acme\MyBundle\Entity\Message
+EOF;
+        $parser = new Parser();
+
+        return $parser->parse($yaml);
+    }
+
+    /**
+     * Gets an empty config but with the optional flash settings enabled
+     * 
+     * @return array
+     */
+    protected function getEmptyConfigWithFlashesEnabled()
+    {
+       $yaml = <<<EOF
+db_driver: mongodb
+thread_class: Acme\MyBundle\Entity\Thread
+message_class: Acme\MyBundle\Entity\Message
+flash_messages:
+    enabled: true
+EOF;
+        $parser = new Parser();
+
+        return $parser->parse($yaml);
+    }
+
+    /**
+     * Asserts that a parameter key has a certain value
+     * 
+     * @param mixed  $value
+     * @param string $key
+     */
+    private function assertParameter($value, $key)
+    {
+        $this->assertEquals($value, $this->containerBuilder->getParameter($key), sprintf('%s parameter is correct', $key));
+    }
+
+    /**
+     * Asserts that a definition exists
+     * 
+     * @param string $id
+     */
+    private function assertHasDefinition($id)
+    {
+        $this->assertTrue(($this->containerBuilder->hasDefinition($id) || $this->containerBuilder->hasAlias($id)));
+    }
+
+    /**
+     * Asserts that a definition does not exist 
+     * 
+     * @param string $id
+     */
+    private function assertNotHasDefinition($id)
+    {
+        $this->assertFalse(($this->containerBuilder->hasDefinition($id) || $this->containerBuilder->hasAlias($id)));
+    }
+}

Tests/EventListener/FlashListenerTest.php

@@ -0,0 +1,62 @@
+<?php
+namespace FOS\MessageBundle\Tests\EventListener;
+
+use FOS\MessageBundle\EventListener\FlashListener;
+use FOS\MessageBundle\Event\FOSMessageEvents;
+
+/**
+ * Test for the Flash listener
+ * 
+ * @author Michiel Boeckaert <[email protected]>
+ */
+class FlashListenerTest extends \PHPUnit_Framework_TestCase
+{
+    private $listener;
+    private $session;
+    private $translator;
+    private $event;   
+    private $key;
+
+    public function setUp() 
+    {
+        $this->event = $this->getMock('Symfony\Component\EventDispatcher\Event');
+
+        //if we use the interface getflashbag returns an error...
+        $this->session = $this->getMockBuilder('Symfony\Component\HttpFoundation\Session\Session')->disableOriginalConstructor()->getMock();
+        $this->translator = $this->getMock('Symfony\Component\Translation\TranslatorInterface');
+        $this->key = 'success';
+        $this->listener = new FlashListener($this->session, $this->translator, $this->key);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage This event does not correspond to a known flash message
+     */
+    public function testAddFlashWithNonSupportedEvent() 
+    {
+        $this->event->expects($this->once())->method('getName')->will($this->returnValue('foo'));
+        $this->listener->addSuccessFlash($this->event);        
+    }
+
+    public function testAddFlashOnValidEvent()
+    {
+        $flashbagMock = $this->getMock('Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface');
+
+        $this->event->expects($this->once())->method('getName')->will($this->returnValue(FOSMessageEvents::POST_SEND));
+
+        $this->translator->expects($this->once())
+            ->method('trans')
+            ->with('flash_post_send_success', array(), 'FOSMessageBundle')
+            ->will($this->returnValue('translatedString'));
+
+        $this->session->expects($this->once())
+            ->method('getFlashBag')
+            ->will($this->returnValue($flashbagMock));
+
+        $flashbagMock->expects($this->once())
+            ->method('add')
+            ->with('success', 'translatedString');
+
+        $this->listener->addSuccessFlash($this->event);
+    }
+}