chore: craft5 support (#16)

* chore: setup ci

Signed-off-by: Fred Carlsen <fred@sjelfull.no>

* chore: refactors and improvements

Signed-off-by: Fred Carlsen <fred@sjelfull.no>

* chore: update readme and changelog + version

Signed-off-by: Fred Carlsen <fred@sjelfull.no>

* chore: cleanup

Signed-off-by: Fred Carlsen <fred@sjelfull.no>

---------

Signed-off-by: Fred Carlsen <fred@sjelfull.no>

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @sjelfull

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug Report
+about: Report an issue or unexpected behavior
+title: ''
+labels: bug
+assignees: sjelfull
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Steps to reproduce**
+
+1. 
+2.
+
+**Screenshots/Video**
+
+If applicable, add screenshots or videos to help explain your problem.
+
+**Additional info**
+- Craft CMS version:
+- Craft Commerce version:
+- Vipps for Craft Commerce version:
+- PHP version:
+- Database driver & version:
+- Plugins & versions:

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Feature Request
+    url: https://github.com/sjelfull/craft3-templateselect/discussions/new?category=ideas
+    about: Start a new discussion about your idea

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea
+title: ''
+labels: enhancement
+assignees: sjelfull
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+- Craft version:
+- PHP version:
+- Database driver & version:
+- Plugins & versions:

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: ci
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+permissions:
+  contents: read
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  ci:
+    name: ci
+    uses: superbigco/.github/.github/workflows/ci.yml@master
+    with:
+      craft_version: '4'
+      jobs: '["ecs", "phpstan"]'
+      notify_slack: true
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+      slack_webhook_url: ${{ secrets.SLACK_CRAFT_PLUGINS_WEBHOOK_URL }}

.github/workflows/create-release.yml

@@ -0,0 +1,21 @@
+name: Create Release
+run-name: Create release for ${{ github.event.client_payload.version }}
+
+on:
+  repository_dispatch:
+    types:
+      - craftcms/new-release
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: ncipollo/release-action@v1
+        with:
+          body: ${{ github.event.client_payload.notes }}
+          makeLatest: ${{ github.event.client_payload.latest }}
+          name: ${{ github.event.client_payload.version }}
+          prerelease: ${{ github.event.client_payload.prerelease }}
+          tag: ${{ github.event.client_payload.tag }}

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 5.0.0 - 2022-10-03
+### Added
+- Made plugin compatible with Craft 5
+- Added support for environment variables in settings 
+- Added `field.subfolder()` method to get subfolder from the field instance 
+- Added `field.withSubfolder()` method to get template path including subfolder if set 
+- Added `field.filename()` method to get the template filename without path 
+
 ## 3.0.0 - 2022-10-03
 ### Added
 - Made plugin compatible with Craft 4

README.md

@@ -1,12 +1,12 @@
-# Template Select plugin for Craft CMS 3.x
+# Template Select plugin for Craft CMS
 
 A fieldtype that allows you to select a template from the site templates folder.
 
-![Screenshot](resources/img/field-screenshot@2x.png)
+![Screenshot](resources/img/field-with-friendly.png)
 
 ## Requirements
 
-This plugin requires Craft CMS 3.0.0-beta.23 or later.
+This plugin requires Craft CMS 4.0 or later.
 
 ## Installation
 
@@ -24,18 +24,57 @@ To install the plugin, follow these instructions.
 
 ## Configuring Template Select
 
-You may limit the template list to a subfolder of the site template folder.
+Create a new field and choose field type Template Select.
 
-The path is relative, i.e. _subfolder/subfolder2/_.
+In the field settings, you can limit the list of available templates to a subfolder of the Craft templates folder. The path is relative, i.e. _subfolder/anotherfolder_. This may also be set to an ENV variable.
 
-![Subfolder](resources/img/field-config@2x.png)
+![Screenshot](resources/img/field-settings.png)
 
-## Using Template Select
+![Screenshot](resources/img/field-without-friendly.png)
 
-If you want to include a template, you may do it like this in your entry template:
+In the field settings, you can choose to make the template names more user friendly. In the field, the list will be improved by changing the following:
+- file extensions will be removed
+- the file names will be capitalized and spaced for readability
+- folders will be separated by ›
+
+![Screenshot](resources/img/field-with-friendly.png)
+
+## Using Template Selector
+
+### Output the chosen template name:
+
+```twig
+{{ entry.fieldHandle }}
+```
+
+### Include/Embed the chosen template:
 
 ```twig
 {% include entry.fieldHandle %}
 ```
 
+### Include the template including subfolder if set:
+
+```twig
+{% include entry.fieldHandle.withSubfolder() %}
+```
+
+This is a alias for the following:
+
+```twig
+{{ entry.templateWithSubfolder.template(true) }}
+```
+
+### Output the subfolder name:
+
+```twig
+{{ entry.fieldHandle.subfolder() }}
+```
+
+### Output the filename without path:
+
+```twig
+{{ entry.fieldHandle.filename() }}
+```
+
 Brought to you by [Superbig](https://superbig.co)

composer.json

@@ -2,7 +2,7 @@
     "name": "superbig/craft3-templateselect",
     "description": "A fieldtype that allows you to select a template from a dropdown.",
     "type": "craft-plugin",
-    "version": "3.0.0",
+    "version": "5.0.0",
     "keywords": [
         "craft",
         "cms",
@@ -24,6 +24,11 @@
     "require": {
         "craftcms/cms": "^4.0.0"
     },
+    "require-dev": {
+        "craftcms/ecs": "dev-main",
+        "craftcms/phpstan": "dev-main",
+        "craftcms/rector": "dev-main"
+    },
     "repositories": [
         {
             "type": "composer",
@@ -43,5 +48,12 @@
         "hasCpSection": false,
         "changelogUrl": "https://raw.githubusercontent.com/sjelfull/craft3-templateselect/master/CHANGELOG.md",
         "class": "superbig\\templateselect\\TemplateSelect"
+    },
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {
+            "yiisoft/yii2-composer": true,
+            "craftcms/plugin-installer": true
+        }
     }
 }

ecs.php

@@ -0,0 +1,14 @@
+<?php
+
+use craft\ecs\SetList;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function(ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+        __FILE__,
+    ]);
+
+    $ecsConfig->parallel();
+    $ecsConfig->sets([SetList::CRAFT_CMS_4]);
+};

phpstan.neon

@@ -0,0 +1,6 @@
+includes:
+    - %currentWorkingDirectory%/vendor/craftcms/phpstan/phpstan.neon
+parameters:
+    level: 5
+    paths:
+        - src

src/TemplateSelect.php

@@ -10,13 +10,10 @@
 
 namespace superbig\templateselect;
 
-
 use Craft;
 use craft\base\Plugin;
-use craft\services\Plugins;
-use craft\events\PluginEvent;
-use craft\services\Fields;
 use craft\events\RegisterComponentTypesEvent;
+use craft\services\Fields;
 
 use superbig\templateselect\fields\TemplateSelectField;
 use yii\base\Event;
@@ -31,29 +28,20 @@
  */
 class TemplateSelect extends Plugin
 {
-    // Static Properties
-    // =========================================================================
-
-    /**
-     * @var TemplateSelect
-     */
-    public static $plugin;
-
-    // Public Methods
-    // =========================================================================
+    public static TemplateSelect $plugin;
 
     /**
      * @inheritdoc
      */
-    public function init ()
+    public function init()
     {
         parent::init();
         self::$plugin = $this;
 
         Event::on(
             Fields::class,
             Fields::EVENT_REGISTER_FIELD_TYPES,
-            function (RegisterComponentTypesEvent $event) {
+            function(RegisterComponentTypesEvent $event) {
                 $event->types[] = TemplateSelectField::class;
             }
         );
@@ -67,8 +55,4 @@ function (RegisterComponentTypesEvent $event) {
             __METHOD__
         );
     }
-
-    // Protected Methods
-    // =========================================================================
-
 }