Refactor / update (wip)

.editorconfig

@@ -1,7 +1,3 @@
-# For more information about the properties used in this file,
-# please see the EditorConfig documentation:
-# http://editorconfig.org
-
 [*]
 charset = utf-8
 end_of_line = lf
@@ -10,8 +6,15 @@ indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[{*.yml,*.json}]
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,js,json,css,scss,eslintrc,feature}]
+indent_size = 2
+indent_style = space
+
+[package.json]
 indent_size = 2
 
-[{*.ss}]
-indent_style = tab
+[composer.json]
+indent_size = 4

.gitattributes

@@ -1,2 +1,12 @@
-# Auto detect text files and perform LF normalization
-* text=auto
+/tests                      export-ignore
+/docs                       export-ignore
+/client/src                 export-ignore
+/.editorconfig              export-ignore
+/.gitattributes             export-ignore
+/.gitignore                 export-ignore
+/.php-cs-fixer.dist.php     export-ignore
+/phpunit.xml.dist           export-ignore
+/.waratah                   export-ignore
+/code-of-conduct.md         export-ignore
+/CONTRIBUTING.md            export-ignore
+/README.md                  export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: CI
+
+on:
+  pull_request: null
+
+jobs:
+  Silverstripe:
+    name: 'Silverstripe (bundle)'
+    uses: nswdpc/ci-files/.github/workflows/[email protected]
+  PHPStan:
+    name: 'PHPStan (analyse)'
+    uses: nswdpc/ci-files/.github/workflows/[email protected]
+    needs: Silverstripe

.gitignore

@@ -1,14 +1,7 @@
-Thumbs.db
-web.config
-.log
-.buildpath
-.project
-.settings
-.idea
+/client/node_modules
+/vendor/
 .DS_Store
-._.DS_Store
-.codekit
-.sublime-*
-.sass-cache
-prepros.cfg
+/.php-cs-fixer.cache
+/public/
+/composer.lock
 node_modules

README.md

@@ -1,82 +1,35 @@
 # Silverstripe embed
 
-[![ko-fi](https://www.ko-fi.com/img/donate_sm.png)](https://ko-fi.com/E1E5HWRR)
-
-Adds embed and video a dataobject along with dataextension to apply embed to existing objects.
+This module adds embed functionality to data objects
 
 ## Installation
-Composer is the recommended way of installing SilverStripe modules.
+
+The only supported method of installing this module is via composer:
+
 ```
 composer require gorriecoe/silverstripe-embed
 ```
 
 ## Requirements
 
-- silverstripe/framework ^4.0
+- silverstripe/framework ^5
 
 ## Maintainers
 
-- [Gorrie Coe](https://github.com/gorriecoe)
++ PD web team
++ Original maintainer: Gorrie Coe
+
 
 ## Usage
-Relationship to Embed Dataobjects
-```php
-use gorriecoe\Embed\Models\Embed;
-
-class ClassName extends DataObject
-{
-    private static $has_one = [
-        'Embed' => Embed::class,
-        'Video' => Video::class
-    ];
-
-    public function getCMSFields()
-    {
-        ...
-        $fields->addFieldsToTab(
-            'Main',
-            [
-                HasOneButtonField::create(
-                    'Embed',
-                    'Embed',
-                    $this
-                ),
-                HasOneButtonField::create(
-                    'Video',
-                    'Video',
-                    $this
-                )
-            ]
-        );
-        ...
-    }
-}
 
-```
-Update current DataObject to be Embeddable with DataExtension
-```php
-use gorriecoe\Embed\Extensions\Embeddable;
-
-class ClassName extends DataObject
-{
-    private static $extensions = [
-        Embeddable::class,
-    ];
-
-    /**
-     * List the allowed included embed types.  If null all are allowed.
-     * @var array
-     */
-    private static $allowed_embed_types = [
-        'video',
-        'photo'
-    ];
-
-    /**
-     * Defines tab to insert the embed fields into.
-     * @var string
-     */
-    private static $embed_tab = 'Main';
-}
+See [documentation for usage](./docs/en/001_index.md).
 
-```
+## Legacy
+
+Copyright: see [LICENSE.md](./LICENSE.md), with additions and improvements
+
+This is a fork of Gorrie Coe's [embed module](https://github.com/gorriecoe/silverstripe-embed). We have maintained the following link from the original module:
+
+[![ko-fi](https://www.ko-fi.com/img/donate_sm.png)](https://ko-fi.com/E1E5HWRR)
+
+[Further information](https://github.com/elliot-sawyer/silverstripe-link/issues/31).

_config/config.yml

@@ -1,3 +1,3 @@
 ---
-Name: embedconfig
+Name: nswdpc-silverstripe-embed
 ---

code-of-conduct.md

@@ -0,0 +1 @@
+When having discussions about this module in issues or pull request please adhere to the [SilverStripe Community Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct).

composer.json

@@ -1,25 +1,54 @@
 {
-  "name": "gorriecoe/silverstripe-embed",
-  "description": "Adds embed and video a dataobject along with dataextension to apply embed to existing objects.",
-  "type": "silverstripe-vendormodule",
-  "license": "BSD-3-Clause",
-  "authors": [
-    {
-      "name": "Gorrie Coe",
-      "email": "[email protected]"
+    "name": "nswdpc/silverstripe-embed",
+    "description": "Adds embed functionality to data objects.",
+    "type": "silverstripe-vendormodule",
+    "license": "BSD-3-Clause",
+    "authors": [
+        {
+            "name": "Gorrie Coe",
+            "email": "[email protected]",
+            "role": "Original author"
+        },
+        {
+            "name": "PD web team",
+            "role": "Maintainer"
+        }
+    ],
+    "keywords": [
+        "silverstripe",
+        "cms",
+        "embed"
+    ],
+    "homepage": "http://github.com/nswdpc/silverstripe-embed",
+    "require": {
+        "embed/embed": "^4.4",
+        "silverstripe/framework": "^5",
+        "silverstripe/asset-admin": "^2"
+    },
+    "require-dev": {
+        "cambis/silverstripe-rector": "^0.5.1",
+        "phpunit/phpunit": "^9.5",
+        "syntro/silverstripe-phpstan": "^5",
+        "nswdpc/ci-files": "^1"
+    },
+    "repositories": [
+        {
+        "type": "git",
+        "url": "https://github.com/nswdpc/ci-files.git"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "NSWDPC\\Embed\\": "src/",
+            "NSWDPC\\Embed\\Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "silverstripe/recipe-plugin": true,
+            "silverstripe/vendor-plugin": true,
+            "phpstan/extension-installer": true
+        }
     }
-  ],
-  "keywords": [
-    "silverstripe",
-    "cms",
-    "embed"
-  ],
-  "homepage": "http://github.com/gorriecoe/silverstripe-embed",
-  "require": {
-    "silverstripe/framework": "^4",
-    "gorriecoe/silverstripe-htmltag": "^1.0"
-  },
-  "extra": {
-    "installer-name": "embed"
-  }
 }