rspec-smart-formatter 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format RSpec::Smart::Formatter
+-r turnip

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@rspec-smart-formatter

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rspec-smart-formatter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# RSpec Smart Formatter
+
+RSpec Smart Formatter automatically chooses an appropriate formatter depending on the amount of
+specs you're running.
+
+## Why this formatter exists
+
+This gem is for scratching an itch I have. When I run focussed tests (like, only one file, or only
+one example group) I want to use the documentation formatter, which gives me a better view of which
+tests pass and which tests fail.
+
+When I run a lot of tests, I want something that doesn't fill my entire bash history and just shows
+the list of specs.
+
+I like formatters like [Instafail](https://github.com/grosser/rspec-instafail) and
+[Fuubar](https://github.com/jeffkreeftmeijer/fuubar), which easily handles thousands of tests,
+without cluttering your terminal, and showing you the failing specs instantly so you can figure out
+what went wrong without having to wait for your whole suite to finish.
+
+I could write `-fd` and `-fp` manually, but I keep forgetting that.
+
+## Usage
+
+Add to your gemfile:
+
+``` ruby
+group :test do
+  gem 'rspec-smart-formatter', :require => false
+end
+```
+
+Run `bundle install`
+
+
+Add it your `.rspec` file:
+
+```
+--format RSpec::Smart::Formatter
+```
+
+And you're done!
+
+## Configuration
+
+Don't know yet. Still working on it.
+
+
+## Copyright
+
+Copyright 2012, Iain Hecker. Released under the MIT License.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :spec do
+  system "bundle exec rspec"
+end
+
+task :default => :spec

data/lib/rspec-smart-formatter.rb

@@ -0,0 +1 @@
+require 'rspec/smart/formatter'

data/lib/rspec/smart/formatter.rb

@@ -0,0 +1,40 @@
+require 'rspec/core/formatters/documentation_formatter'
+require 'rspec/core/formatters/progress_formatter'
+require 'delegate'
+
+module RSpec
+  module Smart
+    class Formatter < ::Delegator
+
+      def initialize(*args)
+        @initialize_args = args
+      end
+
+      def start(example_count)
+        @example_count = example_count
+        super
+      end
+
+      def __getobj__
+        if @example_count <= 20
+          documentation_formatter
+        else
+          progress_formatter
+        end
+      end
+
+      def __setobj__(obj)
+        raise NotImplementedError.new("The delegated object is calculated automatically, it is not to be set")
+      end
+
+      def documentation_formatter
+        @documentation_formatter ||= RSpec::Core::Formatters::DocumentationFormatter.new(*@initialize_args)
+      end
+
+      def progress_formatter
+        @progress_formatter ||= RSpec::Core::Formatters::ProgressFormatter.new(*@initialize_args)
+      end
+
+    end
+  end
+end

data/rspec-smart-formatter.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-smart-formatter"
+  s.version     = '0.0.1'
+  s.authors     = ["iain"]
+  s.email       = ["iain@iain.nl"]
+  s.homepage    = ""
+  s.summary     = %q{Automatically chooses a handy formatter}
+  s.description = %q{When you run individual specs, I want to see documentation output, because it shows better which specs fails. But when I run all my specs I want something like progress or Fuubar.}
+
+  s.rubyforge_project = "rspec-smart-formatter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "turnip"
+  s.add_runtime_dependency "rspec-core", "~> 2.0"
+end

data/spec/smart-formatter.feature

@@ -0,0 +1,28 @@
+Feature: Smart Formatter
+
+  Because I want to save time figuring out which tests have failed,
+  I can specify to always use the smart formatter
+  So it will choose the best possible formatter for me.
+
+  Background:
+    Given I have installed the smart formatter
+
+
+
+  Scenario: Running only a couple of specs
+
+    With a couple of specs, it's easier to use the documentation formatter.
+    It allowes you to see in relation to other specs, which specs failed.
+    I'm guessing about 20 specs is the maximum for documentation to be readable.
+
+    When I run 20 specs
+    Then I should see the documentation output
+
+  Scenario: Running a lot of specs
+
+    Wit a lot of specs, you'd want a shorter output.
+    Since we cannot be sure you have something fancy like Fuubar installed, it will use progress
+
+    When I run 100 specs
+    Then I should see the progress output
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'open3'
+require 'step_definitions'
+
+TEST_PROJECT_DIR = File.expand_path("../../tmp/test_project", __FILE__)
+
+RSpec.configure do |config|
+
+  config.around :each do |example|
+    FileUtils.rm_r TEST_PROJECT_DIR if File.exist?(TEST_PROJECT_DIR)
+    FileUtils.mkdir_p TEST_PROJECT_DIR
+    Dir.chdir TEST_PROJECT_DIR do
+      example.run
+    end
+  end
+
+end

data/spec/step_definitions.rb

@@ -0,0 +1,40 @@
+step "I have installed the smart formatter" do
+  FileUtils.mkdir_p "spec"
+  File.open(".rspec", "w") do |f|
+    f << "--format RSpec::Smart::Formatter\n"
+    f << "-I #{File.expand_path('../../lib')}\n"
+  end
+end
+
+step "I run :count specs" do |count|
+  File.open("spec/sample_spec.rb", "w") do |f|
+    f << "describe 'something' do"
+    count.times do |i|
+      f << "  it 'the description of the specs' do;  end\n\n"
+    end
+    f << "end"
+  end
+  @stdout = ""
+  @stderr = ""
+  Open3.popen3("rspec") do |stdin, stdout, stderr, thr|
+    @stdout << stdout.read
+    @stderr << stderr.read
+  end
+  if @stderr != ""
+    puts @stderr
+  end
+end
+
+step "I should see the documentation output" do
+  @stdout.should include("the description of the specs")
+end
+
+step "I should see the progress output" do
+  @stdout.should include("................")
+end
+
+placeholder :count do
+  match /\d+/ do |count|
+    count.to_i
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rspec-smart-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: &2164228640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164228640
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: &2164228120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164228120
+description: When you run individual specs, I want to see documentation output, because
+  it shows better which specs fails. But when I run all my specs I want something
+  like progress or Fuubar.
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/rspec-smart-formatter.rb
+- lib/rspec/smart/formatter.rb
+- rspec-smart-formatter.gemspec
+- spec/smart-formatter.feature
+- spec/spec_helper.rb
+- spec/step_definitions.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rspec-smart-formatter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Automatically chooses a handy formatter
+test_files:
+- spec/smart-formatter.feature
+- spec/spec_helper.rb
+- spec/step_definitions.rb