rspec-smart-formatter 0.0.2 → 0.0.3

data/.rspec

@@ -1,3 +1,4 @@
 --color
+--order rand
 --format RSpec::Smart::Formatter
 -r turnip

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: rspec
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx-2.0

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.0.4 (unreleased)
+
+* ...
+
+## 0.0.3 (2012-01-07)
+
+* Add Fuubar support
+
+## 0.0.2 (2012-01-07)
+
+* Bugfix, making sure that `@example_count` is an integer
+
+## 0.0.1 (2012-01-06)
+
+* Initial version

data/README.md

@@ -1,8 +1,11 @@
 # RSpec Smart Formatter
 
+[![Build Status](https://secure.travis-ci.org/iain/rspec-smart-formatter.png)](http://travis-ci.org/iain/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
@@ -19,7 +22,8 @@ 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
+
+## Installation
 
 Add to your gemfile:
 
@@ -40,11 +44,34 @@ Add it your `.rspec` file:
 
 And you're done!
 
+## Usage
+
+Just run RSpec [as you normally would](https://www.relishapp.com/rspec/rspec-core/docs/command-line).
+
+For explaination on how the smart formatter works, [see this
+feature](https://github.com/iain/rspec-smart-formatter/blob/master/spec/features/usage.feature).
+
+
+
 ## Configuration
 
 Don't know yet. Still working on it.
 
 
+## Development
+
+To run the specs of rspec-smart-formatter itself:
+
+```
+bundle install
+rspec
+```
+
+PS. Don't run with `bundle exec`.
+
+Pull requests are welcome.
+
+
 ## Copyright
 
 Copyright 2012, Iain Hecker. Released under the MIT License.

data/Rakefile

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

data/lib/rspec/smart/formatter.rb

@@ -17,23 +17,44 @@ module RSpec
       end
 
       def __getobj__
-        if @example_count <= 20
-          documentation_formatter
+        choose_formatter
+      end
+
+      def __setobj__(obj)
+        raise "Nothing to set here"
+      end
+
+      private
+
+      def choose_formatter
+        if few_specs?
+          formatter_for_fewer_specs
         else
-          progress_formatter
+          formatter_for_more_specs
         end
       end
 
-      def __setobj__(obj)
-        raise NotImplementedError.new("The delegated object is calculated automatically, it is not to be set")
+      def few_specs?
+        @example_count <= 20
+      end
+
+      def formatter_for_fewer_specs
+        formatter RSpec::Core::Formatters::DocumentationFormatter
+      end
+
+      def formatter_for_more_specs
+        require 'fuubar'
+        formatter Fuubar
+      rescue LoadError
+        formatter RSpec::Core::Formatters::ProgressFormatter
       end
 
-      def documentation_formatter
-        @documentation_formatter ||= RSpec::Core::Formatters::DocumentationFormatter.new(*@initialize_args)
+      def formatter(formatter)
+        formatters[formatter] ||= formatter.new(*@initialize_args)
       end
 
-      def progress_formatter
-        @progress_formatter ||= RSpec::Core::Formatters::ProgressFormatter.new(*@initialize_args)
+      def formatters
+        @formatters ||= {}
       end
 
     end

data/rspec-smart-formatter.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name        = "rspec-smart-formatter"
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.authors     = ["iain"]
   s.email       = ["iain@iain.nl"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/iain/rspec-smart-formatter"
   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.}
 
@@ -17,5 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "turnip"
+  s.add_development_dependency "fuubar"
+  s.add_development_dependency "rake"
   s.add_runtime_dependency "rspec-core", "~> 2.0"
 end

data/spec/{smart-formatter.feature → features/usage.feature}

@@ -1,10 +1,14 @@
-Feature: Smart Formatter
+Feature: Usage
 
   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:
+
+    To install the smart formatter, add it to your Gemfile
+    and add it to your '.rspec' file.
+
     Given I have installed the smart formatter
 
 
@@ -15,14 +19,24 @@ Feature: Smart 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
+    When I run only a couple of 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
+    Since we cannot be sure you have something fancy like Fuubar installed,
+    it will use the progress formatter.
 
-    When I run 100 specs
+    Given I don't have any special formatters installed
+    When I run a lot of specs
     Then I should see the progress output
 
+
+  Scenario: With Fuubar installed
+
+    If you have Fuubar installed, this will be preferred over the progress formatter
+
+    Given I have installed Fuubar
+    When I run a lot of specs
+    Then I should see the Fuubar output

data/spec/helper_methods.rb

@@ -0,0 +1,43 @@
+module HelperMethods
+
+  def create_specs(count = 1)
+    create_file "spec/sample_spec.rb" do |f|
+      f.puts "describe 'something' do"
+      count.times do |i|
+        f.puts "  it 'the description of the specs' do;  end"
+      end
+      f.puts "end"
+    end
+  end
+
+  def create_rspec_config
+    create_file '.rspec' do |f|
+      f.puts "--format RSpec::Smart::Formatter"
+      f.puts "-I #{File.join(PROJECT_DIR, 'lib')}"
+    end
+  end
+
+  def run_specs
+    run_command "rspec"
+  end
+
+  def run_command(command)
+    @stdout ||= ""
+    @stderr = ""
+    Open3.popen3(command) do |stdin, stdout, stderr, thr|
+      @stdout << stdout.read
+      @stderr << stderr.read
+    end
+    if @stderr != ""
+      puts @stderr
+    end
+  end
+
+  def create_file(filename)
+    FileUtils.mkdir_p File.dirname(filename)
+    File.open filename, 'w' do |f|
+      yield f
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,16 +1,19 @@
+PROJECT_DIR = File.expand_path('../../', __FILE__)
+TEST_PROJECT_DIR = File.expand_path("tmp/test_project", PROJECT_DIR)
+
 require 'open3'
 require 'step_definitions'
-
-TEST_PROJECT_DIR = File.expand_path("../../tmp/test_project", __FILE__)
+require 'helper_methods'
 
 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
 
+  config.include HelperMethods
+
 end

data/spec/step_definitions.rb

@@ -1,28 +1,23 @@
 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
+  create_rspec_config
 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
+step "I don't have any special formatters installed" do
+  run_command "gem uninstall fuubar"
+end
+
+step "I have installed Fuubar" do
+  run_command "gem install fuubar"
+end
+
+step "I run only a couple of specs" do
+  create_specs 20
+  run_specs
+end
+
+step "I run a lot of specs" do
+  create_specs 21
+  run_specs
 end
 
 step "I should see the documentation output" do
@@ -33,8 +28,6 @@ step "I should see the progress output" do
   @stdout.should include("................")
 end
 
-placeholder :count do
-  match /\d+/ do |count|
-    count.to_i
-  end
+step 'I should see the Fuubar output' do
+  @stdout.should include("100% |=======")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-smart-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turnip
-  requirement: &2164228640 !ruby/object:Gem::Requirement
+  requirement: &2170952360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164228640
+  version_requirements: *2170952360
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &2170951920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2170951920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2170951500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2170951500
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &2164228120 !ruby/object:Gem::Requirement
+  requirement: &2170951000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +54,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164228120
+  version_requirements: *2170951000
 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.
@@ -45,16 +67,19 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - lib/rspec-smart-formatter.rb
 - lib/rspec/smart/formatter.rb
 - rspec-smart-formatter.gemspec
-- spec/smart-formatter.feature
+- spec/features/usage.feature
+- spec/helper_methods.rb
 - spec/spec_helper.rb
 - spec/step_definitions.rb
-homepage: ''
+homepage: https://github.com/iain/rspec-smart-formatter
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -79,6 +104,7 @@ signing_key:
 specification_version: 3
 summary: Automatically chooses a handy formatter
 test_files:
-- spec/smart-formatter.feature
+- spec/features/usage.feature
+- spec/helper_methods.rb
 - spec/spec_helper.rb
 - spec/step_definitions.rb