[Settings] Bundle clean up

Sylius · Oct 14, 2016 · b0b5f2a · b0b5f2a
1 parent 8976707
commit b0b5f2a
Show file tree

Hide file tree

Showing 22 changed files with 81 additions and 96 deletions.
diff --git a/Controller/SettingsController.php b/Controller/SettingsController.php
@@ -27,9 +27,6 @@
 class SettingsController extends FOSRestController
 {
     /**
-     * Get a specific settings data.
-     * This controller action only used for Rest API.
-     *
      * @param Request $request
      *
      * @return Response
@@ -103,15 +100,15 @@ public function updateAction(Request $request)
      */
     protected function getSettingsManager()
     {
-        return $this->get('sylius.settings.manager');
+        return $this->get('sylius.manager.settings');
     }
 
     /**
      * @return SettingsFormFactoryInterface
      */
     protected function getSettingsFormFactory()
     {
-        return $this->get('sylius.settings.form_factory');
+        return $this->get('sylius.form_factory.settings');
     }
 
     /**

diff --git a/DependencyInjection/Compiler/RegisterResolversPass.php b/DependencyInjection/Compiler/RegisterResolversPass.php
@@ -18,7 +18,7 @@
 /**
  * @author Steffen Brem <steffenbrem@gmail.com>
  */
-class RegisterResolversPass implements CompilerPassInterface
+final class RegisterResolversPass implements CompilerPassInterface
 {
     /**
      * {@inheritdoc}
@@ -34,7 +34,9 @@ public function process(ContainerBuilder $container)
         foreach ($container->findTaggedServiceIds('sylius.settings_resolver') as $id => $tags) {
             foreach ($tags as $attributes) {
                 if (!isset($attributes['schema'])) {
-                    throw new \InvalidArgumentException(sprintf('Service "%s" must define the "schema" attribute on "sylius.settings_resolver" tags.', $id));
+                    throw new \InvalidArgumentException(
+                        sprintf('Service "%s" must define the "schema" attribute on "sylius.settings_resolver" tags.', $id)
+                    );
                 }
 
                 $schemaAlias = $attributes['schema'];

diff --git a/DependencyInjection/Compiler/RegisterSchemasPass.php b/DependencyInjection/Compiler/RegisterSchemasPass.php
@@ -16,12 +16,9 @@
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
- * Registers all settings schemas in the schema registry.
- * Save the configuration names in parameter for the provider.
- *
  * @author Paweł Jędrzejewski <pawel@sylius.org>
  */
-class RegisterSchemasPass implements CompilerPassInterface
+final class RegisterSchemasPass implements CompilerPassInterface
 {
     /**
      * {@inheritdoc}
@@ -38,8 +35,11 @@ public function process(ContainerBuilder $container)
         foreach ($taggedServicesIds as $id => $tags) {
             foreach ($tags as $attributes) {
                 if (!isset($attributes['alias'])) {
-                    throw new \InvalidArgumentException(sprintf('Service "%s" must define the "alias" attribute on "sylius.settings_schema" tags.', $id));
+                    throw new \InvalidArgumentException(
+                        sprintf('Service "%s" must define the "alias" attribute on "sylius.settings_schema" tags.', $id)
+                    );
                 }
+
                 $schemaRegistry->addMethodCall('register', [$attributes['alias'], new Reference($id)]);
             }
         }

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -21,14 +21,9 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**
- * This class contains the configuration information for the bundle.
- *
- * This information is solely responsible for how the different configuration
- * sections are normalized, and merged.
- *
  * @author Paweł Jędrzejewski <pawel@sylius.org>
  */
-class Configuration implements ConfigurationInterface
+final class Configuration implements ConfigurationInterface
 {
     /**
      * {@inheritdoc}

diff --git a/Exception/ParameterNotFoundException.php b/Exception/ParameterNotFoundException.php
@@ -14,17 +14,17 @@
 /**
  * @author Steffen Brem <steffenbrem@gmail.com>
  */
-class ParameterNotFoundException extends \InvalidArgumentException
+final class ParameterNotFoundException extends \InvalidArgumentException
 {
     /**
      * @param string $parameter
      * @param int $code
-     * @param Exception $previous
+     * @param \Exception|null $previousException
      */
-    public function __construct($parameter, $code = 0, \Exception $previous = null)
+    public function __construct($parameter, $code = 0, \Exception $previousException = null)
     {
         $message = sprintf('Parameter with name "%s" does not exist.', $parameter);
 
-        parent::__construct($message, $code, $previous);
+        parent::__construct($message, $code, $previousException);
     }
 }
diff --git a/Form/Factory/SettingsFormFactoryInterface.php b/Form/Factory/SettingsFormFactoryInterface.php
@@ -20,7 +20,7 @@ interface SettingsFormFactoryInterface
 {
     /**
      * @param string $schemaAlias
-     * @param null|mixed $data
+     * @param mixed|null $data
      * @param array $options
      *
      * @return FormInterface

diff --git a/Manager/SettingsManager.php b/Manager/SettingsManager.php
@@ -84,7 +84,6 @@ public function load($schemaAlias, $namespace = null, $ignoreUnknown = true)
         /** @var SettingsResolverInterface $resolver */
         $resolver = $this->resolverRegistry->get($schemaAlias);
 
-        // try to resolve settings for schema alias and namespace
         $settings = $resolver->resolve($schemaAlias, $namespace);
 
         if (!$settings) {
@@ -99,7 +98,7 @@ public function load($schemaAlias, $namespace = null, $ignoreUnknown = true)
         $schema->buildSettings($settingsBuilder);
 
         // Remove unknown settings' parameters (e.g. From a previous version of the settings schema)
-        if (true === $ignoreUnknown) {
+        if ($ignoreUnknown) {
             foreach ($parameters as $name => $value) {
                 if (!$settingsBuilder->isDefined($name)) {
                     unset($parameters[$name]);

diff --git a/Resolver/DefaultSettingsResolver.php b/Resolver/DefaultSettingsResolver.php
@@ -15,9 +15,6 @@
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 
 /**
- * Default implementation that resolves settings in the simplest way possible. It tries to find a schema by it's name
- * and optionally the given namespace.
- *
  * @author Steffen Brem <steffenbrem@gmail.com>
  */
 final class DefaultSettingsResolver implements SettingsResolverInterface

diff --git a/Resolver/ResolverServiceRegistry.php b/Resolver/ResolverServiceRegistry.php
@@ -11,14 +11,12 @@
 
 namespace Sylius\Bundle\SettingsBundle\Resolver;
 
-use Sylius\Component\Registry\NonExistingServiceException;
-use Sylius\Component\Registry\ServiceRegistry;
 use Sylius\Component\Registry\ServiceRegistryInterface;
 
 /**
  * @author Steffen Brem <steffenbrem@gmail.com>
  */
-/* final */class ResolverServiceRegistry implements ServiceRegistryInterface
+final class ResolverServiceRegistry implements ServiceRegistryInterface
 {
     /**
      * @var ServiceRegistryInterface

diff --git a/Resources/config/routing.yml b/Resources/config/routing.yml
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -12,24 +12,19 @@
 -->
 
 <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="sylius.settings.schema_interface">Sylius\Bundle\SettingsBundle\Schema\SchemaInterface</parameter>
-        <parameter key="sylius.settings.resolver_interface">Sylius\Bundle\SettingsBundle\Resolver\SettingsResolverInterface</parameter>
-    </parameters>
-
     <services>
         <service id="sylius.controller.settings" class="Sylius\Bundle\SettingsBundle\Controller\SettingsController">
             <call method="setContainer">
                 <argument type="service" id="service_container" />
             </call>
         </service>
 
-        <service id="sylius.settings.form_factory" class="Sylius\Bundle\SettingsBundle\Form\Factory\SettingsFormFactory">
+        <service id="sylius.form_factory.settings" class="Sylius\Bundle\SettingsBundle\Form\Factory\SettingsFormFactory">
             <argument type="service" id="sylius.registry.settings_schema" />
             <argument type="service" id="form.factory" />
         </service>
 
-        <service id="sylius.settings.manager" class="Sylius\Bundle\SettingsBundle\Manager\SettingsManager">
+        <service id="sylius.manager.settings" class="Sylius\Bundle\SettingsBundle\Manager\SettingsManager">
             <argument type="service" id="sylius.registry.settings_schema" />
             <argument type="service" id="sylius.registry.settings_resolver" />
             <argument type="service" id="sylius.manager.settings" />
@@ -38,33 +33,33 @@
         </service>
 
         <service id="sylius.registry.settings_schema" class="Sylius\Component\Registry\ServiceRegistry" lazy="true">
-            <argument>%sylius.settings.schema_interface%</argument>
+            <argument>Sylius\Bundle\SettingsBundle\Schema\SchemaInterface</argument>
             <argument>Settings schema</argument>
         </service>
 
         <service id="sylius.registry.settings_resolver" class="Sylius\Bundle\SettingsBundle\Resolver\ResolverServiceRegistry" lazy="true">
             <argument type="service">
                 <service class="Sylius\Component\Registry\ServiceRegistry">
-                    <argument>%sylius.settings.resolver_interface%</argument>
+                    <argument>Sylius\Bundle\SettingsBundle\Resolver\SettingsResolverInterface</argument>
                     <argument>Settings resolver</argument>
                 </service>
             </argument>
-            <argument type="service" id="sylius.settings.default_resolver"/>
+            <argument type="service" id="sylius.settings_resolver.default"/>
         </service>
 
-        <service id="sylius.settings.default_resolver" class="Sylius\Bundle\SettingsBundle\Resolver\DefaultSettingsResolver">
+        <service id="sylius.settings_resolver.default" class="Sylius\Bundle\SettingsBundle\Resolver\DefaultSettingsResolver">
             <argument type="service" id="sylius.repository.settings" />
         </service>
 
-        <service id="sylius.settings.doctrine.transform_settings_listener" class="Sylius\Bundle\SettingsBundle\Doctrine\EventListener\ParameterTransformerListener">
+        <service id="sylius.doctrine.settings_parameter_transformer_listener" class="Sylius\Bundle\SettingsBundle\Doctrine\EventListener\ParameterTransformerListener">
             <argument type="service" id="service_container"/>
             <tag name="doctrine.event_listener" event="onFlush"/>
             <tag name="doctrine.event_listener" event="postFlush"/>
             <tag name="doctrine.event_listener" event="postLoad"/>
         </service>
 
         <service id="sylius.templating.helper.settings" class="Sylius\Bundle\SettingsBundle\Templating\Helper\SettingsHelper">
-            <argument type="service" id="sylius.settings.manager" />
+            <argument type="service" id="sylius.manager.settings" />
             <tag name="templating.helper" alias="sylius_settings" />
         </service>
 

diff --git a/Schema/SettingsBuilder.php b/Schema/SettingsBuilder.php
@@ -27,18 +27,16 @@ class SettingsBuilder extends OptionsResolver implements SettingsBuilderInterfac
     /**
      * {@inheritdoc}
      */
-    public function setTransformer($parameterName, ParameterTransformerInterface $transformer)
+    public function getTransformers()
     {
-        $this->transformers[$parameterName] = $transformer;
-
-        return $this;
+        return $this->transformers;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getTransformers()
+    public function setTransformer($parameterName, ParameterTransformerInterface $transformer)
     {
-        return $this->transformers;
+        $this->transformers[$parameterName] = $transformer;
     }
 }
diff --git a/SyliusSettingsBundle.php b/SyliusSettingsBundle.php
@@ -18,8 +18,6 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Settings system for ecommerce Symfony2 applications.
- *
  * @author Paweł Jędrzejewski <pawel@sylius.org>
  */
 class SyliusSettingsBundle extends AbstractResourceBundle

diff --git a/Transformer/ParameterTransformerInterface.php b/Transformer/ParameterTransformerInterface.php
@@ -17,17 +17,13 @@
 interface ParameterTransformerInterface
 {
     /**
-     * Transform the parameter into format which is suitable for storage.
-     *
      * @param mixed $value
      *
      * @return mixed
      */
     public function transform($value);
 
     /**
-     * Transform parameter value back into it's original form.
-     *
      * @param mixed $value
      *
      * @return mixed

diff --git a/spec/Form/Factory/SettingsFormFactorySpec.php b/spec/Form/Factory/SettingsFormFactorySpec.php
@@ -12,14 +12,17 @@
 namespace spec\Sylius\Bundle\SettingsBundle\Form\Factory;
 
 use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\SettingsBundle\Form\Factory\SettingsFormFactory;
 use Sylius\Bundle\SettingsBundle\Form\Factory\SettingsFormFactoryInterface;
 use Sylius\Bundle\SettingsBundle\Schema\SchemaInterface;
 use Sylius\Component\Registry\ServiceRegistryInterface;
-use Symfony\Component\Form\Form;
 use Symfony\Component\Form\FormBuilder;
 use Symfony\Component\Form\FormFactoryInterface;
+use Symfony\Component\Form\FormInterface;
 
 /**
+ * @mixin SettingsFormFactory
+ *
  * @author Paweł Jędrzejewski <pawel@sylius.org>
  */
 final class SettingsFormFactorySpec extends ObjectBehavior
@@ -33,20 +36,20 @@ function let(
 
     function it_is_initializable()
     {
-        $this->shouldHaveType('Sylius\Bundle\SettingsBundle\Form\Factory\SettingsFormFactory');
+        $this->shouldHaveType(SettingsFormFactory::class);
     }
 
-    function it_should_implement_settings_form_factory_interface()
+    function it_implements_settings_form_factory_interface()
     {
         $this->shouldImplement(SettingsFormFactoryInterface::class);
     }
 
     function it_should_create_a_form_for_given_schema_namespace(
-        $schemaRegistry,
-        SchemaInterface $schema,
-        $formFactory,
+        FormInterface $form,
         FormBuilder $formBuilder,
-        Form $form
+        FormFactoryInterface $formFactory,
+        SchemaInterface $schema,
+        ServiceRegistryInterface $schemaRegistry
     ) {
         $schemaRegistry->get('sylius_general')->willReturn($schema);
         $formFactory->createBuilder('form', null, ['data_class' => null])->willReturn($formBuilder);

diff --git a/spec/Manager/SettingsManagerSpec.php b/spec/Manager/SettingsManagerSpec.php
@@ -13,12 +13,15 @@
 
 use Doctrine\Common\Persistence\ObjectManager;
 use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\SettingsBundle\Manager\SettingsManager;
 use Sylius\Bundle\SettingsBundle\Manager\SettingsManagerInterface;
 use Sylius\Component\Registry\ServiceRegistryInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
+ * @mixin SettingsManager
+ *
  * @author Paweł Jędrzejewski <pawel@sylius.org>
  */
 final class SettingsManagerSpec extends ObjectBehavior
@@ -41,10 +44,10 @@ function let(
 
     function it_is_initializable()
     {
-        $this->shouldHaveType('Sylius\Bundle\SettingsBundle\Manager\SettingsManager');
+        $this->shouldHaveType(SettingsManager::class);
     }
 
-    function it_should_be_a_Sylius_settings_manager()
+    function it_should_be_a_settings_manager()
     {
         $this->shouldImplement(SettingsManagerInterface::class);
     }

diff --git a/spec/Model/SettingsSpec.php b/spec/Model/SettingsSpec.php
@@ -13,16 +13,19 @@
 
 use PhpSpec\ObjectBehavior;
 use Sylius\Bundle\SettingsBundle\Exception\ParameterNotFoundException;
+use Sylius\Bundle\SettingsBundle\Model\Settings;
 use Sylius\Bundle\SettingsBundle\Model\SettingsInterface;
 
 /**
+ * @mixin Settings
+ *
  * @author Steffen Brem <steffenbrem@gmail.com>
  */
 final class SettingsSpec extends ObjectBehavior
 {
     function it_is_initializable()
     {
-        $this->shouldHaveType('Sylius\Bundle\SettingsBundle\Model\Settings');
+        $this->shouldHaveType(Settings::class);
     }
 
     function it_implements_settings_interface()
@@ -78,10 +81,7 @@ function its_parameters_has_empty_array_by_default()
     function it_can_set_a_parameter()
     {
         $this->set('key', 'value');
-        $this->getParameters()->shouldReturn([
-            'key' => 'value',
-        ])
-        ;
+        $this->getParameters()->shouldReturn(['key' => 'value']);
     }
 
     function it_throws_parameter_not_found_exception_when_getting_non_existing_parameter()