citrusbyte-stories 0.0.4 → 0.0.5

data/lib/stories/runner/pdf.rb

@@ -0,0 +1,58 @@
+gem "prawn", "~> 0.4"
+require "prawn"
+
+module Stories
+  class Runner::PDF < Runner
+    def render_header(pdf)
+    end
+
+    def finished(elapsed_time)
+      super
+
+      Prawn::Document.generate("stories.pdf", :page_size => "A4") do |pdf|
+        render_header(pdf)
+
+        pdf.text "User Acceptance Tests", :size => 20, :style => :bold
+        
+        pdf.move_down(15)
+
+        $stories.each do |story|
+          pdf.text story.name, :style => :bold
+
+          story.scenarios.each_with_index do |scenario,i|
+            scenario_leading = 15
+
+            pdf.span(pdf.bounds.width - scenario_leading, :position => scenario_leading) do
+              pdf.text "— #{scenario.name}"
+
+              pdf.fill_color "666666"
+
+              unless scenario.steps.empty? && scenario.assertions.empty?
+                pdf.span(pdf.bounds.width - 30, :position => 30) do
+                  pdf.font_size(9) do
+                    render_many(pdf, scenario.steps)
+                    render_many(pdf, scenario.assertions)
+                  end
+                end
+              end
+
+              pdf.move_down(5) unless i + 1 == story.scenarios.size
+              
+              pdf.fill_color "000000"
+            end
+          end
+
+          pdf.move_down(10)
+        end
+      end
+    end
+
+    def render_many(pdf, elements)
+      elements.each do |el|
+        pdf.text el.to_s.gsub(/"([^"]+)"/) {
+          "“#{$1}”"
+        }
+      end
+    end
+  end
+end

data/lib/stories/runner.rb

@@ -0,0 +1,142 @@
+require 'test/unit/ui/console/testrunner'
+
+$stories = []
+
+class Test::Unit::TestCase
+  class << self
+    alias original_story story
+    alias original_scenario scenario
+
+    def story(name, &block)
+      story = Stories::Story.new(name)
+
+      original_story(name) do
+        @@story = story
+        instance_eval(&block)
+      end
+
+      $stories << story
+    end
+
+    def scenario(name, &block)
+      scenario = Stories::Scenario.new(name)
+
+      original_scenario(name) do
+        @scenario = scenario
+        instance_eval(&block)
+      end
+
+      @@story.scenarios << scenario
+    end
+  end
+end
+
+module Stories
+  class Story
+    attr_accessor :name, :scenarios
+
+    def initialize(name)
+      @name = name
+      @scenarios = []
+    end
+  end
+
+  class Scenario
+    attr_accessor :name, :steps, :assertions
+
+    def initialize(name)
+      @name = name
+      @steps = []
+      @assertions = []
+    end
+  end
+
+  class Runner < Test::Unit::UI::Console::TestRunner
+    def test_finished(name)
+    end
+
+    def add_fault(fault)
+      @faults << fault
+    end
+
+    def finished(elapsed_time)
+      puts
+
+      $stories.each_with_index do |story,i|
+        puts "- #{story.name}"
+
+        story.scenarios.each do |scenario|
+          puts "    #{scenario.name}"
+
+          unless scenario.steps.empty? && scenario.assertions.empty?
+            scenario.steps.each do |step|
+              puts "      #{step}"
+            end
+
+            scenario.assertions.each do |assertion|
+              puts "      #{assertion}"
+            end
+
+            puts
+          end
+        end
+
+        puts unless i + 1 == $stories.size
+      end
+
+      super
+      puts "%d stories, %d scenarios" % [$stories.size, $stories.inject(0) {|total,s| total + s.scenarios.size }]
+    end
+  end
+
+  module Webrat
+    def report(action, &block)
+      define_method(action) do |*args|
+        @scenario.steps << block.call(*args)
+        super
+      end
+    end
+
+    module_function :report
+  end
+end
+
+Test::Unit::AutoRunner::RUNNERS[:stories] = proc do |r|
+  Stories::Runner
+end
+
+Test::Unit::AutoRunner::RUNNERS[:"stories-pdf"] = proc do |r|
+  begin
+    Stories::Runner::PDF
+  rescue NameError
+    require File.expand_path(File.dirname(__FILE__) + "/runner/pdf")
+    Stories::Runner::PDF
+  end
+end
+
+# Common Webrat steps.
+module Stories::Webrat
+  report :click_link do |name|
+    "Click #{name.inspect}"
+  end
+  
+  report :click_button do |name|
+    "Click #{name.inspect}"
+  end
+
+  report :fill_in do |name, opts|
+    "Fill in #{name.inspect} with #{opts[:with].inspect}"
+  end
+
+  report :visit do |page|
+    "Go to #{page.inspect}"
+  end
+  
+  report :check do |name|
+    "Check #{name.inspect}"
+  end
+
+  report :assert_contain do |text|
+    "I should see #{text.inspect}"
+  end
+end

data/lib/stories.rb

@@ -2,30 +2,16 @@ require "rubygems"
 require "contest"
 
 class Test::Unit::TestCase
-  @@stories = []
-
   class << self
+    alias story context
     alias scenario test
-
-    def story(name, &block)
-      @@stories << name
-      context(name, &block)
-    end
-
-    def stories
-      @@stories
-    end
   end
 end
 
-at_exit do
-  unless Test::Unit::TestCase.stories.empty?
-    puts
-
-    Test::Unit::TestCase.stories.each do |s|
-      puts "- #{s}"
-    end
+Test::Unit::AutoRunner::RUNNERS[:stories] = proc do |r|
+  puts "Story runner not found. You need to require 'stories/runner'."
+end
 
-    puts
-  end
+Test::Unit::AutoRunner::RUNNERS[:"stories-pdf"] = proc do |r|
+  puts "Story runner not found. You need to require 'stories/runner'."
 end

data/rails/init.rb

@@ -1,9 +1,13 @@
 if RAILS_ENV == 'test'
 
+  require File.dirname(__FILE__) + "/../lib/stories/runner"
+
   # Require webrat and configure it to work in Rails mode.
   require "webrat"
 
   Webrat.configure do |config|
     config.mode = :rails
   end
+
+  ActionController::IntegrationTest.send(:include, Stories::Webrat)
 end

data/test/all_test.rb

@@ -1,4 +1,8 @@
 require File.dirname(__FILE__) + "/../lib/stories"
+require File.dirname(__FILE__) + "/../lib/stories/runner"
+
+# Use the story runner by default.
+Test::Unit::AutoRunner::RUNNERS[:console] = Proc.new {|r| Stories::Runner }
 
 class UserStoryTest < Test::Unit::TestCase
   story "As a user I want to create stories so I can test if they pass" do

data/test/pdf_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + "/../lib/stories"
+require File.dirname(__FILE__) + "/../lib/stories/runner"
+require File.dirname(__FILE__) + "/../lib/stories/runner/pdf"
+
+class Stories::Runner::PDF
+  def render_header(pdf)
+    pdf.text "My custom header", :size => 20, :style => :bold
+    pdf.move_down 20
+  end
+end
+
+# Use the story runner by default.
+Test::Unit::AutoRunner::RUNNERS[:console] = Proc.new {|r| Stories::Runner::PDF }
+
+class UserStoryTest < Test::Unit::TestCase
+  story "As a user I want to create stories so I can test if they pass" do
+    setup do
+      @user = "valid user"
+    end
+
+    scenario "A valid user" do
+      assert_equal "valid user", @user
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: citrusbyte-stories
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Damian Janowski
@@ -32,12 +32,15 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/stories/runner/pdf.rb
+- lib/stories/runner.rb
 - lib/stories.rb
 - README.markdown
 - LICENSE
 - Rakefile
 - rails/init.rb
 - test/all_test.rb
+- test/pdf_test.rb
 has_rdoc: false
 homepage: http://github.com/citrusbyte/stories
 post_install_message: