Merge pull request #9 from digitalutsc/refactor/dependency-injection

refactor: implement dependency injection

Author: kylehuynh205

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   islandora-module-ci:
-    uses: digitalutsc/reusable_workflows/.github/workflows/islandora-module-ci.yml@main
+    uses: digitalutsc/reusable_workflows/.github/workflows/islandora-module-ci-d10only.yml@main
     with:
       module_name: assign_calc
-      install_chromedriver: false
+      install_chromedriver: true

assign_calc.info.yml

@@ -8,3 +8,11 @@ dependencies:
   - paragraphs
   - entity_reference_revisions
   - contact
+  - node
+  - menu_ui
+  - views
+  - ds
+  - text
+  - datetime
+  - field
+  - path

config/install/field.field.paragraph.step.field_step_name.yml

@@ -19,4 +19,3 @@ default_value: {  }
 default_value_callback: ''
 settings: {  }
 field_type: string
-

config/optional/field.storage.node.body.yml

@@ -0,0 +1,18 @@
+langcode: en
+status: true
+dependencies:
+  module:
+    - node
+    - text
+id: node.body
+field_name: body
+entity_type: node
+type: text_with_summary
+settings: {  }
+module: text
+locked: false
+cardinality: 1
+translatable: true
+indexes: {  }
+persist_with_no_fields: true
+custom_storage: false

src/Form/AssignmentDatesForm.php

@@ -6,12 +6,40 @@
 use Drupal\Core\Form\FormBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Url;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\Core\Database\Connection;
 
 /**
  * Implements an assignment form.
  */
 class AssignmentDatesForm extends FormBase {
 
+  /**
+   * The database connection.
+   *
+   * @var \Drupal\Core\Database\Connection
+   */
+  protected $database;
+
+  /**
+   * Constructs a assignment form object.
+   *
+   * @param \Drupal\Core\Database\Connection $database
+   *   The database connection.
+   */
+  public function __construct(Connection $database) {
+    $this->database = $database;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('database')
+    );
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -36,13 +64,11 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     ];
 
     // For php >8.1.
-    // phpcs:ignore -- \Drupal calls should be avoided in classes, use dependency injection instead
-    if (!isset(\Drupal::database()->getConnectionOptions()['prefix'])) {
+    if (!isset($this->database->getConnectionOptions()['prefix'])) {
       return $form;
     }
 
-    // phpcs:ignore -- \Drupal calls should be avoided in classes, use dependency injection instead
-    $prf = \Drupal::database()->getConnectionOptions()['prefix'];
+    $prf = $this->database->getConnectionOptions()['prefix'];
     $node = $prf . 'node';
     $node_field_data = $prf . 'node_field_data';
     $conn = Database::getConnection();

tests/src/Functional/LoadTest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Drupal\Tests\assign_calc\Functional;
+
+use Drupal\Core\Url;
+use Drupal\Tests\BrowserTestBase;
+use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
+
+/**
+ * Simple test to ensure that main page loads with module enabled.
+ *
+ * @group assign_calc
+ */
+#[RunTestsInSeparateProcesses]
+class LoadTest extends BrowserTestBase {
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  protected static $modules = [
+    'assign_calc',
+    'paragraphs',
+    'entity_reference_revisions',
+    'node',
+    'menu_ui',
+    'views',
+    'ds',
+    'contact',
+    'text',
+    'datetime',
+    'field',
+    'path',
+  ];
+
+  /**
+   * The theme to install as the default for testing.
+   *
+   * Defaults to the install profile's default theme, if it specifies any.
+   *
+   * @var string
+   */
+  protected $defaultTheme = 'stark';
+
+  /**
+   * A user with permission to administer site configuration.
+   *
+   * @var \Drupal\user\UserInterface
+   */
+  protected $user;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    parent::setUp();
+    $this->user = $this->drupalCreateUser(['administer site configuration']);
+    $this->drupalLogin($this->user);
+  }
+
+  /**
+   * Tests that the home page loads with a 200 response.
+   */
+  public function testLoad() {
+    $this->drupalGet(Url::fromRoute('<front>'));
+    $this->assertSession()->statusCodeEquals(200);
+  }
+
+}