1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246

<?xml version="1.0" encoding="UTF-8"?>
<package packagerversion="1.6.1" version="2.0" xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0     http://pear.php.net/dtd/tasks-1.0.xsd     http://pear.php.net/dtd/package-2.0     http://pear.php.net/dtd/package-2.0.xsd">
 <name>Testing_DocTest</name>
 <channel>pear.php.net</channel>
 <summary>A Unit Test framework for writing tests in your php code docstrings.</summary>
 <description>Testing_DocTest allows the developer to write unit tests directly in the &lt;code&gt;&lt;/code&gt; blocs of your functions, classes and class methods doc comments.

It comes with a default runner (phpdt) that will parse all your &lt;code&gt;&lt;/code&gt; blocs and will run the extracted tests. 
Running tests is as simple as:

$ phpdt /path/to/your/code

There are several advantages in using Testing_DocTest:
  * it makes unit tests writing funnier, easier and quicker (there&apos;s no infrastructure to setup, you just install the package, write your code examples tests and you&apos;re done !);
  * it ensures that doc comments are up-to-date by verifying that all examples work as documented;
  * it enforces writing of tutorial documentation, liberally illustrated with input-output examples.</description>
 <lead>
  <name>David Jean Louis</name>
  <user>izi</user>
  <email>izi@php.net</email>
  <active>yes</active>
 </lead>
 <date>2008-04-11</date>
 <time>09:15:00</time>
 <version>
  <release>0.3.1</release>
  <api>0.3.1</api>
 </version>
 <stability>
  <release>alpha</release>
  <api>alpha</api>
 </stability>
 <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
 <notes>* added a Testing_DocTest_TestSuite class;
* renamed outputter to reporter;
* reporter interface improvements.</notes>
 <contents>
  <dir baseinstalldir="Testing" name="/">
   <file baseinstalldir="Testing"  name="Testing/DocTest/Registry.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/Exception.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/FinderInterface.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/ReporterInterface.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/ParserInterface.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/RunnerInterface.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/TestCase.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/TestSuite.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/Finder/Default.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
    <tasks:replace from="@php_dir@" to="php_dir" type="pear-config" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/Reporter/Default.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/Parser/Default.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="Testing/DocTest/Runner/Default.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
    <tasks:replace from="@php_bin@" to="php_bin" type="pear-config" />
   </file>
   <file baseinstalldir="" name="scripts/phpdt" role="script">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
    <tasks:replace from="@php_bin@" to="php_bin" type="pear-config" />
    <tasks:unixeol />
   </file>
   <file baseinstalldir="" name="scripts/phpdt.bat" role="script">
    <tasks:replace from="@php_bin@" to="php_bin" type="pear-config" />
    <tasks:replace from="@bin_dir@" to="bin_dir" type="pear-config" />
    <tasks:replace from="@php_dir@" to="php_dir" type="pear-config" />
    <tasks:replace from="@package_version@" to="version" type="package-info" />
    <tasks:windowseol />
   </file>
   <file baseinstalldir="Testing" name="tests/test1.php" role="test">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
   </file>
   <file baseinstalldir="Testing" name="DocTest.php" role="php">
    <tasks:replace from="@package_version@" to="version" type="package-info" />
    <tasks:replace from="@php_dir@" to="php_dir" type="pear-config" />
   </file>
  </dir>
 </contents>
 <dependencies>
  <required>
   <php>
    <min>5.2.2</min>
   </php>
   <pearinstaller>
    <min>1.4.0</min>
   </pearinstaller>
   <package>
    <name>Console_CommandLine</name>
    <channel>pear.php.net</channel>
    <min>1.0.0RC3</min>
   </package>
   <extension>
    <name>tokenizer</name>
   </extension>
  </required>
 </dependencies>
 <phprelease>
  <installconditions>
   <os>
    <name>windows</name>
   </os>
  </installconditions>
  <filelist>
   <install as="phpdt" name="scripts/phpdt" />
   <install as="phpdt.bat" name="scripts/phpdt.bat" />
  </filelist>
 </phprelease>
 <phprelease>
  <filelist>
   <install as="phpdt" name="scripts/phpdt" />
   <ignore name="scripts/phpdt.bat" />
  </filelist>
 </phprelease>
 <changelog>
  <release>
   <version>
    <release>0.1.0</release>
    <api>0.1.0</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <date>2008-03-08</date>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>initial release</notes>
  </release>
  <release>
   <version>
    <release>0.2.0</release>
    <api>0.2.0</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <date>2008-03-12</date>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>* added &quot;expects-file&quot; support: expected test output can now be stored in an external file;
* added &quot;skip-if&quot; support: tests can now be skipped if they match a condition;
* added &quot;clean&quot; support: cleaning can be done at the end of a doctest, for example to delete temporary files created by a test that failed;
* better subprocess management in the runner;
* ini settings can now be passed to doctest subprocess;
* removed the &quot;global flags&quot; switch in the default runner: it was a bad idea;
* some bug fixes and robustness improvments.</notes>
  </release>
  <release>
   <version>
    <release>0.2.1</release>
    <api>0.2.1</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>* fixed bug in tests pathes;
* added a phpdt.bat for windows;
* now works nearly perfect under windows;
* fixed a small bug in the Runner.</notes>
  </release>
  <release>
   <date>2008-03-17</date>
   <time>19:25:27</time>
   <version>
    <release>0.2.2</release>
    <api>0.2.2</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>* Added @filesource tags and removed unrecognised @const tags.
* make doctest syntax prefix customisable</notes>
  </release>
  <release>
   <date>2008-03-18</date>
   <time>21:51:27</time>
   <version>
    <release>0.2.3</release>
    <api>0.2.3</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>* ini settings can now be set in the doctest using "// ini-set: directive=value" syntax;
* don't read from stderr for php errors, php throws it on stdout anyway.</notes>
  </release>
  <release>
   <date>2008-03-30</date>
   <time>10:25:00</time>
   <version>
    <release>0.3.0</release>
    <api>0.3.0</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>Initial PEAR release.
Changes:
* flags improvement (flags are now handled with bitwise operators);
* Testing_DocTest_TestCase class now uses __get/__set methods;
* Parser improvements in preparation for the next big refactoring.</notes>
  </release>
  <release>
   <date>2008-04-11</date>
   <time>09:15:00</time>
   <version>
    <release>0.3.1</release>
    <api>0.3.1</api>
   </version>
   <stability>
    <release>alpha</release>
    <api>alpha</api>
   </stability>
   <license uri="http://www.opensource.org/licenses/mit-license.html">MIT</license>
   <notes>* added a Testing_DocTest_TestSuite class;
* renamed outputter to reporter;
* reporter interface improvements.</notes>
  </release>
 </changelog>
</package>