citron 0.2.0 → 0.3.0

data/lib/citron/test_proc.rb

@@ -1,5 +1,6 @@
 module Citron
 
+  # Test procedure --what you would call a honest to goodness unit test.
   #
   class TestProc
 
@@ -7,9 +8,12 @@ module Citron
     #
     def initialize(options={}, &procedure)
       @context   = options[:context]
-      @setup     = options[:setup]
+      #@setup     = options[:setup]
       @label     = options[:label]
+      @tags      = options[:tags]
       @skip      = options[:skip]
+      @file      = options[:file]
+      @line      = options[:line]
 
       @procedure = procedure
       @tested    = false
@@ -17,106 +21,152 @@ module Citron
 
   public
 
+    #
     # The parent testcase to which this test belongs.
+    #
     attr :context
 
+    #
+    # Alias for `#context`.
     #
     alias :parent :context
 
-    # Setup and teardown procedures.
-    attr :setup
-
+    #
     # Description of test.
+    #
     attr :label
 
+    #
+    # Symbol list of tags. Trailing element may be Hash
+    # of `symbol => object`.
+    #
+    attr :tags
+
+    #
     # Test procedure, in which test assertions should be made.
+    #
     attr :procedure
 
-    # The before and after advice from the context.
-    def advice
-      context.advice
-    end
-
     #
-    def type
-      'Test'
-    end
+    #
+    #
+    #def type
+    #  'test'
+    #end
 
+    #
+    # Whether to skip this test.
+    #
+    # @return [Boolean,String]
     #
     def skip? ; @skip ; end
 
+    #
+    # Set whether this test should be skipped of not.
+    #
+    # @param [Boolean,String] reason
+    #   Reason to skip, or simple boolean flag.
     #
     def skip=(reason)
       @skip = reason
     end
 
+    #
+    # @todo Is this necessary?
     #
     def tested?
       @tested
     end
 
+    #
+    # @todo Is this necessary?
     #
     def tested=(boolean)
       @tested = !!boolean
     end
 
+    #
+    # Test description.
+    #
+    # @return [String]
     #
     def to_s
       label.to_s
     end
 
+    #
+    # @return [TestSetup] setup
     #
     def setup
-      @setup
+      @context.setup
     end
 
-    # Ruby Test looks for `topic` as the desciption of a test's setup.
+    #
+    # Ruby Test looks for `#topic` as the desciption of a test's setup.
+    #
+    # @return [String] Description of the setup.
+    #
     def topic
-      @setup.to_s
+      setup.to_s
     end
 
+    # 
+    # Location of test definition.
     #
-    def scope
-      context.scope
+    def source_location
+      [file, line]
     end
 
     #
-    def arguments
-      @arguments
-    end
-
+    # Match test's label and/or tags.
     #
-    def arguments=(args)
-      @arguments = args
-    end
-
-    # TODO: how to handle negated tests?
-    def negate
-      @negate
+    # @param [String,Symbol,Regexp,Hash] match
+    #   Pattern to match against.
+    #
+    # @return [Boolean]
+    #
+    def match?(match)
+      case match
+      when Symbol
+        tags.include?(match)
+      when Hash
+        if Hash === tags.last
+          tags.last.any?{ |k,v| match[k] == v }
+        end
+      else
+        match === label
+      end
     end
 
     #
-    def negate=(boolean)
-      @negate = !!boolean
+    # Run this test in context.
+    #
+    def call
+      context.run(self)
     end
 
+    #
+    # Convert `#call` to Proc.
+    #
+    # @return [Proc]
     #
     def to_proc
       lambda{ call }
     end
 
     #
-    def match?(match)
-      match == target || match === description
-    end
+    #def set_proc(&proc)
+    #  @procedure = proc
+    #end
 
-    #
-    def call
-      context.run(self) do
-        setup.run_setup(scope)    if setup
-        scope.instance_exec(*arguments, &procedure)
-        setup.run_teardown(scope) if setup
+    class Scope < World
+
+      def initialize(parent)
+        #include context
+        @_parent = parent
+        extend parent
       end
+
     end
 
   end

data/lib/citron/test_setup.rb

@@ -1,51 +1,73 @@
 module Citron
 
-  # Test Setup/Concern - Setup and Teardown code.
+  # Ecapsulate a test case's setup code.
+  #
   class TestSetup
 
+    #
     # The test case to which this advice belong.
+    #
     attr :context
 
-    # A brief description of this concern.
-    attr :label
+    #
+    # The setup procedures.
+    #
+    attr :procedures
 
-    # The setup procedure.
-    attr :setup
+    #
+    # A brief description of the setup.
+    #
+    attr :label
 
-    # The teardown procedure.
-    attr :teardown
+    #
+    # Initialize new Setup instance.
+    #
+    def initialize(context, label, &proc)
+      @context    = context
+      @label      = label.to_s
+      @procedures = []
 
-    # New case instance.
-    def initialize(context, label, options={}, &setup)
-      @context   = context
-      @label     = label.to_s
-      @setup     = [setup].flatten
-      @teardown  = []
+      @procedures << proc if proc
     end
 
     #
-    def teardown=(procedure)
-      @teardown = [procedure]
-    end
-
-    # Setup.
-    def run_setup(scope)
-      setup.each do |proc|
-        scope.instance_eval(&proc)
-      end
+    # Copy the setup for a new context.
+    #
+    def copy(context)
+      c = self.class.new(context, label)
+      c.procedures = procedures
+      c
     end
 
-    # Teardown.
-    def run_teardown(scope)
-      teardown.each do |proc|
+    #
+    # Run setup procedure in test scope.
+    #
+    def call(scope)
+      procedures.each do |proc|
         scope.instance_eval(&proc)
       end
     end
 
+    #
     # Returns the description with newlines removed.
+    #
     def to_s
       label.gsub(/\n/, ' ')
     end
+
+    #
+    # Add a setup procedure.
+    #
+    def add(&proc)
+      @procedures << proc
+    end
+
+  protected
+
+    def procedures=(procedures)
+      @procedures = procedures
+    end
+
   end
 
 end

data/lib/citron/test_teardown.rb

@@ -0,0 +1,60 @@
+module Citron
+
+  # Ecapsulate a test case's teardown code.
+  #
+  class TestTeardown
+
+    #
+    # The test case to which this advice belong.
+    #
+    attr :context
+
+    #
+    # The setup procedures.
+    #
+    attr :procedures
+
+    #
+    # Initialize new Setup instance.
+    #
+    def initialize(context, &proc)
+      @context    = context
+      @procedures = []
+
+      @procedures << proc if proc
+    end
+
+    #
+    # Copy the teardown for a new context.
+    #
+    def copy(context)
+      c = self.class.new(context)
+      c.procedures = procedures
+      c
+    end
+
+    #
+    # Run teardown procedure in test scope.
+    #
+    def call(scope)
+      procedures.each do |proc|
+        scope.instance_eval(&proc)
+      end
+    end
+
+    #
+    # Add a teardown procedure.
+    #
+    def add(&proc)
+      procedures << proc
+    end
+
+  protected
+
+    def procedures=(procedures)
+      @procedures = procedures
+    end
+
+  end
+
+end

data/lib/citron/world.rb

@@ -1,7 +1,10 @@
 module Citron
 
+  # To add global helpers to test case context, you can
+  # add that functionality to the Citron::World module.
   #
   class World < Module
   end
 
 end
+

data/test/case_basic.rb

@@ -0,0 +1,7 @@
+testcase "basic test case" do
+
+  test "basic test" do
+    assert true
+  end
+
+end

data/test/case_parametric_tests.rb

@@ -0,0 +1,10 @@
+testcase "parametric tests" do
+
+  test "example parametric test" do |x|
+    x.assert.even?
+  end
+
+  ok 2
+  ok 4
+
+end

data/test/case_scope.rb

@@ -0,0 +1,25 @@
+testcase "Test Scope" do
+
+  def helper_method
+    "helped!"
+  end
+
+  test "can use helper method" do
+    helper_method.assert == "helped!"
+  end
+
+  context "sub-case inherits helpers" do
+
+    test "can use helper method" do
+      helper_method.assert == "helped!"
+    end
+
+  end
+
+  test "test can't access case methods" do
+    expect NameError do
+      method(:ok)
+    end
+  end
+
+end

data/test/case_setup.rb

@@ -0,0 +1,26 @@
+testcase "Example of using setup in a testcase" do
+  setup "the number one" do
+    @x = 1
+  end
+
+  test "has setup without a topic" do
+    @x.assert == 1
+  end
+
+  context "sub-case inherits parent setup" do
+    test "has setup" do
+      @x.assert == 1
+    end
+  end
+
+  context "sub-case with setup override parent setup" do
+    setup "has setup" do
+      @y = 10
+    end
+
+    test "has setup" do
+      @x.assert == nil
+      @y.assert == 10
+    end
+  end
+end