rspec-longrun 0.0.1 → 0.0.2

data/README.md

@@ -23,40 +23,52 @@ Specify the custom output format when invoking RSpec, as follows:
 The resulting test output looks something like:
 
     Example group
-      First example
+      * First example
         OK
-      Second example
+      * Second example
         OK
-      Third example
+      * Third example
         PENDING (Not implemented yet)
 
+
 ### Tracking progress
 
-RSpec::Longrun defines a 'step' method that can be used to group blocks of code within the context of a large test.  For example:
+Include RSpec::Longrun::DSL to define the 'step' method, which can be used to group blocks of code within the context of a large test.  For example:
 
-    example "Log in and alter preferences" do
+    describe "Account management" do
 
-      step "Log in" do
-        # ...
-      end
+      include RSpec::Longrun::DSL     # <-- important
 
-      step "Navigate to preferences page" do
-        # ...
-      end
+      example "Log in and alter preferences" do
+
+        step "Log in" do
+          ui.go_home
+          ui.authenticate_as "joe", "fnord"
+        end
+
+        step "Navigate to preferences page" do
+          ui.nav.prefs_link.click
+        end
+
+        step "Change preferences" do
+          ui.prefs_pane.enter_defaults
+          ui.prefs_pane.save
+        end
 
-      step "Change preferences" do
-        # ...
       end
 
     end
 
 The resulting test output looks something like:
 
-    Log in and alter preferences
-      - Log in
-      - Navigate to preferences page
-      - Change preferences
-      OK
+    Account management
+      * Log in and alter preferences
+        - Log in
+        - Navigate to preferences page
+        - Change preferences
+        OK
+
+which gives you some extra context in the event that something fails, or hangs, during the test run.
 
 ## Contributing
 

data/lib/rspec/longrun/core_ext.rb

@@ -0,0 +1,45 @@
+require 'rspec/core/example'
+require 'rspec/core/example_group'
+require 'rspec/core/formatters/base_formatter'
+require 'rspec/core/reporter'
+
+# extend rspec-core with support for "steps"
+
+module RSpec::Core
+
+  class Reporter
+
+    def step_started(description)
+      notify :step_started, description
+    end
+
+    def step_finished(description)
+      notify :step_finished, description
+    end
+
+  end
+
+  class Formatters::BaseFormatter
+
+    def step_started(description)
+    end
+
+    def step_finished(description)
+    end
+
+  end
+
+  class Example
+
+    private
+
+    alias :start_without_reporter :start
+
+    def start(reporter)
+      start_without_reporter(reporter)
+      @example_group_instance.instance_variable_set(:@_rspec_reporter, reporter)
+    end
+
+  end
+
+end

data/lib/rspec/longrun/dsl.rb

@@ -1,58 +1,23 @@
-require 'rspec/core/example'
-require 'rspec/core/example_group'
-require 'rspec/core/formatters/base_formatter'
-require 'rspec/core/reporter'
+require 'rspec/longrun/core_ext'
 
 # extend rspec-core with support for "steps"
 
-module RSpec::Core
+module RSpec
+  module Longrun
+    module DSL
 
-  class Reporter
+      private
 
-    def step_started(description)
-      notify :step_started, description
-    end
-
-    def step_finished(description)
-      notify :step_finished, description
-    end
-
-  end
-
-  class Formatters::BaseFormatter
+      def step(description)
+        pending(description) unless block_given?
+        begin
+          @_rspec_reporter.step_started(description)
+          yield
+        ensure
+          @_rspec_reporter.step_finished(description)
+        end
+      end
 
-    def step_started(description)
     end
-
-    def step_finished(description)
-    end
-
   end
-
-  class Example
-
-    private
-
-    alias :start_without_reporter :start
-
-    def start(reporter)
-      start_without_reporter(reporter)
-      @example_group_instance.instance_variable_set(:@_rspec_reporter, reporter)
-    end
-
-  end
-
-  class ExampleGroup
-
-    private
-
-    def step(description)
-      @_rspec_reporter.step_started(description)
-      yield if block_given?
-    ensure
-      @_rspec_reporter.step_finished(description)
-    end
-
-  end
-
 end

data/lib/rspec/longrun/formatter.rb

@@ -22,7 +22,7 @@ module RSpec
 
       def example_started(example)
         super(example)
-        start_block(example.description)
+        start_block('* ' + cyan(example.description))
       end
 
       def example_passed(example)
@@ -32,7 +32,7 @@ module RSpec
 
       def example_pending(example)
         super(example)
-        end_block(yellow("PENDING (#{example.execution_result[:pending_message]})"))
+        end_block(yellow("PENDING: " + example.execution_result[:pending_message]))
       end
 
       def example_failed(example)
@@ -41,7 +41,7 @@ module RSpec
       end
 
       def step_started(description)
-        start_block('- ' + description)
+        start_block(faint('- ' + description))
       end
 
       def step_finished(description)
@@ -68,6 +68,10 @@ module RSpec
         '  ' * @indent_level
       end
 
+      def faint(text)
+        color(text, "\e[2m")
+      end
+
     end
 
   end

data/lib/rspec/longrun/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Longrun
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/rspec/longrun/formatter_spec.rb

@@ -3,6 +3,8 @@ require "stringio"
 
 describe RSpec::Longrun::Formatter do
 
+  include RSpec::Longrun::DSL
+
   let(:output_buffer) { StringIO.new }
   let(:formatter) { described_class.new(output_buffer) }
 
@@ -73,11 +75,11 @@ describe RSpec::Longrun::Formatter do
     it "outputs example names and status" do
       output.should eql(undent(<<-EOF))
         suite
-          works
+          * works
             OK
-          is unimplemented
-            PENDING (implement me)
-          fails
+          * is unimplemented
+            PENDING: implement me
+          * fails
             FAILED
       EOF
     end
@@ -88,6 +90,7 @@ describe RSpec::Longrun::Formatter do
 
     let(:suite) do
       RSpec::Core::ExampleGroup.describe("suite") do
+        include RSpec::Longrun::DSL
         example "has steps" do
           step "Collect underpants" do
           end
@@ -95,8 +98,7 @@ describe RSpec::Longrun::Formatter do
             step "(thinking)" do
             end
           end
-          step "Profit!" do
-          end
+          step "Profit!"
         end
       end
     end
@@ -105,12 +107,11 @@ describe RSpec::Longrun::Formatter do
       step "try steps" do
         output.should eql(undent(<<-EOF))
           suite
-            has steps
+            * has steps
               - Collect underpants
               - Er ...
                 - (thinking)
-              - Profit!
-              OK
+              PENDING: Profit!
         EOF
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-longrun
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -41,6 +41,7 @@ files:
 - README.md
 - Rakefile
 - lib/rspec/longrun.rb
+- lib/rspec/longrun/core_ext.rb
 - lib/rspec/longrun/dsl.rb
 - lib/rspec/longrun/formatter.rb
 - lib/rspec/longrun/version.rb
@@ -60,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -754123683182328035
+      hash: -1671641901183265154
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -69,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -754123683182328035
+      hash: -1671641901183265154
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23