Merge pull request #18 from digitalutsc/feat/add-ci-and-linting

feat: add ci and linting

Author: kylehuynh205

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ["8.3", "8.4"]
+        drupal-version: ["10.6", "11.3"] 
+
+    name: PHP ${{ matrix.php-versions }} | Drupal ${{ matrix.drupal-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Create docker network
+        run: docker network create ci-default
+
+      - name: PHPUnit tests
+        run: |
+          docker run \
+            --rm \
+            --name drupal \
+            --hostname drupal \
+            --volume $(pwd):/var/www/drupal/web/modules/contrib/$ENABLE_MODULES:ro \
+            --env ENABLE_MODULES \
+            --network ci-default \
+           ghcr.io/islandora/ci:${{ matrix.drupal-version }}-php${{ matrix.php-versions }}
+        env:
+          ENABLE_MODULES: islandora_breadcrumbs

composer.json

@@ -2,5 +2,6 @@
   "name": "islandora_lite/islandora_breadcrumbs",
   "type": "drupal-module",
   "description": "Breadcrumbs for Islandora objects",
-  "keywords": ["Drupal"]
+  "keywords": ["Drupal"],
+  "require": {}
 }

islandora_breadcrumbs.module

@@ -5,8 +5,6 @@
  * Primary module hooks for Islandora Breadcrumbs module.
  */
 
-use Drupal\node\NodeInterface;
-
 /**
  * Implements hook_theme().
  */
@@ -32,7 +30,7 @@ function islandora_breadcrumbs_theme($existing, $type, $theme, $path) {
 function islandora_breadcrumbs_preprocess_islandora_breadcrumb(array &$variables) {
   $variables['breadcrumb'] = [];
   $route_name = \Drupal::routeMatch()->getRouteName();
-  if (strpos($route_name, "view.group") === false) {
+  if (strpos($route_name, "view.group") === FALSE) {
     /** @var \Drupal\Core\Link $link */
     foreach ($variables['links'] as $key => $links) {
       foreach ($links as $link) {
@@ -44,4 +42,3 @@ function islandora_breadcrumbs_preprocess_islandora_breadcrumb(array &$variables
     }
   }
 }
-

src/IslandoraBreadcrumbBuilder.php

@@ -1,7 +1,11 @@
 <?php
 
+// phpcs:disable DrupalPractice.Objects.GlobalDrupal
+// phpcs:disable DrupalPractice.Objects.GlobalClass
+
 namespace Drupal\islandora_breadcrumbs;
 
+use Drupal\views\Views;
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Entity\EntityInterface;
@@ -124,13 +128,15 @@ public function build(RouteMatchInterface $route_match) {
         }
       }
 
-      //$title = str_replace(['-', '_'], ' ', Unicode::ucwords(end($path_elements)));
-      $view = \Drupal\views\Views::getView($parameters['view_id']);
+      // phpcs:ignore -- Line exceeds 80 characters; contains 86 characters
+      // $title = str_replace(['-', '_'], ' ', Unicode::ucwords(end($path_elements)));
+      $view = Views::getView($parameters['view_id']);
       $view->setDisplay($parameters['display_id']);
       $view_title = $view->getTitle();
-      if (is_null($node)){
+      if (is_null($node)) {
         $breadcrumb->addLink(Link::createFromRoute($view_title, '<none>'));
-      } else {
+      }
+      else {
         $this->setReferenceBreadcrumbs($breadcrumb, $node);
         $breadcrumb->addLink(Link::createFromRoute($title, 'entity.node.canonical', ['node' => $nid]));    //updated for breadcrumb issue  
         }
@@ -164,7 +170,7 @@ public function build(RouteMatchInterface $route_match) {
    * @param \Drupal\node\Entity\Node $node
    *   Node to get breadcrumb of.
    */
-  protected function setReferenceBreadcrumbs(IslandoraBreadcrumb &$breadcrumb, Node $node = NULL) {
+  protected function setReferenceBreadcrumbs(IslandoraBreadcrumb &$breadcrumb, ?Node $node = NULL) {
     if ($node == NULL) {
       return;
     }
@@ -175,6 +181,7 @@ protected function setReferenceBreadcrumbs(IslandoraBreadcrumb &$breadcrumb, Nod
 
     // Check referenced fields for members.
     foreach ($referenced_entities as $referenced_entity) {
+      // phpcs:ignore -- Unused variable $link.
       $link = $referenced_entity->toLink()->toString()->getGeneratedLink();
       $node = $this->extractNode($referenced_entity);
       $refs = $this->getReferencedEntities($node);
@@ -190,6 +197,7 @@ protected function setReferenceBreadcrumbs(IslandoraBreadcrumb &$breadcrumb, Nod
     }
     foreach ($referenced_entities as $referenced_entity) {
       $referenced_entity = \Drupal::service('entity.repository')->getTranslationFromContext($referenced_entity);
+      // phpcs:ignore -- Unused variable $link.
       $link = $referenced_entity->toLink()->toString()->getGeneratedLink();
       $node = $this->extractNode($referenced_entity);
 
@@ -213,7 +221,7 @@ protected function setReferenceBreadcrumbs(IslandoraBreadcrumb &$breadcrumb, Nod
    * @return array
    *   List of objects referenced by $node.
    */
-  protected function getReferencedEntities(Node $node = NULL) {
+  protected function getReferencedEntities(?Node $node = NULL) {
     $referenced_entities = [];
     if ($node == NULL) {
       return $referenced_entities;
@@ -251,6 +259,7 @@ protected function nodeHasReferenceFields(Node $node) {
    *   Link representing node.
    */
   protected function getViewLink(Node $node) {
+    // phpcs:ignore -- Unused variable $nid.
     $nid = $node->id();
     if (Term::load($node->get('field_model')->target_id)->get('name')->value === "Paged Content") {
       return Link::createFromRoute($node->getTitle(), "entity.node.canonical", ['node' => $node->id()]);
@@ -269,7 +278,7 @@ protected function getViewLink(Node $node) {
    * @return \Drupal\node\Entity\Node
    *   Translated node.
    */
-  protected function getTranslatedNode(Node $node = NULL) {
+  protected function getTranslatedNode(?Node $node = NULL) {
     if (is_null($node)) {
       return NULL;
     }