dchelimsky-rspec-stories 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+=== Version 0.9.0.0 / 2009-01-09
+
+* Major enhancements
+ 
+  * Extracted RSpec's Story Runner into it's own gem.

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2005-2008 The RSpec Development Team
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,78 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+lib/spec/runner/formatter/story/html_formatter.rb
+lib/spec/runner/formatter/story/plain_text_formatter.rb
+lib/spec/runner/formatter/story/progress_bar_formatter.rb
+lib/spec/runner/options_extensions.rb
+lib/spec/stories.rb
+lib/spec/story/extensions.rb
+lib/spec/story/extensions/main.rb
+lib/spec/story/extensions/regexp.rb
+lib/spec/story/extensions/string.rb
+lib/spec/story/given_scenario.rb
+lib/spec/story/runner.rb
+lib/spec/story/runner/plain_text_story_runner.rb
+lib/spec/story/runner/scenario_collector.rb
+lib/spec/story/runner/scenario_runner.rb
+lib/spec/story/runner/story_mediator.rb
+lib/spec/story/runner/story_parser.rb
+lib/spec/story/runner/story_runner.rb
+lib/spec/story/scenario.rb
+lib/spec/story/step.rb
+lib/spec/story/step_group.rb
+lib/spec/story/step_mother.rb
+lib/spec/story/story.rb
+lib/spec/story/version.rb
+lib/spec/story/world.rb
+resources/rake/verify_rcov.rake
+rspec-stories.gemspec
+spec/spec.opts
+spec/spec/runner/formatter/story/html_formatter_spec.rb
+spec/spec/runner/formatter/story/plain_text_formatter_spec.rb
+spec/spec/runner/formatter/story/progress_bar_formatter_spec.rb
+spec/spec/runner/most_recent_spec.rb
+spec/spec/runner/options_extensions_spec.rb
+spec/spec/runner/resources/a_bar.rb
+spec/spec/runner/resources/a_foo.rb
+spec/spec/runner/resources/a_spec.rb
+spec/spec/runner/resources/custom_example_group_runner.rb
+spec/spec/runner/resources/utf8_encoded.rb
+spec/spec/runner_spec.rb
+spec/spec/spec_classes.rb
+spec/spec/story/builders.rb
+spec/spec/story/extensions/main_spec.rb
+spec/spec/story/extensions_spec.rb
+spec/spec/story/given_scenario_spec.rb
+spec/spec/story/runner/plain_text_story_runner_spec.rb
+spec/spec/story/runner/scenario_collector_spec.rb
+spec/spec/story/runner/scenario_runner_spec.rb
+spec/spec/story/runner/story_mediator_spec.rb
+spec/spec/story/runner/story_parser_spec.rb
+spec/spec/story/runner/story_runner_spec.rb
+spec/spec/story/runner_spec.rb
+spec/spec/story/scenario_spec.rb
+spec/spec/story/step_group_spec.rb
+spec/spec/story/step_mother_spec.rb
+spec/spec/story/step_spec.rb
+spec/spec/story/story_helper.rb
+spec/spec/story/story_spec.rb
+spec/spec/story/world_spec.rb
+spec/spec_helper.rb
+story_server/prototype/javascripts/builder.js
+story_server/prototype/javascripts/controls.js
+story_server/prototype/javascripts/dragdrop.js
+story_server/prototype/javascripts/effects.js
+story_server/prototype/javascripts/prototype.js
+story_server/prototype/javascripts/rspec.js
+story_server/prototype/javascripts/scriptaculous.js
+story_server/prototype/javascripts/slider.js
+story_server/prototype/javascripts/sound.js
+story_server/prototype/javascripts/unittest.js
+story_server/prototype/lib/server.rb
+story_server/prototype/stories.html
+story_server/prototype/stylesheets/rspec.css
+story_server/prototype/stylesheets/test.css

data/README.txt

@@ -0,0 +1,23 @@
+= RSpec Story Runner
+
+* http://rspec.info
+* http://rubyforge.org/projects/rspec-stories
+* http://github.com/dchelimsky/rspec/wikis
+* mailto:rspec-devel@rubyforge.org
+
+== DESCRIPTION:
+
+This is the RSpec Story Runner (formerly RBehave) extracted from RSpec. We extracted it because Cucumber (http://github.com/aslakhellesoy/cucumber) is the new Story Runner, so we don't plan to maintain the original Story Runner any longer, but we don't want to force you to migrate to Cucumber in order to upgrade RSpec (which will no longer ship with the Story Runner).
+
+Many thanks to Chad Humphries for extracting this out from RSpec and untangling a few dependencies so this could stand on its own as a gem.
+
+== INSTALL:
+
+  [sudo] gem install dchelimsky-rspec-stories
+
+ or
+
+  git clone git://github.com/dchelimsky/rspec-stories.git
+  cd rspec-stories
+  rake gem
+  rake install_gem

data/Rakefile

@@ -0,0 +1,87 @@
+# -*- ruby -*-
+
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'rubygems'
+require 'hoe'
+require 'spec/story/version'
+require 'spec/rake/spectask'
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+Hoe.new('rspec-stories', Spec::Story::VERSION::STRING) do |p|
+  p.summary = Spec::Story::VERSION::SUMMARY
+  p.url = 'http://rspec.info/'
+  p.description = "Behaviour Driven Development for Ruby."
+  p.rubyforge_name = 'rspec-stories'
+  p.developer('RSpec Development Team', 'rspec-devel@rubyforge.org')
+  p.extra_deps = [["rspec",">= 1.1.11"]]
+  p.remote_rdoc_dir = "rspec-stories/#{Spec::Story::VERSION::STRING}"
+end
+
+['audit','test','test_deps','default','post_blog'].each do |task|
+  Rake.application.instance_variable_get('@tasks').delete(task)
+end
+
+task :verify_rcov => :spec
+task :default => :verify_rcov
+
+load File.dirname(__FILE__) + '/resources/rake/verify_rcov.rake'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  unless ENV['NO_RCOV']
+    t.rcov = true
+    t.rcov_dir = 'coverage'
+    t.rcov_opts = ['--exclude', "lib/spec.rb,lib/spec/runner.rb,spec\/spec,bin\/spec,examples,\/gems,\/Library\/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+  end
+end
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /(FIXME|TODO|TBD)/
+end
+
+desc "verify_committed, verify_rcov, post_news, release"
+task :complete_release => [:verify_committed, :verify_rcov, :post_news, :release]
+
+desc "Verifies that there is no uncommitted code"
+task :verify_committed do
+  IO.popen('git status') do |io|
+    io.each_line do |line|
+      raise "\n!!! Do a git commit first !!!\n\n" if line =~ /^#\s*modified:/
+    end
+  end
+end
+
+namespace :update do
+  desc "update the manfest"
+  task :manifest do
+    system %q[touch Manifest.txt; rake check_manifest | grep -v "(in " | patch]
+  end
+  
+  desc "update the gemspec"
+  task :gemspec do
+    system %q[rake debug_gem | grep -v "(in " | grep -v "s.add_dependency(%q<hoe" > `basename \\`pwd\\``.gemspec]
+  end
+end

data/init.rb

@@ -0,0 +1,4 @@
+# Placeholder to satisfy Rails.
+#
+# Do NOT add any require statements to this file. Doing
+# so will cause Rails to load this plugin all of the time.

data/lib/spec/runner/formatter/story/html_formatter.rb

@@ -0,0 +1,174 @@
+require 'erb'
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        class HtmlFormatter < BaseTextFormatter
+          include ERB::Util
+          
+          def initialize(options, where)
+            super
+            @previous_type = nil
+            @scenario_text = ""
+            @story_text = ""
+            @scenario_failed = false
+            @story_failed = false
+          end
+          
+          def run_started(count)
+            @output.puts <<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Stories</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Expires" content="-1" />
+    <meta http-equiv="Pragma" content="no-cache" />
+    <script src="javascripts/prototype.js" type="text/javascript"></script>
+    <script src="javascripts/scriptaculous.js" type="text/javascript"></script>
+    <script src="javascripts/rspec.js" type="text/javascript"></script>
+    <link href="stylesheets/rspec.css" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    <div id="container">
+EOF
+          end
+
+          def collected_steps(steps)
+            unless steps.empty?
+              @output.puts "      <ul id=\"stock_steps\" style=\"display: none;\">"
+              steps.each do |step|
+                @output.puts "        <li>#{step}</li>"
+              end
+              @output.puts "      </ul>"
+            end
+          end
+
+          def run_ended
+            @output.puts <<-EOF
+    </div>
+  </body>
+</head>
+EOF
+          end
+          
+          def story_started(title, narrative)
+            @story_failed = false
+            @story_text = <<-EOF 
+        <dt>Story: #{h title}</dt>
+        <dd>
+          <p>
+            #{h(narrative).split("\n").join("<br />")}
+          </p>
+EOF
+          end
+
+          def story_ended(title, narrative)     
+            if @story_failed
+              @output.puts <<-EOF
+      <dl class="story failed">
+EOF
+            else
+              @output.puts <<-EOF
+      <dl class="story passed">
+EOF
+            end
+              @output.puts <<-EOF
+#{@story_text}
+        </dd>
+      </dl>
+EOF
+          end
+     
+          def scenario_started(story_title, scenario_name)
+            @previous_type = nil
+            @scenario_failed = false
+            @scenario_text = <<-EOF
+              <dt>Scenario: #{h scenario_name}</dt>
+              <dd>
+                <ul class="steps">
+EOF
+          end
+
+          def scenario_ended
+            if @scenario_failed
+              @story_text += <<-EOF
+            <dl class="failed">
+EOF
+            else
+              @story_text += <<-EOF
+            <dl class="passed">
+EOF
+            end
+            
+            @story_text += <<-EOF
+#{@scenario_text}
+                </ul>
+              </dd>
+            </dl>
+EOF
+          end
+          
+          def found_scenario(type, description)
+          end
+
+          def scenario_succeeded(story_title, scenario_name)
+            scenario_ended
+          end
+
+          def scenario_pending(story_title, scenario_name, reason)
+            scenario_ended
+          end
+
+          def scenario_failed(story_title, scenario_name, err)
+            @scenario_failed = true
+            @story_failed = true
+            scenario_ended
+          end
+
+          def step_upcoming(type, description, *args)
+          end
+
+          def step_succeeded(type, description, *args)
+            print_step('passed', type, description, *args) # TODO: uses succeeded CSS class
+          end
+
+          def step_pending(type, description, *args)
+            print_step('pending', type, description, *args)
+          end
+
+          def step_failed(type, description, *args)
+            print_step('failed', type, description, *args)
+          end
+          
+          def print_step(klass, type, description, *args)
+            spans = args.map { |arg| "<span class=\"param\">#{arg}</span>" }
+            desc_string = description.step_name
+            arg_regexp = description.arg_regexp           
+            inner = if(type == @previous_type)
+              "And "
+            else
+              "#{type.to_s.capitalize} "
+            end
+            i = -1
+            inner += desc_string.gsub(arg_regexp) { |param| spans[i+=1] }
+            
+            @scenario_text += "                  <li class=\"#{klass}\">#{inner}</li>\n"
+            
+            if type == :'given scenario'
+              @previous_type = :given
+            else
+              @previous_type = type
+            end
+            
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec/runner/formatter/story/plain_text_formatter.rb

@@ -0,0 +1,194 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        class PlainTextFormatter < ::Spec::Runner::Formatter::BaseTextFormatter
+          def initialize(options, where)
+            super
+            @successful_scenario_count = 0
+            @pending_scenario_count = 0
+            
+            @pre_story_pending_count = 0
+            @pre_story_successful_count = 0
+            
+            @failed_scenarios = []
+            @pending_steps = []
+            @previous_type = nil 
+            
+            @scenario_body_text = ""
+            @story_body_text = ""
+            
+            @scenario_head_text = ""
+            @story_head_text = ""
+                  
+            @scenario_failed = false
+            @story_failed = false
+          end
+        
+          def run_started(count)
+            @count = count
+            @output.puts "Running #@count scenarios\n\n"
+          end
+
+          def story_started(title, narrative)
+            @pre_story_pending_count = @pending_scenario_count
+            @pre_story_successful_count = @successful_scenario_count
+            
+            @current_story_title = title
+            @story_failed = false
+            @story_body_text = ""
+            @story_head_text = "Story: #{title}\n\n"
+
+            narrative.each_line do |line|
+              @story_head_text += "  "
+              @story_head_text += line
+            end
+          end
+        
+          def story_ended(title, narrative)
+            if @story_failed
+              @output.print red(@story_head_text)
+            elsif @pre_story_successful_count == @successful_scenario_count && 
+                  @pending_scenario_count >= @pre_story_pending_count
+              @output.print yellow(@story_head_text)
+            else              
+              @output.print green(@story_head_text)
+            end
+            @output.print @story_body_text
+            @output.puts
+            @output.puts
+          end
+
+          def scenario_started(story_title, scenario_name)
+            @current_scenario_name = scenario_name
+            @scenario_already_failed = false
+            @scenario_head_text = "\n\n  Scenario: #{scenario_name}"
+            @scenario_body_text = ""
+            @scenario_ok = true
+            @scenario_pending = false
+            @scenario_failed = false
+          end
+        
+          def scenario_succeeded(story_title, scenario_name)
+            @successful_scenario_count += 1
+            scenario_ended
+          end
+        
+          def scenario_failed(story_title, scenario_name, err)
+            @options.backtrace_tweaker.tweak_backtrace(err)
+            @failed_scenarios << [story_title, scenario_name, err] unless @scenario_already_failed
+            @scenario_already_failed = true
+            @story_failed = true
+            @scenario_failed = true
+            scenario_ended
+          end
+        
+          def scenario_pending(story_title, scenario_name, msg)
+            @pending_scenario_count += 1 unless @scenario_already_failed
+            @scenario_pending = true
+            @scenario_already_failed = true
+            scenario_ended
+          end
+        
+          def scenario_ended
+            if @scenario_failed
+              @story_body_text += red(@scenario_head_text)
+            elsif @scenario_pending
+              @story_body_text += yellow(@scenario_head_text)
+            else
+              @story_body_text += green(@scenario_head_text)
+            end
+            @story_body_text += @scenario_body_text
+          end
+          
+          def run_ended
+            summary_text = "#@count scenarios: #@successful_scenario_count succeeded, #{@failed_scenarios.size} failed, #@pending_scenario_count pending"
+            if !@failed_scenarios.empty?
+              @output.puts red(summary_text)
+            elsif !@pending_steps.empty?
+              @output.puts yellow(summary_text)
+            else
+              @output.puts green(summary_text)
+            end
+            unless @pending_steps.empty?
+              @output.puts "\nPending Steps:"
+              @pending_steps.each_with_index do |pending, i|
+                story_name, scenario_name, msg = pending
+                @output.puts "#{i+1}) #{story_name} (#{scenario_name}): #{msg}"
+              end
+            end
+            unless @failed_scenarios.empty?
+              @output.print "\nFAILURES:"
+              @failed_scenarios.each_with_index do |failure, i|
+                title, scenario_name, err = failure
+                @output.print "\n    #{i+1}) "
+                @output.print red("#{title} (#{scenario_name}) FAILED")
+                @output.print red("\n    #{err.class}: #{err.message}")
+                @output.print "\n    #{err.backtrace.join("\n")}\n"
+              end
+            end            
+          end
+
+          def step_upcoming(type, description, *args)
+          end
+                  
+          def step_succeeded(type, description, *args)
+            found_step(type, description, false, false, *args)
+          end
+        
+          def step_pending(type, description, *args)
+            found_step(type, description, false, true, *args)
+            @pending_steps << [@current_story_title, @current_scenario_name, description]
+            @scenario_body_text +=  yellow(" (PENDING)")
+            @scenario_pending = true
+            @scenario_ok = false
+          end
+        
+          def step_failed(type, description, *args)
+            found_step(type, description, true, @scenario_pending, *args)
+            if @scenario_pending
+              @scenario_body_text +=  yellow(" (SKIPPED)")
+            else
+              @scenario_body_text +=  red(@scenario_ok ? " (FAILED)" : " (SKIPPED)")
+            end
+            @scenario_ok = false
+          end
+          
+          def collected_steps(steps)
+          end
+          
+          def method_missing(sym, *args, &block) #:nodoc:
+            # noop - ignore unknown messages
+          end
+
+        private
+
+          def found_step(type, description, failed, pending, *args)
+            desc_string = description.step_name
+            arg_regexp = description.arg_regexp
+            text = if(type == @previous_type)
+              "\n    And "
+            else
+              "\n\n    #{type.to_s.capitalize} "
+            end
+            i = -1
+            text << desc_string.gsub(arg_regexp) { |param| args[i+=1] }
+            if pending
+              @scenario_body_text += yellow(text)
+            else
+              @scenario_body_text += (failed ? red(text) : green(text))
+            end
+
+            if type == :'given scenario'
+              @previous_type = :given
+            else
+              @previous_type = type
+            end
+          end
+        end
+      end
+    end
+  end
+end