Merge pull request #292 from mirko-pagliai/develop

added `MeCms.default.other_css` and `MeCms.default.other_js` configur…
mirko-pagliai · Feb 28, 2023 · ad2516d · ad2516d
2 parents e664108 + 48ee9e0
commit ad2516d
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 114 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # 2.x branch
 ## 2.31 branch
+### 2.31.4
+* removed the `cookies_policy` template element, the `SystemsController::acceptCookies()` method and all code related to
+  privacy for cookies (you need to integrate your privacy cookie);
+* added `MeCms.default.other_css` and `MeCms.default.other_js` configuration values. These are used directly by the
+  `default` layout, to allow you to easily load css and js files from the application.
+
 ### 2.31.3
 * fixed a small bug for css files that contain relative paths (and therefore shouldn't be used with `AssetHelper`);
 * fixed Roboto fonts.

diff --git a/config/me_cms.php b/config/me_cms.php
@@ -7,8 +7,6 @@
      ],
     //Default layout
     'default' => [
-        //Displays the alert for the cookie policy
-        'cookies_policy' => true,
         //"Contact us" form (enabled or disabled)
         'contact_us' => true,
         //Facebook app ID or `false`
@@ -21,6 +19,10 @@
         'offline' => false,
         //Text to display when the site is offline or `false`
         'offline_text' => false,
+        //Other application css files to load automatically (default `contents` and `layout`)
+        'other_css' => ['contents', 'layout'],
+        //Other application script files to load automatically (default empty)
+        'other_js' => [],
         //Number of records to show per page
         'records' => 10,
         //Number of records to show on RSS

diff --git a/config/routes/systems.php b/config/routes/systems.php
@@ -14,15 +14,6 @@
 
 /** @var \Cake\Routing\RouteBuilder $routes */
 
-//Accept cookies
-if (!$routes->nameExists('acceptCookies')) {
-    $routes->connect(
-        '/accept/cookies',
-        ['controller' => 'Systems', 'action' => 'acceptCookies'],
-        ['_name' => 'acceptCookies']
-    );
-}
-
 //"Contact us" form
 if (!$routes->nameExists('contactUs')) {
     $routes->connect(

diff --git a/src/Controller/SystemsController.php b/src/Controller/SystemsController.php
@@ -15,7 +15,6 @@
 
 namespace MeCms\Controller;
 
-use Cake\Http\Cookie\Cookie;
 use Cake\Http\Response;
 use Cake\I18n\FrozenTime;
 use MeCms\Form\ContactUsForm;
@@ -45,20 +44,6 @@ public function initialize(): void
         $this->ContactUsForm ??= new ContactUsForm();
     }
 
-    /**
-     * Accept cookies policy.
-     * It sets the cookie to remember the user accepted the cookie policy and
-     *  redirects
-     * @return \Cake\Http\Response|null
-     */
-    public function acceptCookies(): ?Response
-    {
-        $cookie = (new Cookie('cookies-policy', '1'))->withNeverExpire();
-        $this->setResponse($this->getResponse()->withCookie($cookie));
-
-        return $this->redirect($this->referer(['_name' => 'homepage']));
-    }
-
     /**
      * "Contact us" form
      * @return \Cake\Http\Response|null|void

diff --git a/templates/element/cookies_policy.php b/templates/element/cookies_policy.php
diff --git a/templates/layout/default.php b/templates/layout/default.php
@@ -11,13 +11,13 @@
  * @copyright   Copyright (c) Mirko Pagliai
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
- *
- * @var \MeCms\View\View\AppView $this
  */
 
-use Cake\Core\Configure;
 use Cake\I18n\I18n;
 
+/**
+ * @var \MeCms\View\View\AppView $this
+ */
 $sidebar = $this->fetch('sidebar') . $this->Widget->all();
 ?>
 <!DOCTYPE html>
@@ -34,35 +34,34 @@
             '/vendor/font-awesome/css/all.min',
             'MeCms.fonts',
         ], ['block' => true]);
-        //Default css and css files from the application (`layout.css` and `contents.css`)
-        $css = array_filter(['layout', 'contents'], fn(string $name): bool => is_readable(Configure::read('App.wwwRoot') . Configure::read('App.cssBaseUrl') . $name . '.css'));
+        //Default css and application css files to load automatically (default `contents` and `layout`)
         echo $this->Asset->css([
             '/vendor/bootstrap/css/bootstrap.min',
             'MeTools.default',
             'MeTools.forms',
             'MeCms.cookies',
             'MeCms.layout',
             'MeCms.contents',
-            ...$css,
+            ...(array)getConfig('default.other_css'),
         ], ['block' => true]);
 
         //Other css files
         echo $this->Asset->css('MeCms.print', ['block' => true, 'media' => 'print']);
         echo $this->fetch('css');
 
+        //Default script and application script files to load automatically (default empty)
         echo $this->Asset->script([
             '/vendor/jquery/jquery.min',
             '/vendor/bootstrap/js/bootstrap.bundle.min',
             'MeCms.js.cookie.min',
             'MeTools.default',
-            'MeCms.layout',
+            ...(array)getConfig('default.other_js'),
         ], ['block' => true]);
         echo $this->fetch('script');
         ?>
     </head>
     <body class="d-flex flex-column min-vh-100">
         <?= $this->element('MeCms.userbar') ?>
-        <?= $this->element('MeCms.cookies_policy') ?>
         <header>
             <?php
             $logo = $this->Html->h1(getConfigOrFail('main.title'));

diff --git a/tests/TestCase/Controller/SystemsControllerTest.php b/tests/TestCase/Controller/SystemsControllerTest.php
@@ -16,11 +16,9 @@
 namespace MeCms\Test\TestCase\Controller;
 
 use Cake\Cache\Cache;
-use Cake\Chronos\Chronos;
 use Cake\Controller\Controller;
 use Cake\Core\Configure;
 use Cake\Event\EventInterface;
-use Cake\I18n\FrozenTime;
 use MeCms\Form\ContactUsForm;
 use MeCms\TestSuite\ControllerTestCase;
 use StopSpam\SpamDetector;
@@ -57,19 +55,6 @@ public function controllerSpy(EventInterface $event, ?Controller $controller = n
         $this->_controller->viewBuilder()->setLayout('with_flash');
     }
 
-    /**
-     * @uses \MeCms\Controller\SystemsController::acceptCookies()
-     * @test
-     */
-    public function testAcceptCookies(): void
-    {
-        $this->get(['_name' => 'acceptCookies']);
-        $this->assertRedirect(['_name' => 'homepage']);
-        $expires = FrozenTime::createFromTimestamp($this->_response->getCookie('cookies-policy')['expires']);
-        $this->assertCookie('1', 'cookies-policy');
-        $this->assertTrue($expires->isWithinNext((string)Chronos::createFromDate(2038, 1, 1)));
-    }
-
     /**
      * @uses \MeCms\Controller\SystemsController::contactUs()
      * @test

diff --git a/tests/test_app/TestApp/config/me_cms.php b/tests/test_app/TestApp/config/me_cms.php
@@ -9,8 +9,6 @@
      ],
     //Default layout
     'default' => [
-        //Displays the alert for the cookie policy
-        'cookies_policy' => true,
         //"Contact us" form (enabled or disabled)
         'contact_us' => true,
         //Facebook app ID or `false`

diff --git a/version b/version
@@ -1 +1 @@
-2.31.3
+2.31.4
diff --git a/webroot/js/layout.js b/webroot/js/layout.js