From 7f61dc95be4ac543986c7df2459532fd8f81368d Mon Sep 17 00:00:00 2001 From: Igor Scheller Date: Tue, 25 Sep 2018 17:33:31 +0200 Subject: [PATCH] EventConfig: Merge event configuration from database to global config --- .../controller/event_config_controller.php | 64 ++++++++------- includes/includes.php | 1 - includes/model/EventConfig_model.php | 78 ------------------ includes/model/UserWorkLog_model.php | 10 ++- includes/model/User_model.php | 46 ++++++----- includes/pages/guest_login.php | 26 +++--- includes/pages/user_settings.php | 19 +++-- includes/sys_form.php | 2 + includes/sys_page.php | 12 ++- includes/view/EventConfig_view.php | 59 +++++++------- includes/view/User_view.php | 9 ++- resources/views/layouts/parts/footer.twig | 24 +++--- src/Config/ConfigServiceProvider.php | 59 +++++++++++++- src/Renderer/Twig/Extensions/Globals.php | 40 +-------- .../Unit/Config/ConfigServiceProviderTest.php | 81 +++++++++++++++++-- .../Renderer/Twig/Extensions/GlobalsTest.php | 31 +------ 16 files changed, 289 insertions(+), 272 deletions(-) delete mode 100644 includes/model/EventConfig_model.php diff --git a/includes/controller/event_config_controller.php b/includes/controller/event_config_controller.php index c227b785..79c276e4 100644 --- a/includes/controller/event_config_controller.php +++ b/includes/controller/event_config_controller.php @@ -1,5 +1,8 @@ get('name'); + $event_welcome_msg = $config->get('welcome_msg'); + /** @var Carbon $buildup_start_date */ + $buildup_start_date = $config->get('buildup_start'); + /** @var Carbon $event_start_date */ + $event_start_date = $config->get('event_start'); + /** @var Carbon $event_end_date */ + $event_end_date = $config->get('event_end'); + /** @var Carbon $teardown_end_date */ + $teardown_end_date = $config->get('teardown_end'); if ($request->has('submit')) { $valid = true; @@ -91,24 +89,34 @@ function event_config_edit_controller() } if ($valid) { - EventConfig_update( - $event_name, - $buildup_start_date, - $event_start_date, - $event_end_date, - $teardown_end_date, - $event_welcome_msg - ); + $eventConfig = new EventConfig(); + + foreach ( + [ + 'name' => $event_name, + 'welcome_msg' => $event_welcome_msg, + 'buildup_start' => $buildup_start_date, + 'event_start' => $event_start_date, + 'event_end' => $event_end_date, + 'teardown_end' => $teardown_end_date, + ] as $key => $value + ) { + $eventConfig + ->findOrNew($key) + ->setAttribute('name', $key) + ->setAttribute('value', $value) + ->save(); + } engelsystem_log( sprintf( 'Changed event config: %s, %s, %s, %s, %s, %s', $event_name, $event_welcome_msg, - date('Y-m-d', $buildup_start_date), - date('Y-m-d', $event_start_date), - date('Y-m-d', $event_end_date), - date('Y-m-d', $teardown_end_date) + $buildup_start_date ? $buildup_start_date->format('Y-m-d') : '', + $event_start_date ? $event_start_date->format('Y-m-d') : '', + $event_end_date ? $event_end_date->format('Y-m-d') : '', + $teardown_end_date ? $teardown_end_date->format('Y-m-d') : '' ) ); success(__('Settings saved.')); diff --git a/includes/includes.php b/includes/includes.php index 628cf88e..855ff359 100644 --- a/includes/includes.php +++ b/includes/includes.php @@ -12,7 +12,6 @@ $includeFiles = [ __DIR__ . '/../includes/sys_template.php', __DIR__ . '/../includes/model/AngelType_model.php', - __DIR__ . '/../includes/model/EventConfig_model.php', __DIR__ . '/../includes/model/Message_model.php', __DIR__ . '/../includes/model/NeededAngelTypes_model.php', __DIR__ . '/../includes/model/Room_model.php', diff --git a/includes/model/EventConfig_model.php b/includes/model/EventConfig_model.php deleted file mode 100644 index 766a5849..00000000 --- a/includes/model/EventConfig_model.php +++ /dev/null @@ -1,78 +0,0 @@ -format('Y-m-d H:i'); } + return [ 'user_id' => $user['UID'], 'work_timestamp' => $work_date, diff --git a/includes/model/User_model.php b/includes/model/User_model.php index 092ddf27..051f8ff6 100644 --- a/includes/model/User_model.php +++ b/includes/model/User_model.php @@ -1,5 +1,6 @@ get('buildup_start'); + $teardown = $config->get('teardown_end'); + + /** @var Carbon $buildup */ + if (!empty($buildup) && $buildup->greaterThan(Carbon::createFromTimestamp($planned_arrival_date))) { // Planned arrival can not be before buildup start date - return new ValidationResult(false, $event_config['buildup_start_date']); + return new ValidationResult(false, $buildup->getTimestamp()); } - if (isset($event_config['teardown_end_date']) && $planned_arrival_date > $event_config['teardown_end_date']) { + + /** @var Carbon $teardown */ + if (!empty($teardown) && $teardown->lessThan(Carbon::createFromTimestamp($planned_arrival_date))) { // Planned arrival can not be after teardown end date - return new ValidationResult(false, $event_config['teardown_end_date']); + return new ValidationResult(false, $teardown->getTimestamp()); } + return new ValidationResult(true, $planned_arrival_date); } @@ -388,23 +393,28 @@ function User_validate_planned_departure_date($planned_arrival_date, $planned_de // null is okay return new ValidationResult(true, null); } + if ($planned_arrival_date > $planned_departure_date) { // departure cannot be before arrival return new ValidationResult(false, $planned_arrival_date); } - $event_config = EventConfig(); - if (empty($event_config)) { - // Nothing to validate against - return new ValidationResult(true, $planned_departure_date); - } - if (isset($event_config['buildup_start_date']) && $planned_departure_date < $event_config['buildup_start_date']) { + + $config = config(); + $buildup = $config->get('buildup_start'); + $teardown = $config->get('teardown_end'); + + /** @var Carbon $buildup */ + if (!empty($buildup) && $buildup->greaterThan(Carbon::createFromTimestamp($planned_departure_date))) { // Planned arrival can not be before buildup start date - return new ValidationResult(false, $event_config['buildup_start_date']); + return new ValidationResult(false, $buildup->getTimestamp()); } - if (isset($event_config['teardown_end_date']) && $planned_departure_date > $event_config['teardown_end_date']) { + + /** @var Carbon $teardown */ + if (!empty($teardown) && $teardown->lessThan(Carbon::createFromTimestamp($planned_departure_date))) { // Planned arrival can not be after teardown end date - return new ValidationResult(false, $event_config['teardown_end_date']); + return new ValidationResult(false, $teardown->getTimestamp()); } + return new ValidationResult(true, $planned_departure_date); } diff --git a/includes/pages/guest_login.php b/includes/pages/guest_login.php index fbad8ff6..797aaea7 100644 --- a/includes/pages/guest_login.php +++ b/includes/pages/guest_login.php @@ -1,5 +1,6 @@ get('welcome_msg')) { + return User_registration_success_view($message); } redirect(page_link_to('/')); @@ -283,13 +284,14 @@ function guest_register() $buildup_start_date = time(); $teardown_end_date = null; - if (!empty($event_config)) { - if (isset($event_config['buildup_start_date'])) { - $buildup_start_date = $event_config['buildup_start_date']; - } - if (isset($event_config['teardown_end_date'])) { - $teardown_end_date = $event_config['teardown_end_date']; - } + if ($buildup = $config->get('buildup_start')) { + /** @var Carbon $buildup */ + $buildup_start_date = $buildup->getTimestamp(); + } + + if ($teardown = $config->get('teardown_end')) { + /** @var Carbon $teardown */ + $teardown_end_date = $teardown->getTimestamp(); } return page_with_title(register_title(), [ @@ -452,12 +454,10 @@ function guest_login() } } - $event_config = EventConfig(); - return page([ div('col-md-12', [ div('row', [ - EventConfig_countdown_page($event_config) + EventConfig_countdown_page() ]), div('row', [ div('col-sm-6 col-sm-offset-3 col-md-4 col-md-offset-4', [ diff --git a/includes/pages/user_settings.php b/includes/pages/user_settings.php index d8f6e44b..cf8d2f0b 100644 --- a/includes/pages/user_settings.php +++ b/includes/pages/user_settings.php @@ -1,5 +1,6 @@ get('buildup_start')) { + /** @var Carbon $buildup */ + $buildup_start_date = $buildup->getTimestamp(); + } + + if ($teardown = $config->get('teardown_end')) { + /** @var Carbon $teardown */ + $teardown_end_date = $teardown->getTimestamp(); } $user_source = $user; diff --git a/includes/sys_form.php b/includes/sys_form.php index edf9542a..a1b78b70 100644 --- a/includes/sys_form.php +++ b/includes/sys_form.php @@ -1,5 +1,6 @@ getTimestamp() : $value; $value = is_numeric($value) ? date('Y-m-d', $value) : ''; $start_date = is_numeric($start_date) ? date('Y-m-d', $start_date) : ''; $end_date = is_numeric($end_date) ? date('Y-m-d', $end_date) : ''; diff --git a/includes/sys_page.php b/includes/sys_page.php index 55fb3b38..a560c3ba 100644 --- a/includes/sys_page.php +++ b/includes/sys_page.php @@ -1,5 +1,6 @@ ENGELSYSTEM'), 2) - ]); - } - + $config = config(); + $name = $config->get('name', ''); + /** @var Carbon $buildup */ + $buildup = $config->get('buildup_start'); + /** @var Carbon $start */ + $start = $config->get('event_start'); + /** @var Carbon $end */ + $end = $config->get('event_end'); + /** @var Carbon $teardown */ + $teardown = $config->get('teardown_end'); $elements = []; - if (!is_null($event_config['event_name'])) { - $elements[] = div('col-sm-12 text-center', [ - heading(sprintf( - __('Welcome to the %s!'), - $event_config['event_name'] . ' ENGELSYSTEM' - ), 2) - ]); - } + $elements[] = div('col-sm-12 text-center', [ + heading(sprintf( + __('Welcome to the %s!'), + $name . ' ENGELSYSTEM' + ), 2) + ]); - if (!is_null($event_config['buildup_start_date']) && time() < $event_config['buildup_start_date']) { + if (!empty($buildup) && $buildup->greaterThan(new Carbon())) { $elements[] = div('col-sm-3 text-center hidden-xs', [ heading(__('Buildup starts'), 4), - '%c', - '' . date(__('Y-m-d'), $event_config['buildup_start_date']) . '' + '%c', + '' . $buildup->format(__('Y-m-d')) . '' ]); } - if (!is_null($event_config['event_start_date']) && time() < $event_config['event_start_date']) { + if (!empty($start) && $start->greaterThan(new Carbon())) { $elements[] = div('col-sm-3 text-center hidden-xs', [ heading(__('Event starts'), 4), - '%c', - '' . date(__('Y-m-d'), $event_config['event_start_date']) . '' + '%c', + '' . $start->format(__('Y-m-d')) . '' ]); } - if (!is_null($event_config['event_end_date']) && time() < $event_config['event_end_date']) { + if (!empty($end) && $end->greaterThan(new Carbon())) { $elements[] = div('col-sm-3 text-center hidden-xs', [ heading(__('Event ends'), 4), - '%c', - '' . date(__('Y-m-d'), $event_config['event_end_date']) . '' + '%c', + '' . $end->format(__('Y-m-d')) . '' ]); } - if (!is_null($event_config['teardown_end_date']) && time() < $event_config['teardown_end_date']) { + if (!empty($teardown) && $teardown->greaterThan(new Carbon())) { $elements[] = div('col-sm-3 text-center hidden-xs', [ heading(__('Teardown ends'), 4), - '%c', - '' . date(__('Y-m-d'), $event_config['teardown_end_date']) . '' + '%c', + '' . $teardown->format(__('Y-m-d')) . '' ]); } diff --git a/includes/view/User_view.php b/includes/view/User_view.php index e092855a..ddf49885 100644 --- a/includes/view/User_view.php +++ b/includes/view/User_view.php @@ -1,5 +1,7 @@ $event_config['buildup_start_date']) { + /** @var Carbon $buildup */ + $buildup = config('buildup_start'); + if (!empty($buildup) && $buildup->lessThan(new Carbon())) { return __('You are not marked as arrived. Please go to heaven\'s desk, get your angel badge and/or tell them that you arrived already.'); } } diff --git a/resources/views/layouts/parts/footer.twig b/resources/views/layouts/parts/footer.twig index 85d87473..27b9adfd 100644 --- a/resources/views/layouts/parts/footer.twig +++ b/resources/views/layouts/parts/footer.twig @@ -2,25 +2,25 @@
{% block eventinfo %} - {% if event_config.event_name %} - {% if event_config.event_start_date and event_config.event_end_date %} + {% if config('name') %} + {% if config('event_start') and config('event_end') %} {{ __('%s, from %s to %s', [ - event_config.event_name, - date(event_config.event_start_date).format(__('Y-m-d')), - date(event_config.event_end_date).format(__('Y-m-d')) + config('name'), + config('event_start').format(__('Y-m-d')), + config('event_end').format(__('Y-m-d')) ]) }} - {% elseif event_config.event_start_date %} + {% elseif config('event_start') %} {{ __('%s, starting %s', [ - event_config.event_name, - date(event_config.event_start_date).format(__('Y-m-d')) + config('name'), + config('event_start').format(__('Y-m-d')) ]) }} {% else %} - {{ event_config.event_name }} + {{ config('name') }} {% endif %}
- {% elseif event_config.event_start_date and event_config.event_end_date %} + {% elseif config('event_start') and config('event_end') %} {{ __('Event from %s to %s', [ - date(event_config.event_start_date).format(__('Y-m-d')), - date(event_config.event_end_date).format(__('Y-m-d')) + config('event_start').format(__('Y-m-d')), + config('event_end').format(__('Y-m-d')) ]) }}
{% endif %} {% endblock %} diff --git a/src/Config/ConfigServiceProvider.php b/src/Config/ConfigServiceProvider.php index 63f43ced..cb8e96ce 100644 --- a/src/Config/ConfigServiceProvider.php +++ b/src/Config/ConfigServiceProvider.php @@ -2,14 +2,31 @@ namespace Engelsystem\Config; +use Engelsystem\Application; use Engelsystem\Container\ServiceProvider; +use Engelsystem\Models\EventConfig; use Exception; +use Illuminate\Database\QueryException; class ConfigServiceProvider extends ServiceProvider { /** @var array */ protected $configFiles = ['config.default.php', 'config.php']; + /** @var EventConfig */ + protected $eventConfig; + + /** + * @param Application $app + * @param EventConfig $eventConfig + */ + public function __construct(Application $app, EventConfig $eventConfig = null) + { + parent::__construct($app); + + $this->eventConfig = $eventConfig; + } + public function register() { $config = $this->app->make(Config::class); @@ -17,7 +34,7 @@ class ConfigServiceProvider extends ServiceProvider $this->app->instance('config', $config); foreach ($this->configFiles as $file) { - $file = config_path($file); + $file = $this->getConfigPath($file); if (!file_exists($file)) { continue; @@ -33,4 +50,44 @@ class ConfigServiceProvider extends ServiceProvider throw new Exception('Configuration not found'); } } + + public function boot() + { + if (!$this->eventConfig) { + return; + } + + /** @var Config $config */ + $config = $this->app->get('config'); + /** @var EventConfig[] $values */ + try { + $values = $this->eventConfig->newQuery()->get(['name', 'value']); + } catch (QueryException $e) { + return; + } + + foreach ($values as $option) { + $data = $option->value; + + if (is_array($data) && $config->has($option->name)) { + $data = array_replace_recursive( + $config->get($option->name), + $data + ); + } + + $config->set($option->name, $data); + } + } + + /** + * Get the config path + * + * @param string $path + * @return string + */ + protected function getConfigPath($path = ''): string + { + return config_path($path); + } } diff --git a/src/Renderer/Twig/Extensions/Globals.php b/src/Renderer/Twig/Extensions/Globals.php index 1a4df42c..f9bffbc8 100644 --- a/src/Renderer/Twig/Extensions/Globals.php +++ b/src/Renderer/Twig/Extensions/Globals.php @@ -2,7 +2,6 @@ namespace Engelsystem\Renderer\Twig\Extensions; -use Carbon\Carbon; use Twig_Extension as TwigExtension; use Twig_Extension_GlobalsInterface as GlobalsInterface; @@ -17,45 +16,8 @@ class Globals extends TwigExtension implements GlobalsInterface { global $user; - $eventConfig = $this->getEventConfig(); - if (empty($eventConfig)) { - $eventConfig = []; - } - return [ - 'user' => isset($user) ? $user : [], - 'event_config' => $this->filterEventConfig($eventConfig), + 'user' => isset($user) ? $user : [], ]; } - - /** - * @return array - * @codeCoverageIgnore - */ - protected function getEventConfig() - { - return EventConfig(); - } - - /** - * @param $eventConfig - * @return mixed - */ - protected function filterEventConfig($eventConfig) - { - array_walk($eventConfig, function (&$value, $key) { - if (is_null($value) || !in_array($key, [ - 'buildup_start_date', - 'event_start_date', - 'event_end_date', - 'teardown_end_date', - ])) { - return; - } - - $value = Carbon::createFromTimestamp($value); - }); - - return $eventConfig; - } } diff --git a/tests/Unit/Config/ConfigServiceProviderTest.php b/tests/Unit/Config/ConfigServiceProviderTest.php index 925854be..b93e1b97 100644 --- a/tests/Unit/Config/ConfigServiceProviderTest.php +++ b/tests/Unit/Config/ConfigServiceProviderTest.php @@ -5,18 +5,22 @@ namespace Engelsystem\Test\Unit\Config; use Engelsystem\Application; use Engelsystem\Config\Config; use Engelsystem\Config\ConfigServiceProvider; +use Engelsystem\Models\EventConfig; use Engelsystem\Test\Unit\ServiceProviderTest; use Exception; -use PHPUnit_Framework_MockObject_MockObject; +use Illuminate\Database\Eloquent\Builder as EloquentBuilder; +use Illuminate\Database\QueryException; +use PHPUnit\Framework\MockObject\MockObject; class ConfigServiceProviderTest extends ServiceProviderTest { /** - * @covers \Engelsystem\Config\ConfigServiceProvider::register() + * @covers \Engelsystem\Config\ConfigServiceProvider::register + * @covers \Engelsystem\Config\ConfigServiceProvider::getConfigPath */ public function testRegister() { - /** @var PHPUnit_Framework_MockObject_MockObject|Config $config */ + /** @var MockObject|Config $config */ $config = $this->getMockBuilder(Config::class) ->getMock(); @@ -53,11 +57,11 @@ class ConfigServiceProviderTest extends ServiceProviderTest } /** - * @covers \Engelsystem\Config\ConfigServiceProvider::register() + * @covers \Engelsystem\Config\ConfigServiceProvider::register */ public function testRegisterException() { - /** @var PHPUnit_Framework_MockObject_MockObject|Config $config */ + /** @var MockObject|Config $config */ $config = $this->getMockBuilder(Config::class) ->getMock(); @@ -68,8 +72,8 @@ class ConfigServiceProviderTest extends ServiceProviderTest $app->expects($this->exactly(2)) ->method('instance') ->withConsecutive( - [Config::class, $config], - ['config', $config] + [Config::class, $config], + ['config', $config] ); $this->setExpects($app, 'get', ['path.config'], __DIR__ . '/not_existing', $this->atLeastOnce()); @@ -81,4 +85,67 @@ class ConfigServiceProviderTest extends ServiceProviderTest $serviceProvider = new ConfigServiceProvider($app); $serviceProvider->register(); } + + /** + * @covers \Engelsystem\Config\ConfigServiceProvider::__construct + * @covers \Engelsystem\Config\ConfigServiceProvider::boot + */ + public function testBoot() + { + $app = $this->getApp(['get']); + + /** @var EventConfig|MockObject $eventConfig */ + $eventConfig = $this->createMock(EventConfig::class); + /** @var EloquentBuilder|MockObject $eloquentBuilder */ + $eloquentBuilder = $this->getMockBuilder(EloquentBuilder::class) + ->disableOriginalConstructor() + ->getMock(); + $config = new Config(['foo' => 'bar', 'lorem' => ['ipsum' => 'dolor', 'bla' => 'foo']]); + + $configs = [ + new EventConfig(['name' => 'test', 'value' => 'testing']), + new EventConfig(['name' => 'lorem', 'value' => ['ipsum' => 'tester']]), + ]; + + $returnValue = $eloquentBuilder; + $eventConfig + ->expects($this->exactly(3)) + ->method('newQuery') + ->willReturnCallback(function () use (&$returnValue) { + if ($returnValue instanceof EloquentBuilder) { + $return = $returnValue; + $returnValue = null; + return $return; + } + + if (is_null($returnValue)) { + throw new QueryException('', [], new Exception()); + } + + return null; + }); + + $this->setExpects($eloquentBuilder, 'get', [['name', 'value']], $configs); + $this->setExpects($app, 'get', ['config'], $config, $this->exactly(3)); + + $serviceProvider = new ConfigServiceProvider($app); + $serviceProvider->boot(); + + $serviceProvider = new ConfigServiceProvider($app, $eventConfig); + $serviceProvider->boot(); + $serviceProvider->boot(); + $serviceProvider->boot(); + + $this->assertArraySubset( + [ + 'foo' => 'bar', + 'lorem' => [ + 'ipsum' => 'tester', + 'bla' => 'foo', + ], + 'test' => 'testing', + ], + $config->get(null) + ); + } } diff --git a/tests/Unit/Renderer/Twig/Extensions/GlobalsTest.php b/tests/Unit/Renderer/Twig/Extensions/GlobalsTest.php index cdd9cd2a..6441904b 100644 --- a/tests/Unit/Renderer/Twig/Extensions/GlobalsTest.php +++ b/tests/Unit/Renderer/Twig/Extensions/GlobalsTest.php @@ -2,54 +2,25 @@ namespace Engelsystem\Test\Unit\Renderer\Twig\Extensions; -use Carbon\Carbon; use Engelsystem\Renderer\Twig\Extensions\Globals; -use PHPUnit\Framework\MockObject\MockObject; class GlobalsTest extends ExtensionTest { /** * @covers \Engelsystem\Renderer\Twig\Extensions\Globals::getGlobals - * @covers \Engelsystem\Renderer\Twig\Extensions\Globals::filterEventConfig */ public function testGetGlobals() { global $user; $user = []; - /** @var Globals|MockObject $extension */ - $extension = $this->getMockBuilder(Globals::class) - ->setMethods(['getEventConfig']) - ->getMock(); - - $extension->expects($this->exactly(2)) - ->method('getEventConfig') - ->willReturnOnConsecutiveCalls( - null, - [ - 'lorem' => 'ipsum', - 'event_end_date' => 1234567890, - ] - ); + $extension = new Globals(); $globals = $extension->getGlobals(); - $this->assertGlobalsExists('user', [], $globals); - $this->assertGlobalsExists('event_config', [], $globals); $user['foo'] = 'bar'; - $globals = $extension->getGlobals(); $this->assertGlobalsExists('user', ['foo' => 'bar'], $globals); - $this->assertGlobalsExists('event_config', ['lorem' => 'ipsum'], $globals); - - $config = $globals['event_config']; - $this->assertArrayHasKey('event_end_date', $config); - /** @var Carbon $eventEndDate */ - $eventEndDate = $config['event_end_date']; - $this->assertInstanceOf(Carbon::class, $eventEndDate); - - $eventEndDate->setTimezone('UTC'); - $this->assertEquals('2009-02-13 23:31:30', $eventEndDate->format('Y-m-d H:i:s')); } }