Merge pull request #24 from sweoggy/patch-1

Make StaticUrlProvider also use proper alternative URLs
stefandoorn · Jan 28, 2018 · 4ea4b6b · 4ea4b6b
2 parents e59a084 + e868b6e
commit 4ea4b6b
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 28 deletions.
diff --git a/src/Provider/StaticUrlProvider.php b/src/Provider/StaticUrlProvider.php
@@ -4,7 +4,8 @@
 
 use SitemapPlugin\Factory\SitemapUrlFactoryInterface;
 use SitemapPlugin\Model\ChangeFrequency;
-use Sylius\Component\Locale\Context\LocaleContextInterface;
+use Sylius\Component\Channel\Context\ChannelContextInterface;
+use Sylius\Component\Core\Model\ChannelInterface;
 use Symfony\Component\Routing\RouterInterface;
 
 /**
@@ -22,11 +23,6 @@ final class StaticUrlProvider implements UrlProviderInterface
      */
     private $sitemapUrlFactory;
 
-    /**
-     * @var LocaleContextInterface
-     */
-    private $localeContext;
-
     /**
      * @var array
      */
@@ -37,22 +33,27 @@ final class StaticUrlProvider implements UrlProviderInterface
      */
     private $routes;
 
+    /**
+     * @var ChannelContextInterface
+     */
+    private $channelContext;
+
     /**
      * StaticUrlProvider constructor.
      * @param RouterInterface $router
      * @param SitemapUrlFactoryInterface $sitemapUrlFactory
-     * @param LocaleContextInterface $localeContext
+     * @param ChannelContextInterface $channelContext
      * @param array $routes
      */
     public function __construct(
         RouterInterface $router,
         SitemapUrlFactoryInterface $sitemapUrlFactory,
-        LocaleContextInterface $localeContext,
+        ChannelContextInterface $channelContext,
         array $routes
     ) {
         $this->router = $router;
         $this->sitemapUrlFactory = $sitemapUrlFactory;
-        $this->localeContext = $localeContext;
+        $this->channelContext = $channelContext;
         $this->routes = $routes;
     }
 
@@ -73,33 +74,55 @@ public function generate(): iterable
             return $this->urls;
         }
 
+        /** @var ChannelInterface $channel */
+        $channel = $this->channelContext->getChannel();
+
         foreach ($this->routes as $route) {
             $staticUrl = $this->sitemapUrlFactory->createNew();
             $staticUrl->setChangeFrequency(ChangeFrequency::weekly());
             $staticUrl->setPriority(0.3);
 
+            // Populate locales array by other enabled locales for current channel if no locales are specified
             if (!isset($route['locales']) || empty($route['locales'])) {
-                $route['locales'] = [$this->localeContext->getLocaleCode()];
+                $route['locales'] = $this->getAlternativeLocales($channel);
+            }
+
+            if (!array_key_exists('_locale', $route['parameters'])) {
+                $route['parameters']['_locale'] = $channel->getDefaultLocale()->getCode();
+            }
+            $location = $this->router->generate($route['route'], $route['parameters']);
+            $staticUrl->setLocalization($location);
+
+            foreach ($route['locales'] as $alternativeLocaleCode) {
+                $route['parameters']['_locale'] = $alternativeLocaleCode;
+                $alternativeLocation = $this->router->generate($route['route'], $route['parameters']);
+                $staticUrl->addAlternative($alternativeLocation, $alternativeLocaleCode);
             }
 
-            foreach ($route['locales'] as $localeCode) {
-                // Add localeCode to parameters if not set
-                if (!array_key_exists('_locale', $route['parameters'])) {
-                    $route['parameters']['_locale'] = $localeCode;
-                }
+            $this->urls[] = $staticUrl;
+        }
 
-                $location = $this->router->generate($route['route'], $route['parameters']);
+        return $this->urls;
+    }
 
-                if ($localeCode === $this->localeContext->getLocaleCode()) {
-                    $staticUrl->setLocalization($location);
-                } else {
-                    $staticUrl->addAlternative($location, $localeCode);
-                }
+    /**
+     * @param ChannelInterface $channel
+     *
+     * @return string[]
+     */
+    private function getAlternativeLocales(ChannelInterface $channel): array
+    {
+        $locales = [];
 
-                $this->urls[] = $staticUrl;
+        foreach ($channel->getLocales() as $locale) {
+            if ($locale === $channel->getDefaultLocale()) {
+                continue;
             }
+
+            $locales[] = $locale->getCode();
         }
 
-        return $this->urls;
+        return $locales;
     }
+
 }
diff --git a/src/Resources/config/services/providers/static.xml b/src/Resources/config/services/providers/static.xml
@@ -4,7 +4,7 @@
         <service id="sylius.sitemap_provider.static" class="SitemapPlugin\Provider\StaticUrlProvider">
             <argument type="service" id="router" />
             <argument type="service" id="sylius.sitemap_url_factory" />
-            <argument type="service" id="sylius.context.locale" />
+            <argument type="service" id="sylius.context.channel" />
             <argument>%sylius.sitemap_static%</argument>
             <tag name="sylius.sitemap_provider" />
         </service>

diff --git a/tests/Controller/AbstractTestController.php b/tests/Controller/AbstractTestController.php
@@ -60,6 +60,7 @@ public function setupDatabase()
         $this->channel->setTaxCalculationStrategy('order_items_based');
 
         $this->channel->addLocale($this->locale);
+        $this->channel->addLocale($locale);
 
         $this->getEntityManager()->persist($this->channel);
         $this->getEntityManager()->flush();

diff --git a/tests/Controller/SitemapStaticControllerApiTest.php b/tests/Controller/SitemapStaticControllerApiTest.php
@@ -2,8 +2,6 @@
 
 namespace Tests\SitemapPlugin\Controller;
 
-use Sylius\Component\Core\Model\Taxon;
-
 /**
  * @author Stefan Doorn <[email protected]>
  */

diff --git a/tests/Responses/Expected/show_sitemap_all.xml b/tests/Responses/Expected/show_sitemap_all.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <url>
     <loc>http://localhost/en_US/products/test</loc>
     <lastmod>@[email protected]()</lastmod>
@@ -13,11 +13,29 @@
   </url>
   <url>
     <loc>http://localhost/en_US/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/"/>
+    <changefreq>weekly</changefreq>
+    <priority>0.3</priority>
+  </url>
+  <url>
+    <loc>http://localhost/nl_NL/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/"/>
     <changefreq>weekly</changefreq>
     <priority>0.3</priority>
   </url>
   <url>
     <loc>http://localhost/en_US/contact/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/contact/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/contact/"/>
+    <changefreq>weekly</changefreq>
+    <priority>0.3</priority>
+  </url>
+  <url>
+    <loc>http://localhost/nl_NL/contact/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/contact/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/contact/"/>
     <changefreq>weekly</changefreq>
     <priority>0.3</priority>
   </url>

diff --git a/tests/Responses/Expected/show_sitemap_all_relative.xml b/tests/Responses/Expected/show_sitemap_all_relative.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <url>
     <loc>/en_US/products/test</loc>
     <lastmod>@[email protected]()</lastmod>
@@ -13,11 +13,29 @@
   </url>
   <url>
     <loc>/en_US/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="/en_US/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="/nl_NL/"/>
+    <changefreq>weekly</changefreq>
+    <priority>0.3</priority>
+  </url>
+  <url>
+    <loc>/nl_NL/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="/en_US/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="/nl_NL/"/>
     <changefreq>weekly</changefreq>
     <priority>0.3</priority>
   </url>
   <url>
     <loc>/en_US/contact/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="/en_US/contact/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="/nl_NL/contact/"/>
+    <changefreq>weekly</changefreq>
+    <priority>0.3</priority>
+  </url>
+  <url>
+    <loc>/nl_NL/contact/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="/en_US/contact/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="/nl_NL/contact/"/>
     <changefreq>weekly</changefreq>
     <priority>0.3</priority>
   </url>

diff --git a/tests/Responses/Expected/show_sitemap_static.xml b/tests/Responses/Expected/show_sitemap_static.xml
@@ -2,11 +2,29 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <url>
     <loc>http://localhost/en_US/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/"/>
+    <changefreq>weekly</changefreq>
+    <priority>0.3</priority>
+  </url>
+  <url>
+    <loc>http://localhost/nl_NL/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/"/>
     <changefreq>weekly</changefreq>
     <priority>0.3</priority>
   </url>
   <url>
     <loc>http://localhost/en_US/contact/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/contact/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/contact/"/>
+    <changefreq>weekly</changefreq>
+    <priority>0.3</priority>
+  </url>
+  <url>
+    <loc>http://localhost/nl_NL/contact/</loc>
+    <xhtml:link rel="alternate" hreflang="en" href="http://localhost/en_US/contact/"/>
+    <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/nl_NL/contact/"/>
     <changefreq>weekly</changefreq>
     <priority>0.3</priority>
   </url>
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,8 +2,6 @@ @@
     namespace Tests\SitemapPlugin\Controller;
-    use Sylius\Component\Core\Model\Taxon;
     /**
      * @author Stefan Doorn <[email protected]>
      */
@@ Expand Down @@