Merge pull request #14 from smmd/master

[ALICE-1062] Added help message.

Author: Harrison Heck

DependencyInjection/CompilerPass.php

@@ -16,6 +16,7 @@ public function process(ContainerBuilder $container)
         $this->loadFormlyFields($container);
         $this->loadDataProviders($container);
         $this->loadSubscribers($container);
+        $this->loadHelpMessageProviders($container);
     }
 
     /**
@@ -66,4 +67,19 @@ public function loadSubscribers(ContainerBuilder $container)
             }
         }
     }
+
+    /**
+     * @param ContainerBuilder $container
+     */
+    public function loadHelpMessageProviders(ContainerBuilder $container)
+    {
+        $containerDefinition = $container->getDefinition('dynamic_form.factory');
+        $taggedServices = $container->findTaggedServiceIds('dynamic_form.help_message_provider');
+
+        foreach ($taggedServices as $id => $tags) {
+            foreach ($tags as $attributes) {
+                $containerDefinition->addMethodCall('addHelpMessageProvider', [$attributes['alias'], new Reference($id)]);
+            }
+        }
+    }
 }

DependencyInjection/Configuration.php

@@ -47,6 +47,9 @@ public function getConfigTreeBuilder()
 
                         ->scalarNode('data_provider')
                         ->end()
+
+                        ->scalarNode('help_message_provider')
+                        ->end()
                     ->end()
                 ->end()
             ->end()

Form/Extension/HelpMessageTypeExtension.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Linio\DynamicFormBundle\Form\Extension;
+
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormView;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\Form\Extension\Core\Type\FormType;
+
+class HelpMessageTypeExtension extends AbstractTypeExtension
+{
+    /**
+     * @return string
+     */
+    public function getExtendedType()
+    {
+        return FormType::class;
+    }
+
+    /**
+     * @param OptionsResolver $resolver
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefined(['help']);
+    }
+
+    /**
+     * @param FormView $view
+     * @param FormInterface $form
+     * @param array $options
+     */
+    public function buildView(FormView $view, FormInterface $form, array $options)
+    {
+        $view->vars['help'] = isset($options['help']) ? $options['help'] : '';
+    }
+}

Form/FormFactory.php

@@ -3,6 +3,7 @@
 namespace Linio\DynamicFormBundle\Form;
 
 use Linio\DynamicFormBundle\DataProvider;
+use Linio\DynamicFormBundle\HelpMessageProvider;
 use Linio\DynamicFormBundle\Exception\NonExistentFormException;
 use Linio\DynamicFormBundle\Exception\NotExistentDataProviderException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -32,6 +33,11 @@ class FormFactory
      */
     protected $eventSubscribers = [];
 
+    /**
+     * @var HelpMessageProvider[]
+     */
+    protected $helpMessageProviders = [];
+
     /**
      * @param SymfonyFormFactory $formFactory
      */
@@ -57,6 +63,15 @@ public function addDataProvider($alias, DataProvider $dataProvider)
         $this->dataProviders[$alias] = $dataProvider;
     }
 
+    /**
+     * @param string $alias
+     * @param HelpMessageProvider $helpMessageProvider
+     */
+    public function addHelpMessageProvider($alias, HelpMessageProvider $helpMessageProvider)
+    {
+        $this->helpMessageProviders[$alias] = $helpMessageProvider;
+    }
+
     /**
      * @param string                   $formName
      * @param EventSubscriberInterface $eventSubscriber
@@ -120,6 +135,10 @@ public function createBuilder($key, $data = [], $options = [], $name = null)
                 $fieldOptions['choices'] = $this->loadDataProvider($fieldConfiguration['data_provider'])->getData();
             }
 
+            if (isset($fieldConfiguration['help_message_provider'])) {
+                $fieldOptions['help'] = $this->loadHelpMessageProvider($fieldConfiguration['help_message_provider'])->getHelpMessage($fieldOptions['help']);
+            }
+
             if (isset($fieldConfiguration['validation'])) {
                 $constraints = [];
 
@@ -167,6 +186,22 @@ public function loadDataProvider($alias)
         return $this->dataProviders[$alias];
     }
 
+    /**
+     * @param string $alias
+     *
+     * @return HelpMessageProvider
+     *
+     * @throws NotExistentDataProviderException
+     */
+    public function loadHelpMessageProvider($alias)
+    {
+        if (!isset($this->helpMessageProviders[$alias])) {
+            throw new NotExistentDataProviderException();
+        }
+
+        return $this->helpMessageProviders[$alias];
+    }
+
     /**
      * @param string $name
      *

HelpMessageProvider.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Linio\DynamicFormBundle;
+
+interface HelpMessageProvider
+{
+    /**
+     * @param string $key
+     *
+     * @return string
+     */
+    public function getHelpMessage($key);
+}

Resources/config/services.yml

@@ -104,3 +104,8 @@ services:
         lazy: true
         tags:
             - {name: formly_field, alias: url}
+
+    form.type_extension.help_message:
+        class: Linio\DynamicFormBundle\Form\Extension\HelpMessageTypeExtension
+        tags:
+            - {name: form.type_extension, alias: Symfony\Component\Form\Extension\Core\Type\FormType}

Tests/Form/FormFactoryTest.php

@@ -23,6 +23,7 @@ class FormFactoryTest extends \PHPUnit_Framework_TestCase
      * @var ObjectProphecy
      */
     protected $formFactoryMock;
+
     /**
      * @expectedException \Linio\DynamicFormBundle\Exception\NonExistentFormException
      */
@@ -159,6 +160,51 @@ public function testIsCreatingFormWithTransformers()
         $this->assertEquals('foo_form', $actual);
     }
 
+    public function testIsCreatingFormWithHelpMessages()
+    {
+        $formConfiguration = [
+            'foo' => [
+                'field1' => [
+                    'enabled' => true,
+                    'type' => 'field1_type',
+                    'help_message_provider' => 'cache',
+                    'options' => [
+                        'help' => 'cms:message',
+                    ],
+                ],
+            ],
+        ];
+
+        $helpMessageProviderMock = $this->prophesize('Linio\DynamicFormBundle\HelpMessageProvider');
+
+        $helpMessageProviderMock->getHelpMessage('cms:message')
+            ->shouldBeCalled()
+            ->willReturn('message');
+
+        $this->formFactoryMock->createNamedBuilder('foo', 'form', ['foo_form_data'], $formConfiguration)
+            ->shouldBeCalled()
+            ->willReturn($this->formBuilderMock->reveal());
+
+        $this->formBuilderMock->create('field1', 'field1_type', ['help' => 'message'])
+            ->shouldBeCalled()
+            ->willReturn('field1_instance');
+
+        $this->formBuilderMock->add('field1_instance')
+            ->shouldBeCalled();
+
+        $this->formBuilderMock->getForm()
+            ->shouldBeCalled()
+            ->willReturn('foo_form');
+
+        $this->formFactory->setFormFactory($this->formFactoryMock->reveal());
+        $this->formFactory->setConfiguration($formConfiguration);
+        $this->formFactory->addHelpMessageProvider('cache', $helpMessageProviderMock->reveal());
+
+        $actual = $this->formFactory->createForm('foo', ['foo_form_data'], $formConfiguration);
+
+        $this->assertEquals('foo_form', $actual);
+    }
+
     public function testIsGettingConfiguration()
     {
         $configuration = [
@@ -242,12 +288,15 @@ class MockTransformer implements DataTransformerInterface
     public function setUserFormat()
     {
     }
+
     public function setInputFormat()
     {
     }
+
     public function transform($value)
     {
     }
+
     public function reverseTransform($value)
     {
     }