MNT Use gha-dispatch-ci (#32)

* ENH Update deprecation messages

* API Update deprecations

.github/workflows/ci.yml

@@ -0,0 +1,11 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ci:
+    name: CI
+    uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1

.github/workflows/dispatch-ci.yml

@@ -0,0 +1,16 @@
+name: Dispatch CI
+
+on:
+  # At 12:00 PM UTC, only on Friday and Saturday
+  schedule:
+    - cron: '0 12 * * 5,6'
+
+jobs:
+  dispatch-ci:
+    name: Dispatch CI
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch CI
+        uses: silverstripe/gha-dispatch-ci@v1

.github/workflows/keepalive.yml

@@ -0,0 +1,17 @@
+name: Keepalive
+
+on:
+  workflow_dispatch:
+  # The 4th of every month at 10:50am UTC
+  schedule:
+    - cron: '50 10 4 * *'
+
+jobs:
+  keepalive:
+    name: Keepalive
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Keepalive
+        uses: silverstripe/gha-keepalive@v1

README.md

@@ -1,4 +1,7 @@
-# SilverStripe recipe-plugin
+# Silverstripe recipe-plugin
+
+[![CI](https://github.com/silverstripe/recipe-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/recipe-plugin/actions/workflows/ci.yml)
+[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
 
 ## Introduction
 

composer.json

@@ -25,7 +25,8 @@
         "composer-plugin-api": "^1.1 || ^2"
     },
     "require-dev": {
-        "composer/composer": "^1.2 || 2"
+        "composer/composer": "^1.2 || 2",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "minimum-stability": "dev"
 }

phpcs.xml.dist

@@ -1,2 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<ruleset><rule ref="PSR2" /></ruleset>
+<ruleset name="SilverStripe">
+    <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
+
+    <file>src</file>
+
+    <!-- base rules are PSR-12 -->
+    <rule ref="PSR12" >
+        <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps" />
+		<exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
+    </rule>
+</ruleset>

src/RecipeCommandBehaviour.php

@@ -14,31 +14,6 @@ use Symfony\Component\Console\Output\OutputInterface;
 
 trait RecipeCommandBehaviour
 {
-    /**
-     * Gets the application instance for this command.
-     *
-     * @return Application An Application instance
-     */
-    public abstract function getApplication();
-
-    /**
-     * @param  bool              $required
-     * @param  bool|null         $disablePlugins
-     * @throws \RuntimeException
-     * @return Composer
-     */
-    public abstract function getComposer($required = true, $disablePlugins = null);
-
-    /**
-     * Removes the cached composer instance
-     */
-    public abstract function resetComposer();
-
-    /**
-     * @return IOInterface
-     */
-    abstract public function getIO();
-
     /**
      * @param OutputInterface $output
      * @param string $recipe
@@ -128,17 +103,17 @@ trait RecipeCommandBehaviour
         }
 
         // Existing version is already a ^1.0.0 or ~1.0.0 constraint
-        if (preg_match('#^[~^]#', $existingVersion)) {
+        if (preg_match('#^[~^]#', $existingVersion ?? '')) {
             return $existingVersion;
         }
 
         // Existing version is already a dev constraint
-        if (stristr($existingVersion, 'dev') !== false) {
+        if (stristr($existingVersion ?? '', 'dev') !== false) {
             return $existingVersion;
         }
 
         // Numeric-only version maps to semver constraint
-        if (preg_match('#^([\d.]+)$#', $existingVersion)) {
+        if (preg_match('#^([\d.]+)$#', $existingVersion ?? '')) {
             return "^{$existingVersion}";
         }
 

src/RecipeInstaller.php

@@ -16,6 +16,10 @@ use RegexIterator;
 
 class RecipeInstaller extends LibraryInstaller
 {
+    /**
+     * @var bool
+     */
+    private $hasWrittenFiles = false;
 
     public function __construct(IOInterface $io, Composer $composer)
     {
@@ -61,19 +65,21 @@ class RecipeInstaller extends LibraryInstaller
             $relativePath = $this->installProjectFile($sourceRoot, $destinationRoot, $path, $installedFiles);
 
             // Add file to installed (even if already exists)
-            if (!in_array($relativePath, $installedFiles)) {
+            if (!in_array($relativePath, $installedFiles ?? [])) {
                 $installedFiles[] = $relativePath;
             }
         }
 
         // If any files are written, modify composer.json with newly installed files
-        if ($installedFiles) {
+        if ($this->hasWrittenFiles) {
             sort($installedFiles);
             if (!isset($composerData['extra'])) {
                 $composerData['extra'] = [];
             }
             $composerData['extra'][$registrationKey] = $installedFiles;
             $composerFile->write($composerData);
+            // Reset the variable so that we can try this trick again later
+            $this->hasWrittenFiles = false;
         }
     }
 
@@ -87,15 +93,15 @@ class RecipeInstaller extends LibraryInstaller
     protected function installProjectFile($sourceRoot, $destinationRoot, $sourcePath, $installedFiles)
     {
         // Relative path
-        $relativePath = substr($sourcePath, strlen($sourceRoot) + 1); // Name path without leading '/'
+        $relativePath = substr($sourcePath ?? '', strlen($sourceRoot ?? '') + 1); // Name path without leading '/'
 
         // Get destination path
         $relativeDestination = $this->rewriteFilePath($destinationRoot, $relativePath);
         $destination = $destinationRoot . DIRECTORY_SEPARATOR . $relativeDestination;
 
         // Check if file exists
-        if (file_exists($destination)) {
+        if (file_exists($destination ?? '')) {
-            if (file_get_contents($destination) === file_get_contents($sourcePath)) {
+            if (file_get_contents($destination ?? '') === file_get_contents($sourcePath ?? '')) {
                 $this->io->write(
                     "  - Skipping <info>$relativePath</info> (<comment>existing, but unchanged</comment>)"
                 );
@@ -104,15 +110,19 @@ class RecipeInstaller extends LibraryInstaller
                     "  - Skipping <info>$relativePath</info> (<comment>existing and modified in project</comment>)"
                 );
             }
-        } elseif (in_array($relativePath, $installedFiles) || in_array($relativeDestination, $installedFiles)) {
+        } elseif (
+            in_array($relativePath, $installedFiles ?? []) ||
+            in_array($relativeDestination, $installedFiles ?? [])
+        ) {
             // Don't re-install previously installed files that have been deleted
             $this->io->write(
                 "  - Skipping <info>$relativePath</info> (<comment>previously installed</comment>)"
             );
         } else {
             $this->io->write("  - Copying <info>$relativePath</info>");
-            $this->filesystem->ensureDirectoryExists(dirname($destination));
+            $this->filesystem->ensureDirectoryExists(dirname($destination ?? ''));
-            copy($sourcePath, $destination);
+            copy($sourcePath ?? '', $destination ?? '');
+            $this->hasWrittenFiles = true;
         }
         return $relativePath;
     }
@@ -131,7 +141,7 @@ class RecipeInstaller extends LibraryInstaller
         foreach ($patterns as $pattern) {
             $expressions[] = $this->globToRegexp($pattern);
         }
-        $regExp = '#^' . $this->globToRegexp($sourceRoot . '/').'(('.implode(')|(', $expressions).'))$#';
+        $regExp = '#^' . $this->globToRegexp($sourceRoot . '/') . '((' . implode(')|(', $expressions) . '))$#';
 
         // Build directory iterator
         $directoryIterator = new RecursiveDirectoryIterator(
@@ -155,10 +165,10 @@ class RecipeInstaller extends LibraryInstaller
      */
     protected function globToRegexp($glob)
     {
-        $sourceParts = explode('*', $glob);
+        $sourceParts = explode('*', $glob ?? '');
         $regexParts = array_map(function ($part) {
-            return preg_quote($part, '#');
+            return preg_quote($part ?? '', '#');
-        }, $sourceParts);
+        }, $sourceParts ?? []);
         return implode('(.+)', $regexParts);
     }
 
@@ -176,11 +186,11 @@ class RecipeInstaller extends LibraryInstaller
         $recipePath = $this->getInstallPath($package);
 
         // Find project path
-        $projectPath = dirname(realpath(Factory::getComposerFile()));
+        $projectPath = dirname(realpath(Factory::getComposerFile() ?? '') ?? '');
 
         // Find public path
         $candidatePublicPath = $projectPath . DIRECTORY_SEPARATOR . RecipePlugin::PUBLIC_PATH;
-        $publicPath = is_dir($candidatePublicPath) ? $candidatePublicPath : $projectPath;
+        $publicPath = is_dir($candidatePublicPath ?? '') ? $candidatePublicPath : $projectPath;
 
         // Copy project files to root
         $name = $package->getName();
@@ -215,8 +225,9 @@ class RecipeInstaller extends LibraryInstaller
      * Perform any file rewrites necessary to a relative path of a file being installed.
      * E.g. if 'mysite' folder exists, rewrite 'mysite' to 'app' and 'mysite/code' to 'app/src'
      *
-     * @deprecated 1.2..2.0 Will be removed in 2.0; app folder will be hard coded and no
+     * This will be removed in 2.0 as the app folder will be hard coded and no rewrites supported.
-     * rewrites supported.
+     *
+     * @deprecated 1.2.0 Will be removed without equivalent functionality to replace it
      * @param string $destinationRoot Project root
      * @param string $relativePath Relative path to the resource being installed
      * @return string Relative path we should write to
@@ -238,8 +249,8 @@ class RecipeInstaller extends LibraryInstaller
             'app' => 'mysite',
         ];
         foreach ($rewrites as $from => $to) {
-            if (stripos($relativePath, $from) === 0) {
+            if (stripos($relativePath ?? '', $from ?? '') === 0) {
-                return $to . substr($relativePath, strlen($from));
+                return $to . substr($relativePath ?? '', strlen($from ?? ''));
             }
         }
         return $relativePath;

src/RecipePlugin.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace SilverStripe\RecipePlugin;
 
 use Composer\Composer;
@@ -27,37 +26,37 @@ class RecipePlugin implements PluginInterface, EventSubscriberInterface, Capable
     /**
      * Type of recipe to check for
      */
-    const RECIPE_TYPE = 'silverstripe-recipe';
+    public const RECIPE_TYPE = 'silverstripe-recipe';
 
     /**
      * 'extra' key for project files
      */
-    const PROJECT_FILES = 'project-files';
+    public const PROJECT_FILES = 'project-files';
 
     /**
      * 'extra' key for public files
      */
-    const PUBLIC_FILES = 'public-files';
+    public const PUBLIC_FILES = 'public-files';
 
     /**
      * Hard-coded 'public' web-root folder
      */
-    const PUBLIC_PATH = 'public';
+    public const PUBLIC_PATH = 'public';
 
     /**
      * 'extra' key for list of project files installed
      */
-    const PROJECT_FILES_INSTALLED = 'project-files-installed';
+    public const PROJECT_FILES_INSTALLED = 'project-files-installed';
 
     /**
      * 'extra' key for list of public files installed
      */
-    const PUBLIC_FILES_INSTALLED = 'public-files-installed';
+    public const PUBLIC_FILES_INSTALLED = 'public-files-installed';
 
     /**
      * 'extra' key for project dependencies installed
      */
-    const PROJECT_DEPENDENCIES_INSTALLED = 'project-dependencies-installed';
+    public const PROJECT_DEPENDENCIES_INSTALLED = 'project-dependencies-installed';
 
     public function activate(Composer $composer, IOInterface $io)
     {
@@ -137,11 +136,9 @@ class RecipePlugin implements PluginInterface, EventSubscriberInterface, Capable
 
     public function deactivate(Composer $composer, IOInterface $io)
     {
-
     }
 
     public function uninstall(Composer $composer, IOInterface $io)
     {
-
     }
 }