Changeset 74973 in spip-zone

Timestamp:

Aug 26, 2013, 6:21:45 PM (6 years ago)

Author:

marcimat@…

Message:

Commande from:directory pour un répertoire déjà existant.

Les commandes from:directory et from:svn fonctionnent.

Location:

_galaxie_/code.spip.net/autodoc/trunk

Files:

• bin/autodoc_helper.php (modified) (1 diff)
• installation.md (modified) (1 diff)
• src/autodoc/Application.php (modified) (2 diffs)
• src/autodoc/Helpers/Command/FromDirectory.php (added)
• src/autodoc/Helpers/Command/FromSvn.php (modified) (2 diffs)
• src/autodoc/Helpers/Generator.php (modified) (8 diffs)
• src/autodoc/Helpers/phpdoc_helper.xml (modified) (3 diffs)

_galaxie_/code.spip.net/autodoc/trunk/bin/autodoc_helper.php

@@ -19 +19 @@
 $app = new \Cilex\Application('Autodoc Generator Helper', '1.0.0');
 $app->command(new autodoc\Helpers\Command\FromSvn());
+$app->command(new autodoc\Helpers\Command\FromDirectory());
 $app->run();

_galaxie_/code.spip.net/autodoc/trunk/installation.md

@@ -145 +145 @@
 
 
+#### from:directory
+
+Générer la documentation depuis un répertoire quelconque.
+Par défaut, la sortie est enregistrée dans le répertoire `work/output/default`
+
+        php autodoc/bin/autodoc_helper.php from:directory /home/marcimat/www/spip-dev
+
+Forcer un préfixe de sortie ici dans `work/output/spip-dev` :
+
+        php autodoc/bin/autodoc_helper.php from:directory /home/marcimat/www/spip-dev --prefixe=spip-dev
+
+
 #### from:svn
 
 Générer la documentation depuis une source SVN quelconque.
-Par défaut, la sortie est enregistrée dans le répertoire `work/output/default`
 
         php autodoc/bin/autodoc_helper.php from:svn svn://trac.rezo.net/spip/spip
-
-Forcer un préfixe de sortie ici dans `work/output/spip-dev` :
-
-        php autodoc/bin/autodoc_helper.php from:svn svn://trac.rezo.net/spip/spip --prefixe=spip-dev
 
 

_galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Application.php

@@ -8 +8 @@
 use phpDocumentor\Application as phpDocumentor;
 use phpDocumentor\Console\Output\Output as ConsoleOutput;
+use Symfony\Component\Console\Input\StringInput;
 
 /**
@@ -56 +57 @@
     }
 
+
+    /**
+     * Run the application with command as string
+     *
+     * @example
+     *      $app->run_with_command("project:run --config=phpdoc.xml");
+     * 
+     * @param bool $interactive Whether to run in interactive mode.
+     *
+     * @return void
+     */
+    public function run_with_command($command = "")
+    {
+        /** @var ConsoleApplication $app  */
+        $app = $this['console'];
+        $app->setAutoExit(false);
+
+
+        $output = new ConsoleOutput();
+        $output->setLogger($this['monolog']);
+
+        $app->run(new StringInput($command), $output);
+    }
 }
 

_galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromSvn.php

@@ -2 +2 @@
 
 /*
- * Commande d'execution …
+ * Commande d'exécution depuis une source svn …
  */
 
@@ -14 +14 @@
 use autodoc\Helpers\Generator;
 
+
 /**
- * Exécuter l'application…
+ * Déclaration et exécution de l'application depuis un svn
  */
 class FromSvn extends Command

_galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Generator.php

@@ -7 +7 @@
 namespace autodoc\Helpers;
 
-use Cilex\Command\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 autodoc\Helpers\Generator;
+use autodoc\Application;
 
 /**
@@ -22 +19 @@
     private $output;
 
-    private $dirs = array();
-    
+    private $dirs     = array();
+    private $files    = array();
+    private $options = array('dirs' => array()); // forcer des répertoires en dehors des options de ligne de commande
+
+    /**
+     * Description de la documentation à générer
+     * @var string $description */
+    private $description = "";
+
+    /**
+     * Présentation de la documentation à générer
+     * @var string $presentation */
+    private $presentation = "";
+
+    /**
+     * Constructeur
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+    **/
     public function __construct(InputInterface $input, OutputInterface $output)
     {
@@ -29 +44 @@
         $this->output = $output;
 
+        $this->setApplicationDirectories();
+    }
+
+
+    /**
+     * Générer la documentation à partir d'une url SVN
+     *
+     * @param string $source URL SVN
+    **/
+    public function generateFromSvn($source) {
+        $prefixe = $this->input->getOption('prefixe');
+        $ok =  $this->createDirectories($prefixe)
+            && $this->getSvnSource($source)
+            && $this->generateFromDirectory($this->dirs['input'], true);
+        return $ok;
+    }
+
+
+    /**
+     * Générer la documentation à partir d'un répertoire indiqué
+     *
+     * @param string $dir Chemin du répertoire source
+     * @param bool $is_ready
+     *     Indique si les préparatifs (création des répertoires) sont déjà faits
+    **/
+    public function generateFromDirectory($dir, $is_ready = false) {
+        $prefixe = $this->input->getOption('prefixe');
+        $ok = true;
+
+        if (!$is_ready) {
+            # forcer le chemin de la source spécifique
+            $this->options['dirs']['input'] = $dir;
+            $ok = $this->createDirectories($prefixe);
+        }
+        $ok =  $ok
+            && $this->prepareConfigXml();
+
+        if (!$ok) {
+            return false;
+        }
+
+        $this->execute();
+    }
+
+
+    /**
+     * Définit les répertoires utiles à l'application
+    **/
+    private function setApplicationDirectories() {
         # ce répertoire
         $this->dirs['helper'] = realpath(__DIR__);
@@ -41 +105 @@
         # répertoire de travail (celui où on écrira tout).
         $this->dirs['work'] = $this->dirs['root'] . '/work';
-    }
-
-    /**
-     * Générer la documentation à partir d'une url SVN
-     *
-     * @param string $source URL SVN
-    **/
-    public function generateFromSvn($source) {
-        $prefixe = $this->input->getOption('prefixe');
-        $this->createDirectories($prefixe);
-        $this->getSvnSource($source);
-    }
-
-
-    /**
-     * Crée les répertoires nécessaires au fonctionnement de ce programme
+
+        $this->files['phpdoc.xml'] = $this->dirs['work'] . '/phpdoc.xml';
+    }
+
+
+    /**
+     * Définit et crée les répertoires nécessaires au fonctionnement de ce programme
      *
      * @param string $prefixe Préfixe utilisé pour cette génération
@@ -65 +120 @@
         $this->output->writeln("* Vérifier/créer les répertoires de travail dans <info>$_work</info>");
 
-        $this->dirs['output'] = $_work . '/' . "output/$prefixe";
-        $this->dirs['input']  = $_work . '/' . "input/$prefixe";
-        $this->dirs['log']    = $_work . '/' . "log/$prefixe";
-        $this->dirs['cache']  = $_work . '/' . "cache/$prefixe";
+        foreach (array('output', 'input', 'log', 'cache') as $dir) {
+            // valeur par défaut, en fonction du préfixe
+            $this->dirs[$dir] = "$_work/$dir/$prefixe";
+
+            // valeur forcée dans certains cas
+            if (isset($this->options['dirs'][$dir]) and $path = $this->options['dirs'][$dir]) {
+                $this->dirs[$dir] = $path;
+            }
+        }
 
         foreach (array('output', 'input', 'log', 'cache') as $dir) {
@@ -92 +152 @@
             $this->output->writeln("  - Création du répertoire <info>$dir</info>");
 
-            if (!@mkdir($_dir, 0755, true)) {
+            if (!@mkdir($dir, 0755, true)) {
                 $this->output->writeln("<error>Impossible de créer le répertoire : $dir</error>");
                 $error = error_get_last();
@@ -144 +204 @@
 
         if (!$this->makeSvnCommand("checkout $source .")) {
-            $this->output->writeln("[<error>Echec</error>]");
+            $this->output->writeln("<error>[Echec]</error>");
             return false;
         }
 
         $last = array_pop($res);
-        $this->output->writeln("[<info>OK</info>]  ($last)");
+        $this->output->writeln("<info>[OK]</info>  ($last)");
         return true;
     }
@@ -199 +259 @@
         return true;
     }
+
+
+    /**
+     * Utilise le template de configuration phpdoc.xml en modifiant ses variables
+     * et l'enregistre pour qu'il soit utilisé par l'application
+     *
+     * @return bool true si réussi.
+    **/
+    private function prepareConfigXml() {
+
+        $this->output->write("* Préparer le fichier phpdoc.xml   ");
+        $template = $this->dirs['helper'] . '/phpdoc_helper.xml';
+        $template = file_get_contents($template);
+
+        $substitutions = array(
+            '@DIR_CACHE@'  => $this->dirs['cache'],
+            '@DIR_OUTPUT@' => $this->dirs['output'],
+            '@DIR_INPUT@'  => $this->dirs['input'],
+            '@DIR_LOG@'    => $this->dirs['log'],
+            '@DIR_ROOT@'   => $this->dirs['root'],
+        );
+
+        $template = str_replace(array_keys($substitutions), array_values($substitutions), $template);
+
+        $destination = $this->dirs['work'] . '/phpdoc.xml';
+        @unlink($destination);
+
+        if (!@file_put_contents($this->files['phpdoc.xml'], $template)) {
+            $this->output->writeln("<error>[Echec]</error>");
+            return false;
+        }
+
+        $this->output->writeln("<info>[OK]</info>");
+        return true;
+    }
+
+
+    /**
+     * Exécute l'application phpDocumentor avec le phpdoc.xml qui a été créé
+     *
+     * @return bool true si réussi.
+    **/
+    private function execute() {
+        $conf = $this->files['phpdoc.xml'];
+        $command = "project:run --config=$conf --parseprivate";
+
+        $app = new Application();
+        $app->run_with_command($command);
+    }
 }

_galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/phpdoc_helper.xml

@@ -4 +4 @@
         <default-package-name>SPIP</default-package-name>
         <encoding>utf-8</encoding>
-        <target>work/cache/@PREFIXE@</target>
+        <target>@DIR_CACHE@</target>
         <markers>
             <item>TODO</item>
@@ -15 +15 @@
     </parser>
     <files>
+        <directory>@DIR_INPUT@</directory>
+
         <ignore-hidden>on</ignore-hidden>
         <ignore-symlinks>on</ignore-symlinks>
@@ -31 +33 @@
 
         <ignore>squelettes-dist/*</ignore>
+        
+        
     </files>
     <transformer>
-        <target>work/output/@PREFIXE@</target>
+        <target>@DIR_OUTPUT@</target>
     </transformer>
     <logging>
         <level>warn</level>
         <paths>
-            <default>work/log/@PREFIXE@/phpdoc-{DATE}.log</default>
-            <errors>work/log/@PREFIXE@/phpdoc-{DATE}.errors.log</errors>
+            <default>@DIR_LOG@/phpdoc-{DATE}.log</default>
+            <errors>@DIR_LOG@/phpdoc-{DATE}.errors.log</errors>
         </paths>
     </logging>
     <transformations>
-        <template name="autodoc/templates/zora" />
+        <template name="@DIR_ROOT@/autodoc/templates/zora" />
     </transformations>
 
     <options>
+        <description  value="Documentation du code PHP de SPIP." />
+        <presentation value="Cette documentation est extraite à partir du code source de la version de développement." />
+<!--
         <site         value="http://code.spip.net/" />
         <proposer     value="oui" />
-        <description  value="Documentation automatique du code PHP de SPIP." />
-        <presentation value="Cette documentation est extraite automatiquement à partir du code source
-            PHP de la version en développement de SPIP." />
-        <!--chemin   value="autodoc/" / -->
+        <chemin   value="autodoc/" />
+-->
     </options>
 </phpdocumentor>