packbackbooks · dbhynds · Dec 21, 2023 · Dec 18, 2023 · Dec 18, 2023 · Dec 18, 2023
diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml
@@ -1,10 +1,13 @@
-name: Tests & style checks
+name: Tests & Style Checks
 on:
-  # Trigger on any PR being opened, or on a merge to master (to update the badge)
+  # Trigger on any PR being opened
   pull_request:
+  # Or weekly and on a merge to master (to update the badge)
   push:
     branches:
       - master
+  schedule:
+    - cron: 0 0 * * 0
 jobs:
   lint:
     name: Lint
@@ -34,3 +37,19 @@ jobs:
           composer-options: "${{ matrix.composer-options }}"
       - name: Run tests
         run: composer test
+
+  coverage:
+    name: Code Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: "actions/checkout@v3"
+      - uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: latest
+          coverage: xdebug
+      - uses: "ramsey/composer-install@v2"
+      - uses: paambaati/[email protected]
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: composer test
diff --git a/.gitignore b/.gitignore
@@ -15,4 +15,5 @@ tests/_support/_generated/*
 vendor
 
 # ignore the coverage folders
+**/.phpunit.cache
 **/coverage
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # LTI 1.3 Tool Library
 
-![Test status](https://github.com/packbackbooks/lti-1-3-php-library/actions/workflows/run_tests.yml/badge.svg?branch=master)
+![Test status](https://github.com/packbackbooks/lti-1-3-php-library/actions/workflows/run_tests.yml/badge.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/16055e83ea04ad95a2f9/maintainability)](https://codeclimate.com/github/packbackbooks/lti-1-3-php-library/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/16055e83ea04ad95a2f9/test_coverage)](https://codeclimate.com/github/packbackbooks/lti-1-3-php-library/test_coverage)
 
 A library used for building IMS-certified LTI 1.3 tool providers in PHP.
 

diff --git a/composer.json b/composer.json
@@ -30,7 +30,7 @@
         "nesbot/carbon": "^2.43",
         "laravel/pint": "^1.0",
         "phpstan/phpstan": "^1.10",
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.0|^10.0"
     },
     "autoload": {
         "psr-4": {
@@ -43,11 +43,11 @@
         }
     },
     "scripts": {
-        "test": [
-            "phpunit",
+        "test": "phpunit",
+        "lint": [
+            "pint --test",
             "phpstan analyse"
         ],
-        "lint": "pint -v --test",
         "lint-fix": "pint -v"
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,9 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
   <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
     <report>
       <clover outputFile="build/logs/clover.xml"/>
       <html outputDirectory="build/coverage"/>
@@ -18,4 +15,9 @@
   <logging>
     <junit outputFile="build/report.junit.xml"/>
   </logging>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/Concerns/Arrayable.php b/src/Concerns/Arrayable.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Packback\Lti1p3\Concerns;
+
+use Packback\Lti1p3\Helpers\Helpers;
+
+trait Arrayable
+{
+    abstract public function getArray(): array;
+
+    public function toArray(): array
+    {
+        return Helpers::filterOutNulls($this->getArray());
+    }
+}
diff --git a/src/Concerns/JsonStringable.php b/src/Concerns/JsonStringable.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Packback\Lti1p3\Concerns;
+
+trait JsonStringable
+{
+    use Arrayable;
+
+    public function __toString(): string
+    {
+        return json_encode($this->toArray());
+    }
+}
diff --git a/src/DeepLinkResources/DateTimeInterval.php b/src/DeepLinkResources/DateTimeInterval.php
@@ -3,10 +3,12 @@
 namespace Packback\Lti1p3\DeepLinkResources;
 
 use DateTime;
+use Packback\Lti1p3\Concerns\Arrayable;
 use Packback\Lti1p3\LtiException;
 
 class DateTimeInterval
 {
+    use Arrayable;
     public const ERROR_NO_START_OR_END = 'Either a start or end time must be specified.';
     public const ERROR_START_GT_END = 'The start time cannot be greater than end time.';
 
@@ -22,6 +24,20 @@ public static function new(): self
         return new DateTimeInterval();
     }
 
+    public function getArray(): array
+    {
+        if (!isset($this->start) && !isset($this->end)) {
+            throw new LtiException(self::ERROR_NO_START_OR_END);
+        }
+
+        $this->validateStartAndEnd();
+
+        return [
+            'startDateTime' => $this->start?->format(DateTime::ATOM),
+            'endDateTime' => $this->end?->format(DateTime::ATOM),
+        ];
+    }
+
     public function setStart(?DateTime $start): self
     {
         $this->start = $start;
@@ -46,26 +62,9 @@ public function getEnd(): ?DateTime
         return $this->end;
     }
 
-    public function toArray(): array
-    {
-        if (!isset($this->start) && !isset($this->end)) {
-            throw new LtiException(self::ERROR_NO_START_OR_END);
-        }
-
-        $this->validateStartAndEnd();
-
-        $dateTimeInterval = [];
-
-        if (isset($this->start)) {
-            $dateTimeInterval['startDateTime'] = $this->start->format(DateTime::ATOM);
-        }
-        if (isset($this->end)) {
-            $dateTimeInterval['endDateTime'] = $this->end->format(DateTime::ATOM);
-        }
-
-        return $dateTimeInterval;
-    }
-
+    /**
+     * @throws LtiException
+     */
     private function validateStartAndEnd(): void
     {
         if (isset($this->start) && isset($this->end) && $this->start > $this->end) {

diff --git a/src/DeepLinkResources/Icon.php b/src/DeepLinkResources/Icon.php
@@ -2,9 +2,11 @@
 
 namespace Packback\Lti1p3\DeepLinkResources;
 
+use Packback\Lti1p3\Concerns\Arrayable;
+
 class Icon
 {
-    use HasDimensions;
+    use Arrayable, HasDimensions;
 
     public function __construct(
         private string $url,
@@ -18,6 +20,15 @@ public static function new(string $url, int $width, int $height): self
         return new Icon($url, $width, $height);
     }
 
+    public function getArray(): array
+    {
+        return [
+            'url' => $this->url,
+            'width' => $this->width,
+            'height' => $this->height,
+        ];
+    }
+
     public function setUrl(string $url): self
     {
         $this->url = $url;
@@ -29,13 +40,4 @@ public function getUrl(): string
     {
         return $this->url;
     }
-
-    public function toArray(): array
-    {
-        return [
-            'url' => $this->url,
-            'width' => $this->width,
-            'height' => $this->height,
-        ];
-    }
 }
diff --git a/src/DeepLinkResources/Iframe.php b/src/DeepLinkResources/Iframe.php
@@ -2,9 +2,11 @@
 
 namespace Packback\Lti1p3\DeepLinkResources;
 
+use Packback\Lti1p3\Concerns\Arrayable;
+
 class Iframe
 {
-    use HasDimensions;
+    use Arrayable, HasDimensions;
 
     public function __construct(
         private ?string $src = null,
@@ -18,6 +20,15 @@ public static function new(): self
         return new Iframe();
     }
 
+    public function getArray(): array
+    {
+        return [
+            'width' => $this->width,
+            'height' => $this->height,
+            'src' => $this->src,
+        ];
+    }
+
     public function setSrc(?string $src): self
     {
         $this->src = $src;
@@ -29,21 +40,4 @@ public function getSrc(): ?string
     {
         return $this->src;
     }
-
-    public function toArray(): array
-    {
-        $iframe = [];
-
-        if (isset($this->width)) {
-            $iframe['width'] = $this->width;
-        }
-        if (isset($this->height)) {
-            $iframe['height'] = $this->height;
-        }
-        if (isset($this->src)) {
-            $iframe['src'] = $this->src;
-        }
-
-        return $iframe;
-    }
 }
diff --git a/src/DeepLinkResources/Resource.php b/src/DeepLinkResources/Resource.php
@@ -2,11 +2,13 @@
 
 namespace Packback\Lti1p3\DeepLinkResources;
 
+use Packback\Lti1p3\Concerns\Arrayable;
 use Packback\Lti1p3\LtiConstants;
 use Packback\Lti1p3\LtiLineitem;
 
 class Resource
 {
+    use Arrayable;
     private string $type = LtiConstants::DL_RESOURCE_LINK_TYPE;
     private ?string $title = null;
     private ?string $text = null;
@@ -26,6 +28,42 @@ public static function new(): self
         return new Resource();
     }
 
+    public function getArray(): array
+    {
+        $resource = [
+            'type' => $this->type,
+            'title' => $this->title,
+            'text' => $this->text,
+            'url' => $this->url,
+            'icon' => $this->icon?->toArray(),
+            'thumbnail' => $this->thumbnail?->toArray(),
+            'iframe' => $this->iframe?->toArray(),
+            'window' => $this->window?->toArray(),
+            'available' => $this->availability_interval?->toArray(),
+            'submission' => $this->submission_interval?->toArray(),
+        ];
+
+        if (!empty($this->custom_params)) {
+            $resource['custom'] = $this->custom_params;
+        }
+
+        if (isset($this->line_item)) {
+            $resource['lineItem'] = [
+                'scoreMaximum' => $this->line_item->getScoreMaximum(),
+                'label' => $this->line_item->getLabel(),
+            ];
+        }
+
+        // Kept for backwards compatibility
+        if (!isset($this->iframe) && !isset($this->window)) {
+            $resource['presentation'] = [
+                'documentTarget' => $this->target,
+            ];
+        }
+
+        return $resource;
+    }
+
     public function getType(): string
     {
         return $this->type;
@@ -169,58 +207,4 @@ public function setSubmissionInterval(?DateTimeInterval $submissionInterval): se
 
         return $this;
     }
-
-    public function toArray(): array
-    {
-        $resource = [
-            'type' => $this->type,
-        ];
-
-        if (isset($this->title)) {
-            $resource['title'] = $this->title;
-        }
-        if (isset($this->text)) {
-            $resource['text'] = $this->text;
-        }
-        if (isset($this->url)) {
-            $resource['url'] = $this->url;
-        }
-        if (!empty($this->custom_params)) {
-            $resource['custom'] = $this->custom_params;
-        }
-        if (isset($this->icon)) {
-            $resource['icon'] = $this->icon->toArray();
-        }
-        if (isset($this->thumbnail)) {
-            $resource['thumbnail'] = $this->thumbnail->toArray();
-        }
-        if ($this->line_item !== null) {
-            $resource['lineItem'] = [
-                'scoreMaximum' => $this->line_item->getScoreMaximum(),
-                'label' => $this->line_item->getLabel(),
-            ];
-        }
-
-        // Kept for backwards compatibility
-        if (!isset($this->iframe) && !isset($this->window)) {
-            $resource['presentation'] = [
-                'documentTarget' => $this->target,
-            ];
-        }
-
-        if (isset($this->iframe)) {
-            $resource['iframe'] = $this->iframe->toArray();
-        }
-        if (isset($this->window)) {
-            $resource['window'] = $this->window->toArray();
-        }
-        if (isset($this->availability_interval)) {
-            $resource['available'] = $this->availability_interval->toArray();
-        }
-        if (isset($this->submission_interval)) {
-            $resource['submission'] = $this->submission_interval->toArray();
-        }
-
-        return $resource;
-    }
 }