citron 0.3.0 → 0.4.0

data/.ruby

@@ -1,6 +1,7 @@
 ---
 source:
 - PROFILE
+- Profile
 authors:
 - name: Thomas Sawyer
   email: transfire@gmail.com
@@ -33,15 +34,18 @@ repositories:
 resources:
   home: http://rubyworks.github.com/citron
   code: http://github.com/rubyworks/citron
+  bugs: http://github.com/rubyworks/citron/issues
+  chat: irc://chat.us.freenode.net/rubyworks
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
 extra: {}
 load_path:
 - lib
 revision: 0
 name: citron
 title: Citron
-version: 0.3.0
-summary: Classic Unit-style Test Framework
-description: Citron is a unit testing framework with a classic test-case/test-unit
-  style.
+version: 0.4.0
+summary: Classic Unit Testing
+description: Citron is a classical unit testing framework with a developer freindly
+  DSL, runs on top of RubyTest and is BRASS compliant.
 organization: RubyWorks
 date: '2012-02-25'

data/COPYING.md

@@ -1,14 +1,13 @@
 # COPYRIGHT
 
-
 ## NOTICES
 
 ### Citron
 
-http://rubyworks.github.com/citron
-
-* Copyright (c) 2011 Rubyworks (BSD-2-Clause)
-
+    Citron - Classic Unit Testing
+    2011 (c) Rubyworks (BSD-2-Clause license)
+    All rights expressly reserved.
+    http://rubyworks.github.com/citron
 
 ## LICENSES
 

data/{HISTORY.md → History.md}

@@ -1,5 +1,15 @@
 # Release History
 
+## 0.4.0 / 2012-02-28
+
+Reimplmented with a class-based model. This design is the traditional XUnit
+OOP design, so it is more fitting Citron's design goals.
+
+Changes:
+
+* Reimplement with class-based model.
+
+
 ## 0.3.0 / 2012-02-25
 
 This release cleans up the code, deprecates the complex Before and After

data/{LICENSE.txt → License.txt}

@@ -1,6 +1,7 @@
-BSD 2 Clause License
-
-Copyright 2011 Thomas Sawyer. All rights reserved.
+Citron - Classic Unit Testing
+Copyright (c) 2011 Rubyworks (BSD-2-Clause license)
+All rights are expressly reserved.
+http://rubyworks.github.com/citron
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

data/README.md

@@ -1,20 +1,36 @@
 # Citron
 
 [Website](http://rubyworks.github.com/citron) /
-[Development](http://github.com/rubyworks/citron) /
 [Report Issue](http://github.com/rubyworks/citron/issues) /
+[IRC Channel](irc://chat.us.freenode.net/rubyworks) /
+[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /
+[Development](http://github.com/rubyworks/citron)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/citron.png)](http://travis-ci.org/rubyworks/citron)
 
 
 ## Description
 
-Citron is a traditional unit test framework. It defines a simple
-domain language for creating classically styled unit tests.
+Citron is a classical unit testing framework. It defines a simple
+domain language for creating traditionally modeled unit tests.
+
+
+## Installation
+
+Using Rubygems simply install `citron`:
+
+    $ gem install citron
 
+Citron depends on `ansi` for terminal colorization and `rubytest`,
+so those will be installed as well if they are not already.
 
-## Example
 
-Here's a fun example.
+## Instruction
 
+Citon tests are written as a collection of testcase and test blocks.
+Here is a fun example. We'll call the test file `test/test_beatit.rb`:
+
+```ruby
     TestCase "Show them how to Beat It" do
 
       setup do
@@ -42,14 +58,15 @@ Here's a fun example.
         raise NotImplementedError
       end
 
-      # omit
-      test "just beat it" do
-        e = NotImplementedError.new
-        e.set_assertion(true)
-        raise e
-      end
-
     end
+```
+
+Citron doesn't dictate the assertions system you use. In the above example, we are using
+the [A.E.](http://rubyworks.github.com/ae) assertion framework. You can use any [BRASS](http://rubyworks.github.com)
+compliant system you prefer.
+
+Citron is built on top of [RubyTest](http://rubyworks.github.com/rubytest).
+Jump over to its website to learn how to run tests and setup test run profiles.
 
 
 ## Copyrights

data/lib/citron.rb

@@ -2,8 +2,6 @@ $TEST_SUITE ||= []
 
 module Citron
   require 'citron/world'
-  require 'citron/test_setup'
-  require 'citron/test_teardown'
   require 'citron/test_proc'
   require 'citron/test_case'
 
@@ -11,8 +9,9 @@ module Citron
     #
     # Define a general test case.
     #
-    def test_case(label, &block)
-      $TEST_SUITE << Citron::TestCase.new(:label=>label, &block)
+    def test_case(label, *tags, &block)
+      testcase = Citron::TestCase.context(label, *tags, &block)
+      $TEST_SUITE << testcase.new
     end
 
     alias :TestCase :test_case

data/lib/citron/test_case.rb

@@ -3,202 +3,99 @@ module Citron
   # Test Case encapsulates a collection of
   # unit tests organized into groups of contexts.
   #
-  class TestCase
+  class TestCase < World
 
-    # The parent context in which this case resides.
-    attr :context
+    class << self
 
-    # Brief description of the test case.
-    attr :label
+      # Brief description of the test case.
+      attr :label
 
-    # Symbol list of tags. Trailing element may be Hash
-    # of `symbol => object`.
-    attr :tags
+      # Symbol list of tags. Trailing element may be Hash
+      # of `symbol => object`.
+      attr :tags
 
-    # List of tests and sub-cases.
-    attr :tests
+      # List of tests and sub-cases.
+      attr :tests
 
-    # The setup advice.
-    attr :setup
+      # Code unit that is subject of test case.
+      attr :unit
 
-    # The teardown advice.
-    attr :teardown
-
-    # Code unit that is subject of test case.
-    attr :unit
+      # Initialize new TestCase.
+      #
+      def __set__(settings={}, &block)
+        @label   = settings[:label]
+        @tags    = settings[:tags]
+        @skip    = settings[:skip]
 
-    # Module for evaluating tests.
-    attr :scope
+        @unit    = calc_unit(@label)
 
-  private
+        @tests   = []
 
-    # Initialize new TestCase.
-    #
-    def initialize(settings={}, &block)
-      @context = settings[:context]
-      @label   = settings[:label]
-      @tags    = settings[:tags]
-      #@setup  = settings[:setup]
-      @skip    = settings[:skip]
-
-      @unit    = calc_unit
-
-      if context
-        @setup    = context.setup.copy(self)    if context.setup
-        @teardown = context.teardown.copy(self) if context.teardown
+        class_eval(&block)
       end
 
-      @tests = []
-
-      @scope = Scope.new(self)
-
-      @scope.module_eval(&block) if block
-    end
-
-    #
-    def calc_unit
-      case @label
-      when Module, Class
-        @label
-      when /^(\.|\#|\:\:)\w+/
-        if @context && Module === @context.unit
-          [@context.unit, @label].join('')
-        else
+      #
+      #
+      #
+      def calc_unit(label)
+        case label
+        when Module, Class
           @label
+        when /^(\.|\#|\:\:)\w+/
+          if Module === superclass.unit
+            [superclass.unit, @label].join('')
+          else
+            @label
+          end
         end
       end
-    end
-
-  public
-
-    #
-    # Assign the setup procedure
-    #
-    # @param [TestSetup] test_setup
-    #
-    def setup=(test_setup)
-      @setup = test_setup
-    end
-
-    #
-    # Assign the teardown procedure.
-    #
-    # @param [TestTeardown] test_teardown
-    #
-    def teardown=(test_teardown)
-      @teardown = test_teardown
-    end
-
-    #
-    # Add new test or sub-case.
-    #
-    # @param [TestCase,TestProc] test_obejct
-    #   Test sub-case or procedure to add to this case.
-    #
-    def <<(test_object)
-      @tests << test_object
-    end
-
-    #
-    # Iterate over each test and sub-case.
-    #
-    # @param [Proc] block
-    #   Iteration procedure.
-    #
-    def each(&block)
-      tests.each(&block)
-    end
 
-    # 
-    #def call
-    #  yield
-    #end
-
-    #
-    # Number of tests and sub-cases.
-    #
-    # @return [Fixnum] size
-    #
-    def size
-      tests.size
-    end
-
-    #
-    # Subclasses of TestCase can override this to describe
-    # the type of test case they define.
-    #
-    # @return [String]
-    #
-    #def type
-    #  'TestCase'
-    #end
-
-    #
-    # Test case label.
-    #
-    # @return [String]
-    #
-    def to_s
-      label.to_s
-    end
-
-    #
-    # Is test case to be skipped?
-    #
-    # @return [Boolean,String]
-    #   If +false+ or +nil+ if not skipped, otherwise
-    #   +true+ or a string explain why to skip.
-    #
-    def skip?
-      @skip
-    end
-
-    #
-    # Set test case to be skipped.
-    #
-    # @param [Boolean,String] reason
-    #   Set to +false+ or +nil+ if not skipped, otherwise
-    #   +true+ or a string explain why to skip.
-    #
-    def skip=(reason)
-      @skip = reason
-    end
-
-    def test_scope
-      @test_scope ||= TestProc::Scope.new(scope)
-    end
+      #
+      # Subclasses of TestCase can override this to describe
+      # the type of test case they define.
+      #
+      # @return [String]
+      #
+      #def type
+      #  'TestCase'
+      #end
 
-    #
-    # Run +test+ in the context of this case.
-    #
-    # @param [TestProc] test
-    #   The test unit to run.
-    #
-    def run(test)
-      setup.call(test_scope) if setup
-      #scope.instance_exec(*arguments, &procedure)
-      test_scope.instance_eval(&test.procedure)
-      teardown.call(test_scope) if teardown
-    end
+      #
+      # Add new test or sub-case.
+      #
+      # @param [Class<TestCase>,TestProc] test_obejct
+      #   Test sub-case or procedure to add to this case.
+      #
+      def <<(test_object)
+        @tests ||= []
+        @tests << test_object
+      end
 
-    # The evaluation scope for a test case.
-    #
-    class Scope < World
+      # 
+      #def call
+      #  yield
+      #end
 
       #
-      # Initialize new evaluation scope.
+      # Is test case to be skipped?
       #
-      # @param [TestCase] testcase
-      #   The test case this scope belongs.
+      # @return [Boolean,String]
+      #   If +false+ or +nil+ if not skipped, otherwise
+      #   +true+ or a string explain why to skip.
       #
-      def initialize(testcase) #, &code)
-        @_case  = testcase
-        @_setup = testcase.setup
-        @_skip  = false
+      def skip?
+        @skip
+      end
 
-        if testcase.context
-          include(testcase.context.scope)
-        end
+      #
+      # Set test case to be skipped.
+      #
+      # @param [Boolean,String] reason
+      #   Set to +false+ or +nil+ if not skipped, otherwise
+      #   +true+ or a string explain why to skip.
+      #
+      def skip=(reason)
+        @skip = reason
       end
 
       #
@@ -212,19 +109,17 @@ module Citron
       #   These can be used as a means of filtering tests.
       #
       def Context(label, *tags, &block)
-        settings = {
-          :context => @_case,
-          #:setup   => @_setup,
+        context = Class.new(self)
+        context.__set__(
           :skip    => @_skip,
           :label   => label,
-          :tags    => tags
-        }
-
-        testcase = TestCase.new(settings, &block)
+          :tags    => tags,
+          &block
+        )
 
-        @_case.tests << testcase
+        self << context
 
-        testcase
+        context
       end
 
       alias :context :Context
@@ -243,8 +138,7 @@ module Citron
         file, line, _ = *caller[0].split(':')
 
         settings = {
-          :context => @_case,
-          #:setup   => @_setup,
+          :context => self,
           :skip    => @_skip,
           :label   => label,
           :tags    => tags,
@@ -254,9 +148,12 @@ module Citron
 
         if procedure.arity == 0 || (RUBY_VERSION < '1.9' && procedure.arity == -1)
           test = TestProc.new(settings, &procedure)
-          @_case.tests << test
+
+          self << test
+
           @_test = nil
-          test
+
+          return test
         else
           @_test = [settings, procedure]
         end
@@ -276,7 +173,7 @@ module Citron
           procedure.call(*args)
         end
 
-        @_case << test
+        self << test
 
         return test
       end
@@ -291,12 +188,9 @@ module Citron
       #   A brief description of what the setup procedure sets-up.
       #
       def Setup(label=nil, &proc)
-        if proc
-          @_case.setup    = TestSetup.new(@_case, label, &proc)
-          @_case.teardown = nil  # if the setup is reset, then so it the teardown
-        else
-          @_case.setup
-        end
+        define_method(:setup, &proc)
+        # if the setup is reset, then so should the teardown
+        define_method(:teardown){}
       end
 
       alias :setup :Setup
@@ -305,11 +199,7 @@ module Citron
       # Teardown procedure is used to clean-up after each unit test.
       #
       def Teardown(&proc)
-        if proc
-          @_case.teardown = TestTeardown.new(@_case, &proc)
-        else
-          @_case.teardown
-        end
+        define_method(:teardown, &proc)
       end
 
       alias :teardown :Teardown
@@ -348,6 +238,61 @@ module Citron
 
       alias :skip :Skip
 
+      alias :inspect :to_s
+
+      #
+      # Test case label.
+      #
+      # @return [String]
+      #
+      def to_s
+        label.to_s
+      end
+
+    end
+
+    #
+    # Iterate over each test and sub-case.
+    #
+    def each
+      self.class.tests.each do |test_object|
+        case test_object
+        when Class #TestCase
+          yield(test_object.new)
+        when TestProc
+          yield(test_object.for(self))
+        end
+      end
+    end
+
+    #
+    # Number of tests and sub-cases.
+    #
+    # @return [Fixnum] size
+    #
+    def size
+      self.class.tests.size
+    end
+
+    #
+    # Test case label.
+    #
+    # @return [String]
+    #
+    def to_s
+      self.class.label.to_s
+    end
+
+    #
+    # Dummy method for setup.
+    #
+    def setup
+    end
+
+    #
+    # Dummy method for teardown.
+    #
+    def teardown
     end
 
   end

data/lib/citron/test_proc.rb

@@ -8,7 +8,6 @@ module Citron
     #
     def initialize(options={}, &procedure)
       @context   = options[:context]
-      #@setup     = options[:setup]
       @label     = options[:label]
       @tags      = options[:tags]
       @skip      = options[:skip]
@@ -97,18 +96,20 @@ module Citron
     #
     # @return [TestSetup] setup
     #
-    def setup
-      @context.setup
-    end
+    #def setup
+    #  @context.setup
+    #end
 
-    #
-    # Ruby Test looks for `#topic` as the desciption of a test's setup.
-    #
-    # @return [String] Description of the setup.
-    #
-    def topic
-      setup.to_s
-    end
+    # TODO: possible to support topic?
+
+    ##
+    ## Ruby Test looks for `#topic` as the desciption of a test's setup.
+    ##
+    ## @return [String] Description of the setup.
+    ##
+    #def topic
+    #  setup.to_s
+    #end
 
     # 
     # Location of test definition.
@@ -142,33 +143,32 @@ module Citron
     # Run this test in context.
     #
     def call
-      context.run(self)
+      @scope.setup
+      @scope.instance_eval(&procedure)
+      @scope.teardown
     end
 
     #
-    # Convert `#call` to Proc.
-    #
-    # @return [Proc]
+    # Return copy with `@scope` set.
     #
-    def to_proc
-      lambda{ call }
+    def for(scope)
+      @scope = scope
+      self.dup
     end
 
+    ##
+    ## Convert `#call` to Proc.
+    ##
+    ## @return [Proc]
+    ##
+    #def to_proc
+    #  lambda{ call }  # procedure ?
+    #end
+
     #
     #def set_proc(&proc)
     #  @procedure = proc
     #end
-
-    class Scope < World
-
-      def initialize(parent)
-        #include context
-        @_parent = parent
-        extend parent
-      end
-
-    end
-
   end
 
 end

data/lib/citron/world.rb

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

data/test/case_unit.rb

@@ -7,7 +7,7 @@ testcase Array do
     end
 
     test "unit should be class and method" do
-      @_parent.instance_variable_get(:@_case).unit.assert == "Array#join"
+      self.class.unit.assert == "Array#join"
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: citron
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000 Z
+date: 2012-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubytest
-  requirement: &22941000 !ruby/object:Gem::Requirement
+  requirement: &18271840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22941000
+  version_requirements: *18271840
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &22940460 !ruby/object:Gem::Requirement
+  requirement: &18271300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22940460
+  version_requirements: *18271300
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &22939960 !ruby/object:Gem::Requirement
+  requirement: &18270800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22939960
+  version_requirements: *18270800
 - !ruby/object:Gem::Dependency
   name: reap
-  requirement: &22939440 !ruby/object:Gem::Requirement
+  requirement: &18270280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22939440
+  version_requirements: *18270280
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &22938940 !ruby/object:Gem::Requirement
+  requirement: &18269780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,24 +65,22 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22938940
-description: Citron is a unit testing framework with a classic test-case/test-unit
-  style.
+  version_requirements: *18269780
+description: Citron is a classical unit testing framework with a developer freindly
+  DSL, runs on top of RubyTest and is BRASS compliant.
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE.txt
+- License.txt
 - COPYING.md
-- HISTORY.md
 - README.md
+- History.md
 files:
 - .ruby
 - lib/citron/test_case.rb
 - lib/citron/test_proc.rb
-- lib/citron/test_setup.rb
-- lib/citron/test_teardown.rb
 - lib/citron/world.rb
 - lib/citron.rb
 - test/case_basic.rb
@@ -91,9 +89,9 @@ files:
 - test/case_setup.rb
 - test/case_unit.rb
 - COPYING.md
-- LICENSE.txt
-- HISTORY.md
 - README.md
+- History.md
+- License.txt
 homepage: http://rubyworks.github.com/citron
 licenses:
 - BSD-2-Clause
@@ -118,5 +116,5 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Classic Unit-style Test Framework
+summary: Classic Unit Testing
 test_files: []

data/lib/citron/test_setup.rb

@@ -1,73 +0,0 @@
-module Citron
-
-  # Ecapsulate a test case's setup code.
-  #
-  class TestSetup
-
-    #
-    # The test case to which this advice belong.
-    #
-    attr :context
-
-    #
-    # The setup procedures.
-    #
-    attr :procedures
-
-    #
-    # A brief description of the setup.
-    #
-    attr :label
-
-    #
-    # Initialize new Setup instance.
-    #
-    def initialize(context, label, &proc)
-      @context    = context
-      @label      = label.to_s
-      @procedures = []
-
-      @procedures << proc if proc
-    end
-
-    #
-    # Copy the setup for a new context.
-    #
-    def copy(context)
-      c = self.class.new(context, label)
-      c.procedures = procedures
-      c
-    end
-
-    #
-    # 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

@@ -1,60 +0,0 @@
-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