Merge pull request #2 from webfactory/update_symfony_fix_tests

Fix tests, cover newer Symfony versions

Author: mpdude

.gitignore

@@ -1,3 +1,5 @@
 composer.lock
 vendor/
 phpunit.xml
+.php_cs.cache
+Tests/Fixtures/cache/

.php_cs.dist

@@ -0,0 +1,20 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setRules(array(
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+//         'array_syntax' => array('syntax' => 'long'),
+        'no_unreachable_default_argument_value' => false,
+        'braces' => array('allow_single_line_closure' => true),
+        'heredoc_to_nowdoc' => false,
+        'phpdoc_annotation_without_dot' => false,
+    ))
+    ->setRiskyAllowed(true)
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__)
+            ->notPath('Tests/Fixtures/cache/')
+            ->notPath('vendor/')
+    )
+;

.scrutinizer.yml

@@ -1,67 +1,29 @@
 build:
     environment:
-        php: '5.5.9'
         timezone: 'Europe/Berlin'
         postgresql: false
         node: false
         redis: false
+        variables:
+            COMPOSER_MEMORY_LIMIT: -1
 
     tests:
         override:
-            -
-                command: 'vendor/bin/phpunit --coverage-clover=clover.xml'
-                coverage:
-                    file: 'clover.xml'
-                    format: 'clover'
+        -   command: 'vendor/bin/phpunit --coverage-clover=clover.xml'
+            coverage:
+                file: 'clover.xml'
+                format: 'clover'
 
-tools:
-    php_mess_detector:
-        config:
-            code_size_rules: { cyclomatic_complexity: true, npath_complexity: true, excessive_method_length: true, excessive_class_length: true, excessive_parameter_list: true, excessive_public_count: true, too_many_fields: true, too_many_methods: true, excessive_class_complexity: true }
-            design_rules: { number_of_class_children: true, depth_of_inheritance: true, coupling_between_objects: true }
-            unused_code_rules: { unused_local_variable: true, unused_private_method: true, unused_formal_parameter: true }
-            naming_rules: { short_variable: true, long_variable: true, short_method: true, boolean_method_name: true }
-            controversial_rules: { camel_case_class_name: true, camel_case_property_name: true, camel_case_method_name: true, camel_case_parameter_name: true, camel_case_variable_name: true }
-    php_cs_fixer:
-        config:
-            level: all
-            fixers: { unused_use: true, phpdoc_params: true, braces: true, php_closing_tag: true }
-    php_analyzer:
-        config:
-            suspicious_code: { enabled: true, overriding_parameter: true, overriding_closure_use: true, parameter_closure_use_conflict: true, parameter_multiple_times: true, non_existent_class_in_instanceof_check: true, non_existent_class_in_catch_clause: true, assignment_of_null_return: true, non_commented_switch_fallthrough: true, non_commented_empty_catch_block: true, overriding_private_members: true, use_statement_alias_conflict: true, precedence_in_condition_assignment: true }
-            verify_php_doc_comments: { enabled: true, parameters: true, return: true, suggest_more_specific_types: true, ask_for_return_if_not_inferrable: true, ask_for_param_type_annotation: true }
-            loops_must_use_braces: { enabled: true }
-            simplify_boolean_return: { enabled: true }
-            phpunit_checks: { enabled: true }
-            reflection_fixes: { enabled: true }
-            use_statement_fixes: { enabled: true, order_alphabetically: true, remove_unused: true, preserve_multiple: false, preserve_blanklines: false }
-            parameter_reference_check: { enabled: false }
-            checkstyle: { enabled: false, no_trailing_whitespace: true, naming: { enabled: true, local_variable: '^[a-z][a-zA-Z0-9]*$', abstract_class_name: ^Abstract|Factory$, utility_class_name: 'Utils?$', constant_name: '^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$', property_name: '^[a-z][a-zA-Z0-9]*$', method_name: '^(?:[a-z]|__)[a-zA-Z0-9]*$', parameter_name: '^[a-z][a-zA-Z0-9]*$', interface_name: '^[A-Z][a-zA-Z0-9]*Interface$', type_name: '^[A-Z][a-zA-Z0-9]*$', exception_name: '^[A-Z][a-zA-Z0-9]*Exception$', isser_method_name: '^(?:is|has|should|may|supports)' } }
-            unreachable_code: { enabled: false }
-            check_access_control: { enabled: false }
-            typo_checks: { enabled: false }
-            check_variables: { enabled: false }
-            check_calls: { enabled: true, too_many_arguments: true, missing_argument: true, argument_type_checks: lenient }
-            dead_assignments: { enabled: false }
-            check_usage_context: { enabled: true, foreach: { value_as_reference: true, traversable: true } }
-            reflection_checks: { enabled: false }
-            precedence_checks: { enabled: true, assignment_in_condition: true, comparison_of_bit_result: true }
-            basic_semantic_checks: { enabled: false }
-            unused_code: { enabled: false }
-            deprecation_checks: { enabled: false }
-            useless_function_calls: { enabled: false }
-            metrics_lack_of_cohesion_methods: { enabled: false }
-            metrics_coupling: { enabled: true, stable_code: { namespace_prefixes: {  }, classes: {  } } }
-            doctrine_parameter_binding: { enabled: false }
-            doctrine_entity_manager_injection: { enabled: false }
-            symfony_request_injection: { enabled: false }
-            doc_comment_fixes: { enabled: false }
-    php_code_sniffer:
-        config:
-            standard: PSR2
-            sniffs: { psr2: { classes: { property_declaration_sniff: true }, methods: { method_declaration_sniff: true } } }
-    sensiolabs_security_checker: true
-    php_loc: true
-    php_pdepend: true
-    php_sim: true
-    php_changetracking: true
+    nodes:
+
+        deps_lowest:
+            environment:
+                php: '7.2'
+            dependencies:
+                before:
+                    - command: composer update --prefer-lowest
+                      idle_timeout: 600
+                    
+        php_72:
+            environment:
+                php: '7.2'

Controller/GuideController.php

@@ -2,10 +2,7 @@
 
 namespace Webfactory\ShortcodeBundle\Controller;
 
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
-use Symfony\Component\DependencyInjection\Container;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
@@ -15,7 +12,9 @@
 final class GuideController
 {
     /**
-     * @var array [
+     * @var array
+     *
+     * Example structure: [
      *     [
      *         'shortcode' => 'img'
      *         'example' (optional key) => '[img src="https://upload.wikimedia.org/wikipedia/en/f/f7/RickRoll.png"]'
@@ -32,17 +31,19 @@ public function __construct(array $shortcodeTags)
 
     /**
      * @Template()
+     *
      * @return array
      */
     public function listAction()
     {
         return [
-            'shortcodeTags' => $this->shortcodeTags
+            'shortcodeTags' => $this->shortcodeTags,
         ];
     }
 
     /**
      * @Template()
+     *
      * @return array
      */
     public function detailAction($shortcode, Request $request)
@@ -52,7 +53,7 @@ public function detailAction($shortcode, Request $request)
                 // if custom parameters are provided, replace the example
                 $customParameters = $request->get('customParameters');
                 if ($customParameters) {
-                    $shortcodeTag['example'] = $shortcode . ' ' . $customParameters;
+                    $shortcodeTag['example'] = $shortcode.' '.$customParameters;
                 }
 
                 return [

DependencyInjection/WebfactoryShortcodeExtension.php

@@ -14,7 +14,7 @@ final class WebfactoryShortcodeExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container)
     {
-        $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('shortcodes.xml');
     }
 }

Handler/EmbeddedShortcodeHandler.php

@@ -33,28 +33,29 @@ class EmbeddedShortcodeHandler
 
     /**
      * @param FragmentHandler $fragmentHandler
-     * @param string $controllerName
-     * @param string $renderer
+     * @param string          $controllerName
+     * @param string          $renderer
      * @param LoggerInterface $logger
-     * @param RequestStack $requestStack
+     * @param RequestStack    $requestStack
      */
     public function __construct(
         FragmentHandler $fragmentHandler,
         $controllerName,
         $renderer,
-        LoggerInterface $logger = null,
-        RequestStack $requestStack
+        RequestStack $requestStack,
+        LoggerInterface $logger = null
     ) {
         $this->fragmentHandler = $fragmentHandler;
         $this->controllerName = $controllerName;
         $this->renderer = $renderer;
-        $this->logger = $logger ?: new NullLogger();
         $this->requestStack = $requestStack;
+        $this->logger = $logger ?: new NullLogger();
     }
 
     /**
      * @param ShortcodeInterface $shortcode
-     * @return null|string
+     *
+     * @return string|null
      */
     public function __invoke(ShortcodeInterface $shortcode)
     {

Handler/RemoveWrappingParagraphElementsEventHandler.php

@@ -50,7 +50,7 @@ function ($state, ReplacedShortcode $r) {
                     );
                 }
 
-                return $sourceTextBeforeShortcode . $r->getReplacement() . $sourceTextAfterShortcode;
+                return $sourceTextBeforeShortcode.$r->getReplacement().$sourceTextAfterShortcode;
             },
             $text
         );

Resources/config/shortcodes.xml

@@ -21,21 +21,21 @@
             <argument type="service" id="fragment.handler"/>
             <argument><!-- Controller name placeholder argument --></argument>
             <argument>esi</argument>
-            <argument type="service" id="logger" on-invalid="null" />
             <argument type="service" id="request_stack" />
+            <argument type="service" id="logger" on-invalid="null" />
         </service>
 
         <!-- Base definition for the EmbedForShortcodeHandler with inline renderer. -->
         <service abstract="true" id="webfactory.shortcode.embed_inline_for_shortcode_handler" class="Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler" lazy="true">
             <argument type="service" id="fragment.handler"/>
             <argument><!-- Controller name placeholder argument --></argument>
             <argument>inline</argument>
-            <argument type="service" id="logger" on-invalid="null" />
             <argument type="service" id="request_stack" />
+            <argument type="service" id="logger" on-invalid="null" />
         </service>
 
         <!-- Twig extension providing the |shortcodes filter. The content will be passed to the ShortcodeFacade. -->
-        <service class="Webfactory\ShortcodeBundle\Twig\ShortcodeExtension">
+        <service id="Webfactory\ShortcodeBundle\Twig\ShortcodeExtension" class="Webfactory\ShortcodeBundle\Twig\ShortcodeExtension">
             <argument type="service" id="webfactory.shortcode.facade"/>
             <tag name="twig.extension"/>
         </service>

Tests/DependencyInjection/Compiler/ShortcodeCompilerPassTest.php

@@ -2,12 +2,13 @@
 
 namespace Webfactory\ShortcodeBundle\Tests\DependencyInjection\Compiler;
 
+use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 use Webfactory\ShortcodeBundle\DependencyInjection\Compiler\ShortcodeCompilerPass;
 
-final class ShortcodeCompilerPassTest extends \PHPUnit_Framework_TestCase
+final class ShortcodeCompilerPassTest extends TestCase
 {
     /**
      * System under test.
@@ -34,24 +35,24 @@ public function tagged_services_are_added_as_handlers_to_facade()
             ->method('findTaggedServiceIds')
             ->willReturn([
                 'service_id1' => [
-                    ['shortcode' => 'shortcode1']
+                    ['shortcode' => 'shortcode1'],
                 ],
                 'service_id2' => [
-                    ['shortcode' => 'shortcode2']
-                ]
+                    ['shortcode' => 'shortcode2'],
+                ],
             ]);
 
-        $mockedShortcodeFacade = $this->getMock(Definition::class);
+        $mockedShortcodeFacade = $this->createMock(Definition::class);
         $mockedShortcodeFacade->expects($this->at(0))
             ->method('addMethodCall')
             ->with('addHandler', $this->callback(function (array $argument) {
-                return $argument[0] === 'shortcode1'
+                return 'shortcode1' === $argument[0]
                     && $argument[1] instanceof Reference;
             }));
         $mockedShortcodeFacade->expects($this->at(1))
             ->method('addMethodCall')
             ->with('addHandler', $this->callback(function ($argument) {
-                return $argument[0] === 'shortcode2'
+                return 'shortcode2' === $argument[0]
                     && $argument[1] instanceof Reference;
             }));
 
@@ -70,9 +71,9 @@ public function no_tagged_services_do_no_harm()
             ->method('findTaggedServiceIds')
             ->willReturn([]);
 
-        $this->setExpectedException(null);
-
         $this->compilerPass->process($this->containerBuilder);
+
+        $this->assertTrue(true);
     }
 
     /** @test */
@@ -82,31 +83,31 @@ public function shortcode_guide_service_gets_configured_if_set()
             ->method('findTaggedServiceIds')
             ->willReturn([
                 'service_id1' => [
-                    ['shortcode' => 'shortcode1']
+                    ['shortcode' => 'shortcode1'],
                 ],
                 'service_id2' => [
-                    ['shortcode' => 'shortcode2']
-                ]
+                    ['shortcode' => 'shortcode2'],
+                ],
             ]);
 
         $this->containerBuilder->expects($this->once())
             ->method('findDefinition')
             ->with('webfactory.shortcode.facade')
-            ->willReturn($this->getMock(Definition::class));
+            ->willReturn($this->createMock(Definition::class));
 
         $this->containerBuilder->expects($this->once())
             ->method('has')
             ->with('webfactory.shortcode.guide.controller')
             ->willReturn(true);
 
-        $mockedShortcodeGuideServiceDefinition = $this->getMock(Definition::class);
+        $mockedShortcodeGuideServiceDefinition = $this->createMock(Definition::class);
         $mockedShortcodeGuideServiceDefinition->expects($this->once())
             ->method('setArgument')
             ->with(
                 0,
                 [
                     ['shortcode' => 'shortcode1'],
-                    ['shortcode' => 'shortcode2']
+                    ['shortcode' => 'shortcode2'],
                 ]
             );
 
@@ -130,8 +131,8 @@ public function missing_shortcode_guide_service_does_no_harm()
             ->with('webfactory.shortcode.guide.controller')
             ->willReturn(false);
 
-        $this->setExpectedException(null);
-
         $this->compilerPass->process($this->containerBuilder);
+
+        $this->assertTrue(true);
     }
 }

Tests/Fixtures/PublicFragmentHandlerClass.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Webfactory\ShortcodeBundle\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Make fragement.handler public so it can be mocked in tests.
+ */
+class PublicFragmentHandlerClass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $container->getDefinition('fragment.handler')->setPublic(true);
+    }
+}