add generate command

Command/GenerateCommand.php

@@ -0,0 +1,154 @@
+<?php
+
+namespace Kaliop\eZWorkflowEngineBundle\Command;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\HttpFoundation\File\Exception\FileException;
+use Symfony\Component\Yaml\Yaml;
+use Kaliop\eZMigrationBundle\API\MigrationGeneratorInterface;
+use Kaliop\eZMigrationBundle\API\MatcherInterface;
+
+class GenerateCommand extends AbstractCommand
+{
+    const DIR_CREATE_PERMISSIONS = 0755;
+
+    private $availableMigrationFormats = array('yml', 'json');
+    //private $availableModes = array('create', 'update', 'delete');
+    //private $availableTypes = array('role', 'content', 'content_type', 'content_type_group', 'object_state_group', 'section', 'generic', 'db', 'php');
+    private $thisBundle = 'EzWorkflowEngineBundle';
+
+    /**
+     * Configure the console command
+     */
+    protected function configure()
+    {
+        $this->setName('kaliop:workflows:generate')
+            ->setDescription('Generate a blank workflows definition file.')
+            ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The format of workflow file to generate (' . implode(', ', $this->availableMigrationFormats) . ')', 'yml')
+            ->addArgument('bundle', InputArgument::REQUIRED, 'The bundle to generate the workflow definition file in. eg.: AcmeWorkflowsBundle')
+            ->addArgument('name', InputArgument::OPTIONAL, 'The workflow name (will be prefixed with current date)', null)
+            ->setHelp(<<<EOT
+The <info>kaliop:workflows:generate</info> command generates a skeleton workflows definition file:
+
+    <info>php ezpublish/console kaliop:workflows:generate bundlename</info>
+EOT
+            );
+    }
+
+    /**
+     * Run the command and display the results.
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return null|int null or 0 if everything went fine, or an error code
+     * @throws \InvalidArgumentException When an unsupported file type is selected
+     */
+    public function execute(InputInterface $input, OutputInterface $output)
+    {
+        $bundleName = $input->getArgument('bundle');
+        $name = $input->getArgument('name');
+        $fileType = $input->getOption('format');
+
+        if ($bundleName == $this->thisBundle) {
+            throw new \InvalidArgumentException("It is not allowed to create workflows in bundle '$bundleName'");
+        }
+
+        if (!in_array($fileType, $this->availableMigrationFormats)) {
+            throw new \InvalidArgumentException('Unsupported migration file format ' . $fileType);
+        }
+
+        $workflowDirectory = $this->getMigrationDirectory($bundleName);
+
+        if (!is_dir($workflowDirectory)) {
+            $output->writeln(sprintf(
+                "Workflows directory <info>%s</info> does not exist. I will create it now....",
+                $workflowDirectory
+            ));
+
+            if (mkdir($workflowDirectory, self::DIR_CREATE_PERMISSIONS, true)) {
+                $output->writeln(sprintf(
+                    "Workflows directory <info>%s</info> has been created",
+                    $workflowDirectory
+                ));
+            } else {
+                throw new FileException(sprintf(
+                    "Failed to create workflows directory %s.",
+                    $workflowDirectory
+                ));
+            }
+        }
+
+        $date = date('YmdHis');
+
+        if ($name == '') {
+            $name = 'placeholder';
+        }
+        $fileName = $date . '_' . $name . '.' . $fileType;
+
+        $path = $workflowDirectory . '/' . $fileName;
+
+        $warning = $this->generateWorkflowFile($path, $fileType);
+
+        $output->writeln(sprintf("Generated new workflow file: <info>%s</info>", $path));
+
+        if ($warning != '') {
+            $output->writeln("<comment>$warning</comment>");
+        }
+    }
+
+    /**
+     * Generates a migration definition file.
+     *
+     * @param string $path filename to file to generate (full path)
+     * @param string $fileType The type of migration file to generate
+     * @param array $parameters
+     * @return string A warning message in case file generation was OK but there was something weird
+     * @throws \Exception
+     */
+    protected function generateWorkflowFile($path, $fileType, $parameters = array())
+    {
+        $warning = '';
+
+        // Generate migration file by template
+        $template = 'Workflow.' . $fileType . '.twig';
+        $templatePath = $this->getApplication()->getKernel()->getBundle($this->thisBundle)->getPath() . '/Resources/views/WorkflowTemplate/';
+        if (!is_file($templatePath . $template)) {
+            throw new \Exception("Generation of a workflow example is not supported with format '$fileType'");
+        }
+
+        $code = $this->getContainer()->get('twig')->render($this->thisBundle . ':WorkflowTemplate:' . $template, $parameters);
+
+        file_put_contents($path, $code);
+
+        return $warning;
+    }
+
+    /**
+     * @param string $bundleName a bundle name or filesystem path to a directory
+     * @return string
+     */
+    protected function getMigrationDirectory($bundleName)
+    {
+        // Allow direct usage of a directory path instead of a bundle name
+        if (strpos($bundleName, '/') !== false && is_dir($bundleName)) {
+            return rtrim($bundleName, '/');
+        }
+
+        $activeBundles = array();
+        foreach ($this->getApplication()->getKernel()->getBundles() as $bundle) {
+            $activeBundles[] = $bundle->getName();
+        }
+        asort($activeBundles);
+        if (!in_array($bundleName, $activeBundles)) {
+            throw new \InvalidArgumentException("Bundle '$bundleName' does not exist or it is not enabled. Try with one of:\n" . implode(', ', $activeBundles));
+        }
+
+        $bundle = $this->getApplication()->getKernel()->getBundle($bundleName);
+        $workflowDirectory = $bundle->getPath() . '/' . $this->getContainer()->getParameter('ez_workflowengine_bundle.workflow_directory');
+
+        return $workflowDirectory;
+    }
+}

Resources/views/WorkflowTemplate/Workflow.json.twig

@@ -0,0 +1,11 @@
+[
+    {
+        "type": "workflow",
+        "signal": "A_signal_name_here"
+    },
+    {
+        "type": "some_migration_step...",
+        "mode": "create/load/update/delete/etc...",
+        "etc": "etc.."
+    }
+]

Resources/views/WorkflowTemplate/Workflow.yml.twig

@@ -0,0 +1,17 @@
+# Customize this file to obtain a workflow definition
+
+# The 1st step has to use a fixed format:
+
+-
+    type: workflow
+    signal: A_signal_name_here # See the complete list at https://doc.ez.no/display/EZP/Signals+reference
+    #run_as: admin # Optional. If not set or false, the workflow will execute as the current user. If set, as the user specified here
+    #transaction: false # Optional. If set to true, the whole workflow will execute within a database transaction
+    #avoid_recursion: false # Optional. If set to true, the workflow will not trigger when the signal is generated by another workflow
+
+# All other workflow steps follow the syntax of migration steps from the migration bundle
+
+-
+    type: some_migration_step...
+    mode: create/load/update/delete/etc...
+    etc: etc...