From d8b8a0aa2602b12e397bb6d371049de16210ed58 Mon Sep 17 00:00:00 2001
From: xjm <xjm@65776.no-reply.drupal.org>
Date: Sat, 23 Feb 2019 15:15:16 -0600
Subject: [PATCH] Issue #2942661 by tedbow, tim.plunkett, bkosborne,
johndevman, xjm, phenaproxima, Kristen Pol: Sections should have third-party
settings
---
.../config/schema/layout_builder.schema.yml | 5 +
.../layout_builder.post_update.php | 7 +
core/modules/layout_builder/src/Section.php | 71 ++++++-
.../fixtures/update/layout-builder-enable.php | 1 +
.../layout_builder_defaults_test.schema.yml | 6 +
.../LayoutBuilderEnableUpdatePathTest.php | 1 +
.../src/Kernel/DefaultsSectionStorageTest.php | 11 +-
.../tests/src/Unit/SectionTest.php | 189 +++++++++++++++++-
8 files changed, 280 insertions(+), 11 deletions(-)
create mode 100644 core/modules/layout_builder/tests/modules/layout_builder_defaults_test/config/schema/layout_builder_defaults_test.schema.yml
diff --git a/core/modules/layout_builder/config/schema/layout_builder.schema.yml b/core/modules/layout_builder/config/schema/layout_builder.schema.yml
index d92cc4286e9f..f9f2ee8e9e2e 100644
--- a/core/modules/layout_builder/config/schema/layout_builder.schema.yml
+++ b/core/modules/layout_builder/config/schema/layout_builder.schema.yml
@@ -28,6 +28,11 @@ layout_builder.section:
label: 'Components'
sequence:
type: layout_builder.component
+ third_party_settings:
+ type: sequence
+ label: 'Third party settings'
+ sequence:
+ type: '[%parent.%parent.%type].third_party.[%key]'
layout_builder.component:
type: mapping
diff --git a/core/modules/layout_builder/layout_builder.post_update.php b/core/modules/layout_builder/layout_builder.post_update.php
index 8b69590d54bc..ff4ef098bd73 100644
--- a/core/modules/layout_builder/layout_builder.post_update.php
+++ b/core/modules/layout_builder/layout_builder.post_update.php
@@ -146,3 +146,10 @@ function layout_builder_post_update_fix_tempstore_keys() {
}
}
}
+
+/**
+ * Clear caches due to config schema additions.
+ */
+function layout_builder_post_update_section_third_party_settings_schema() {
+ // Empty post-update hook.
+}
diff --git a/core/modules/layout_builder/src/Section.php b/core/modules/layout_builder/src/Section.php
index 1ec0b8af10ae..26f597b3fd5c 100644
--- a/core/modules/layout_builder/src/Section.php
+++ b/core/modules/layout_builder/src/Section.php
@@ -2,6 +2,8 @@
namespace Drupal\layout_builder;
+use Drupal\Core\Config\Entity\ThirdPartySettingsInterface;
+
/**
* Provides a domain object for layout sections.
*
@@ -22,7 +24,7 @@
* @todo Determine whether an interface will be provided for this in
* https://www.drupal.org/project/drupal/issues/2930334.
*/
-class Section {
+class Section implements ThirdPartySettingsInterface {
/**
* The layout plugin ID.
@@ -45,6 +47,15 @@ class Section {
*/
protected $components = [];
+ /**
+ * Third party settings.
+ *
+ * An array of key/value pairs keyed by provider.
+ *
+ * @var array[]
+ */
+ protected $thirdPartySettings = [];
+
/**
* Constructs a new Section.
*
@@ -54,13 +65,16 @@ class Section {
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
+ * @param array[] $third_party_settings
+ * (optional) Any third party settings.
*/
- public function __construct($layout_id, array $layout_settings = [], array $components = []) {
+ public function __construct($layout_id, array $layout_settings = [], array $components = [], array $third_party_settings = []) {
$this->layoutId = $layout_id;
$this->layoutSettings = $layout_settings;
foreach ($components as $component) {
$this->setComponent($component);
}
+ $this->thirdPartySettings = $third_party_settings;
}
/**
@@ -334,6 +348,7 @@ public function toArray() {
'components' => array_map(function (SectionComponent $component) {
return $component->toArray();
}, $this->getComponents()),
+ 'third_party_settings' => $this->thirdPartySettings,
];
}
@@ -349,10 +364,18 @@ public function toArray() {
* The section object.
*/
public static function fromArray(array $section) {
+ // Ensure expected array keys are present.
+ $section += [
+ 'layout_id' => '',
+ 'layout_settings' => [],
+ 'components' => [],
+ 'third_party_settings' => [],
+ ];
return new static(
$section['layout_id'],
$section['layout_settings'],
- array_map([SectionComponent::class, 'fromArray'], $section['components'])
+ array_map([SectionComponent::class, 'fromArray'], $section['components']),
+ $section['third_party_settings']
);
}
@@ -365,4 +388,46 @@ public function __clone() {
}
}
+ /**
+ * {@inheritdoc}
+ */
+ public function getThirdPartySetting($provider, $key, $default = NULL) {
+ return isset($this->thirdPartySettings[$provider][$key]) ? $this->thirdPartySettings[$provider][$key] : $default;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getThirdPartySettings($provider) {
+ return isset($this->thirdPartySettings[$provider]) ? $this->thirdPartySettings[$provider] : [];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setThirdPartySetting($provider, $key, $value) {
+ $this->thirdPartySettings[$provider][$key] = $value;
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function unsetThirdPartySetting($provider, $key) {
+ unset($this->thirdPartySettings[$provider][$key]);
+ // If the third party is no longer storing any information, completely
+ // remove the array holding the settings for this provider.
+ if (empty($this->thirdPartySettings[$provider])) {
+ unset($this->thirdPartySettings[$provider]);
+ }
+ return $this;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getThirdPartyProviders() {
+ return array_keys($this->thirdPartySettings);
+ }
+
}
diff --git a/core/modules/layout_builder/tests/fixtures/update/layout-builder-enable.php b/core/modules/layout_builder/tests/fixtures/update/layout-builder-enable.php
index fc69baae3375..980a87064ef7 100644
--- a/core/modules/layout_builder/tests/fixtures/update/layout-builder-enable.php
+++ b/core/modules/layout_builder/tests/fixtures/update/layout-builder-enable.php
@@ -32,6 +32,7 @@
'weight' => 0,
],
],
+ 'third_party_settings' => [],
];
$connection->update('config')
->fields([
diff --git a/core/modules/layout_builder/tests/modules/layout_builder_defaults_test/config/schema/layout_builder_defaults_test.schema.yml b/core/modules/layout_builder/tests/modules/layout_builder_defaults_test/config/schema/layout_builder_defaults_test.schema.yml
new file mode 100644
index 000000000000..cd7d15152603
--- /dev/null
+++ b/core/modules/layout_builder/tests/modules/layout_builder_defaults_test/config/schema/layout_builder_defaults_test.schema.yml
@@ -0,0 +1,6 @@
+layout_builder.section.third_party.layout_builder_defaults_test:
+ type: mapping
+ mapping:
+ which_party:
+ label: 'Which party?'
+ type: string
diff --git a/core/modules/layout_builder/tests/src/Functional/Update/LayoutBuilderEnableUpdatePathTest.php b/core/modules/layout_builder/tests/src/Functional/Update/LayoutBuilderEnableUpdatePathTest.php
index 5577539359dd..413d0eae0ab3 100644
--- a/core/modules/layout_builder/tests/src/Functional/Update/LayoutBuilderEnableUpdatePathTest.php
+++ b/core/modules/layout_builder/tests/src/Functional/Update/LayoutBuilderEnableUpdatePathTest.php
@@ -47,6 +47,7 @@ public function testRunUpdates() {
'weight' => 0,
],
],
+ 'third_party_settings' => [],
],
],
];
diff --git a/core/modules/layout_builder/tests/src/Kernel/DefaultsSectionStorageTest.php b/core/modules/layout_builder/tests/src/Kernel/DefaultsSectionStorageTest.php
index 2f355e221a17..637da2994751 100644
--- a/core/modules/layout_builder/tests/src/Kernel/DefaultsSectionStorageTest.php
+++ b/core/modules/layout_builder/tests/src/Kernel/DefaultsSectionStorageTest.php
@@ -103,9 +103,14 @@ public function testAccess($expected, $operation, $is_enabled, array $section_da
*/
public function providerTestAccess() {
$section_data = [
- new Section('layout_onecol', [], [
- 'first-uuid' => new SectionComponent('first-uuid', 'content', ['id' => 'foo']),
- ]),
+ new Section(
+ 'layout_onecol',
+ [],
+ [
+ 'first-uuid' => new SectionComponent('first-uuid', 'content', ['id' => 'foo'], ['harold' => 'maude']),
+ ],
+ ['layout_builder_defaults_test' => ['which_party' => 'third']]
+ ),
];
// Data provider values are:
diff --git a/core/modules/layout_builder/tests/src/Unit/SectionTest.php b/core/modules/layout_builder/tests/src/Unit/SectionTest.php
index eff239507d2b..232e1719c525 100644
--- a/core/modules/layout_builder/tests/src/Unit/SectionTest.php
+++ b/core/modules/layout_builder/tests/src/Unit/SectionTest.php
@@ -25,11 +25,19 @@ class SectionTest extends UnitTestCase {
protected function setUp() {
parent::setUp();
- $this->section = new Section('layout_onecol', [], [
- new SectionComponent('existing-uuid', 'some-region', ['id' => 'existing-block-id']),
- (new SectionComponent('second-uuid', 'ordered-region', ['id' => 'second-block-id']))->setWeight(3),
- (new SectionComponent('first-uuid', 'ordered-region', ['id' => 'first-block-id']))->setWeight(2),
- ]);
+ $this->section = new Section(
+ 'layout_onecol',
+ [],
+ [
+ new SectionComponent('existing-uuid', 'some-region', ['id' => 'existing-block-id']),
+ (new SectionComponent('second-uuid', 'ordered-region', ['id' => 'second-block-id']))->setWeight(3),
+ (new SectionComponent('first-uuid', 'ordered-region', ['id' => 'first-block-id']))->setWeight(2),
+ ],
+ [
+ 'bad_judgement' => ['blink_speed' => 'fast', 'spin_direction' => 'clockwise'],
+ 'hunt_and_peck' => ['delay' => '300ms'],
+ ]
+ );
}
/**
@@ -179,4 +187,175 @@ protected function assertComponents(array $expected, Section $section) {
$this->assertSame(array_keys($expected), array_keys($result));
}
+ /**
+ * @covers ::getThirdPartySettings
+ * @dataProvider providerTestGetThirdPartySettings
+ */
+ public function testGetThirdPartySettings($provider, $expected) {
+ $this->assertSame($expected, $this->section->getThirdPartySettings($provider));
+ }
+
+ /**
+ * Provides test data for ::testGetThirdPartySettings().
+ */
+ public function providerTestGetThirdPartySettings() {
+ $data = [];
+ $data[] = [
+ 'bad_judgement',
+ ['blink_speed' => 'fast', 'spin_direction' => 'clockwise'],
+ ];
+ $data[] = [
+ 'hunt_and_peck',
+ ['delay' => '300ms'],
+ ];
+ $data[] = [
+ 'non_existing_provider',
+ [],
+ ];
+ return $data;
+ }
+
+ /**
+ * @covers ::getThirdPartySetting
+ * @dataProvider providerTestGetThirdPartySetting
+ */
+ public function testGetThirdPartySetting($provider, $key, $expected, $default = FALSE) {
+ if ($default) {
+ $this->assertSame($expected, $this->section->getThirdPartySetting($provider, $key, $default));
+ }
+ else {
+ $this->assertSame($expected, $this->section->getThirdPartySetting($provider, $key));
+ }
+ }
+
+ /**
+ * Provides test data for ::testGetThirdPartySetting().
+ */
+ public function providerTestGetThirdPartySetting() {
+ $data = [];
+ $data[] = [
+ 'bad_judgement',
+ 'blink_speed',
+ 'fast',
+ ];
+ $data[] = [
+ 'hunt_and_peck',
+ 'delay',
+ '300ms',
+ ];
+ $data[] = [
+ 'hunt_and_peck',
+ 'non_existing_key',
+ NULL,
+ ];
+ $data[] = [
+ 'non_existing_provider',
+ 'non_existing_key',
+ NULL,
+ ];
+ $data[] = [
+ 'non_existing_provider',
+ 'non_existing_key',
+ 'default value',
+ 'default value',
+ ];
+ return $data;
+ }
+
+ /**
+ * @covers ::setThirdPartySetting
+ * @dataProvider providerTestSetThirdPartySetting
+ */
+ public function testSetThirdPartySetting($provider, $key, $value, $expected) {
+ $this->section->setThirdPartySetting($provider, $key, $value);
+ $this->assertSame($expected, $this->section->getThirdPartySettings($provider));
+ }
+
+ /**
+ * Provides test data for ::testSetThirdPartySettings().
+ */
+ public function providerTestSetThirdPartySetting() {
+ $data = [];
+ $data[] = [
+ 'bad_judgement',
+ 'blink_speed',
+ 'super fast',
+ [
+ 'blink_speed' => 'super fast',
+ 'spin_direction' => 'clockwise',
+ ],
+ ];
+ $data[] = [
+ 'bad_judgement',
+ 'new_setting',
+ 'new_value',
+ [
+ 'blink_speed' => 'fast',
+ 'spin_direction' => 'clockwise',
+ 'new_setting' => 'new_value',
+ ],
+ ];
+ $data[] = [
+ 'new_provider',
+ 'new_setting',
+ 'new_value',
+ [
+ 'new_setting' => 'new_value',
+ ],
+ ];
+ return $data;
+ }
+
+ /**
+ * @covers ::unsetThirdPartySetting
+ * @dataProvider providerTestUnsetThirdPartySetting
+ */
+ public function testUnsetThirdPartySetting() {
+ $this->section->unsetThirdPartySetting('bad_judgement', 'blink_speed');
+ $this->assertSame(['spin_direction' => 'clockwise'], $this->section->getThirdPartySettings('bad_judgement'));
+ $this->section->unsetThirdPartySetting('hunt_and_peck', 'delay');
+ $this->assertSame([], $this->section->getThirdPartySettings('hunt_and_peck'));
+ $this->section->unsetThirdPartySetting('bad_judgement', 'non_existing_key');
+ $this->section->unsetThirdPartySetting('non_existing_provider', 'non_existing_key');
+ }
+
+ /**
+ * Provides test data for ::testUnsetThirdPartySettings().
+ */
+ public function providerTestUnsetThirdPartySetting() {
+ $data = [];
+ $data[] = [
+ 'bad_judgement',
+ 'blink_speed',
+ [
+ 'spin_direction' => 'clockwise',
+ ],
+ ];
+ $data[] = [
+ 'hunt_and_peck',
+ 'delay',
+ [],
+ ];
+ $data[] = [
+ 'bad_judgement',
+ 'non_existing_key',
+ [],
+ ];
+ $data[] = [
+ 'non_existing_provider',
+ 'non_existing_key',
+ [],
+ ];
+ return $data;
+ }
+
+ /**
+ * @covers ::getThirdPartyProviders
+ */
+ public function testGetThirdPartyProviders() {
+ $this->assertSame(['bad_judgement', 'hunt_and_peck'], $this->section->getThirdPartyProviders());
+ $this->section->unsetThirdPartySetting('hunt_and_peck', 'delay');
+ $this->assertSame(['bad_judgement'], $this->section->getThirdPartyProviders());
+ }
+
}
--
GitLab