rspec-longrun 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+coverage
+doc/
+pkg
+rdoc
+spec/reports
+tmp

data/.rspec

@@ -0,0 +1 @@
+-r rspec/longrun -f RSpec::Longrun::Formatter --color

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gemspec
+
+gem "rake"
+gem "rspec"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mike Williams
+
+MIT License
+
+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/README.md

@@ -0,0 +1,63 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-longrun'
+
+In a Rails project, you can safely limit it to the "test" group.
+
+## Usage
+
+### Running tests
+
+Specify the custom output format when invoking RSpec, as follows:
+
+    rspec -r rspec/longrun -f RSpec::Longrun::Formatter spec ...
+
+The resulting test output looks something like:
+
+    Example group
+      First example
+        OK
+      Second example
+        OK
+      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:
+
+    example "Log in and alter preferences" do
+
+      step "Log in" do
+        # ...
+      end
+
+      step "Navigate to preferences page" do
+        # ...
+      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
+
+## Contributing
+
+rspec-longrun is on Github. You know what to do.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--colour", "--format", "nested"]
+end
+
+task :default => :spec

data/lib/rspec/longrun.rb

@@ -0,0 +1,4 @@
+require "rspec/longrun/dsl"
+require "rspec/longrun/formatter"
+require "rspec/longrun/version"
+

data/lib/rspec/longrun/dsl.rb

@@ -0,0 +1,58 @@
+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
+
+  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

@@ -0,0 +1,74 @@
+require "rspec/core/formatters/base_text_formatter"
+
+module RSpec
+  module Longrun
+
+    class Formatter < RSpec::Core::Formatters::BaseTextFormatter
+
+      def initialize(output)
+        super(output)
+        @indent_level = 0
+      end
+
+      def example_group_started(example_group)
+        super(example_group)
+        start_block(example_group.description)
+      end
+
+      def example_group_finished(example_group)
+        super(example_group)
+        end_block
+      end
+
+      def example_started(example)
+        super(example)
+        start_block(example.description)
+      end
+
+      def example_passed(example)
+        super(example)
+        end_block(green("OK"))
+      end
+
+      def example_pending(example)
+        super(example)
+        end_block(yellow("PENDING (#{example.execution_result[:pending_message]})"))
+      end
+
+      def example_failed(example)
+        super(example)
+        end_block(red("FAILED"))
+      end
+
+      def step_started(description)
+        start_block('- ' + description)
+      end
+
+      def step_finished(description)
+        end_block
+      end
+
+      private
+
+      def start_block(message)
+        emit(message.strip)
+        @indent_level += 1
+      end
+
+      def end_block(message = nil)
+        emit(message.strip) if message
+        @indent_level -= 1
+      end
+
+      def emit(message)
+        output.puts(message.gsub(/^/, current_indentation))
+      end
+
+      def current_indentation
+        '  ' * @indent_level
+      end
+
+    end
+
+  end
+end

data/lib/rspec/longrun/version.rb

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

data/rspec-longrun.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rspec/longrun/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mike Williams"]
+  gem.email         = ["mdub@dogbiscuit.org"]
+  gem.summary       = "An RSpec formatter for long-running specs."
+  gem.homepage      = "http://github.com/mdub/rspec-longrun"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rspec-longrun"
+  gem.require_paths = ["lib"]
+  gem.version       = RSpec::Longrun::VERSION
+
+  gem.add_runtime_dependency("rspec-core", ">= 2.10.0")
+
+end

data/spec/rspec/longrun/formatter_spec.rb

@@ -0,0 +1,120 @@
+require "rspec/longrun"
+require "stringio"
+
+describe RSpec::Longrun::Formatter do
+
+  let(:output_buffer) { StringIO.new }
+  let(:formatter) { described_class.new(output_buffer) }
+
+  def undent(raw)
+    if raw =~ /\A( +)/
+      indent = $1
+      raw.gsub(/^#{indent}/, '').gsub(/ +$/, '')
+    else
+      raw
+    end
+  end
+
+  def output
+    output_buffer.string
+  end
+
+  module NoColor
+
+    def color_enabled?
+      false
+    end
+
+  end
+
+  before do
+    formatter.extend(NoColor)
+    suite.run(formatter)
+  end
+
+  context "for nested example groups" do
+
+    let(:suite) do
+      RSpec::Core::ExampleGroup.describe("foo") do
+        describe "bar" do
+          describe "baz" do
+          end
+        end
+        describe "qux" do
+        end
+      end
+    end
+
+    it "outputs nested group name" do
+      output.should eql(undent(<<-EOF))
+        foo
+          bar
+            baz
+          qux
+      EOF
+    end
+
+  end
+
+  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
+      end
+    end
+
+    it "outputs example names and status" do
+      output.should eql(undent(<<-EOF))
+        suite
+          works
+            OK
+          is unimplemented
+            PENDING (implement me)
+          fails
+            FAILED
+      EOF
+    end
+
+  end
+
+  context "with steps" do
+
+    let(:suite) do
+      RSpec::Core::ExampleGroup.describe("suite") do
+        example "has steps" do
+          step "Collect underpants" do
+          end
+          step "Er ..." do
+            step "(thinking)" do
+            end
+          end
+          step "Profit!" do
+          end
+        end
+      end
+    end
+
+    it "outputs steps" do
+      step "try steps" do
+        output.should eql(undent(<<-EOF))
+          suite
+            has steps
+              - Collect underpants
+              - Er ...
+                - (thinking)
+              - Profit!
+              OK
+        EOF
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rspec-longrun
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-24 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: 
+email:
+- mdub@dogbiscuit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec/longrun.rb
+- lib/rspec/longrun/dsl.rb
+- lib/rspec/longrun/formatter.rb
+- lib/rspec/longrun/version.rb
+- rspec-longrun.gemspec
+- spec/rspec/longrun/formatter_spec.rb
+homepage: http://github.com/mdub/rspec-longrun
+licenses: []
+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: -754123683182328035
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -754123683182328035
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An RSpec formatter for long-running specs.
+test_files:
+- spec/rspec/longrun/formatter_spec.rb