adjust tests to changes in svn, unify the way plugin classes are identified to match the docs I just wrote

cellog · cellog · commit 47829626fbf8 · 2009-06-30T20:31:19.000Z
that were wrong, but are actually a much better idea :) git-svn-id: http://svn.php.net/repository/pear2/Pyrus/trunk@286123 c90b9560-bf6c-de11-be94-00142212c4b1
diff --git a/data/customrole-2.0.xsd b/data/customrole-2.0.xsd
@@ -6,10 +6,10 @@
   <xs:complexType>
    <xs:sequence>
     <xs:element name="name" type="xs:string"/>
-    <xs:element name="classprefix" type="xs:string">
+    <xs:element name="class" type="xs:string">
      <xs:annotation>
       <xs:documentation xml:lang="EN">
-       Prefix to role for proper class name
+       Class implementing custom role
       </xs:documentation>
      </xs:annotation>
     </xs:element>
diff --git a/data/customtask-2.0.xsd b/data/customtask-2.0.xsd
@@ -6,10 +6,10 @@
   <xs:complexType>
    <xs:sequence>
     <xs:element name="name" type="xs:string"/>
-    <xs:element name="classprefix" type="xs:string">
+    <xs:element name="class" type="xs:string">
      <xs:annotation>
       <xs:documentation xml:lang="EN">
-       Prefix to role for proper class name
+       Class implementing custom task
       </xs:documentation>
      </xs:annotation>
     </xs:element>
diff --git a/src/Pyrus/Installer/Role.php b/src/Pyrus/Installer/Role.php
@@ -66,7 +66,7 @@ static function factory($packagetype, $role)
                                                       'requested for package type ' . $packagetype);
         }
 
-        $class = self::$_roles[$role]['classprefix'] . '_' . ucfirst($role);
+        $class = self::$_roles[$role]['class'];
         return new $class(PEAR2_Pyrus_Config::current(), self::$_roles[$role]);
     }
 
diff --git a/src/Pyrus/Installer/Role/Cfg.xml b/src/Pyrus/Installer/Role/Cfg.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>cfg</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Cfg</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Customcommand.xml b/src/Pyrus/Installer/Role/Customcommand.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>customcommand</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Customcommand</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Customrole.xml b/src/Pyrus/Installer/Role/Customrole.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>customrole</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Customrole</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Customtask.xml b/src/Pyrus/Installer/Role/Customtask.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>customtask</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Customtask</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Data.xml b/src/Pyrus/Installer/Role/Data.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>data</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Data</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Doc.xml b/src/Pyrus/Installer/Role/Doc.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>doc</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Doc</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Ext.xml b/src/Pyrus/Installer/Role/Ext.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>ext</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Ext</class>
  <releasetypes>extbin</releasetypes>
  <releasetypes>zendextbin</releasetypes>
  <installable>1</installable>
diff --git a/src/Pyrus/Installer/Role/Php.xml b/src/Pyrus/Installer/Role/Php.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>php</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Php</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Script.xml b/src/Pyrus/Installer/Role/Script.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>script</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Script</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Src.xml b/src/Pyrus/Installer/Role/Src.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>src</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Src</class>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>zendextsrc</releasetypes>
  <installable>1</installable>
diff --git a/src/Pyrus/Installer/Role/Test.xml b/src/Pyrus/Installer/Role/Test.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>test</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Test</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/Installer/Role/Www.xml b/src/Pyrus/Installer/Role/Www.xml
@@ -1,6 +1,6 @@
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>www</name>
- <classprefix>PEAR2_Pyrus_Installer_Role</classprefix>
+ <class>PEAR2_Pyrus_Installer_Role_Www</class>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
  <releasetypes>extbin</releasetypes>
diff --git a/src/Pyrus/PackageFile/v2.php b/src/Pyrus/PackageFile/v2.php
@@ -25,7 +25,6 @@
  */
 class PEAR2_Pyrus_PackageFile_v2 implements PEAR2_Pyrus_IPackageFile
 {
-    static protected $customtasks = array();
     public $rootAttributes = array(
                                  'version' => '2.1',
                                  'xmlns' => 'http://pear.php.net/dtd/package-2.1',
@@ -868,39 +867,6 @@ function getTasksNs()
         return $this->_tasksNs;
     }
 
-    /**
-     * Determine whether a task name is a valid task.  Custom tasks may be defined
-     * using subdirectories by putting a "-" in the name, as in <tasks:mycustom-task>
-     *
-     * Note that this method will auto-load the task class file and test for the existence
-     * of the name with "-" replaced by "_" as in PEAR/Task/mycustom/task.php makes class
-     * PEAR_Task_mycustom_task
-     * @param string
-     * @return boolean
-     */
-    function getTask($task)
-    {
-        $this->getTasksNs();
-        // transform all '-' to '/' and 'tasks:' to '' so tasks:replace becomes replace
-        $task = $tasktest = str_replace($this->_tasksNs . ':', '', $task);
-        $task = str_replace('-', ' ', $task);
-        $task = str_replace(' ', '/', ucwords($task));
-        if (isset(static::$customtasks[$tasktest])) {
-            $test = static::$customtasks[$tasktest]['classprefix'] . '_' . str_replace('/', '_', $task);
-        } else {
-            $test = 'PEAR2_Pyrus_Task_' . str_replace('/', '_', $task);
-        }
-        if (class_exists($test, true)) {
-            return $test;
-        }
-        return false;
-    }
-
-    static function registerCustomTask($taskinfo)
-    {
-        static::$customtasks[$taskinfo['name']] = $taskinfo;
-    }
-
     function getBaseInstallDir($file)
     {
         $file = dirname($file);
diff --git a/src/Pyrus/PackageFile/v2/Validator.php b/src/Pyrus/PackageFile/v2/Validator.php
@@ -165,7 +165,7 @@ function validate(PEAR2_Pyrus_IPackage $pf, $state = PEAR2_Pyrus_Validate::NORMA
             if (count($file->tasks) && $this->_curState != PEAR2_Pyrus_Validate::DOWNLOADING) { // has tasks
                 $save = $file->getArrayCopy();
                 foreach ($file->tasks as $task => $value) {
-                    if ($tagClass = $this->_pf->getTask($task)) {
+                    if ($tagClass = PEAR2_Pyrus_Task_Common::getTask($task)) {
                         if (!is_array($value) || !isset($value[0])) {
                             $value = array($value);
                         }
diff --git a/src/Pyrus/PluginRegistry.php b/src/Pyrus/PluginRegistry.php
@@ -85,7 +85,7 @@ function scan()
                                 $taskinfo = $parser->parse($path, $taskschema);
                                 $taskinfo = $taskinfo['task'];
                                 static::makeAutoloader($taskinfo, 'task');
-                                PEAR2_Pyrus_PackageFile_v2::registerCustomTask($taskinfo);
+                                PEAR2_Pyrus_Task_Common::registerCustomTask($taskinfo);
                                 continue 2;
                             case 'customcommand' :
                                 $commands = $parser->parse($path, $commandschema);
diff --git a/src/Pyrus/Task/Common.php b/src/Pyrus/Task/Common.php
@@ -43,6 +43,7 @@
  */
 abstract class PEAR2_Pyrus_Task_Common extends \ArrayObject implements \SplSubject
 {
+    static protected $customtasks = array();
     const PACKAGE = 1;
     const INSTALL = 2;
     const PACKAGEANDINSTALL = 3;
@@ -206,5 +207,49 @@ function notify()
             $observer->update($this);
         }
     }
+
+    /**
+     * Determine whether a task name is a valid task.  Custom tasks may be defined
+     * using subdirectories by putting a "-" in the name, as in <tasks:mycustom-task>
+     *
+     * Note that this method will auto-load the task class file and test for the existence
+     * of the name with "-" replaced by "_" as in PEAR/Task/mycustom/task.php makes class
+     * PEAR_Task_mycustom_task
+     * @param string
+     * @return boolean
+     */
+    static function getTask($task)
+    {
+        if (!count(static::$customtasks)) {
+            static::registerBuiltinTasks();
+        }
+        if ($pos = strpos($task, ':')) {
+            $task = substr($task, $pos + 1);
+        }
+        if (isset(static::$customtasks[$task])) {
+            $test = static::$customtasks[$task]['class'];
+            if (class_exists($test, true)) {
+                return $test;
+            }
+        }
+        return false;
+    }
+
+    static function registerBuiltinTasks()
+    {
+        static::registerCustomTask(array('name' => 'replace',
+                                         'class' => 'PEAR2_Pyrus_Task_Replace'));
+        static::registerCustomTask(array('name' => 'windowseol',
+                                         'class' => 'PEAR2_Pyrus_Task_Windowseol'));
+        static::registerCustomTask(array('name' => 'unixeol',
+                                         'class' => 'PEAR2_Pyrus_Task_Unixeol'));
+        static::registerCustomTask(array('name' => 'postinstallscript',
+                                         'class' => 'PEAR2_Pyrus_Task_Postinstallscript'));
+    }
+
+    static function registerCustomTask($taskinfo)
+    {
+        static::$customtasks[$taskinfo['name']] = $taskinfo;
+    }
 }
 ?>
diff --git a/tests/Config/__get__set__unset__isset/test2.phpt b/tests/Config/__get__set__unset__isset/test2.phpt
@@ -27,13 +27,13 @@ try {
     $a->php_dir = 'oops';
     throw new Exception('php_dir setting did not fail');
 } catch (PEAR2_Pyrus_Config_Exception $e) {
-    $test->assertEquals('Cannot set php_dir, move the repository to change this value', $e->getMessage(), 'php_dir message');
+    $test->assertEquals('Cannot set php_dir, php_dir is always php/ in the repository', $e->getMessage(), 'php_dir message');
 }
 try {
     $a->data_dir = 'oops';
     throw new Exception('data_dir setting did not fail');
 } catch (PEAR2_Pyrus_Config_Exception $e) {
-    $test->assertEquals('Cannot set data_dir, move the repository to change this value', $e->getMessage(), 'data_dir message');
+    $test->assertEquals('Cannot set data_dir, data_dir is always data/ in the repository', $e->getMessage(), 'data_dir message');
 }
 try {
     $a->gronk = 'oops';
diff --git a/tests/Custom/Role/basic.phpt b/tests/Custom/Role/basic.phpt
@@ -10,7 +10,7 @@ $test->assertTrue($package->isPlugin(), 'ensure the package registers as a plugi
 file_put_contents(__DIR__ . '/testit/foobar', '<?xml version="1.0" encoding="UTF-8"?>
 <role version="2.0" xmlns="http://pear2.php.net/dtd/customrole-2.0">
  <name>burm</name>
- <classprefix>Fronky_Wonky</classprefix>
+ <class>Fronky_Wonky_Burm</class>
  <autoloadpath></autoloadpath>
  <releasetypes>php</releasetypes>
  <releasetypes>extsrc</releasetypes>
diff --git a/tests/Custom/Task/basic.phpt b/tests/Custom/Task/basic.phpt
@@ -10,7 +10,7 @@ $test->assertTrue($package->isPlugin(), 'ensure the package registers as a plugi
 file_put_contents(__DIR__ . '/testit/foobar', '<?xml version="1.0" encoding="UTF-8"?>
 <task version="2.0" xmlns="http://pear2.php.net/dtd/customtask-2.0">
  <name>burm</name>
- <classprefix>Fronky_Wonky</classprefix>
+ <class>Fronky_Wonky_Burm</class>
  <autoloadpath></autoloadpath>
 </task>');
 define('MYDIR', __DIR__);
@@ -37,8 +37,10 @@ PEAR2_Pyrus_Installer::commit();
 $reg = new PEAR2_Pyrus_PluginRegistry(__DIR__ . '/testit/plugins');
 $reg->scan();
 $test->assertTrue(isset($reg->package['pear2.php.net/testing2']), 'custom task installed');
-$task = $package->getTask('burm');
+$task = PEAR2_Pyrus_Task_Common::getTask('burm');
 $test->assertEquals('Fronky_Wonky_Burm', $task, 'right task class retrieved');
+$task = PEAR2_Pyrus_Task_Common::getTask('foo:burm');
+$test->assertEquals('Fronky_Wonky_Burm', $task, 'right task class retrieved 2');
 ?>
 ===DONE===
 --CLEAN--

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ static function factory($packagetype, $role)`
`66`	`66`	`'requested for package type ' . $packagetype);`
`67`	`67`	`}`
`68`	`68`
`69`		`- $class = self::$_roles[$role]['classprefix'] . '_' . ucfirst($role);`
	`69`	`+ $class = self::$_roles[$role]['class'];`
`70`	`70`	`return new $class(PEAR2_Pyrus_Config::current(), self::$_roles[$role]);`
`71`	`71`	`}`
`72`	`72`