Merge pull request #25 from afilina/generator

Add generator script.

Author: Paul M. Jones

.gitignore

@@ -0,0 +1 @@
+/vendor/

README.md

@@ -41,7 +41,14 @@ copyright terms of the package contents.
 Quickly validate your project's compliance by following these steps:
 
 - Install package in your project: `composer require pds/skeleton @dev`
-- Run the validator: `./vendor/pds/skeleton/bin/validate`
+- Run the validator: `vendor/bin/pdsskeleton validate`
+
+## Generator
+
+Generate a compliant package skeleton by following these steps:
+
+- Install package in your project: `composer require pds/skeleton @dev`
+- Run the generator: `vendor/bin/pdsskeleton generate`
 
 ## Root-Level Directories
 

bin/pdsskeleton

@@ -0,0 +1,20 @@
+#!/usr/bin/env php
+
+<?php 
+
+$autoloadFiles = [
+    __DIR__ . '/../vendor/autoload.php',
+    __DIR__ . '/../../../autoload.php'
+];
+
+foreach ($autoloadFiles as $autoloadFile) {
+    if (file_exists($autoloadFile)) {
+        require_once $autoloadFile;
+        break;
+    }
+}
+
+use Pds\Skeleton\Console;
+
+$console = new Console();
+$console->execute($argv);

composer.json

@@ -3,5 +3,9 @@
     "type": "standard",
     "description": "Standard for PHP package skeletons.",
     "homepage": "https://github.com/php-pds/skeleton",
-    "license": "CC-BY-SA-4.0"
+    "license": "CC-BY-SA-4.0",
+    "autoload": {
+        "psr-4": { "Pds\\Skeleton\\": "src/" }
+    },
+    "bin": ["bin/pdsskeleton"]
 }

bin/validate renamed to src/ComplianceValidator.php

@@ -1,18 +1,6 @@
-#!/usr/bin/env php
-
 <?php
 
-if (!defined('ENV') || ENV != 'test') {
-    $lines = scandir(__DIR__ . "/../../../../");
-    foreach ($lines as $i => $line) {
-        if (is_dir($line)) {
-            $lines[$i] .= "/";
-        }
-    }
-    $validator = new ComplianceValidator();
-    $results = $validator->validate($lines);
-    $validator->outputResults($results);
-}
+namespace Pds\Skeleton;
 
 class ComplianceValidator
 {
@@ -21,6 +9,16 @@ class ComplianceValidator
     const STATE_REQUIRED_NOT_PRESENT = 3;
     const STATE_INCORRECT_PRESENT = 4;
 
+    protected $files = null;
+
+    public function execute()
+    {
+        $lines = $this->getFiles();
+        $results = $this->validate($lines);
+        $this->outputResults($results);
+        return true;
+    }
+
     public function validate($lines)
     {
         $complianceTests = [
@@ -53,6 +51,24 @@ public function validate($lines)
         return $results;
     }
 
+    /**
+     * Get list of files and directories previously set, or generate from parent project.
+     */
+    public function getFiles()
+    {
+        if ($this->files == null) {
+            $files = scandir(__DIR__ . "/../../../../");
+            foreach ($files as $i => $file) {
+                if (is_dir($file)) {
+                    $files[$i] .= "/";
+                }
+            }
+            $this->files = $files;
+        }
+
+        return $this->files;
+    }
+
     public function outputResults($results)
     {
         foreach ($results as $result) {
@@ -288,4 +304,4 @@ protected function checkResources($lines)
             'Ressources/',
         ]);
     }
-}
+}

src/Console.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Pds\Skeleton;
+
+class Console
+{
+    protected $commandsWhitelist = [
+        'validate' => 'Pds\Skeleton\ComplianceValidator',
+        'generate' => 'Pds\Skeleton\PackageGenerator',
+    ];
+
+    public function execute($args)
+    {
+        if (count($args) > 1) {
+
+            $executable = array_shift($args);
+            $commandName = array_shift($args);
+
+            if (array_key_exists($commandName, $this->commandsWhitelist)) {
+                return $this->executeCommand($this->commandsWhitelist[$commandName], $args);
+            }
+            
+            $this->outputHelp();
+            return false;
+        }
+
+        $this->outputHelp();
+        return false;
+    }
+
+    protected function executeCommand($commandClass, $args)
+    {
+        $command = new $commandClass();
+        return $command->execute($args);
+    }
+
+    protected function outputHelp()
+    {
+        echo 'Available commands:' . PHP_EOL;
+        foreach ($this->commandsWhitelist as $key => $value) {
+            echo 'pdsskeleton ' . $key . PHP_EOL;
+        }
+    }
+}

src/PackageGenerator.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Pds\Skeleton;
+
+use Pds\Skeleton\ComplianceValidator;
+
+class PackageGenerator
+{
+    public function execute()
+    {
+        $validator = new ComplianceValidator();
+        $lines = $validator->getFiles();
+        $validatorResults = $validator->validate($lines);
+        $files = $this->createFiles($validatorResults);
+        $this->outputResults($files);
+        return true;
+    }
+
+    public function createFiles($validatorResults, $root = null)
+    {
+        if ($root == null) {
+            $root = realpath(__DIR__ . "/../../../../");
+        }
+        $files = $this->createFileList($validatorResults);
+        $createdFiles = [];
+        foreach ($files as $i => $file) {
+            $isDir = substr($file, -1, 1) == '/';
+            if ($isDir) {
+                $path = $root . '/' . substr($file, 0, -1);
+                $createdFiles[$file] = $path;
+                mkdir($path, 0755);
+                continue;
+            }
+            $path = $root . '/' . $file . '.md';
+            $createdFiles[$file] = $file . '.md';
+            file_put_contents($path, '');
+            chmod($path, 0644);
+        }
+        return $createdFiles;
+    }
+
+    public function createFileList($validatorResults)
+    {
+        $files = [];
+        foreach ($validatorResults as $label => $complianceResult) {
+            if (in_array($complianceResult['state'], [
+                ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT,
+                ComplianceValidator::STATE_REQUIRED_NOT_PRESENT,
+                ])) {
+                $files[$label] = $complianceResult['expected'];
+            }
+        }
+        return $files;
+    }
+
+    public function outputResults($results)
+    {
+        foreach ($results as $file) {
+            echo "Created {$file}" . PHP_EOL;
+        }
+    }
+}

tests/ComplianceValidatorTest.php

@@ -1,7 +1,18 @@
 <?php
 
-define('ENV', 'test');
-require __DIR__ . "/../bin/validate";
+$autoloadFiles = [
+    __DIR__ . '/../vendor/autoload.php',
+    __DIR__ . '/../../../autoload.php'
+];
+
+foreach ($autoloadFiles as $autoloadFile) {
+    if (file_exists($autoloadFile)) {
+        require_once $autoloadFile;
+        break;
+    }
+}
+
+use Pds\Skeleton\ComplianceValidator;
 
 $tester = new ComplianceValidatorTest();
 // Test all 4 possible states.

tests/PackageGeneratorTest.php

@@ -0,0 +1,53 @@
+<?php
+
+$autoloadFiles = [
+    __DIR__ . '/../vendor/autoload.php',
+    __DIR__ . '/../../../autoload.php'
+];
+
+foreach ($autoloadFiles as $autoloadFile) {
+    if (file_exists($autoloadFile)) {
+        require_once $autoloadFile;
+        break;
+    }
+}
+
+use Pds\Skeleton\ComplianceValidator;
+use Pds\Skeleton\PackageGenerator;
+
+$tester = new PackageGeneratorTest();
+$tester->testGenerate_WithMissingBin_ReturnsBin();
+
+echo "Errors: {$tester->numErrors}" . PHP_EOL;
+
+class PackageGeneratorTest
+{
+    public $numErrors = 0;
+
+    public function testGenerate_WithMissingBin_ReturnsBin()
+    {
+        $validatorResults = [
+            'bin/' => [
+                'state' => ComplianceValidator::STATE_OPTIONAL_NOT_PRESENT,
+                'expected' => 'bin/',
+            ],
+            'config/' => [
+                'state' => ComplianceValidator::STATE_INCORRECT_PRESENT,
+                'expected' => 'config/',
+            ],
+        ];
+
+        $generator = new PackageGenerator();
+        $files = $generator->createFileList($validatorResults);
+
+        if (!array_key_exists('bin/', $files)) {
+            $this->numErrors++;
+                echo __FUNCTION__ . ": Expected bin/ to be present" . PHP_EOL;
+        }
+
+        if (array_key_exists('config/', $files)) {
+            $this->numErrors++;
+                echo __FUNCTION__ . ": Expected config/ to be absent" . PHP_EOL;
+        }
+    }
+}