add RouteName value object

rectorphp · Jan 13, 2021 · d926085 · d926085
1 parent 3b4f851
commit d926085
Show file tree

Hide file tree

Showing 24 changed files with 108 additions and 57 deletions.
diff --git a/packages/blog/src/Controller/BlogController.php b/packages/blog/src/Controller/BlogController.php
@@ -11,11 +11,12 @@
 
 final class BlogController extends AbstractController
 {
-    public function __construct(private PostRepository $postRepository)
-    {
+    public function __construct(
+        private PostRepository $postRepository
+    ) {
     }
 
-    #[Route('blog', name: 'blog')]
+    #[Route('blog', name: \Rector\Website\ValueObject\Routing\RouteName::BLOG)]
     public function __invoke(): Response
     {
         return $this->render('blog/blog.twig', [

diff --git a/packages/blog/src/Controller/PostController.php b/packages/blog/src/Controller/PostController.php
@@ -11,11 +11,12 @@
 
 final class PostController extends AbstractController
 {
-    public function __construct(private PostRepository $postRepository)
-    {
+    public function __construct(
+        private PostRepository $postRepository
+    ) {
     }
 
-    #[Route('blog/{postSlug}', name: 'post', requirements: [
+    #[Route('blog/{postSlug}', name: \Rector\Website\ValueObject\Routing\RouteName::POST, requirements: [
         'postSlug' => '.+',
     ])]
     public function __invoke(string $postSlug): Response

diff --git a/packages/blog/src/Controller/RssController.php b/packages/blog/src/Controller/RssController.php
@@ -13,11 +13,12 @@
 
 final class RssController extends AbstractController
 {
-    public function __construct(private PostRepository $postRepository)
-    {
+    public function __construct(
+        private PostRepository $postRepository
+    ) {
     }
 
-    #[Route('rss.xml', name: 'rss')]
+    #[Route('rss.xml', name: \Rector\Website\ValueObject\Routing\RouteName::RSS)]
     public function __invoke(): Response
     {
         $posts = $this->postRepository->getPosts();

diff --git a/packages/blog/src/Repository/PostRepository.php b/packages/blog/src/Repository/PostRepository.php
@@ -22,8 +22,10 @@ final class PostRepository
      */
     private array $posts = [];
 
-    public function __construct(private FinderSanitizer $finderSanitizer, private PostFactory $postFactory)
-    {
+    public function __construct(
+        private FinderSanitizer $finderSanitizer,
+        private PostFactory $postFactory
+    ) {
         $this->createPosts();
     }
 

diff --git a/packages/blog/src/Twig/MarkdownTwigExtension.php b/packages/blog/src/Twig/MarkdownTwigExtension.php
@@ -10,8 +10,9 @@
 
 final class MarkdownTwigExtension extends AbstractExtension
 {
-    public function __construct(private ParsedownExtra $parsedownExtra)
-    {
+    public function __construct(
+        private ParsedownExtra $parsedownExtra
+    ) {
     }
 
     /**

diff --git a/packages/blog/src/Twig/RoutingTwigExtension.php b/packages/blog/src/Twig/RoutingTwigExtension.php
@@ -12,8 +12,9 @@
 
 final class RoutingTwigExtension extends AbstractExtension
 {
-    public function __construct(private RequestStack $requestStack)
-    {
+    public function __construct(
+        private RequestStack $requestStack
+    ) {
     }
 
     /**

diff --git a/packages/demo/src/DemoRunner.php b/packages/demo/src/DemoRunner.php
@@ -11,8 +11,9 @@
 
 final class DemoRunner
 {
-    public function __construct(private RectorProcessRunner $rectorProcessRunner)
-    {
+    public function __construct(
+        private RectorProcessRunner $rectorProcessRunner
+    ) {
     }
 
     public function processRectorRun(RectorRun $rectorRun): void

diff --git a/packages/demo/src/Lint/PHPLinter.php b/packages/demo/src/Lint/PHPLinter.php
@@ -18,8 +18,9 @@ final class PHPLinter
      */
     private const OPENING_PHP_TAG_REGEX = '#(\s+)?\<\?php#';
 
-    public function __construct(private SmartFileSystem $smartFileSystem)
-    {
+    public function __construct(
+        private SmartFileSystem $smartFileSystem
+    ) {
     }
 
     public function checkContentSyntax(string $content): void

diff --git a/packages/demo/src/Repository/RectorRunRepository.php b/packages/demo/src/Repository/RectorRunRepository.php
@@ -11,8 +11,9 @@
 
 final class RectorRunRepository
 {
-    public function __construct(private EntityManagerInterface $entityManager)
-    {
+    public function __construct(
+        private EntityManagerInterface $entityManager
+    ) {
     }
 
     public function save(RectorRun $rectorRun): void

diff --git a/packages/demo/src/ValueObject/AppliedRule.php b/packages/demo/src/ValueObject/AppliedRule.php
@@ -17,8 +17,9 @@ final class AppliedRule
 
     private string $shortClass;
 
-    public function __construct(private string $class)
-    {
+    public function __construct(
+        private string $class
+    ) {
         $shortClassName = Strings::after($class, '\\', -1);
         if (! is_string($shortClassName)) {
             throw new ShouldNotHappenException();

diff --git a/packages/demo/src/ValueObjectFactory/RectorRunFactory.php b/packages/demo/src/ValueObjectFactory/RectorRunFactory.php
@@ -19,8 +19,9 @@ final class RectorRunFactory
      */
     public const CONFIG_FILE_PATH = __DIR__ . '/../../data/demo-config.php';
 
-    public function __construct(private SmartFileSystem $smartFileSystem)
-    {
+    public function __construct(
+        private SmartFileSystem $smartFileSystem
+    ) {
     }
 
     public function createEmpty(): RectorRun

diff --git a/packages/github-magic-link/src/LinkFactory/IssueLinkFactory.php b/packages/github-magic-link/src/LinkFactory/IssueLinkFactory.php
@@ -15,8 +15,9 @@ final class IssueLinkFactory
      */
     private const BASE_URL = 'https://github.com/rectorphp/rector/issues/new?labels=bug&template=1_Bug_report.md';
 
-    public function __construct(private IssueBodyFactory $issueBodyFactory)
-    {
+    public function __construct(
+        private IssueBodyFactory $issueBodyFactory
+    ) {
     }
 
     public function create(RectorRun $rectorRun): string

diff --git a/packages/github-magic-link/src/Twig/FixtureLinkTwigExtension.php b/packages/github-magic-link/src/Twig/FixtureLinkTwigExtension.php
@@ -16,8 +16,9 @@ final class FixtureLinkTwigExtension extends AbstractExtension
      */
     private const PR_LINK = 'pr_link';
 
-    public function __construct(private FixtureLinkFactory $fixtureLinkFactory)
-    {
+    public function __construct(
+        private FixtureLinkFactory $fixtureLinkFactory
+    ) {
     }
 
     /**

diff --git a/packages/github-magic-link/src/Twig/IssueLinkTwigExtension.php b/packages/github-magic-link/src/Twig/IssueLinkTwigExtension.php
@@ -16,8 +16,9 @@ final class IssueLinkTwigExtension extends AbstractExtension
      */
     private const ISSUE_LINK = 'issue_link';
 
-    public function __construct(private IssueLinkFactory $issueLinkFactory)
-    {
+    public function __construct(
+        private IssueLinkFactory $issueLinkFactory
+    ) {
     }
 
     /**

diff --git a/phpstan.neon b/phpstan.neon
@@ -17,3 +17,4 @@ parameters:
         - '#Method Rector\\Website\\Demo\\Form\\DemoFormType\:\:buildForm\(\) has parameter \$formBuilder with no value type specified in iterable type Symfony\\Component\\Form\\FormBuilderInterface#'
         - '#Method Rector\\Website\\Form\\ContactFormType\:\:buildForm\(\) has parameter \$formBuilder with no value type specified in iterable type Symfony\\Component\\Form\\FormBuilderInterface#'
         - '#Method Rector\\Website\\Demo\\Controller\\DemoController\:\:processFormAndReturnRoute\(\) has parameter \$form with no value type specified in iterable type Symfony\\Component\\Form\\FormInterface#'
+        - '#Content of method "save\(\)" is duplicated with method "save\(\)" in "Rector\\Website\\Repository\\ContactMessageRepository" class\. Use unique content or abstract service instead#'
diff --git a/rector.php b/rector.php
@@ -7,6 +7,7 @@
 use Rector\DeadCode\Rector\Class_\RemoveUnusedDoctrineEntityMethodAndPropertyRector;
 use Rector\Generic\Rector\FuncCall\FuncCallToStaticCallRector;
 use Rector\Set\ValueObject\SetList;
+use Rector\SymfonyCodeQuality\Rector\Attribute\ExtractAttributeRouteNameConstantsRector;
 use Rector\Transform\ValueObject\FuncCallToStaticCall;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\inline_service;
@@ -46,6 +47,8 @@
 
     $services = $containerConfigurator->services();
 
+    $services->set(ExtractAttributeRouteNameConstantsRector::class);
+
     $services->set(FuncCallToStaticCallRector::class)
         ->call('configure', [[
             FuncCallToStaticCallRector::FUNC_CALLS_TO_STATIC_CALLS => [

diff --git a/src/Controller/BankDetailsController.php b/src/Controller/BankDetailsController.php
@@ -10,7 +10,7 @@
 
 final class BankDetailsController extends AbstractController
 {
-    #[Route(path: 'bank-details', name: 'bank_details')]
+    #[Route(path: 'bank-details', name: \Rector\Website\ValueObject\Routing\RouteName::BANK_DETAILS)]
     public function __invoke(): Response
     {
         return $this->render('homepage/bank_details.twig');

diff --git a/src/Controller/ContactController.php b/src/Controller/ContactController.php
@@ -8,19 +8,19 @@
 use Rector\Website\Exception\ShouldNotHappenException;
 use Rector\Website\Form\ContactFormType;
 use Rector\Website\Repository\ContactMessageRepository;
-use Rector\Website\ValueObject\RouteName;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 
 final class ContactController extends AbstractController
 {
-    public function __construct(private ContactMessageRepository $contactMessageRepository, )
-    {
+    public function __construct(
+        private ContactMessageRepository $contactMessageRepository,
+    ) {
     }
 
-    #[Route(path: 'contact', name: RouteName::CONTACT)]
+    #[Route(path: 'contact', name: \Rector\Website\ValueObject\Routing\RouteName::CONTACT)]
     public function __invoke(Request $request): Response
     {
         $form = $this->createForm(ContactFormType::class);
@@ -35,7 +35,7 @@ public function __invoke(Request $request): Response
             $this->contactMessageRepository->save($contactMessage);
             $this->addFlash('success', 'Your message is on the way!');
 
-            return $this->redirectToRoute(RouteName::CONTACT);
+            return $this->redirectToRoute(\Rector\Website\ValueObject\Routing\RouteName::CONTACT);
         }
 
         return $this->render('homepage/contact.twig', [

diff --git a/src/Controller/HomepageController.php b/src/Controller/HomepageController.php
@@ -11,11 +11,12 @@
 
 final class HomepageController extends AbstractController
 {
-    public function __construct(private PostRepository $postRepository)
-    {
+    public function __construct(
+        private PostRepository $postRepository
+    ) {
     }
 
-    #[Route(path: '/', name: 'homepage')]
+    #[Route(path: '/', name: \Rector\Website\ValueObject\Routing\RouteName::HOMEPAGE)]
     public function __invoke(): Response
     {
         return $this->render('homepage/homepage.twig', [

diff --git a/src/Controller/MissionController.php b/src/Controller/MissionController.php
@@ -10,7 +10,7 @@
 
 final class MissionController extends AbstractController
 {
-    #[Route(path: 'mission', name: 'mission')]
+    #[Route(path: 'mission', name: \Rector\Website\ValueObject\Routing\RouteName::MISSION)]
     public function __invoke(): Response
     {
         return $this->render('homepage/mission.twig');

diff --git a/src/Controller/RssController.php b/src/Controller/RssController.php
@@ -10,7 +10,7 @@
 
 final class RssController extends AbstractController
 {
-    #[Route(path: 'rss.xml', name: 'rss')]
+    #[Route(path: 'rss.xml', name: \Rector\Website\ValueObject\Routing\RouteName::RSS)]
     public function __invoke(): Response
     {
         return $this->render('homepage/rss.twig');

diff --git a/src/Repository/ContactMessageRepository.php b/src/Repository/ContactMessageRepository.php
@@ -9,8 +9,9 @@
 
 final class ContactMessageRepository
 {
-    public function __construct(private EntityManagerInterface $entityManager)
-    {
+    public function __construct(
+        private EntityManagerInterface $entityManager
+    ) {
     }
 
     public function save(ContactMessage $contactMessage): void

diff --git a/src/ValueObject/RouteName.php b/src/ValueObject/RouteName.php
diff --git a/src/ValueObject/Routing/RouteName.php b/src/ValueObject/Routing/RouteName.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Website\ValueObject\Routing;
+
+final class RouteName
+{
+    /**
+     * @var string
+     */
+    public const BANK_DETAILS = 'bank_details';
+
+    /**
+     * @var string
+     */
+    public const HOMEPAGE = 'homepage';
+
+    /**
+     * @var string
+     */
+    public const MISSION = 'mission';
+
+    /**
+     * @var string
+     */
+    public const RSS = 'rss';
+
+    /**
+     * @var string
+     */
+    public const BLOG = 'blog';
+
+    /**
+     * @var string
+     */
+    public const POST = 'post';
+
+    /**
+     * @var string
+     */
+    public const CONTACT = 'contact';
+}