Allow LocationCreateStruct objects inside the $locations argument of ContentCreateStructure to have more control over the created locations. (#40)

* bump PHP version

* update PHPUnit config

.github/workflows/php.yml

@@ -0,0 +1,55 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: [7.3, 7.4, 8.0, 8.1]
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup PHP ${{ matrix.php-version }}
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-version }}
+        extensions: xdebug
+    - name: PHP Version
+      run: php -v
+
+    - name: PHP Lint
+      run: find . -type f -name '*.php' -exec php -l {} \; | (! grep -v "No syntax errors detected" )
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v2
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php${{ matrix.php-version }}-
+
+    - name: Install dependencies
+      run: composer update --prefer-dist --no-progress --no-scripts
+
+    - name: PHPUnit
+      run: php -d xdebug.mode=coverage vendor/bin/phpunit --log-junit junit.xml
+
+    - name: Publish Unit Test Results
+      uses: EnricoMi/publish-unit-test-result-action@v1
+      if: always()
+      with:
+        files: junit.xml

CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 3.1.0
+
+* Allow `LocationCreateStruct` objects inside the `$locations` argument of `ContentCreateStructure` to have more control over the created locations.
+
+# Version 3.0.1
+
+* Bump minimum PHP version to PHP 7.3 like code-rhapsodie/dataflow-bundle dependency.
+* Allow PHP 8.x.
+* Add GitHub Action to run tests.
+
 # Version 3.0.0
 
 * Add compatibility with Ibexa Content 3.3

composer.json

@@ -41,7 +41,7 @@
         }
     },
     "require": {
-        "php": "^7.1",
+        "php": "^7.3||^8.0",
         "code-rhapsodie/dataflow-bundle": "^3.0",
         "ezsystems/ezplatform-admin-ui": "^2.3",
         "ezsystems/ezplatform-kernel": "^1.3"

phpunit.xml

@@ -1,32 +1,21 @@
-<?xml version = '1.0' encoding = 'UTF-8'?>
-
+<?xml version="1.0" encoding="UTF-8"?>
 <!-- http://www.phpunit.de/manual/current/en/appendixes.configuration.html -->
-<phpunit
-        backupGlobals="false"
-        backupStaticAttributes="false"
-        bootstrap="tests/bootstrap.php"
-        convertErrorsToExceptions="true"
-        convertNoticesToExceptions="true"
-        convertWarningsToExceptions="true"
-        colors="false"
->
-    <php>
-        <ini name="error_reporting" value="-1" />
-    </php>
-    <testsuites>
-        <testsuite name="EzDataflow tests suite">
-            <directory suffix="Test.php">./tests</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory>./src/</directory>
-            <exclude>
-                <directory>tests/</directory>
-                <directory>vendor/</directory>
-            </exclude>
-        </whitelist>
-    </filter>
-
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" bootstrap="tests/bootstrap.php" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" colors="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory>./src/</directory>
+    </include>
+    <exclude>
+      <directory>tests/</directory>
+      <directory>vendor/</directory>
+    </exclude>
+  </coverage>
+  <php>
+    <ini name="error_reporting" value="-1"/>
+  </php>
+  <testsuites>
+    <testsuite name="EzDataflow tests suite">
+      <directory suffix="Test.php">./tests</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

src/Core/Content/ContentCreator.php

@@ -60,9 +60,15 @@ class ContentCreator implements ContentCreatorInterface
     {
         $locationCreateStructs = [];
 
-        foreach ($locations as $locationOrIdOrRemoteId) {
+        foreach ($locations as $locationOrIdOrRemoteIdOrStruct) {
+            if ($locationOrIdOrRemoteIdOrStruct instanceof LocationCreateStruct) {
+                $locationCreateStructs[] = $locationOrIdOrRemoteIdOrStruct;
+
+                continue;
+            }
+
             $locationCreateStructs[] = new LocationCreateStruct([
-                'parentLocationId' => $this->matcher->matchLocation($locationOrIdOrRemoteId)->id,
+                'parentLocationId' => $this->matcher->matchLocation($locationOrIdOrRemoteIdOrStruct)->id,
             ]);
         }
 

src/Model/ContentCreateStructure.php

@@ -6,6 +6,7 @@ namespace CodeRhapsodie\EzDataflowBundle\Model;
 
 use CodeRhapsodie\EzDataflowBundle\Exception\InvalidArgumentTypeException;
 use eZ\Publish\API\Repository\Values\Content\Location;
+use eZ\Publish\API\Repository\Values\Content\LocationCreateStruct;
 
 class ContentCreateStructure extends ContentStructure
 {
@@ -24,6 +25,7 @@ class ContentCreateStructure extends ContentStructure
      *                         <li>an integer, the id of the Location object</li>
      *                         <li>a string, the remote id of the Location object</li>
      *                         <li>a Location object</li>
+     *                         <li>a LocationCreateStruct object</li>
      *                         </ul>
      *
      * @throws InvalidArgumentTypeException
@@ -52,12 +54,13 @@ class ContentCreateStructure extends ContentStructure
      */
     private function setLocations(array $locations)
     {
-        foreach ($locations as $locationOrIdOrRemoteId) {
-            if (!is_int($locationOrIdOrRemoteId)
-                && !is_string($locationOrIdOrRemoteId)
-                && !$locationOrIdOrRemoteId instanceof Location
+        foreach ($locations as $locationOrIdOrRemoteIdOrStruct) {
+            if (!is_int($locationOrIdOrRemoteIdOrStruct)
+                && !is_string($locationOrIdOrRemoteIdOrStruct)
+                && !$locationOrIdOrRemoteIdOrStruct instanceof Location
+                && !$locationOrIdOrRemoteIdOrStruct instanceof LocationCreateStruct
             ) {
-                throw InvalidArgumentTypeException::create(['int', 'string', Location::class], $locationOrIdOrRemoteId);
+                throw InvalidArgumentTypeException::create(['int', 'string', Location::class, LocationCreateStruct::class], $locationOrIdOrRemoteIdOrStruct);
             }
         }