tapout 0.1.0

data/.ruby

@@ -0,0 +1,44 @@
+--- 
+spec_version: 1.0.0
+replaces: []
+
+loadpath: 
+- lib
+name: tapout
+repositories: 
+  public: git://github.com/proutils/tapout.git
+conflicts: []
+
+engine_check: []
+
+title: Tap Out
+contact: trans <transfire@gmail.com>
+resources: 
+  code: http://github.com/rubyworks/tapout
+  home: http://rubyworks.github.com/tapout
+maintainers: []
+
+requires: 
+- group: []
+
+  name: ansi
+  version: 0+
+- group: 
+  - build
+  name: redline
+  version: 0+
+- group: 
+  - build
+  name: qed
+  version: 0+
+manifest: MANIFEST.txt
+version: 0.1.0
+licenses: 
+- Apache 2.0
+copyright: Copyright (c) 2010 Thomas Sawyer
+authors: 
+- Thomas Sawyer
+organization: RubyWorks
+description: Tap Out is a TAP consumer that can take any TAP, TAP-Y or TAP-J stream and output it in a variety of useful formats.
+summary: Progressive TAP Harness
+created: 2010-12-23

data/APACHE2.txt

@@ -0,0 +1,204 @@
+
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

data/HISTORY.rdoc

@@ -0,0 +1,11 @@
+= RELEASE HISTORY
+
+== 1.0.0 / 2011-05-21
+
+This is the initial release of Tap Out,
+a TAP and TAP-Y/J output formatter.
+
+Changes:
+
+* Happy Release Day!
+

data/NOTICE.rdoc

@@ -0,0 +1,38 @@
+= COPYRIGHT NOTICES
+
+== KO
+
+Copyright (c) 2010 Thomas Sawyer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+== Detest
+
+A small segement of code for outputing error messages was borrowed from the
+Detest[http://snk.tuxfamily.org/lib/detest/] project.
+
+Copyright 2009 Suraj N. Kurapati <sunaku@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,73 @@
+= Tap Out
+
+
+== RESOURCES
+
+* home: http://rubyworks.github.com/tapout
+* work: http://github.com/rubyworks/tapout
+
+
+== DESCRIPTION
+
+Tap Out is a TAP handler. Tap Out supports TAP-Y/J as well as traditional TAP.
+
+TAP-Y/J is an innovation of KO and Tap Out. It is a modernization of TAP using
+pure YAML/JSON streams.
+
+Traditional TAP has less detail than TAP-Y/J, but it can still be translated
+with fairly good results. Tap Out includes a TAP adapter to handle the
+translation transparently. Current Tap Out support TAP v12 with minor
+limitations.
+
+Tap Out fully supports TAP-Y at this time. TAP-J support is still in
+development.
+
+To learn about the TAP-Y/J specification, see the TAP-YJ.rdoc file.
+
+For information about TAP, see http://testanything.org/wiki/index.php/Main_Page.
+
+
+== SYNOPSIS
+
+Using a test framework that produces a TAP-Y output stream, simply pipe
+the stream into `tapout`.
+
+  $ ko -y -Ilib test/foo.rb | tapout
+
+Tap Out supports a variety of output formats. These are selectable via the `-f`
+option.
+
+  $ ko -y -Ilib test/foo.rb | tapout -f progessbar
+
+Tap Out is smart enough to match the closest matching format name. So, for
+example, the above could be written as:
+
+  $ ko -y -Ilib test/foo.rb | tapout -f pro
+
+And tapout will know to use the `progressbar` format.
+
+To see a list of supported formats use the list subcommand:
+
+  $ tapout list
+
+If your test framework does not support TAP-Y, but does support traditional
+TAP, Tap Out will automatically recognize the difference by TAP's `1..N` header.
+
+  $ ko -t -Ilib test/foo.rb | tapout -f progressbar
+
+
+== COPYRIGHT
+
+Tap Out, Copyright (c) 2010 Thomas Sawyer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this program except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/TAP-YJ.rdoc

@@ -0,0 +1,296 @@
+= TAP-Y/J Format
+
+TAP-Y and TAP-J are test streams. They are essentially the same except
+for the underlying format used, which are YAML and JSON repsectively.
+
+== TAP-Y Structure
+
+TAP-Y is a plain YAML stream format. Only YAML core types are used, 
+scalar, sequence and mapping.
+
+A YAML stream is composed a sequence of YAML *documents*, each divided by
+a start document marker (<code>---</code>). Each document MUST have a +type+
+field which designates it a +header+, +case+, +test+, +note+ or +footer+. Any
+document MAY have an +extra+ field which contains an open mapping for
+extraneous information.
+
+=== Header
+
+A +header+ starts a stream of tests.
+
+  ---
+  type: header
+  start: 2011-10-10 12:12:32
+  count: 2
+  range: 1..2
+
+The header +count+ indicates the number of total tests forethcoming. If
+the number of tests is unknow, count can be omitted or marked <code>~</code>.
+
+The +range+ defines the index of tests to be run separated by two period marks.
+The range will usually start with 1, but may start with another number if the
+underlying test system index tests.
+
+The +start+ entry marks the date and time testing began.
+
+=== Case
+
+The +case+ type indicates the start of a test case.
+
+  ---
+  type: case
+  description: Subtraction
+
+The case docoument has a  +description+ that is a free-form string describing
+the nature of the test case.
+
+=== Test
+
+The +test+ type indicates a test. A test MUST have a +status+ with
+one of five possible values: +pass+, +fail+, +error+, +omit+, +pending+.
+
+  ---
+  type: test
+  status: pass
+  description: an important test
+  file: foo.rb
+  line: 45
+  returned: true
+  expected: true
+  source: ok 1, 2
+  snippet:
+    - 44: ok 0,0
+    - 45: ok 1,2
+    - 46: ok 2,4
+  time: 0.01
+
+Like a case, the test can have a +description+.
+
+A test SHOULD also have a +file+ and +line+ number for the location of
+of the definition of the test, when +pass+ or +omit+, or the location
+of the exception when +fail+ or +error+. A +pending+ test will give the
+location of one or the other depending on how the underlying test system
+behaves.
+
+If a test fails or errors it MUST also provide a +message+ describing the
+nature of the exception. It MAY also provide a system +backtrace+.
+
+A test SHOULD also give an +expected+ and +returned+ value, if relavent
+to the nature of the test. For example, the most common test operation is
+equality, e.g. <code>assert_equal(4,3)</code>, so +expected+ would be 3 and
++returned+ 4.
+
+A test SHOULD provide the line of +source+ code that triggers the test.
+This will be the line of code the +file+ and +line+ number references.
+
+The +snippet+ is like +source+ but provides surronding context. It MAY be
+a verbatim string, in which case it MUST have an odd number of lines with
+the source line in the center. Or, it MAY be an ordered map of 
+<i>- line: source</i>. Using an ordered map the line numbers may start
+and end wherever, but they MUST be consecutive and the source line MUST
+be among them.
+
+Lastly, the +time+ is the number of seconds that have elapsed since the
+the header start time.
+
+=== Footer
+
+The +footer+ type incidates the end of a test set.
+
+  ---
+  type: footer
+  count: 2
+  tally:
+    pass: 1
+    fail: 1
+    error: 0
+    omit: 0
+    pending: 0
+  time: 0.03
+  ...
+
+It MUST give the total test +count+ and +tally+ for each test status, and
+SHOULD give the time ellapsed.
+
+The test stream end when a full ellipsis (<code>...</code>) appears.
+
+As you can see TAP-Y streams provide a great deal of detail. They are not
+intended for the end-user, but rather to pipe to consuming apps to process
+into a human readable form.
+
+
+== TAP-J
+
+TAP-J documents follows all the same feild rules as TAP-Y, but are represented
+as a stream of JSON documents.
+
+  {"type":"header", "count":"2", "range":"1..2"}
+  {"type":"case", "description":"Subtraction"}
+  {"type": "test", "status": "pass", "file": "foo.rb", "line": "45", "description": "an important test", "returned": true, "expected": true, "source": "ok 1, 2", "snippet": [{44:"  ok 0,0"},{45:"  ok 1,2"},{46:"  ok 2,4"}], "time": 0.01}
+
+  ...  
+
+Ans so on.
+
+
+== Glossery of Fields
+
+=== count
+
+The `count` field provides the total number of tests being executed. It SHOULD
+be given in the header, if possible, and it MUST be given in the footer.
+
+=== extra
+
+Additional data, not specifucally designated by this sepecification can
+place under the `extra` section without worry that future versions of the
+specification will come into conflict with the field name. The namespace
+is a free-for-all, so use it with that in mind. Teh `extra` field can 
+appear in any document.
+
+=== file
+
+The `file` field provides the name of the file in which the test is defined,
+or where th test failed/errored.
+
+=== line
+
+The `line` field provides the line number of the file on which the
+definition of the test begins, or is the line number of where the 
+test failed/errored.
+
+=== message
+
+For tests with `fail` or `error` status, the message provides the explination
+for the failure or error. Usually this is just the error message produced by
+the underlying exception. The `pass` type can have the message field too,
+but it will generally be ignored by TAP consumers.
+
+=== range
+
+The range of tests being executed of the test suite. The range is written in
+the form of `X..Y`. Where X is the index of the first test and Y is the index
+of last test.
+
+NOTE: This may be deprecated since the count field probably suffices. Can a
+range uniquely identify the tests being run? If not, the first sentinal will
+always be 1, which is redundant.
+
+=== snippet
+
+The `snippet` field is either a verbatim string or an ordered mapping of line
+number mapped to the source code for that line. While `snippet` is
+like `source` it also contains extra lines of code before and after the
+test `line` for context.
+
+If `snippet` is a string it MUST consist an odd number of lines, the same
+number before and after the source line in the center, unless the line occurs
+at the begining or the end of the file. The number of lines before and after is
+arbitrary and up to the producer, but should be the same on either side. Three
+to five is generally enough.
+
+=== source
+
+The `source` field is a verbatim copy of the source code that defines the test.
+This may be just the first line of the definition. In classic TAP this
+is called `raw_test`.
+
+=== start
+
+The header SHOULD have a start time in ISO standard format <code>YYYY-MM-DD HH:MM:SS</code>.
+
+=== status
+
+The `status` field designates the status of a test document. Valid values
+are `pass`, `fail`, `error`, `omit` and `pending`.
+
+In comparison to the classic TAP format, `pass` is equivalent to `ok` and 
+`fail` and `error` are akin to `not ok`, where `fail` is "not ok" with regards
+to a test assertion and `error` is "not ok" becuase of a raised coding error.
+
+Tests with an `omit` status do not need to be provided in the document stream,
+so this status will rarely appear in practice. But if a producer chooses to do
+so this status simply means the test is purposefully being disregarded.
+
+On the other hand, `pending` means the test will be used in the future
+but implementation has not been completed. It serves as reminder to developers
+to write a missing test.
+
+=== tally
+
+The footer MUST provide a tally for all status categories. This is like `count`
+but broken down into status groups.
+
+=== time
+
+The tests and the footer SHOULD have the +time+ elapsed since starting the 
+tests given in number of seconds.
+
+=== type
+
+Each document MUST have a *type*. Valid types are `header`, `footer`, `case`,
+`test` and `note`.
+
+The `header` and `footer` types can only occur once, at the start and end of the
+stream, respectively. All other types may occur repeatedly in between.
+
+The `case` type marks the start of a testcase. All `test` (and `note`) 
+documents following it are considered a part of the case until a new case
+document occurs.
+
+
+== Example - Complete TAP-Y Stream
+
+Here is a complete example.
+
+An example of a TAP-Y stream looks like this:
+
+  ---
+  type: header
+  count: 2
+  range: 1..2
+  ---
+  type: case
+  description: Subtraction
+  ---
+  type: test
+  status: pass
+  file: foo.rb
+  line: 45
+  description: an important test
+  returned: true
+  expected: true
+  source: ok 1, 2
+  snippet:
+    - 44: ok 0,0
+    - 45: ok 1,2
+    - 46: ok 2,4
+  ---
+  type: test
+  status: fail
+  file: foo.rb
+  line: 46
+  description: another test
+  returned: false
+  expected: true
+  source: ok 2,4
+  snippet:
+    - 45: ok 1,2
+    - 46: ok 2,4
+    - 47:
+  message:
+    blah blah
+  extra:
+    THAC0: 16
+  ---
+  type: footer
+  time: 0.01
+  count: 2
+  tally:
+    pass: 1
+    fail: 1
+    error: 0
+    omit: 0
+    pending: 0
+  ...
+