stendhal 0.1.3 → 0.1.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stendhal (0.1.2)
+    stendhal (0.1.3)
 
 GEM
   remote: http://rubygems.org/

data/Readme.md

@@ -8,8 +8,9 @@ development.
 
 ##Current features
 
+* Pretty decent reporter with colors
 * Test doubles and stubs (no partial stubbing yet)
-* Nested example groups
+* Nested example groups (declare them with either describe or context)
 * Pending examples
 * Lame reporter (but will get better eventually)
 * Matchers (use with object.must or object.must_not)
@@ -62,6 +63,12 @@ development.
           my_object.future_method
         end
 
+        context "under some unknown circumstances" do
+          it "may act differently" do
+            MyClass.must be_a(Class)
+          end
+        end
+
       end
 
       describe "Test double" do
@@ -85,27 +92,29 @@ development.
 
     stendhal foo_spec.rb
 
-###And the output...
+###And the nice colored output...
 
     Foo
-    * does something
-    * fails when 7 is not 9 [FAILED]
-            expected 7 to equal 9
-    * asks for a kind of object
-    * asks things to objects [FAILED]
-            expected "string" to be frozen
-    * has common sense
+      * does something
+      * fails when 7 is not 9 [FAILED]
+        expected 7 to equal 9
+      * asks for a kind of object
+      * asks things to objects [FAILED]
+        expected "string" to be frozen
+      * has common sense
 
     Pending examples
-    * should do something but I don't know what yet
-    * will do something else
+      * should do something but I don't know what yet
+      * will do something else
+      under some unknown circumstances
+        * may act differently
 
     Test double
-    * is declared with fake
-    * is declared with double as well
-    * can be given stubs
+      * is declared with fake
+      * is declared with double as well
+      * can be given stubs
 
-    10 examples, 2 failures, 2 pending
+    11 examples, 2 failures, 2 pending
 
 ##Note on Patches/Pull Requests
  

data/features/examples.feature

@@ -80,6 +80,11 @@ Feature: Examples and example groups
           it "does this" do
             # put your code here
           end
+          context "under certain circumstances" do
+            it "does that" do
+              # put your code here
+            end
+          end
         end
         describe "pending" do
           pending "todo" do
@@ -96,8 +101,10 @@ Feature: Examples and example groups
     And the output should contain "something"
     And the output should contain "inside another thing"
     And the output should contain "* does this"
+    And the output should contain "under certain circumstances"
+    And the output should contain "* does that"
     And the output should contain "pending"
     And the output should contain "* todo"
     And the output should contain "* fails [FAILED]"
     And the output should contain "indeed"
-    And the output should contain "3 examples, 1 failure, 1 pending"
+    And the output should contain "4 examples, 1 failure, 1 pending"

data/features/reporter.feature

@@ -0,0 +1,31 @@
+Feature: Reporter
+
+  Stendhal reports examples in a decent visual manner.
+
+  Scenario: simple colored report
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+          false.must eq(false)
+        end
+      end
+
+      describe "other thing" do
+        describe "under other circumstances" do
+          it "fails" do
+            true.must_not eq(true)
+          end
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "37msomething"
+    And the output should contain "32m* does something"
+    And the output should contain "37mother thing"
+    And the output should contain "37munder other circumstances"
+    And the output should contain "31m* fails"
+    And the output should contain "31m2 examples, 1 failure"

data/lib/stendhal/autorun.rb

@@ -5,7 +5,10 @@ ARGV.each do |file|
 end
 
 examples, failures, pending = Stendhal::ExampleGroup.run_all
-report = "\n#{examples} #{examples != 1 ? 'examples' : 'example'}, #{failures} #{failures != 1 ? 'failures' : 'failure'}"
+report = "#{examples} #{examples != 1 ? 'examples' : 'example'}, #{failures} #{failures != 1 ? 'failures' : 'failure'}"
 report += ", #{pending} pending" if pending > 0
-puts report
+
+Stendhal::Reporter.whitespace
+color = failures == 0 ? :green : :red
+Stendhal::Reporter.line report, :color => color
 

data/lib/stendhal/core_ext/kernel.rb

@@ -1,7 +1,13 @@
 module Kernel
   def describe(*args,&blk)
-    Stendhal::ExampleGroup.new(*args,&blk)
+    if self.is_a? Stendhal::ExampleGroup
+      self.add_example_group(*args,&blk)
+    else
+      Stendhal::ExampleGroup.new(*args,&blk)
+    end
   end
+  alias_method :context, :describe
+
   def must(matcher)
     matcher.match self
   end

data/lib/stendhal/example_group.rb

@@ -3,36 +3,66 @@ module Stendhal
     @@example_groups = []
 
     attr_reader :description
+    attr_reader :example_groups
     attr_reader :block
     attr_reader :examples
 
     def initialize(docstring, options = {}, &block)
       @description = docstring
       @block = block
+      @parent = options[:parent]
+      @example_groups = []
       @examples = []
       instance_exec(&@block) if block_given?
       @@example_groups << self
     end
 
+    def add_example_group(*args, &block)
+      if args.last.is_a?(Hash)
+        args.last.update(:parent => true)
+      else
+        args << {:parent => true}
+      end
+      @example_groups << ExampleGroup.new(*args, &block)
+    end
+
+    def has_parent?
+      !@parent.nil?
+    end
+
     def run
+      Reporter.line @description, :indent => Reporter.current_indentation, :color => :white
+      original_indentation = Reporter.current_indentation
+
       failures = pending = 0
       examples.reject do |example|
         if example.pending? 
           pending += 1
-          $stdout.print "* #{example.description} [PENDING]\n"
+          Reporter.line "* #{example.description} [PENDING]", :indent => Reporter.current_indentation + 1, :color => :yellow
           true
         else
           false
         end
       end.each do |example|
         failures += example.run
+        color = :red
+        color = :green unless example.failed? || example.aborted?
         status = " [FAILED]" if example.failed?
         status = " [ABORTED]" if example.aborted?
-        $stdout.print "* #{example.description}#{status || ''}\n"
-        $stdout.print "\t#{example.failed_message}\n" if example.failed?
-        $stdout.print "\t#{example.aborted_message}\n" if example.aborted?
+        Reporter.line "* #{example.description}#{status || ''}", :indent => Reporter.current_indentation + 1, :color => color
+        Reporter.line "#{example.failed_message}", :indent => Reporter.current_indentation + 2, :color => :red if example.failed?
+        Reporter.line "#{example.aborted_message}", :indent => Reporter.current_indentation + 2, :color => :red if example.aborted?
       end
-      [examples.count, failures, pending]
+      group_result = [examples.count, failures, pending]
+
+      @example_groups.each do |group|
+        Reporter.current_indentation += 1
+        sub_result = group.run
+        group_result = group_result.zip(sub_result).map{ |pair| pair[0] + pair[1] } if sub_result
+      end
+      Reporter.current_indentation = original_indentation
+
+      group_result
     end
 
     def add_example(example)
@@ -47,16 +77,20 @@ module Stendhal
       end
 
       def run_all
+        Reporter.whitespace
         result = [0,0,0]
-        @@example_groups.each do |g|
-          puts "\n"
-          puts g.description
+        primary_example_groups.each do |g|
           group_result = g.run
+          Reporter.whitespace
           result = result.zip(group_result).map{ |pair| pair[0] + pair[1] }
         end
         result
       end
 
+      def primary_example_groups
+        @@example_groups.reject { |g| g.has_parent? }
+      end
+
       def count
         @@example_groups.count
       end

data/lib/stendhal/matchers.rb

@@ -10,10 +10,6 @@ module Stendhal
     end
     alias_method :eql, :eq
 
-    def caca(other)
-      Equality.new(other)
-    end
-
     def be_a(kind)
       Kind.new(kind)
     end

data/lib/stendhal/reporter.rb

@@ -0,0 +1,75 @@
+require 'singleton'
+
+module Stendhal
+  class Reporter
+    include ::Singleton
+
+    def initialize
+      @current_indentation = 0 
+      @output = $stdout
+    end
+
+    attr_writer :output
+    attr_accessor :current_indentation
+
+    COLORS = 
+      {"black" => "30",
+       "red" => "31",
+       "green" => "32",
+       "yellow" => "33",
+       "blue" => "34",
+       "magenta" => "35",
+       "cyan" => "36",
+       "white" => "37",
+
+       "RED" => "41",
+       "GREEN" => "42",
+       "YELLOW" => "43",
+       "BLUE" => "44",
+       "MAGENTA" => "45",
+       "CYAN" => "46",
+       "WHITE" => "47"}
+
+    def reset
+      @output = $stdout
+    end
+
+    def line(text, options = {})
+      options[:indent].times { tab } if options[:indent]
+      with_color(options[:color]) do
+        @output.print text
+      end
+      @output.print "\n"
+    end
+
+    def whitespace
+      @output.print "\n"
+    end
+
+    def tab
+      @output.print "  "
+    end
+
+    # Delegate all methods to instance
+    class << self
+      def method_missing(*args, &block)
+        instance.send(*args, &block)
+      end
+    end
+
+    private
+
+      def with_color(color,&block)
+        return unless block_given?
+        if color
+          @output.print "\e[0;#{COLORS[color.to_s]}m"
+          yield
+          @output.print "\e[0m"
+        else
+          yield
+        end
+      end
+
+  end
+end
+

data/lib/stendhal/version.rb

@@ -1,3 +1,3 @@
 module Stendhal
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/stendhal.rb

@@ -1,3 +1,4 @@
+require 'stendhal/reporter'
 require 'stendhal/exceptions'
 require 'stendhal/matchers'
 require 'stendhal/mocks'

data/spec/stendhal/example_group_spec.rb

@@ -49,6 +49,7 @@ module Stendhal
         @group.add_example @failing_example
         @pending_example = Example.new("pending")
         @group.add_example @pending_example
+        @group.add_example_group("another group")
       end
 
       it "runs all non-pending examples" do
@@ -59,11 +60,26 @@ module Stendhal
         @group.run
       end
 
+      it "runs all its children" do
+        @group.example_groups.each do |g|
+          g.should_receive(:run)
+        end
+        @group.run
+      end
+
       it "returns an array with total examples, failures and pendings" do
         @group.run.should == [6,1,1]
       end
     end    
 
+    describe "#add_example_group" do
+      it "adds a nested example group inside self" do
+        example_group = ExampleGroup.new("group")
+        example_group.add_example_group(ExampleGroup.new("other group"))
+        example_group.example_groups.first.should have_parent
+      end
+    end
+
     describe "class methods" do
       describe "#count" do
         it "returns the number of example groups in memory" do

data/spec/stendhal/reporter_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module Stendhal
+  describe Reporter do
+
+    let(:out) { StringIO.new }
+
+    after(:each) do
+      Reporter.reset
+      out.flush
+    end
+
+    it 'is a singleton' do
+      Reporter.instance.should be_a(Reporter)  
+    end
+
+    describe "instance methods" do
+
+      before(:each) do
+        Reporter.output = out
+      end
+    
+      describe "#line" do
+
+        it 'outputs a line' do
+          Reporter.line "This is a line"
+          out.string.should include("This is a line\n")
+        end
+
+        context "with indentation" do
+          it 'outputs an indented line' do
+            Reporter.line "This is a line", :indent => 2
+            out.string.should include("  This is a line\n")
+          end
+        end
+
+        context "with color" do
+          it 'outputs a coloured line' do
+            Reporter.line "This is a line", :color => :red
+            out.string.should include("\e[0;31mThis is a line\e[0m\n")
+          end
+        end
+
+      end
+
+      describe "#whitespace" do
+        it 'outputs whitespace' do
+          Reporter.whitespace
+          out.string.should match(/\n/)
+        end
+      end
+
+      describe "#tab" do
+        it 'outputs a tab' do
+          Reporter.tab
+          out.string.should include("  ")
+        end
+      end
+
+      describe "#current_indentation" do
+        it 'returns 0 by default' do
+          Reporter.current_indentation.should == 0
+        end
+        it 'can be set' do
+          Reporter.current_indentation = 2
+          Reporter.current_indentation.should == 2
+        end
+      end
+    
+    end
+
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Josep M. Bach
@@ -91,6 +91,7 @@ files:
 - bin/stendhal
 - features/examples.feature
 - features/expectations.feature
+- features/reporter.feature
 - features/support/env.rb
 - features/test_doubles_and_stubs.feature
 - lib/stendhal.rb
@@ -107,6 +108,7 @@ files:
 - lib/stendhal/matchers/predicate.rb
 - lib/stendhal/mocks.rb
 - lib/stendhal/mocks/test_double.rb
+- lib/stendhal/reporter.rb
 - lib/stendhal/version.rb
 - script/console
 - spec/spec_helper.rb
@@ -118,6 +120,7 @@ files:
 - spec/stendhal/matchers/kind_spec.rb
 - spec/stendhal/matchers/predicate_spec.rb
 - spec/stendhal/matchers_spec.rb
+- spec/stendhal/reporter_spec.rb
 - spec/stendhal/test_double_spec.rb
 - stendhal.gemspec
 has_rdoc: true
@@ -155,6 +158,7 @@ summary: Stendhal is a really simple test framework.
 test_files: 
 - features/examples.feature
 - features/expectations.feature
+- features/reporter.feature
 - features/support/env.rb
 - features/test_doubles_and_stubs.feature
 - spec/spec_helper.rb
@@ -166,4 +170,5 @@ test_files:
 - spec/stendhal/matchers/kind_spec.rb
 - spec/stendhal/matchers/predicate_spec.rb
 - spec/stendhal/matchers_spec.rb
+- spec/stendhal/reporter_spec.rb
 - spec/stendhal/test_double_spec.rb