svn: /pear/pearweb/trunk/cron/ apidoc-queue.php

[Daniel O'Connor]

clockwerx Mon, 12 Sep 2011 15:02:54 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=316549

Log:
Added (repeatable) steps to setup & testing of phpdocumentor implementation; added docblox implementation (defaults to phpdocumentor)

Changed paths:
U pear/pearweb/trunk/cron/apidoc-queue.php

Modified: pear/pearweb/trunk/cron/apidoc-queue.php
===================================================================
--- pear/pearweb/trunk/cron/apidoc-queue.php 2011-09-12 14:41:10 UTC (rev 316548)
+++ pear/pearweb/trunk/cron/apidoc-queue.php 2011-09-12 15:02:54 UTC (rev 316549)
@@ -19,12 +19,37 @@
*
* $Id$
*/
+// Old PHPDocumentor setup:
+// For manual testing on sg1
+// $_ENV[DSN]

+// 1. Ensure you have the appropriate phpdocumentor html template smarty bit installed.
+// ERROR: template directory "/usr/local/lib/php/pear/data/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PEAR/" does not exist
+// svn co svn co https://svn.php.net/repository/pear/packages/PhpDocumentor/trunk/ ../PhpDocumentor
+// cp -R ../PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PEAR/* /usr/local/lib/php/pear/data/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PEAR/
+
+// 2. Ensure you have a package in the correct APIDOC_QUEUE location - IE
+// /home/pear/packages/Validate_HU-0.1.2.tgz
+// 3. Ensure the apidoc_queue table has an entry to that .tar.gz file. IE:
+// INSERT INTO apidoc_queue(filename) VALUES( '/home/pear/packages/Validate_HU-0.1.2.tgz');
+
+// Shiny new docblox setup
+// pear channel-discover pear.docblox-project.org
+// pear channel-discover pear.michelf.com
+// pear install michelf/markdownextra
+// pear install docblox
+// apt-get install graphviz
+// And... uncomment the below
+$documentation_engine = 'phpdocumentor';
+// $documentation_engine = 'docblox';
+
require_once dirname(dirname(__FILE__)) . '/include/pear-config.php';
require_once 'DB.php';
require_once 'PEAR/Common.php';
require_once 'Archive/Tar.php';

+$debug = false;
+
class apidocqueue extends PEAR_Common
{
// {{{ infoFromTgzFile()
@@ -113,6 +138,7 @@
$tar = new Archive_Tar($filename);

if (PEAR::isError($info)) {
+ trigger_error($info->getMessage());
continue;
}

@@ -129,15 +155,32 @@

$tar->extract($tmpdir);

- $command = sprintf("/usr/local/bin/phpdoc -d %s -dn '%s' -ti '%s' -p on -s on -t %s -o %s --ignore */data/*,*/tests/*; rm -rf %s",
- $tmpdir,
- $name,
- $name . " " . $info['version'],
- PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
- "HTML:Smarty:PEAR",
- $tmpdir
- );

+ switch ($documentation_engine) {
+ case 'docblox':
+ $command = sprintf("/usr/local/bin/docblox -d %s --title '%s' -t %s --template %s --ignore */data/*,*/tests/*; rm -rf %s",
+ $tmpdir,
+ $name,
+ $name . " " . $info['version'],
+ PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
+ "default",
+ $tmpdir
+ );
+
+ break;
+ case 'phpdocumentor':
+ default:
+ $command = sprintf("/usr/local/bin/phpdoc -d %s -dn '%s' -ti '%s' -p on -s on -t %s -o %s --ignore */data/*,*/tests/*; rm -rf %s",
+ $tmpdir,
+ $name,
+ $name . " " . $info['version'],
+ PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
+ "HTML:Smarty:PEAR",
+ $tmpdir
+ );
+ }
+ }
+
$output = "";
$process = popen($command, "r");

@@ -153,7 +196,15 @@
is_link($latestdir) && unlink($latestdir);
symlink($versiondir, $latestdir);

- $query = "UPDATE apidoc_queue SET finished = NOW(), log = ? WHERE filename = ?";
- $dbh->query($query, array($output, $filename));
+ // In debug mode; we render the output to stdout
+ if ($debug) {
+ print $output;
+ }
+
+ // In debug mode; we may not wish to write back changes
+ if (!$debug) {
+ $query = "UPDATE apidoc_queue SET finished = NOW(), log = ? WHERE filename = ?";
+ $dbh->query($query, array($output, $filename));
+ }
}
}

[Daniel O'Connor]

clockwerx Mon, 12 Sep 2011 15:09:28 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=316551

Log:
Less syntax errors this time

Changed paths:
U pear/pearweb/trunk/cron/apidoc-queue.php

Modified: pear/pearweb/trunk/cron/apidoc-queue.php
===================================================================
--- pear/pearweb/trunk/cron/apidoc-queue.php 2011-09-12 15:05:10 UTC (rev 316550)
+++ pear/pearweb/trunk/cron/apidoc-queue.php 2011-09-12 15:09:28 UTC (rev 316551)
@@ -21,7 +21,7 @@
*/
// Old PHPDocumentor setup:
// For manual testing on sg1
-// $_ENV[DSN]
+// $_ENV['PEAR_DATABASE_DSN'] = 'mysqli://user:***@localhost/database';

// 1. Ensure you have the appropriate phpdocumentor html template smarty bit installed.
// ERROR: template directory "/usr/local/lib/php/pear/data/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PEAR/" does not exist
@@ -158,27 +158,30 @@

switch ($documentation_engine) {
case 'docblox':
- $command = sprintf("/usr/local/bin/docblox -d %s --title '%s' -t %s --template %s --ignore */data/*,*/tests/*; rm -rf %s",
- $tmpdir,
- $name,
- $name . " " . $info['version'],
- PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
- "default",
- $tmpdir
- );
+ $command = sprintf(
+ "/usr/local/bin/docblox -d %s --title '%s' -t %s --template %s --ignore */data/*,*/tests/*; rm -rf %s",
+ $tmpdir,
+ $name,
+ $name . " " . $info['version'],
+ PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
+ "default",
+ $tmpdir
+ );

break;
case 'phpdocumentor':
default:
- $command = sprintf("/usr/local/bin/phpdoc -d %s -dn '%s' -ti '%s' -p on -s on -t %s -o %s --ignore */data/*,*/tests/*; rm -rf %s",
- $tmpdir,
- $name,
- $name . " " . $info['version'],
- PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
- "HTML:Smarty:PEAR",
- $tmpdir
- );
- }
+ $command = sprintf(
+ "/usr/local/bin/phpdoc -d %s -dn '%s' -ti '%s' -p on -s on -t %s -o %s --ignore */data/*,*/tests/*; rm -rf %s",
+ $tmpdir,
+ $name,
+ $name . " " . $info['version'],
+ PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
+ "HTML:Smarty:PEAR",
+ $tmpdir
+ );
+
+ break;
}

$output = "";

[Daniel O'Connor]

clockwerx Mon, 12 Sep 2011 15:12:42 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=316552

Log:
Use correct template

Changed paths:
U pear/pearweb/trunk/cron/apidoc-queue.php

Modified: pear/pearweb/trunk/cron/apidoc-queue.php
===================================================================
--- pear/pearweb/trunk/cron/apidoc-queue.php 2011-09-12 15:09:28 UTC (rev 316551)
+++ pear/pearweb/trunk/cron/apidoc-queue.php 2011-09-12 15:12:42 UTC (rev 316552)
@@ -161,7 +161,6 @@
$command = sprintf(
"/usr/local/bin/docblox -d %s --title '%s' -t %s --template %s --ignore */data/*,*/tests/*; rm -rf %s",
$tmpdir,
- $name,
$name . " " . $info['version'],
PEAR_APIDOC_DIR . "/" . $name . "-" . $info['version'],
"default",