foca-storyteller 0.1.0 → 0.1.1

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 major: 0
-patch: 0
+patch: 1
 minor: 1

data/lib/storyteller.rb

@@ -1,29 +1,66 @@
+require "rubygems"
 require "context"
 
-module Test::Storyteller
-  def self.included(base)
-    base.before(:all) do
-      puts
-      print "\e[36m"
-      puts  self.class.story.to_s.gsub(/^\s+/, '')
-      print "\e[0m"
+module Test
+  # Including Storyteller in your TestCase allows you to declare a user story
+  # (global to the entire test case) and then run `scenarios' (tests) regarding
+  # that user story
+  #
+  # For example:
+  #
+  # class MyTestCase < Test::Unit::TestCase
+  #   include Test::Storyteller
+  #   
+  #   story <<-EOS
+  #     As a <role>
+  #     I want to <feature>
+  #     So that <profit>
+  #   EOS
+  #
+  #   scenario "some scenario description" do
+  #     ...
+  #   end
+  # end
+  module Storyteller
+    def self.included(base)
+      base.before(:all) do
+        puts
+        print Storyteller.color.first
+        print self.class.story.to_s.gsub(/^\s+/, '')
+        print Storyteller.color.last
+      end
+
+      base.after(:all) do
+        puts
+      end
+    
+      class << base
+        alias :scenario :test
+      end
+    
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def story(story=nil)
+        @story = story if story
+        @story
+      end  
     end
 
-    base.after(:all) do
-      puts
+    def self.color=(color)
+      if color
+        @start_color = "\e[#{color}m"
+        @end_color   = "\e[0m"
+      else
+        @start_color = @end_color = nil
+      end
     end
     
-    class << base
-      alias :scenario :test
+    def self.color
+      [@start_color, @end_color]
     end
     
-    base.extend ClassMethods
-  end
-  
-  module ClassMethods
-    def story(story=nil)
-      @story = story if story
-      @story
-    end  
+    self.color = 36 # cyan
   end
 end

data/storyteller.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{storyteller}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nicol\303\241s Sanguinetti"]
   s.date = %q{2008-12-30}
   s.description = %q{Minimalist user story runner on top of test/unit}
   s.email = %q{contacto@nicolassanguinetti.info}
-  s.files = ["lib", "lib/storyteller.rb", "Rakefile", "README.markdown", "storyteller.gemspec", "VERSION.yml"]
+  s.files = ["lib", "lib/storyteller.rb", "Rakefile", "README.markdown", "storyteller.gemspec", "test", "test/fixtures", "test/fixtures/test_example.rb", "test/test_storyteller.rb", "VERSION.yml"]
   s.homepage = %q{http://nicolassanguinetti.info}
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{storyteller}

data/test/fixtures/test_example.rb

@@ -0,0 +1,17 @@
+class ExampleStorytellerTest < Test::Unit::TestCase
+  include Test::Storyteller
+  
+  story <<-EOS
+    As a tester
+    I want pretty output from my stories
+    So I can see how nice they look
+  EOS
+  
+  scenario "Running a successful scenario" do
+    assert true
+  end
+  
+  scenario "Running another scenario" do
+    assert true
+  end
+end

data/test/test_storyteller.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + "/../lib/storyteller"
+require "test/unit"
+require "redgreen"
+
+# Quick and dirty way to test our output
+class StdoutStub
+  attr_accessor :text
+  
+  def initialize
+    @text = ""
+  end
+  
+  def write(text)
+    @text += text.to_s
+  end
+
+  def puts(text)
+    write(text.to_s + "\n")
+  end
+  
+  def flush
+  end
+end
+
+class TestStoryteller < Test::Unit::TestCase
+  def test_it_displays_the_story_in_color
+    output = capturing_stdout { run_fixtures }
+    assert_match /\e\[36mAs a tester\nI want pretty output from my stories\nSo I can see how nice they look\n\e\[0m\e\[32m\.\e\[0m\e\[32m\.\e\[0m\n/, output
+  end
+  
+  private
+  
+    def run_fixtures
+      Test::Unit::AutoRunner.run(true, File.dirname(__FILE__) + "/fixtures", [])
+    end
+  
+    def capturing_stdout
+      old = $stdout
+      $> = StdoutStub.new
+      yield
+      output = $>.text
+      $> = old
+      output
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: foca-storyteller
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Nicol\xC3\xA1s Sanguinetti"
@@ -35,6 +35,10 @@ files:
 - Rakefile
 - README.markdown
 - storyteller.gemspec
+- test
+- test/fixtures
+- test/fixtures/test_example.rb
+- test/test_storyteller.rb
 - VERSION.yml
 has_rdoc: false
 homepage: http://nicolassanguinetti.info