Release 4.4.0

Author: lcharette

.gitignore

@@ -1,7 +1,7 @@
 # Ignores text editor metadata
 *.komodoproject
-.php_cs.cache
-.serenata
+.editorconfig
+.vscode
 
 # Ignores Mac metadata.  You can configure this globally if you use a Mac: http://islegend.com/development/setting-global-gitignore-mac-windows/
 .DS_Store
@@ -73,6 +73,10 @@ app/assets/*
 vagrant/Homestead/
 .vagrant/*
 
+# Ignore dev utils cache
+.phpunit.result.cache
+.php_cs.cache
+
 # Igore npm lockfile
 build/package-lock.json
 build/package.lock

.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
-dist: trusty
+dist: xenial
 language: php
 
 services:
@@ -12,6 +12,7 @@ php:
   - 7.1
   - 7.2
   - 7.3
+  - 7.4
 
 env:
   matrix:
@@ -20,6 +21,9 @@ env:
     - DB=pgsql
     - DB=memory
 
+matrix:
+  fast_finish: true
+
 cache:
   directories:
     - $HOME/.composer/cache

CHANGELOG.md

@@ -5,6 +5,48 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [v4.4.0]
+
+### Changed Requirements
+- PHP 7.3 is now the recommended version, as 7.2 is already security fixes only.
+
+### Changed Composer Dependencies
+- Reset Slim version to ^3.12
+- Updated PHPUnit to 8.5 (Version 7.5 still used for PHP 7.1)
+
+### Added
+- PHP 7.4 Support & Travis environment.
+- New `Locale` service. Provides a list of available locales in diffeent form.
+- New `BaseServicesProvider` abstract class added as base for all ServiceProvider class.
+- Sprinkle Services Provider can now be autoloaded using the `$servicesproviders` property in the sprinkle bootstrapper class.
+- Current locale code can now be accessed from Twig using the `currentLocale` global variable ([#1056]).
+- Locale now have config & metadata file ([#850])
+- Added `locale:compare`, `locale:dictionary` and `locale:info` Bakery commands.
+- New `cli` service. Returns true if current app is a CLI envrionement, false otherwise.
+
+### Changed
+- `Interop\Container\ContainerInterface` has been replaced with `Psr\Container\ContainerInterface`.
+- `\UserFrosting\I18n\MessageTranslator` is now `\UserFrosting\I18n\Translator`.
+- Translator service moved to it's own `UserFrosting\Sprinkle\Core\I18n\TranslatorServicesProvider` class.
+- Travis now uses Xenial instead of Trusty.
+- `site.locales.available` config now accept `(string) identifier => (bool) enabled`. Set identifier to false or null to remove it from the list.
+- Locale plural rules moved from the keys file to the new metadata files.
+
+### Fixed
+- When internationalizing, the lang attribute value of the Twig template is not set to follow changes ([#982])
+- `pt_Br` locale identifier renamed to `pt_BR`.
+- Improved Docker support ([#1057])
+- Improved Bakery debug command output
+- Improve ordering by activity date ([#1061] & [#1062]; Thanks @ktecho!)
+- Updated Vagrant config and documentation
+- Fixed a bug where `withTrashed` in `findUnique` was not available when `SoftDeletes` trait is not included in a model.
+- CSRF global middleware is not loaded anymore if in a CLI envrionement. This will avoid sessions to be created for bakery and tests by default.
+- Browserified node modules not being correctly loaded.
+- Browserified node modules potentially colliding with real entrypoints.
+
+### Removed
+- `localePathBuilder` service removed. Task now handled by the `locale` and `translator` services.
+
 ## [v4.3.3]
 
 ### Fixed
@@ -786,7 +828,7 @@ See [http://learn.userfrosting.com/upgrading/40-to-41](Upgrading 4.0.x to 4.1.x
 - Implemented DB-driven home pages for groups.  Upon login, a user will be redirected to the `home_page` for their primary group.
 - Implemented templated menus.  Every group has a corresponding menu template in `models/menu-templates`.  Upon login, the menu for a user's primary group is automatically loaded and rendered.
 - Implemented function-level user authorization.  Whenever a function in `secure_functions` is called, the `user_action_permits` table is checked to see whether or not that user has access to the function (the `action` column), conditional on the boolean functions specified in the `permits` column.
-- Organized pages into four categories: account pages, API pages, form pages, and public pages.  Public pages reside in the root directory and can be accessed by anyone.  Account pages are in the `account` directory and are only accessible after logging in.  API pages are in the `api` directory, and consist of all the pages that process or fetch data from the DB and interact with the frontend via AJAX/JSON.  They are accessible by any logged in user, but will only perform a function if the user is authorized.  Form pages are in the `forms` directory, and consist of pages that generate forms (for creating/updating users, groups, etc.)  
+- Organized pages into four categories: account pages, API pages, form pages, and public pages.  Public pages reside in the root directory and can be accessed by anyone.  Account pages are in the `account` directory and are only accessible after logging in.  API pages are in the `api` directory, and consist of all the pages that process or fetch data from the DB and interact with the frontend via AJAX/JSON.  They are accessible by any logged in user, but will only perform a function if the user is authorized.  Form pages are in the `forms` directory, and consist of pages that generate forms (for creating/updating users, groups, etc.)
 - Converted registration page to AJAX.
 - Improved installer with site configuration.
 
@@ -834,6 +876,7 @@ See [http://learn.userfrosting.com/upgrading/40-to-41](Upgrading 4.0.x to 4.1.x
 [#829]: https://github.com/userfrosting/UserFrosting/issues/829
 [#833]: https://github.com/userfrosting/UserFrosting/issues/833
 [#838]: https://github.com/userfrosting/UserFrosting/issues/838
+[#850]: https://github.com/userfrosting/UserFrosting/issues/850
 [#853]: https://github.com/userfrosting/UserFrosting/issues/853
 [#854]: https://github.com/userfrosting/UserFrosting/issues/854
 [#867]: https://github.com/userfrosting/UserFrosting/issues/867
@@ -859,6 +902,7 @@ See [http://learn.userfrosting.com/upgrading/40-to-41](Upgrading 4.0.x to 4.1.x
 [#968]: https://github.com/userfrosting/UserFrosting/issues/968
 [#976]: https://github.com/userfrosting/UserFrosting/issues/976
 [#981]: https://github.com/userfrosting/UserFrosting/issues/981
+[#982]: https://github.com/userfrosting/UserFrosting/issues/982
 [#983]: https://github.com/userfrosting/UserFrosting/issues/983
 [#986]: https://github.com/userfrosting/UserFrosting/issues/986
 [#987]: https://github.com/userfrosting/UserFrosting/issues/987
@@ -890,6 +934,10 @@ See [http://learn.userfrosting.com/upgrading/40-to-41](Upgrading 4.0.x to 4.1.x
 [#1042]: https://github.com/userfrosting/UserFrosting/issues/1042
 [#1045]: https://github.com/userfrosting/UserFrosting/issues/1045
 [#1050]: https://github.com/userfrosting/UserFrosting/issues/1050
+[#1056]: https://github.com/userfrosting/UserFrosting/issues/1056
+[#1057]: https://github.com/userfrosting/UserFrosting/issues/1057
+[#1061]: https://github.com/userfrosting/UserFrosting/issues/1061
+[#1062]: https://github.com/userfrosting/UserFrosting/issues/1062
 
 [v4.2.0]: https://github.com/userfrosting/UserFrosting/compare/v4.1.22...v4.2.0
 [v4.2.1]: https://github.com/userfrosting/UserFrosting/compare/v4.2.0...v.4.2.1
@@ -899,3 +947,4 @@ See [http://learn.userfrosting.com/upgrading/40-to-41](Upgrading 4.0.x to 4.1.x
 [v4.3.1]: https://github.com/userfrosting/UserFrosting/compare/v4.3.0...v4.3.1
 [v4.3.2]: https://github.com/userfrosting/UserFrosting/compare/v4.3.1...v4.3.2
 [v4.3.3]: https://github.com/userfrosting/UserFrosting/compare/v4.3.2...v4.3.3
+[v4.4.0]: https://github.com/userfrosting/UserFrosting/compare/v4.3.3...v4.4.0

README.md

@@ -1,4 +1,4 @@
-# UserFrosting 4.3
+# UserFrosting 4.4
 
 [![Latest Version](https://img.shields.io/github/release/userfrosting/UserFrosting.svg)](https://github.com/userfrosting/UserFrosting/releases)
 ![PHP Version](https://img.shields.io/packagist/php-v/userfrosting/userfrosting.svg?color=brightgreen)
@@ -11,8 +11,8 @@
 | Branch | Version | Build | Coverage | Style |
 | ------ |:-------:|:-----:|:--------:|:-----:|
 | [master] | ![](https://img.shields.io/github/release/userfrosting/userfrosting.svg?color=success&label=Version) | [![](https://travis-ci.org/userfrosting/UserFrosting.svg?branch=master)][UF-Travis] | [![](https://codecov.io/gh/userfrosting/userfrosting/branch/master/graph/badge.svg)][UF-Codecov] | [![][style-master]][style] |
-| [hotfix] | ![](https://img.shields.io/badge/Version-v4.3.x-yellow.svg) | [![](https://travis-ci.org/userfrosting/UserFrosting.svg?branch=hotfix)][UF-Travis] | [![](https://codecov.io/gh/userfrosting/userfrosting/branch/hotfix/graph/badge.svg)][UF-Codecov] | [![][style-hotfix]][style] |
-| [develop] | ![](https://img.shields.io/badge/Version-v4.4.x-orange.svg) | [![](https://travis-ci.org/userfrosting/UserFrosting.svg?branch=develop)][UF-Travis] | [![](https://codecov.io/gh/userfrosting/userfrosting/branch/develop/graph/badge.svg)][UF-Codecov] | [![][style-develop]][style] |
+| [hotfix] | ![](https://img.shields.io/badge/Version-v4.4.x-yellow.svg) | [![](https://travis-ci.org/userfrosting/UserFrosting.svg?branch=hotfix)][UF-Travis] | [![](https://codecov.io/gh/userfrosting/userfrosting/branch/hotfix/graph/badge.svg)][UF-Codecov] | [![][style-hotfix]][style] |
+| [develop] | ![](https://img.shields.io/badge/Version-v4.5.x-orange.svg) | [![](https://travis-ci.org/userfrosting/UserFrosting.svg?branch=develop)][UF-Travis] | [![](https://codecov.io/gh/userfrosting/userfrosting/branch/develop/graph/badge.svg)][UF-Codecov] | [![][style-develop]][style] |
 
 <!-- Links -->
 [master]: https://github.com/userfrosting/UserFrosting
@@ -56,7 +56,7 @@ Please see our [installation guide](https://learn.userfrosting.com/installation)
 
 If you are having trouble installing UserFrosting, please [join us in chat](https://chat.userfrosting.com) or try our [forums](https://forums.userfrosting.com).
 
-If you are generally confused about the structure and layout of the code, or it doesn't look like the kind of PHP code that you're used to, please [start from the beginning](https://learn.userfrosting.com/background).  
+If you are generally confused about the structure and layout of the code, or it doesn't look like the kind of PHP code that you're used to, please [start from the beginning](https://learn.userfrosting.com/background).
 
 ## Mission Objectives
 

app/defines.php

@@ -11,10 +11,10 @@
 namespace UserFrosting;
 
 // Some standard defines
-define('UserFrosting\VERSION', '4.3.3');
+define('UserFrosting\VERSION', '4.4.0');
 define('UserFrosting\DS', '/');
 define('UserFrosting\PHP_MIN_VERSION', '7.1');
-define('UserFrosting\PHP_RECOMMENDED_VERSION', '7.2');
+define('UserFrosting\PHP_RECOMMENDED_VERSION', '7.3');
 define('UserFrosting\NODE_MIN_VERSION', 'v10.12.0');
 define('UserFrosting\NPM_MIN_VERSION', '6.0.0');
 

app/sprinkles/account/composer.json

@@ -9,6 +9,15 @@
         {
             "name": "Alexander Weissman",
             "homepage": "https://alexanderweissman.com"
+        },
+        {
+            "name": "Louis Charette",
+            "homepage": "https://bbqsoftwares.com"
+        },
+        {
+            "name": "Jordan Mele",
+            "email": "SiliconSoldier@outlook.com.au",
+            "homepage": "https://blog.djmm.me"
         }
     ],
     "require": {

app/sprinkles/account/src/Account.php

@@ -10,6 +10,7 @@
 
 namespace UserFrosting\Sprinkle\Account;
 
+use UserFrosting\Sprinkle\Account\I18n\LocaleServicesProvider;
 use UserFrosting\System\Sprinkle\Sprinkle;
 
 /**
@@ -19,4 +20,10 @@
  */
 class Account extends Sprinkle
 {
+    /**
+     * @var string[] List of services provider to register
+     */
+    protected $servicesproviders = [
+        LocaleServicesProvider::class,
+    ];
 }

app/sprinkles/account/src/Account/Registration.php

@@ -11,7 +11,7 @@
 namespace UserFrosting\Sprinkle\Account\Account;
 
 use Illuminate\Database\Capsule\Manager as Capsule;
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use UserFrosting\Sprinkle\Account\Database\Models\Interfaces\UserInterface;
 use UserFrosting\Sprinkle\Account\Facades\Password;
 use UserFrosting\Sprinkle\Core\Mail\EmailRecipient;

app/sprinkles/account/src/Authenticate/Authenticator.php

@@ -118,7 +118,7 @@ public function __construct(ClassMapper $classMapper, Session $session, Config $
         $this->rememberMe->getCookie()->setPath($this->config['remember_me.session.path']);
 
         // Set expire time, if specified
-        if ($this->config->has('remember_me.expire_time') && $this->config->has('remember_me.expire_time') != null) {
+        if ($this->config->has('remember_me.expire_time') && $this->config->get('remember_me.expire_time') !== null) {
             $this->rememberMe->getCookie()->setExpireTime($this->config['remember_me.expire_time']);
         }
 

app/sprinkles/account/src/Authorize/AuthorizationManager.php

@@ -10,7 +10,7 @@
 
 namespace UserFrosting\Sprinkle\Account\Authorize;
 
-use Interop\Container\ContainerInterface;
+use Psr\Container\ContainerInterface;
 use UserFrosting\Sprinkle\Account\Database\Models\Interfaces\UserInterface;
 
 /**

app/sprinkles/account/src/Controller/AccountController.php

@@ -58,9 +58,6 @@ class AccountController extends SimpleController
      */
     public function checkUsername(Request $request, Response $response, $args)
     {
-        /** @var \UserFrosting\Sprinkle\Core\Alert\AlertStream $ms */
-        $ms = $this->ci->alerts;
-
         // GET parameters
         $params = $request->getQueryParams();
 
@@ -97,7 +94,7 @@ public function checkUsername(Request $request, Response $response, $args)
         /** @var \UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
         $classMapper = $this->ci->classMapper;
 
-        /** @var \UserFrosting\I18n\MessageTranslator $translator */
+        /** @var \UserFrosting\I18n\Translator $translator */
         $translator = $this->ci->translator;
 
         // Log throttleable event
@@ -500,9 +497,6 @@ public function pageRegister(Request $request, Response $response, $args)
         /** @var \UserFrosting\Support\Repository\Repository $config */
         $config = $this->ci->config;
 
-        /** @var \UserFrosting\I18n\LocalePathBuilder */
-        $localePathBuilder = $this->ci->localePathBuilder;
-
         if (!$config['site.registration.enabled']) {
             throw new NotFoundException();
         }
@@ -526,14 +520,17 @@ public function pageRegister(Request $request, Response $response, $args)
         $validatorRegister = new JqueryValidationAdapter($schema, $this->ci->translator);
 
         // Get locale information
-        $currentLocales = $localePathBuilder->getLocales();
+        $currentLocale = $this->ci->translator->getLocale()->getIdentifier();
+
+        // Get a list of all locales
+        $locales = $this->ci->locale->getAvailableOptions();
 
         // Hide the locale field if there is only 1 locale available
         $fields = [
             'hidden'   => [],
             'disabled' => [],
         ];
-        if (count($config->getDefined('site.locales.available')) <= 1) {
+        if (count($locales) <= 1) {
             $fields['hidden'][] = 'locale';
         }
 
@@ -545,8 +542,8 @@ public function pageRegister(Request $request, Response $response, $args)
             ],
             'fields'  => $fields,
             'locales' => [
-                'available' => $config['site.locales.available'],
-                'current'   => end($currentLocales),
+                'available' => $locales,
+                'current'   => $currentLocale,
             ],
         ]);
     }
@@ -708,14 +705,14 @@ public function pageSettings(Request $request, Response $response, $args)
         $validatorProfileSettings = new JqueryValidationAdapter($schema, $this->ci->translator);
 
         // Get a list of all locales
-        $locales = $config->getDefined('site.locales.available');
+        $locales = $this->ci->locale->getAvailableOptions();
 
         // Hide the locale field if there is only 1 locale available
         $fields = [
             'hidden'   => [],
             'disabled' => [],
         ];
-        if (count($config->getDefined('site.locales.available')) <= 1) {
+        if (count($locales) <= 1) {
             $fields['hidden'][] = 'locale';
         }
 
@@ -830,8 +827,11 @@ public function profile(Request $request, Response $response, $args)
 
         $error = false;
 
+        // Get locales
+        $locales = $this->ci->locale->getAvailableIdentifiers();
+
         // Ensure that in the case of using a single locale, that the locale is set
-        if (count($config->getDefined('site.locales.available')) <= 1) {
+        if (count($locales) <= 1) {
             $data['locale'] = $currentUser->locale;
         }
 
@@ -843,8 +843,7 @@ public function profile(Request $request, Response $response, $args)
         }
 
         // Check that locale is valid
-        $locales = $config->getDefined('site.locales.available');
-        if (isset($data['locale']) && !array_key_exists($data['locale'], $locales)) {
+        if (isset($data['locale']) && !in_array($data['locale'], $locales)) {
             $ms->addMessageTranslated('danger', 'LOCALE.INVALID', $data);
             $error = true;
         }
@@ -953,7 +952,7 @@ public function register(Request $request, Response $response, $args)
         $error = false;
 
         // Ensure that in the case of using a single locale, that the locale is set
-        if (count($config->getDefined('site.locales.available')) <= 1) {
+        if (count($this->ci->locale->getAvailableIdentifiers()) <= 1) {
             $data['locale'] = $config['site.registration.user_defaults.locale'];
         }
 
@@ -1252,7 +1251,7 @@ public function settings(Request $request, Response $response, $args)
         $error = false;
 
         // Ensure that in the case of using a single locale, that the locale is set
-        if (count($config->getDefined('site.locales.available')) <= 1) {
+        if (count($this->ci->locale->getAvailableIdentifiers()) <= 1) {
             $data['locale'] = $currentUser->locale;
         }
 

app/sprinkles/account/src/I18n/LocaleServicesProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * UserFrosting (http://www.userfrosting.com)
+ *
+ * @link      https://github.com/userfrosting/UserFrosting
+ * @copyright Copyright (c) 2019 Alexander Weissman
+ * @license   https://github.com/userfrosting/UserFrosting/blob/master/LICENSE.md (MIT License)
+ */
+
+namespace UserFrosting\Sprinkle\Account\I18n;
+
+use UserFrosting\Sprinkle\Core\ServicesProvider\BaseServicesProvider;
+
+/**
+ * Locale service provider, replacing the Core one.
+ *
+ * Registers:
+ *  - locale : \UserFrosting\Sprinkle\Account\I18n\SiteLocale
+ */
+class LocaleServicesProvider extends BaseServicesProvider
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function register(): void
+    {
+        $this->ci['locale'] = new SiteLocale($this->ci);
+    }
+}