Merge pull request #40 from psu-libraries/39-fix-linter-issue-in-block

39 fix linter issue in block

Author: zipymonkey

psulib_base_helper.install

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the psulib_base_helper module.
+ */
+
+/**
+ * Remove unsupported configs from psulib_base settings.
+ */
+function psulib_base_helper_update_10001() {
+  $config = \Drupal::configFactory()->getEditable('psulib_base.settings');
+  $schema = \Drupal::service('config.typed')->getDefinition('psulib_base.settings');
+
+  if ($schema) {
+    $supported_keys = array_keys($schema['mapping'] ?? []);
+    $current_data = $config->getRawData();
+
+    foreach (array_keys($current_data) as $key) {
+      if ($key !== 'uuid' && $key !== '_core' && !in_array($key, $supported_keys)) {
+        $config->clear($key);
+      }
+    }
+
+    $config->save();
+  }
+}

src/Hook/ThemeHooks.php

@@ -4,7 +4,7 @@
 
 namespace Drupal\psulib_base_helper\Hook;
 
-use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Extension\ThemeSettingsProvider;
 use Drupal\Core\Hook\Attribute\Hook;
 use Drupal\psulib_base_helper\PsuFederatedDataFetcher;
 
@@ -18,7 +18,7 @@ class ThemeHooks {
    */
   public function __construct(
     private readonly PsuFederatedDataFetcher $dataFetcher,
-    private readonly ConfigFactoryInterface $configFactory,
+    private readonly ThemeSettingsProvider $themeSettingsProvider,
   ) {}
 
   /**
@@ -28,9 +28,7 @@ public function __construct(
    */
   #[Hook('preprocess_page')]
   public function preprocessPage(&$variables): void {
-    $show_federated_footer = $this->configFactory
-      ->get('psulib_base.settings')
-      ->get('show_federated_footer');
+    $show_federated_footer = $this->themeSettingsProvider->getSetting('show_federated_footer');
 
     if (!$show_federated_footer) {
       return;

src/Plugin/Block/PsulBrandingBlock.php

@@ -16,7 +16,7 @@
  *   category = @Translation("PSU Libraries"),
  * )
  */
-final class PsulBrandingBlock extends SystemBrandingBlock {
+class PsulBrandingBlock extends SystemBrandingBlock {
 
   /**
    * {@inheritdoc}
@@ -88,7 +88,7 @@ public function build(): array {
       '#component' => 'psulib_base:header_mark',
       '#props' => [
         'site_name' => $this->configuration['use_site_name'] ? $site_config->get('name') : '',
-        'site_logo' => $this->configuration['use_site_logo'] ? \Drupal::service('Drupal\Core\Extension\ThemeSettingsProvider')->getSetting('logo.url') : '',
+        'site_logo' => $this->configuration['use_site_logo'] ? $this->themeSettingsProvider->getSetting('logo.url') : '',
         'site_slogan' => $this->configuration['use_site_slogan'] ? $site_config->get('slogan') : '',
         'hide_site_name' => (bool) $this->configuration['hide_site_name'],
         'logo_title' => $this->configuration['logo_title'],

tests/src/Unit/Hook/ThemeHooksTest.php

@@ -4,8 +4,7 @@
 
 namespace Drupal\Tests\psulib_base_helper\Unit\Hook;
 
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\Config\ImmutableConfig;
+use Drupal\Core\Extension\ThemeSettingsProvider;
 use Drupal\psulib_base_helper\Hook\ThemeHooks;
 use Drupal\psulib_base_helper\PsuFederatedDataFetcher;
 use Drupal\Tests\UnitTestCase;
@@ -29,18 +28,11 @@ class ThemeHooksTest extends UnitTestCase {
   protected $dataFetcher;
 
   /**
-   * The mocked config factory.
+   * The mocked theme settings provider.
    *
-   * @var \Drupal\Core\Config\ConfigFactoryInterface|\PHPUnit\Framework\MockObject\MockObject
+   * @var \Drupal\Core\Extension\ThemeSettingsProvider|\PHPUnit\Framework\MockObject\MockObject
    */
-  protected $configFactory;
-
-  /**
-   * The mocked config.
-   *
-   * @var \Drupal\Core\Config\ImmutableConfig|\PHPUnit\Framework\MockObject\MockObject
-   */
-  protected $config;
+  protected $themeSettingsProvider;
 
   /**
    * The ThemeHooks instance.
@@ -56,16 +48,11 @@ protected function setUp(): void {
     parent::setUp();
 
     $this->dataFetcher = $this->createMock(PsuFederatedDataFetcher::class);
-    $this->configFactory = $this->createMock(ConfigFactoryInterface::class);
-    $this->config = $this->createMock(ImmutableConfig::class);
-
-    $this->configFactory->method('get')
-      ->with('psulib_base.settings')
-      ->willReturn($this->config);
+    $this->themeSettingsProvider = $this->createMock(ThemeSettingsProvider::class);
 
     $this->hooks = new ThemeHooks(
       $this->dataFetcher,
-      $this->configFactory
+      $this->themeSettingsProvider
     );
   }
 
@@ -74,7 +61,7 @@ protected function setUp(): void {
    */
   #[Test]
   public function testFederatedFooterAddedWhenSettingsAndDataPresent(): void {
-    $this->config->method('get')
+    $this->themeSettingsProvider->method('getSetting')
       ->with('show_federated_footer')
       ->willReturn(TRUE);
 
@@ -118,7 +105,7 @@ public function testFederatedFooterAddedWhenSettingsAndDataPresent(): void {
   #[Test]
   #[DataProvider('federatedFooterNotAddedProvider')]
   public function testFederatedFooterNotAddedWhenNoDataOrDisabled(?bool $showSetting, array $data, bool $expectFetcherCall): void {
-    $this->config->method('get')
+    $this->themeSettingsProvider->method('getSetting')
       ->with('show_federated_footer')
       ->willReturn($showSetting);