qed 2.2.2 → 2.3.0

data/History.rdoc

@@ -1,5 +1,28 @@
 = RELEASE HISTORY
 
+== 2.3.0 / 2010-07-14
+
+Bug to the scurry! QED has broken through the code/document ceiling and
+is cracking ectoskeletons all the way to the bank. A proverbal can of
+Roach-Be-Gone this is! What's that you say? I will exlpain. QED can now
+run directly against code comments. Simply slip the qed command the -c
+option and feed it some ruby scripts, and presto watch you commnets
+fail ;) I think you can figure out what to do next.
+
+In addition to this coolness QED has been improved under the floor
+boards as well. The parser, which is much faster, now blocks commentary
+paragraphs and code examples togeher in one-to-one pairings. Not only
+does this clean-up the code, but it opens up the potential for Around
+advice in a future version.
+
+Changes:
+
+* NEW! Ruby script comment run mode.
+* Better parsing system uses commentary-example pairs.
+* Colon can also be used to specify plain text (along with ellipsis).
+* Now distributed under the more permissive Apache 2.0 license.
+
+
 == 2.2.2 / 2010-06-21
 
 An issue was reported in which the a code block at the very

data/LICENSE

@@ -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/README.rdoc

@@ -1,6 +1,6 @@
 = Ruby Q.E.D.
 
-      homepage: http://proutils.github.com/qed
+     homepage: http://proutils.github.com/qed
   mailing list: http://groups.google.com/group/proutils
    development: http://github.com/proutils/qed
 
@@ -106,7 +106,7 @@ the directory will be automatically loaded.
 
 Within these applique scripts *advice* can be defined. Advice can be
 either *event advice*, which is simply triggered by some fixed cycle
-of running, such as <code>Before :document</code> or <code>After :all</code>,
+of running, such as <code>Before :each</code> or <code>After :all</code>,
 and *pattern advice* which are used to match against descriptive
 phrases in the QED demos. An example would be:
 
@@ -118,7 +118,7 @@ So that whenever the phrase "a new round is started" appears in a demo,
 the @round instance variable with be reset to an empty array.
 
 It is rather amazing what can be accomplished with such a system,
-be sure to look at QED's own demonstandum to get a better notion of
+be sure to look at QED's own demonstrandum to get a better notion of
 how you can put the the system to use.
 
 === Generating Documentation
@@ -135,8 +135,6 @@ Use the <code>--help</code> options on each command to get more information
 on the use of these commands.
 
 
-
-
 == Requirements
 
 QED depends on the following external libraries:
@@ -153,22 +151,17 @@ if they are not already installed.
 
 Q.E.D.
 
-Copyright (c) 2007,2009 Thomas Sawyer
-
-Unless otherwise permitted by the author, QED is distributed under the
-terms of the GPL version 3 or greater. See COPYING file for details.
+Copyright (c) 2007 Thomas Sawyer
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+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
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+   http://www.apache.org/licenses/LICENSE-2.0
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+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/VERSION

@@ -1,5 +1,5 @@
 name : qed
 major: 2
-minor: 2
-patch: 2
-date : 2010-06-21
+minor: 3
+patch: 0
+date : 2010-07-14

data/demo/01_demos.rdoc

@@ -12,18 +12,18 @@ Each code section is executed in order of appearance, within a
 rescue wrapper that captures any failures or errors. If neither
 a failure or error occur then the code gets a "pass".
 
-For example, the following passes:
+For example, the following passes.
 
     (2 + 2).assert == 4
 
 While the following would "fail", as indicated by the raising of 
-an Assertion error:
+an Assertion error.
 
     expect Assertion do
       (2 + 2).assert == 5
     end
 
-And this would have raised a NameError:
+And this would have raised a NameError.
 
     expect NameError do
       nobody_knows_method
@@ -48,7 +48,7 @@ Now lets try out our new macro definition.
 
     assert_integer(4)
 
-Let's prove that it can also fail:
+Let's prove that it can also fail.
 
     expect Assertion do
       assert_integer("IV")

data/demo/02_advice.rdoc

@@ -48,7 +48,7 @@ There can be more than one before and after clause at a time. If we
 define a new *before* or *after* clause later in the document,
 it will be appended to the current list of clauses in use.
 
-As a demonstration of this:
+As a demonstration of this,
 
     b = nil
 
@@ -99,12 +99,12 @@ to be run when the event is triggered.
   x = []
 
   When(:text) do |section|
-    section.text.scan(/^\*(.*?)$/) do |m|
+    section.commentary.scan(/^\*(.*?)$/) do |m|
       x << $1.strip
     end
   end
 
-Not let see if it worked:
+Not let see if it worked.
 
 * SampleA
 * SampleB
@@ -118,7 +118,6 @@ So +x+ should now contain these three list samples.
 
 QED also supports comment match triggers. With the +When+ method one can
 define procedures to run when a given pattern matches comment text.
-For example:
 
     When 'given a setting @a equal to (((\d+)))' do |n|
       @a = n.to_i
@@ -139,7 +138,7 @@ so any number can be used. For example, "given a setting @a equal to 2".
     @a.assert == 2
 
 When clauses can also use consecutive pattern matching. For instance
-we could write:
+we could write,
 
   When 'first match #(((\d+)))', 'then match #(((\d+)))' do |i1, i2|
     @a = [i1.to_i, i2.to_i]
@@ -148,7 +147,7 @@ we could write:
 So that 'first match #1' will be looked for first, and only after
 that if 'then match #2' is found, will it be condiered a complete match.
 All regular expression slots are collected from all matches and passed to
-the block. We can see that the rule matched this very paragraph:
+the block. We can see that the rule matched this very paragraph.
 
   @a.assert == [1,2]
 

data/demo/03_helpers.rdoc

@@ -22,16 +22,17 @@ marked links.
 
 For example, because this link, Advice[qed://helpers/advice.rb],
 begins with +qed:+, it will be used to load a global
-helper. We can see this with the following:
+helper. We can see this with the following assertion.
 
   pudding.assert.include?('load advice.rb')
 
-No where in the demonstration have we  defined +pudding+, but
+No where in the demonstration have we defined +pudding+, but
 it has been defined for us in the advice.rb helper script.
 
 We can also see that the generic When clause in our advice
-helper is keeping count of descriptions. Since the helper
-script was loaded three paragraphs back, the count will be 3.
+helper is keeping count of sections. Since the helper
+script was loaded two paragraphs section back, the curent count
+will be 3.
 
   count.assert == 3
 

data/demo/04_samples.rdoc

@@ -27,7 +27,7 @@ This makes it easy to test tables of examples.
 
 The arity of the table block corresponds to the number of columns in
 each row of the table. Each row is assigned in turn and run through
-the coded step. Consider the following example:
+the coded step. Consider the following example.
 
 Every row in the {table.yml table}[table.yml] will be assigned to
 the block parameters and run through the subsequent assertion.

data/demo/05_quote.rdoc

@@ -1,7 +1,7 @@
 = Quotes
 
-We do not always want verbatum clauses to be interpreted as code.
-Sometimes it would more useful to trest them a plan text to 
+We do not always want verbatim clauses to be interpreted as code.
+Sometimes it would more useful to treat them a plain text to 
 which the preceeding paragraph can make use in a processing rule.
 
 For example let say we want to make an example out of the following
@@ -12,13 +12,26 @@ text...
   this text
 
 The use of the ellipsis ('...') tells the processor that the next
-segment is a continuation of the current segment. If the next segment
-is varbatum it will be added to the end of the arguments list of
-any applicable processing rule.
+segment is a plain text continuation of the current segment, rather
+than example code. If the next segment is varbatim it will be added to
+the end of the arguments list of any applicable processing rule.
 
 Behind the scenes we created a rule to set the text to an instance
-variable called @quote_text, as we can now verify:
+variable called @quote_text, and we can verify it is so.
 
   @quote_text.assert == "The file will contain\n\nthis text"
 
+Alternately we can use a colon (':') instead of ellipsis. We can repeat
+the same statment as above.
+
+For example let say we want to make an example out of the following
+text:
+
+  The file will contain
+
+  different text
+
+And again we can verify that it did in fact set the @quote_text variable.
+
+  @quote_text.assert == "The file will contain\n\ndifferent text"