rspec-longrun 1.0.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7b0d901e0ecd2a67b69060390b5264b9f76b3790017bf6078e0dc58ad8149b9
+  data.tar.gz: ae6d4575321836e4543825ad7ef9f478a71ed763a78f663b58ffe128bf7ab53c
+SHA512:
+  metadata.gz: 0e1046bb744651efb275009ba7ddae501689ceab9e6702dbed4a4453d42250980fa82f47e345e0483545197f77d2f866a1f568b67560dff2877af10460793cd4
+  data.tar.gz: 04adfebac8fd026560a8dfb675a75f4b01eeb130dba732ff228acf7a5f0878982905ad1c57ea868ee666ba9d0117e701969dafbe665b0f5b0ac32a6b6ff9b3e1

data/.travis.yml

@@ -1,7 +1,3 @@
 language: ruby
 env:
-  - RSPEC_VERSION="~> 2.10.0"
-  - RSPEC_VERSION="~> 2.11.0"
-  - RSPEC_VERSION="~> 2.12.0"
-  - RSPEC_VERSION="~> 2.13.0"
-  - RSPEC_VERSION="~> 2.14.0"
+  - RSPEC_VERSION="~> 3.7.0"

data/README.md

@@ -1,5 +1,8 @@
 # RSpec::Longrun
 
+[![Gem Version](https://badge.fury.io/rb/rspec-longrun.png)](http://badge.fury.io/rb/rspec-longrun)
+[![Build Status](https://secure.travis-ci.org/mdub/rspec-longrun.png?branch=master)](http://travis-ci.org/mdub/rspec-longrun)
+
 RSpec is a fine unit-testing framework, but is also handy for acceptance and integration tests.  But the default report formatters make it difficult to track progress of such long-running tests.
 
 The RSpec::Longrun::Formatter outputs the name of each test as it starts, rather than waiting until it passes or fails.  It also provides a mechanism for reporting on progress of a test while it is still executing.
@@ -34,29 +37,31 @@ The resulting test output looks something like:
 
 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:
 
-    describe "Account management" do
+```ruby
+describe "Account management" do
 
-      include RSpec::Longrun::DSL     # <-- important
+  include RSpec::Longrun::DSL     # <-- important
 
-      example "Log in and alter preferences" do
+  example "Log in and alter preferences" do
 
-        step "Log in" do
-          ui.go_home
-          ui.authenticate_as "joe", "fnord"
-        end
+    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 "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
+      ui.prefs_pane.enter_defaults
+      ui.prefs_pane.save
+    end
 
-      end
+  end
 
-    end
+end
+```
 
 The resulting test output looks something like:
 

data/Rakefile

@@ -5,7 +5,7 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/**/*_spec.rb'
-  t.rspec_opts = ["--colour", "--format", "nested"]
+  t.rspec_opts = ["--colour", "--format", "documentation"]
 end
 
 task :default => :spec

data/examples/example_spec.rb

@@ -12,7 +12,7 @@ describe "Underpants gnomes" do
       sleep 0.3 # thinking
     end
     step "Profit!" do
-      pending "need a real business plan"
+      skip "need a real business plan"
     end
   end
 

data/examples/nested_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'rspec/longrun'
+
+RSpec.describe("foo") do
+  describe "bar" do
+    describe "baz" do
+      it "bleeds"
+    end
+  end
+  describe "qux" do
+    it "hurts"
+  end
+end

data/examples/status_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'rspec/longrun'
+
+RSpec.describe("suite") do
+  example "works" do; end
+  example "is unimplemented" do
+    pending "implement me"
+    raise "not implemented"
+  end
+  example "fails" do
+    fail "no worky"
+  end
+end

data/examples/stepped_spec.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'rspec/longrun'
+
+RSpec.describe("stepped") do
+
+  include RSpec::Longrun::DSL
+
+  example "has steps" do
+    step "Collect underpants" do
+    end
+    step "Er ..." do
+      step "(thinking)" do
+      end
+    end
+    step "Profit!" do
+      pending "a real plan"
+      fail
+    end
+  end
+
+end

data/lib/rspec/longrun/dsl.rb

@@ -1,23 +1,37 @@
-require 'rspec/longrun/core_ext'
-
-# extend rspec-core with support for "steps"
-
 module RSpec
   module Longrun
     module DSL
 
-      private
-
       def step(description)
-        pending(description) unless block_given?
+        rspec_longrun_formatter.step_started(description)
         begin
-          @_rspec_reporter.step_started(description)
-          yield
-        ensure
-          @_rspec_reporter.step_finished(description)
+          yield if block_given?
+          rspec_longrun_formatter.step_finished
+        rescue => e
+          rspec_longrun_formatter.step_errored(e)
+          raise e
         end
       end
 
+      private
+
+      def rspec_longrun_formatter
+        Thread.current["rspec.longrun.formatter"] || NullStepFormatter.new
+      end
+
+      class NullStepFormatter
+
+        def step_started(_description)
+        end
+
+        def step_finished
+        end
+
+        def step_errored(_e)
+        end
+
+      end
+
     end
   end
 end

data/lib/rspec/longrun/formatter.rb

@@ -5,64 +5,63 @@ module RSpec
 
     class Formatter < RSpec::Core::Formatters::BaseTextFormatter
 
+      RSpec::Core::Formatters.register self,
+        :start,
+        :example_group_started, :example_group_finished,
+        :example_started, :example_passed,
+        :example_pending, :example_failed
+
       def initialize(output)
         super(output)
         @blocks = [Block.new(true)]
       end
 
-      def example_group_started(example_group)
-        super(example_group)
-        begin_block(example_group.description)
+      def start(notification)
+        Thread.current["rspec.longrun.formatter"] = self
+      end
+
+      def example_group_started(notification)
+        begin_block(notification.group.description)
       end
 
-      def example_group_finished(example_group)
-        super(example_group)
+      def example_group_finished(notification)
         end_block
       end
 
-      def example_started(example)
-        super(example)
-        begin_block(detail_color(example.description))
+      def example_started(notification)
+        begin_block(wrap(notification.example.description, :detail))
       end
 
-      def example_passed(example)
-        super(example)
-        end_block(success_color("OK"))
+      def example_passed(notification)
+        end_block(wrap("OK", :success))
       end
 
-      def example_pending(example)
-        super(example)
-        end_block(pending_color("PENDING: " + example.execution_result[:pending_message]))
+      def example_pending(notification)
+        end_block(wrap("PENDING: " + notification.example.execution_result.pending_message, :pending))
       end
 
-      def example_failed(example)
-        super(example)
-        end_block(failure_color("FAILED"))
+      def example_failed(notification)
+        end_block(wrap("FAILED", :failure))
       end
 
       def step_started(description)
         begin_block(description)
       end
 
-      def step_finished(description)
-        end_block
+      def step_finished
+        end_block(wrap("✓", :success))
       end
 
-      protected
-
-      def self.alias_missing_method(method_name, fallback_method_name)
-        unless method_defined?(method_name)
-          alias_method method_name, fallback_method_name
-        end
+      def step_errored(e)
+        end_block(wrap("✗", :failure))
       end
 
-      alias_missing_method :detail_color, :cyan
-      alias_missing_method :success_color, :green
-      alias_missing_method :pending_color, :yellow
-      alias_missing_method :failure_color, :red
-
       private
 
+      def wrap(*args)
+        RSpec::Core::Formatters::ConsoleCodes.wrap(*args)
+      end
+
       def current_block
         @blocks.last
       end
@@ -98,7 +97,8 @@ module RSpec
       end
 
       def faint(text)
-        color(text, "\e[2m")
+        return text unless RSpec.configuration.color_enabled?
+        "\e[2m#{text}\e[0m"
       end
 
       class Block

data/lib/rspec/longrun/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Longrun
-    VERSION = "1.0.1"
+    VERSION = "2.0.0"
   end
 end

data/rspec-longrun.gemspec

@@ -13,6 +13,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = RSpec::Longrun::VERSION
 
-  gem.add_runtime_dependency("rspec-core", ">= 2.10.0")
+  gem.add_runtime_dependency("rspec-core", ">= 3.7.0")
 
 end

data/spec/rspec/longrun/formatter_spec.rb

@@ -4,17 +4,6 @@ require "stringio"
 describe RSpec::Longrun::Formatter do
 
   let(:output_buffer) { StringIO.new }
-  let(:formatter) { described_class.new(output_buffer) }
-  let(:reporter) { RSpec::Core::Reporter.new(formatter) }
-
-  def undent(raw)
-    if raw =~ /\A( +)/
-      indent = $1
-      raw.gsub(/^#{indent}/, '').gsub(/ +$/, '')
-    else
-      raw
-    end
-  end
 
   def output
     output_buffer.string
@@ -24,46 +13,47 @@ describe RSpec::Longrun::Formatter do
     output.gsub(/0\.\d\ds/, "N.NNs")
   end
 
-  module NoColor
+  let(:formatter) { described_class.new(output_buffer) }
 
-    def color_enabled?
-      false
-    end
+  before do
+    allow(RSpec.configuration).to receive(:color_enabled?).and_return(false)
+  end
 
+  def example_group(desc)
+    notification = double(group: double(description: desc))
+    formatter.example_group_started(notification)
+    yield if block_given?
+    formatter.example_group_finished(notification)
   end
 
-  before do
-    formatter.extend(NoColor)
-    suite.run(reporter)
+  def example(desc, result, pending_message = nil)
+    notification = double(
+      example: double(
+        description: desc,
+        execution_result: double(pending_message: pending_message)
+      )
+    )
+    formatter.example_started(notification)
+    yield if block_given?
+    formatter.public_send("example_#{result}", notification)
+  end
+
+  def step(desc)
+    formatter.step_started(desc)
+    yield if block_given?
+    formatter.step_finished
   end
 
-  context "for nested example groups" do
+  context "given an empty example group" do
 
-    let(:suite) do
-      RSpec::Core::ExampleGroup.describe("foo") do
-        describe "bar" do
-          describe "baz" do
-            it "bleeds"
-          end
-        end
-        describe "qux" do
-          it "hurts"
-        end
+    before do
+      example_group "suite" do
       end
     end
 
-    it "outputs nested group names" do
-      normalized_output.should eql(undent(<<-EOF))
-        foo {
-          bar {
-            baz {
-              bleeds PENDING: Not yet implemented (N.NNs)
-            } (N.NNs)
-          } (N.NNs)
-          qux {
-            hurts PENDING: Not yet implemented (N.NNs)
-          } (N.NNs)
-        } (N.NNs)
+    it "outputs suite entry" do
+      expect(normalized_output).to eql(<<~EOF)
+        suite (N.NNs)
       EOF
     end
 
@@ -71,24 +61,46 @@ describe RSpec::Longrun::Formatter do
 
   context "with examples" do
 
-    let(:suite) do
-      RSpec::Core::ExampleGroup.describe("suite") do
-        example "works" do; end
-        example "is unimplemented" do
-          pending "implement me"
-        end
-        example "fails" do
-          fail "no worky"
-        end
+    before do
+      example_group "suite" do
+        example "works", :passed
+        example "fails", :failed
+        example "is unimplemented", :pending, "implement me"
       end
     end
 
     it "outputs example names and status" do
-      normalized_output.should eql(undent(<<-EOF))
+      expect(normalized_output).to eql(<<~EOF)
         suite {
           works OK (N.NNs)
-          is unimplemented PENDING: implement me (N.NNs)
           fails FAILED (N.NNs)
+          is unimplemented PENDING: implement me (N.NNs)
+        } (N.NNs)
+      EOF
+    end
+
+  end
+
+  context "with nested example groups" do
+
+    before do
+      example_group "top" do
+        example_group "A" do
+        end
+        example_group "B" do
+          example_group "1" do
+          end
+        end
+      end
+    end
+
+    it "outputs nested group names" do
+      expect(normalized_output).to eql(<<~EOF)
+        top {
+          A (N.NNs)
+          B {
+            1 (N.NNs)
+          } (N.NNs)
         } (N.NNs)
       EOF
     end
@@ -97,10 +109,9 @@ describe RSpec::Longrun::Formatter do
 
   context "with steps" do
 
-    let(:suite) do
-      RSpec::Core::ExampleGroup.describe("suite") do
-        include RSpec::Longrun::DSL
-        example "has steps" do
+    before do
+      example_group "suite" do
+        example "has steps", :passed do
           step "Collect underpants" do
           end
           step "Er ..." do
@@ -113,14 +124,15 @@ describe RSpec::Longrun::Formatter do
     end
 
     it "outputs steps" do
-      normalized_output.should eql(undent(<<-EOF))
+      expect(normalized_output).to eql(<<~EOF)
         suite {
           has steps {
-            Collect underpants (N.NNs)
+            Collect underpants ✓ (N.NNs)
             Er ... {
-              (thinking) (N.NNs)
-            } (N.NNs)
-          } PENDING: Profit! (N.NNs)
+              (thinking) ✓ (N.NNs)
+            } ✓ (N.NNs)
+            Profit! ✓ (N.NNs)
+          } OK (N.NNs)
         } (N.NNs)
       EOF
     end

metadata

@@ -1,32 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-longrun
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 3.7.0
 description: 
 email:
 - mdub@dogbiscuit.org
@@ -34,16 +31,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - examples/example_spec.rb
+- examples/nested_spec.rb
+- examples/status_spec.rb
+- examples/stepped_spec.rb
 - 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
@@ -51,33 +50,26 @@ files:
 - spec/rspec/longrun/formatter_spec.rb
 homepage: http://github.com/mdub/rspec-longrun
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1047382986774099312
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1047382986774099312
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An RSpec formatter for long-running specs.
 test_files:
 - spec/rspec/longrun/formatter_spec.rb

data/lib/rspec/longrun/core_ext.rb

@@ -1,50 +0,0 @@
-require 'rspec/core'
-require 'rspec/core/formatters/base_formatter'
-
-# extend rspec-core with support for "steps"
-module RSpec::Core
-
-  class Reporter
-
-    if defined?(NOTIFICATIONS)
-      NOTIFICATIONS.push("step_started", "step_finished")
-    end
-
-    def step_started(description)
-      notify :step_started, description
-    end
-
-    def step_finished(description)
-      notify :step_finished, description
-    end
-
-  end
-
-  unless defined?(Reporter::NOTIFICATIONS)
-
-    class Formatters::BaseFormatter
-
-      def step_started(description)
-      end
-
-      def step_finished(description)
-      end
-
-    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