[5.1] Convert mod_feed to service provider (#42215)

Co-authored-by: Martina  Scholz <[email protected]>

Author: heelc29

modules/mod_feed/mod_feed.php

@@ -11,7 +11,7 @@
 	<description>MOD_FEED_XML_DESCRIPTION</description>
 	<namespace path="src">Joomla\Module\Feed</namespace>
 	<files>
-		<filename module="mod_feed">mod_feed.php</filename>
+		<folder module="mod_feed">services</folder>
 		<folder>src</folder>
 		<folder>tmpl</folder>
 	</files>

modules/mod_feed/mod_feed.xml

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_feed
+ *
+ * @copyright   (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+\defined('_JEXEC') or die;
+
+use Joomla\CMS\Extension\Service\Provider\HelperFactory;
+use Joomla\CMS\Extension\Service\Provider\Module;
+use Joomla\CMS\Extension\Service\Provider\ModuleDispatcherFactory;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+
+/**
+ * The feed module service provider.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+return new class () implements ServiceProviderInterface {
+    /**
+     * Registers the service provider with a DI container.
+     *
+     * @param   Container  $container  The DI container.
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function register(Container $container): void
+    {
+        $container->registerServiceProvider(new ModuleDispatcherFactory('\\Joomla\\Module\\Feed'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\Feed\\Site\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

modules/mod_feed/services/provider.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  mod_feed
+ *
+ * @copyright   (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\Feed\Site\Dispatcher;
+
+use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
+use Joomla\CMS\Helper\HelperFactoryAwareInterface;
+use Joomla\CMS\Helper\HelperFactoryAwareTrait;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_feed
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
+{
+    use HelperFactoryAwareTrait;
+
+    /**
+     * Returns the layout data.
+     *
+     * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    protected function getLayoutData(): array
+    {
+        $data = parent::getLayoutData();
+
+        $data['rssurl'] = $data['params']->get('rssurl', '');
+        $data['rssrtl'] = $data['params']->get('rssrtl', 0);
+        $data['feed']   = $this->getHelperFactory()->getHelper('FeedHelper')->getFeedInformation($data['params']);
+
+        return $data;
+    }
+}

modules/mod_feed/src/Dispatcher/Dispatcher.php

@@ -30,8 +30,10 @@ class FeedHelper
      * @param   \Joomla\Registry\Registry  $params  module parameters
      *
      * @return  \Joomla\CMS\Feed\Feed|string
+     *
+     * @since   __DEPLOY_VERSION__
      */
-    public static function getFeed($params)
+    public function getFeedInformation($params)
     {
         // Module params
         $rssurl = $params->get('rssurl', '');
@@ -52,4 +54,23 @@ public static function getFeed($params)
             return $rssDoc;
         }
     }
+
+    /**
+     * Retrieve feed information
+     *
+     * @param   \Joomla\Registry\Registry  $params  module parameters
+     *
+     * @return  \Joomla\CMS\Feed\Feed|string
+     *
+     * @deprecated __DEPLOY_VERSION__ will be removed in 7.0
+     *              Use the non-static method getFeedInformation
+     *              Example: Factory::getApplication()->bootModule('mod_feed', 'site')
+     *                           ->getHelper('FeedHelper')
+     *                           ->getFeedInformation($params, Factory::getApplication())
+     *
+     */
+    public static function getFeed($params)
+    {
+        return (new self())->getFeedInformation($params);
+    }
 }

modules/mod_feed/src/Helper/FeedHelper.php

@@ -0,0 +1,18 @@
+describe('Test in frontend that the feed module', () => {
+  ['joomla.org'].forEach((file) => {
+    it('can display feed', () => {
+      cy.db_createModule({
+        title: 'automated test feed',
+        module: 'mod_feed',
+        params: `{"rssurl": "${Cypress.config('baseUrl')}/tests/System/data/com_newsfeeds/${file}.xml" }`,
+      })
+        .then(() => {
+          cy.visit('/');
+
+          cy.contains('automated test feed');
+          cy.get('ul.newsfeed').should('exist');
+          cy.get('ul.newsfeed').children().should('have.length', 3);
+        });
+    });
+  });
+});