feat: use TagField for inline linking to elements (fixes #49)

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+composer.lock
+/resources/

.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":{"DNADesign\\ElementalVirtual\\Tests\\BaseElementExtensionTest::testVirtualElementAnchor":4,"DNADesign\\ElementalVirtual\\Tests\\BaseElementExtensionTest::testUpdateCmsFields":1},"times":{"DNADesign\\ElementalVirtual\\Tests\\BaseElementExtensionTest::testVirtualElementAnchor":0,"DNADesign\\ElementalVirtual\\Tests\\BaseElementExtensionTest::testUpdateCmsFields":0}}

behat.yml

@@ -0,0 +1,21 @@
+# Note: Currently chrome latest is recommended
+# Behat test setup requires an `.env` with `SS_BASE_URL` defined, as well
+# as each of the following commands to initiate a test run:
+# ========================================================================= #
+# composer require silverstripe/recipe-testing ^1
+# vendor/bin/behat-ss @<module>
+# ========================================================================= #
+default:
+  suites: []
+  extensions:
+    SilverStripe\BehatExtension\MinkExtension:
+      default_session: facebook_web_driver
+      javascript_session: facebook_web_driver
+      facebook_web_driver:
+        browser: chrome
+        wd_host: "http://127.0.0.1:9515" #chromedriver port
+      browser_name: chrome
+    SilverStripe\BehatExtension\Extension:
+      bootstrap_file: vendor/silverstripe/cms/tests/behat/serve-bootstrap.php
+      screenshot_path: %paths.base%/artifacts/screenshots
+      retry_seconds: 4 # default is 2

composer.json

@@ -13,32 +13,37 @@
     "prefer-stable": true,
     "require": {
         "dnadesign/silverstripe-elemental": "^3 || ^4",
-        "tractorcow/silverstripe-autocomplete": "^4",
+        "silverstripe/tagfield": "^2.0",
         "silverstripe/vendor-plugin": "^1.0",
         "silverstripe/admin": "^1.5"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7",
-        "squizlabs/php_codesniffer": "^3.0"
+        "silverstripe/recipe-testing": "^2"
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.x-dev"
+            "dev-main": "1.x-dev"
         },
         "expose": [
             "css"
+        ],
+        "project-files-installed": [
+            "behat.yml",
+            "phpcs.xml.dist",
+            "phpunit.xml.dist"
         ]
     },
-    "scripts": {
-        "lint": "phpcs --extensions=php src/ tests/",
-        "syntax-check": "find src/ tests/ -type f -name '*.php' -exec php -l {} \\;",
-        "lint-clean": "phpcbf src/ tests/ --extensions=php",
-        "remove-uses": "php-cs-fixer fix src/ tests/ --rules=no_unused_imports"
-    },
     "autoload": {
         "psr-4": {
             "DNADesign\\ElementalVirtual\\": "src/",
             "DNADesign\\ElementalVirtual\\Tests\\": "tests/php/"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "silverstripe/recipe-plugin": true,
+            "silverstripe/vendor-plugin": true
+        }
     }
 }

phpcs.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset name="SS4">
+    <description>Coding standard for SilverStripe 4.x</description>
+
+    <!-- Don't sniff third party libraries -->
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/thirdparty/*</exclude-pattern>
+
+    <!-- Show progress and output sniff names on violation, and add colours -->
+    <arg value="sp"/>
+    <arg name="colors"/>
+
+    <!-- Use PSR-2 as a base standard -->
+    <rule ref="PSR2">
+        <!-- Allow classes to not declare a namespace -->
+        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
+
+        <!-- Allow underscores in class names -->
+        <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps"/>
+
+        <!-- Allow non camel cased method names -->
+        <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
+    </rule>
+</ruleset>

phpunit.xml.dist

@@ -1,14 +1,14 @@
-<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
-    <testsuite name="Default">
-        <directory>tests/php</directory>
-    </testsuite>
-
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src/</directory>
-            <exclude>
-                <directory suffix=".php">tests/php</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage includeUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <exclude>
+      <directory suffix=".php">tests/php</directory>
+    </exclude>
+  </coverage>
+  <testsuite name="Default">
+    <directory>tests/php</directory>
+  </testsuite>
 </phpunit>

src/Model/ElementVirtual.php

@@ -2,23 +2,16 @@
 
 namespace DNADesign\ElementalVirtual\Model;
 
-use TractorCow\AutoComplete\AutoCompleteField;
-use SilverStripe\ElementalVirtual\Forms\ElementalGridFieldAddExistingAutocompleter;
 use DNADesign\Elemental\Models\BaseElement;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\LiteralField;
-use SilverStripe\Forms\Tab;
-use SilverStripe\Forms\TabSet;
-use SilverStripe\ORM\FieldType\DBField;
-use SilverStripe\ORM\FieldType\DBHTMLText;
+use SilverStripe\TagField\TagField;
 
 /**
  * Virtual Linked Element.
  *
  * As elemental is based on a natural has_one relation to an object,
  * this allows the same element to be linked to multiple pages.
- *
- * {@see ElementalGridFieldAddExistingAutocompleter}
  */
 class ElementVirtual extends BaseElement
 {
@@ -36,8 +29,8 @@ class ElementVirtual extends BaseElement
     private static $table_name = 'ElementVirtual';
 
     private static $singular_name = 'virtual block';
-    
-    private static $inline_editable = false;
+
+    private static $inline_editable = true;
 
     /**
      * @param BaseElement
@@ -67,29 +60,23 @@ public function getCMSFields()
                 $fields->addFieldToTab('Root.Main', LiteralField::create('WarningHeader', '<p class="message error">' . $warning . '</p>'));
             }
 
-            $autocomplete = AutoCompleteField::create(
-                'LinkedElementID',
-                _t(__CLASS__ . '.LinkedElement', 'Linked Element'),
-                '',
-                BaseElement::class,
-                'Title'
-            );
-
-            $autocomplete->setLabelField('VirtualLinkedSummary');
-            $autocomplete->setDisplayField('VirtualLinkedSummary');
-            $autocomplete->setSourceFilter(['AvailableGlobally' => 1]);
+            $availableBlocks = BaseElement::get()->filter('AvailableGlobally', 1)->exclude('ClassName', ElementVirtual::class);
 
             $fields->replaceField(
                 'LinkedElementID',
-                $autocomplete
+                TagField::create("LinkedElementID", $this->fieldLabel('LinkedElement'), $availableBlocks)
+                    ->setIsMultiple(false)
+                    ->setCanCreate(false)
+                    ->setShouldLazyLoad(true)
             );
-            
-            if($this->LinkedElementID){
+
+            if ($this->LinkedElementID) {
                 $message = sprintf(
                     '<p>%s</p><p><a href="%2$s" target="_blank">Click here to edit the original</a></p>',
                     _t(__CLASS__ . '.VirtualDescription', 'This is a virtual copy of an element.'),
                     $this->LinkedElement()->getEditLink()
                 );
+
                 $fields->addFieldToTab('Root.Main', LiteralField::create('Existing', $message));
             }
         });

tests/php/BaseElementExtensionTest.php

@@ -19,7 +19,7 @@ class BaseElementExtensionTest extends SapphireTest
         TestPage::class
     ];
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();