citron 0.1.0 → 0.2.0

data/.gitignore

@@ -2,5 +2,5 @@
 doc
 log
 pkg
-site
+site/api
 tmp

data/.ruby

@@ -43,8 +43,8 @@ alternatives: []
 revision: 0
 name: citron
 title: Citron
-suite: RubyWorks
 summary: Classic Unit-style Test Framework
 description: Citron is a unit testing framework with a classic test-case/test-unit style.
-version: 0.1.0
-date: "2011-07-29"
+organization: RubyWorks
+version: 0.2.0
+date: "2011-08-12"

data/.yardopts

@@ -1,6 +1,6 @@
---output-dir site
+--output-dir doc
 --protected
---readme README.md
+--readme README.rdoc
 lib
 -
 [A-Z]*.*

data/Assembly

@@ -44,3 +44,13 @@ email:
   login  : <%= ENV['EMAIL_LOGIN'] %>
   secure : <%= ENV['EMAIL_SECURE'] %>
 
+rdoc:
+  format: redfish
+  output: site/api
+  main: README.rdoc
+  include: 
+    - 'lib'
+    - '[A-Z]*.*'
+  active: false
+
+

data/HISTORY.rdoc

@@ -0,0 +1,10 @@
+= Release History
+
+== 0.2.0 / 2011-08-11
+
+This is the first usable release of Citron.
+
+Changes:
+
+* General improvements.
+

data/MANIFEST

@@ -2,11 +2,13 @@
 .ruby
 lib/citron/test_advice.rb
 lib/citron/test_case.rb
+lib/citron/test_proc.rb
 lib/citron/test_setup.rb
-lib/citron/test_unit.rb
+lib/citron/world.rb
 lib/citron.rb
+HISTORY.rdoc
 PROFILE
 LICENSE.txt
-README.md
+README.rdoc
 VERSION
 COPYING.rdoc

data/PROFILE

@@ -1,7 +1,6 @@
 --- 
 name   : citron
 title  : Citron
-suite  : RubyWorks
 summary: Classic Unit-style Test Framework
 authors:
   - Thomas Sawyer <transfire@gmail.com>
@@ -17,9 +16,6 @@ resources:
 repositories:
   upstream: git://github.com/proutils/citron.git
 
-copyrights:
-  - 2011 Thomas Sawyer (BSD-2-Clause)
-
 requirements:
   - test
   - ae
@@ -27,3 +23,9 @@ requirements:
   - reap     (build)
   - qed      (test)
 
+organization: RubyWorks
+
+copyrights:
+  - 2011 Thomas Sawyer (BSD-2-Clause)
+
+

data/README.rdoc

@@ -0,0 +1,65 @@
+= Citron
+
+{Homepage}[http://rubyworks.github.com/citron] -
+{Development}[http://github.com/rubyworks/citron]
+
+Author:: Thomas Sawyer
+License:: FreeBSD
+Copyright:: (c) 2011 Thomas Sawyer, Rubyworks
+
+
+== Description
+
+Citron is a classic unit test framework. It defines a simple
+domain language for create classic-style tests.
+
+
+== Example
+
+Here's a fun example.
+
+    TestCase "Show them how to Beat It" do
+
+      setup do
+        @funky = "funky"
+        @right = "right"
+      end
+
+      # fail
+      test "show them how to funky" do
+        @funky.assert != "funky"
+      end
+
+      # pass
+      test "show them what's right" do
+        @right.assert == "right"
+      end
+
+      # error
+      test "no one wants to be defeated" do
+        raise SyntaxError
+      end
+
+      # todo
+      test "better do what you can" do
+        raise NotImplementedError
+      end
+
+      # omit
+      test "just beat it" do
+        e = NotImplementedError.new
+        e.set_assertion(true)
+        raise e
+      end
+
+    end
+
+
+== License
+
+Copyright (c) 2011 Thomas Sawyer, Rubyworks
+
+Citron is distributed according to the terms of the FreeBSD license.
+
+See COPYING.rd for details.
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bm/minitest_example.rb

@@ -0,0 +1,33 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+
+class ShowThemHowToBeatIt  < MiniTest::Unit::TestCase
+
+  # will fail
+  def test_show_them_how_to_funky
+    refute_equal("funky", "funky")
+  end
+
+  # will pass
+  def test_show_them_whats_right
+    assert_equal("right", "right")
+  end
+
+  # will error
+  def test_no_one_wants_to_be_defeated
+    raise SyntaxError
+  end
+
+  # pending
+  def test_better_do_what_you_can
+    raise NotImplementedError
+  end
+
+  # omit
+  def test_just_beat_it
+    e = NotImplementedError.new
+    #e.set_assertion(true)
+    raise e
+  end
+
+end

data/lib/citron.rb

@@ -2,22 +2,22 @@ module Citron
   $TEST_SUITE ||= []
 
   require 'citron/test_case'
-  require 'citron/test_unit'
+  require 'citron/test_proc'
   require 'citron/test_advice'
   require 'citron/test_setup'
 end
 
-module Test
-  extend self
+module Citron
+  module DSL
 
-  # Define a general test case.
-  def Case(label, &block)
-    $TEST_SUITE << Citron::TestCase.new(nil, :label=>label, &block)
-  end
+    # Define a general test case.
+    def test_case(label, &block)
+      $TEST_SUITE << Citron::TestCase.new(:label=>label, &block)
+    end
 
-  alias :TestCase  :Case
-  alias :test_case :Case
-  alias :case :Case
+    alias :TestCase :test_case
+    alias :testcase :test_case
+  end
 end
 
-extend Test
+extend Citron::DSL

data/lib/citron/test_case.rb

@@ -2,6 +2,8 @@
 #require 'citron/test_context'
 require 'citron/test_advice'
 require 'citron/test_setup'
+require 'citron/test_proc'
+require 'citron/world'
 
 module Citron
 
@@ -22,8 +24,7 @@ module Citron
     # The setup and teardown advice.
     attr :setup
 
-    # Advice are labeled procedures, such as before
-    # and after advice.
+    # Pattern mathing before and after advice.
     attr :advice
 
     # Module for evaluating tests.
@@ -31,27 +32,23 @@ module Citron
 
     # A test case +target+ is a class or module.
     #
-    # @param [TestSuite] context
-    #   The parent case to which this case belongs.
-    #
-    def initialize(context, settings={}, &block)
-      if context
-        @context = context
-        @advice  = context.advice.clone
+    def initialize(settings={}, &block)
+      @context = settings[:context]
+      @label   = settings[:label]
+      @setup   = settings[:setup]
+      @skip    = settings[:skip]
+
+      if @context
+        @advice = context.advice.clone
       else
-        @context = nil
-        @advice  = TestAdvice.new
+        @advice = TestAdvice.new
       end
 
-      @label = settings[:label]
-      @setup = settings[:setup]
-      @skip  = settings[:skip]
+      @tests = []
 
-      @tests   = []
+      @scope = Scope.new(self)
 
-      domain = DSL.new(self, &block)
-      @scope = Module.new
-      @scope.extend domain
+      @scope.module_eval(&block) if block
     end
 
     #
@@ -77,7 +74,7 @@ module Citron
 
     #
     def to_s
-      "#{type}: " + @label.to_s
+      label.to_s
     end
 
     #
@@ -86,8 +83,8 @@ module Citron
     end
 
     #
-    def skip=(boolean)
-      @skip = !!boolean
+    def skip=(reason)
+      @skip = reason
     end
 
     # Run test in the context of this case.
@@ -112,56 +109,48 @@ module Citron
     end
 
     #
-    #--
-    # TODO: Change so that the scope is the DSL
-    #       and ** includes the DSL of the context ** !!!
-    #++
-    #def scope
-    #  @scope ||= (
-    #    scope = Object.new
-    #    scope.extend(domain)
-    #    scope
-    #  )
-    #end
-
-    #
-    class DSL < Module
+    class Scope < World
 
-      #
-      def initialize(testcase, &code)
+      # Setup new evaluation scope.
+      def initialize(testcase) #, &code)
         @_case  = testcase
         @_setup = testcase.setup
+        @_skip  = false
 
         if testcase.context
           extend(testcase.context.scope)
         end
-
-        module_eval(&code)
       end
 
-      # Create a sub-case.
       #--
-      # @TODO: Instead of resuing TestCase can we have a TestContext
-      #        that more generically mimics it's context context?
+      # TODO: Instead of reusing TestCase can we have a TestContext
+      #       that more generically mimics it's context context?
       #++
+
+      # Create a sub-case.
       def Context(label, &block)
         settings = {
-          :label => label,
-          :setup => @_setup
+          :context => @_case,
+          :setup   => @_setup,
+          :skip    => @_skip,
+          :label   => label
         }
-        testcase = TestCase.new(@_case, settings, &block)
+        testcase = TestCase.new(settings, &block)
         @_case.tests << testcase
         testcase
       end
-      alias_method :context, :Context
+
+      alias :context :Context
 
       # Create a test.
       def Test(label=nil, &procedure)
         settings = {
-          :label => label,
-          :setup => @_setup
+          :context => @_case,
+          :setup   => @_setup,
+          :skip    => @_skip,
+          :label   => label
         }
-        testunit = TestUnit.new(@_case, settings, &procedure)
+        testunit = TestProc.new(settings, &procedure)
         if procedure.arity == 0
           @_case.tests << testunit
         else
@@ -169,9 +158,9 @@ module Citron
         end
         testunit
       end
-      alias_method :test, :Test
 
-      #
+      alias :test :Test
+
       #
       #
       def Ok(*args)
@@ -182,7 +171,8 @@ module Citron
         return test
       end
 
-      #
+      alias :ok :Ok
+
       #
       #
       def No(*args)
@@ -194,33 +184,30 @@ module Citron
         return test
       end
 
+      alias :no :No
+
       # Setup is used to set things up for each unit test.
       # The setup procedure is run before each unit.
       #
-      # @param [String] description
+      # @param [String] label
       #   A brief description of what the setup procedure sets-up.
       #
-      def Setup(description=nil, &procedure)
-        if procedure
-          @_setup = TestSetup.new(@_case, description, &procedure)
-        end
+      def Setup(label=nil, &proc)
+        @_setup = TestSetup.new(@_case, label, &proc)
       end
 
-      alias_method :setup, :Setup
+      alias :setup :Setup
 
       #alias_method :Concern, :Setup
       #alias_method :concern, :Setup
 
-      #alias_method :Subject, :Setup
-      #alias_method :subject, :Setup
-
       # Teardown procedure is used to clean-up after each unit test.
       #
-      def Teardown(&procedure)
-        @_setup.teardown = procedure
+      def Teardown(&proc)
+        @_setup.teardown = proc
       end
 
-      alias_method :teardown, :Teardown
+      alias :teardown :Teardown
 
       # Define a _complex_ before procedure. The #before method allows
       # before procedures to be defined that are triggered by a match
@@ -251,7 +238,7 @@ module Citron
         @_case.advice[:before][matches] = procedure
       end
 
-      alias_method :before, :Before
+      alias :before :Before
 
       # Define a _complex_ after procedure. The #before method allows
       # before procedures to be defined that are triggered by a match
@@ -282,14 +269,25 @@ module Citron
         @_case.advice[:after][matches] = procedure
       end
 
-      alias_method :after, :After
+      alias :after :After
 
-      # Mark a test or testcase to be omitted.
+      # Mark tests or subcases to be skipped.
       #
-      def Omit(test_obect)
-        test_object.omit = true
+      # @example
+      #   skip("reason for skipping") do
+      #     test "some test" do
+      #       ...
+      #     end
+      #   end
+      #
+      def Skip(reason=true, &block)
+        @_skip = reason
+        block.call
+        @_skip = false
       end
 
+      alias :skip :Skip
+
     end
 
   end

data/lib/citron/{test_unit.rb → test_proc.rb}

@@ -1,13 +1,12 @@
 module Citron
 
   #
-  class TestUnit
+  class TestProc
 
     # New unit test procedure.
     #
-    def initialize(context, options={}, &procedure)
-      @context    = context
-
+    def initialize(options={}, &procedure)
+      @context   = options[:context]
       @setup     = options[:setup]
       @label     = options[:label]
       @skip      = options[:skip]
@@ -40,15 +39,15 @@ module Citron
 
     #
     def type
-      'Unit'
+      'Test'
     end
 
     #
     def skip? ; @skip ; end
 
     #
-    def skip=(boolean)
-      @skip = !!boolean
+    def skip=(reason)
+      @skip = reason
     end
 
     #
@@ -58,7 +57,7 @@ module Citron
 
     #
     def tested=(boolean)
-      @tested = boolean
+      @tested = !!boolean
     end
 
     #
@@ -71,8 +70,10 @@ module Citron
       @setup
     end
 
-    #
-    alias :subtext :setup
+    # Ruby Test looks for `topic` as the desciption of a test's setup.
+    def topic
+      @setup.to_s
+    end
 
     #
     def scope

data/lib/citron/world.rb

@@ -0,0 +1,7 @@
+module Citron
+
+  #
+  class World < Module
+  end
+
+end

data/site/assets/styles/reset.css

@@ -0,0 +1,17 @@
+html { font-family: sans-serif; font-size: 16px; color: black; }
+body { padding: 0; margin: 0; font-family: sans-serif; font-size: 12px; background: #fff; }
+
+h1 { font-size: 90px; margin: 20px; }
+
+p { font-size: 110%; text-align: justify; margin: 20px 0; line-height: 150%; }
+
+a { text-decoration: none; font-size: 100%; }
+a:hover { text-decoration: underline; }
+
+ul { margin: 0 auto; list-style-type: none; width: 300px; }
+li { float: left; padding: 10px; text-align: center; }
+
+pre  { font-size: 130%; padding: 10px 0 0 0; -moz-border-radius: 10px; font-family: courier, monospace; color: #000; }
+code { font-family: courier, monospace; }
+
+img { border: none; }

data/site/assets/styles/site.css

@@ -0,0 +1,47 @@
+html { font-size: 16px; }
+
+h1 { font-family: times; font-size: 400%; margin: 20px 0; color: #f7d901; }
+h2 { font-size: 220%; margin-top: 30px; color: #444; }
+h3 { font-size: 190%; color: green; }
+
+p { color: #222; font-weight: normal; font-size: 110%; }
+a { color: #262; }
+a:hover { text-decoration: underline; }
+
+ pre { background: #ffffff; -moz-border-radius: 10px; line-height: 140%; font-size: 0.9em; }}
+code { color: #222; font-weight: bold; }
+  tt { color: #222; font-weight: bold; }
+
+#nav { padding: 0 30px 20px 60px; text-align: left; color: pink; float: right; }
+#nav a { font-size: 160%; font-weight: bold; line-height: 150%; color: orange; }
+#nav a:hover { color: #FFF; text-decoration: none; }
+
+#header { height: 250px; text-align: left; }
+#header h1 { font-size: 100px; margin-bottom: 0; padding: 40px 0 0 0; color: #f7d901; margin-left: -10px; }
+#header h2 { padding: 0 0 0 110px; margin-top: 0; }
+
+#main { color: white; padding: 20px 0 30px 0; background: url(../images/skin.jpg) #f7e931; }
+#main p { font-weight: bold; font-family: sans-serif; font-size: 1.8em; color: #222; font-weight: bold; text-shadow: 1px 1px white; }
+#main h2 { color: #333333; }
+#main h3 { color: #333333; }
+
+#example p { font-size: 2em; }
+
+#footer { margin-top: 40px; padding: 40px 0; text-align: center; background: url(../images/skin.jpg) #f7e931; }
+#footer .copyright { padding-top: 0; }
+#footer .copyright p { color: #222; font-weight: normal; font-size: 80%; line-height: 150%; }
+
+#forkme {
+  position: absolute;
+  top: 0; right: 0;
+  width: 150px;
+}
+
+.page { width: 730px; margin: 0 auto; }
+
+.bordered { border-top: 2px solid #99ff99; border-bottom: 2px solid #99ff99; }
+
+.copyright { padding: 0; text-align: left; }
+.copyright td { font-size: 10px; color: #444; }
+
+

data/site/index.html

@@ -0,0 +1,147 @@
+<html> 
+<head> 
+  <title>Citron</title> 
+  <link href="assets/styles/reset.css" rel="stylesheet" type="text/css"/> 
+  <link href="assets/styles/site.css"  rel="stylesheet" type="text/css"/> 
+  <link href="assets/images/citron.jpg" rel="shortcut icon"/> 
+ 
+  <!-- syntax highlighing --> 
+  <script src="http://rubyworks.github.com/assets/includes/shjs/sh_main.min.js"></script> 
+  <script src="http://rubyworks.github.com/assets/includes/shjs/lang/sh_ruby.min.js"></script> 
+  <script src="http://rubyworks.github.com/assets/includes/shjs/lang/sh_sh.min.js"></script> 
+  <link  href="http://rubyworks.github.com/assets/includes/shjs/css/sh_acid.min.css" rel="stylesheet" type="text/css" /> 
+</head> 
+<body onload="sh_highlightDocument();"> 
+ 
+<div id="forkme"> 
+  <a href="http://github.com/rubyworks/citron"><img src="assets/images/forkme.png" /></a> 
+</div> 
+ 
+<div id="header"> 
+<div class="page"> 
+  <img src="assets/images/cut-citron.png" height="200px" align="right" style="padding-top: 15px;"/> 
+  <h1><img src="assets/images/title.png"/></h1> 
+  <h2>Clean Classic Testing</h2> 
+</div> 
+</div> 
+ 
+<div id="main" class="bordered"> 
+<div class="page"> 
+ 
+  <p>Citron is classic unit testing framework with a clear domain specific language
+  notating testcase and test procedure, that runs on top of the Ruby Universal Test
+  Harness, <a href="http://rubyworks.github.com/test">Ruby Test</a>.</p> 
+ 
+<!--
+  <p>Citron uses the <a href="http://rubyworks.github.com/ae">Assertive Expressive</a>
+  assertions framework. This is the same verstile framework used by <a href="http://rubyworks.github.com/qed">Q.E.D.</a>.
+  By default Citron test support the standard <code>#assert</code> and <code>#expect</code> assertion methods.
+  If you wish to use subjunctive terms, either <code>#should</code> or <code>#must</code>, you can load these
+  via a helper script (eg. <code>require 'ae/should'</code>).</p>
+--> 
+ 
+</div> 
+</div> 
+ 
+<div id="example"> 
+<div class="page"> 
+
+  <div id="nav"> 
+    <!-- <a href="guide/doc.en/index.html">English Manual</a> &nbsp;&middot;&nbsp; --> 
+    <a href="http://wiki.github.com/rubyworks/citron">Wiki</a> &nbsp;
+    <a href="http://rubydoc.info/gems/citron/frames">API</a> &nbsp;
+    <a href="http://googlegroups.com/group/rubyworks-mailinglist">Email</a> &nbsp;
+    <a href="http://github.com/rubyworks/citron/issues">Issue</a> &nbsp;
+    <a href="http://github.com/rubyworks/citron">Code</a> 
+  </div> 
+
+  <h3>Example</h3> 
+ 
+  <p>Citron tests are organized into test cases and test procedures.
+  Here is an example:</p> 
+ 
+<pre class="sh_ruby">
+  TestCase "Show them how to Beat It" do
+
+    # will fail
+    test "show them how to funky" do
+      "funky".assert != "funky"
+    end
+
+    # will pass
+    test "show them what's right" do
+      "right".assert == "right"
+    end
+
+    # will error
+    test "no one wants to be defeated" do
+      raise SyntaxError
+    end
+
+    # pending
+    test "better do what you can" do
+      raise NotImplementedError
+    end
+
+    # omit
+    test "just beat it" do
+      e = NotImplementedError.new
+      e.set_assertion(true)
+      raise e
+    end
+
+  end
+</pre> 
+ 
+  <p>The assertion framework is actually independent of the test framework,
+  so almost any assertion system will work. In the example above we are using
+  <a href="http://rubyworks.github.com/ae">A.E.</a></p> 
+ 
+</div> 
+</div> 
+ 
+<div id="footer" class="bordered"> 
+<div class="page"> 
+  <script type="text/javascript"><!--
+  google_ad_client = "ca-pub-1126154564663472";
+  /* RUBYWORKS 09-10-02 728x90 */
+  google_ad_slot = "0788888658";
+  google_ad_width = 728;
+  google_ad_height = 90;
+  //-->
+  </script> 
+  <script type="text/javascript"
+  src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 
+  </script> 
+ 
+  <br/><br/><br/> 
+ 
+  <div class="copyright" width="100%"> 
+    <a href="http://rubyworks.github.com/"> 
+      <img src="assets/images/ruby-logo.png" height="110px" align="left" style="margin: 0 5px; padding: 0 10px" /> 
+    </a> 
+    <a href="http://www.apache.org/licenses/LICENSE-2.0.html"> 
+      <img src="assets/images/opensource.png" height="120px" align="left" style="padding: 0 10px;" /> 
+    </a> 
+    <a href="github.com/rubyworks/citron"> 
+      <img src="assets/images/github-logo.png" height="115px" align="left" style="margin: 0; padding: 0 10px;" /> 
+    </a> 
+    <a href="http://testanything.org/wiki/index.php/Main_Page"> 
+      <img src="assets/images/tap.png" height="113px" align="left" style="margin: 0; padding: 0 20px;" /> 
+    </a> 
+    <a href=""> 
+      <img src="assets/images/citrons-are-good.png" height="117px" align="left" style="margin: 0; padding: 0 10px;" /> 
+    </a> 
+  </div> 
+ 
+  <br style="clear: both;" /> 
+ 
+  <div style="margin-top: 30px;"> 
+      <b>Citron</b>, Copyright &copy; 2009 Thomas Sawyer &middot;
+      <b>Contact:</b> transfire @ gmail.com
+  </div> 
+</div> 
+</div> 
+ 
+</body> 
+</html>

data/try/.test

@@ -0,0 +1,2 @@
+require 'ae'
+require 'citron'

data/try/case_setup.rb

@@ -0,0 +1,23 @@
+test_case "Example of using setup in a testcase" do
+
+  setup do
+    @x = 1
+  end
+
+  test "has setup without a topic" do
+    @x.assert == 1
+  end
+
+  setup "has a topic" do
+    @x = 10
+  end
+
+  test "has setup with a topic" do
+    @x.assert == 10
+  end
+
+  test "alos has setup with a topic" do
+    @x.assert! == 5
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: citron
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-29 00:00:00 Z
+date: 2011-08-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test
@@ -76,8 +76,9 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
+- HISTORY.rdoc
+- README.rdoc
 - COPYING.rdoc
-- README.md
 files: 
 - .gemspec
 - .gitignore
@@ -85,17 +86,36 @@ files:
 - .yardopts
 - Assembly
 - COPYING.rdoc
+- HISTORY.rdoc
 - LICENSE.txt
 - MANIFEST
 - PROFILE
-- README.md
+- README.rdoc
 - VERSION
+- bm/minitest_example.rb
 - lib/citron.rb
 - lib/citron/test_advice.rb
 - lib/citron/test_case.rb
+- lib/citron/test_proc.rb
 - lib/citron/test_setup.rb
-- lib/citron/test_unit.rb
+- lib/citron/world.rb
+- site/assets/images/citrons-are-good.png
+- site/assets/images/cut-citron.png
+- site/assets/images/forkme.png
+- site/assets/images/github-logo.png
+- site/assets/images/opensource.png
+- site/assets/images/ruby-logo.png
+- site/assets/images/skin.jpg
+- site/assets/images/skin1.jpg
+- site/assets/images/tap.png
+- site/assets/images/title.png
+- site/assets/images/title2.png
+- site/assets/styles/reset.css
+- site/assets/styles/site.css
+- site/index.html
+- try/.test
 - try/case_example.rb
+- try/case_setup.rb
 homepage: http://rubyworks.github.com/citron
 licenses: []
 

data/README.md

@@ -1,58 +0,0 @@
-# Citron
-
-<table>
-<tr><td><b>Author   </b></td><td>Thomas Sawyer</td></tr>
-<tr><td><b>License  </b></td><td>FreeBSD</td></tr>
-<tr><td><b>Copyright</b></td><td>(c) 2011 Thomas Sawyer, Rubyworks</td></tr>
-</table>
-
-## Description
-
-Citron is a classic unit test framework. It defines a simple
-domain language for create classic-style tests.
-
-## Example
-
-Here's a fun example.
-
-``` ruby
-TestCase "Show them how to Beat It" do
-
-  # fail
-  test "show them how to funky" do
-    "funky".assert != "funky"
-  end
-
-  # pass
-  test "show them what's right" do
-    "right".assert == "right"
-  end
-
-  # error
-  test "no one wants to be defeated" do
-    raise SyntaxError
-  end
-
-  # todo
-  test "better do what you can" do
-    raise NotImplementedError
-  end
-
-  # omit
-  test "just beat it" do
-    e = NotImplementedError.new
-    e.set_assertion(true)
-    raise e
-  end
-
-end
-```
-
-## License
-
-Copyright (c) 2011 Thomas Sawyer, Rubyworks
-
-Citron is distributed according to the terms of the FreeBSD license.
-
-See COPYING.rd for details.
-