fuubar 1.2.1 → 1.3.2

data/LICENSE

@@ -1,3 +1,23 @@
-Copyright 2010 Jeff Kreeftmeijer.
-You may use this work without restrictions, as long as this notice is included.
-The work is provided "as is" without warranty of any kind, neither express nor implied.
+(The MIT License)
+
+Copyright (c) 2010 Jeff Kreeftmeijer.
+Copyright (c) 2013 The Kompanee - Jeff Felchner
+
+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,81 @@
+Fuubar ![Travis CI Status](https://travis-ci.org/jeffkreeftmeijer/fuubar.png)
+================================================================================
+
+Fuubar is an instafailing [RSpec](http://github.com/rspec) formatter that uses a progress bar instead of a string of letters and dots as feedback. Here's [a video of Fuubar in action](http://vimeo.com/16845253).
+
+Supported Rubies
+--------------------------------
+* MRI Ruby 1.8.7
+* MRI Ruby 1.9.2
+* MRI Ruby 1.9.3
+* MRI Ruby 2.0.0
+* JRuby (in 1.8 compat mode)
+* JRuby (in 1.9 compat mode)
+
+Installation
+--------------------------------------------------------------------------------
+
+First:
+
+```ruby
+gem install ruby-progressbar
+```
+
+or in your Gemfile
+
+```ruby
+gem 'ruby-progressbar'
+```
+
+Then, when running rspec:
+
+```
+rspec --format Fuubar --color spec
+```
+
+Or, if you want to use Fuubar as your default formatter, simply put the options in your `.rspec` file:
+
+    --format Fuubar
+    --color
+
+Advanced Usage
+--------------------------------
+
+### Customizing the Bar ###
+
+Fuubar exposes an RSpec configuration variable called `fuubar_progress_bar_options` which, when set will be passed directly to [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) which does all the heavy lifting.  Take a look at the documentation for details on all of the options you can pass in.
+
+Let's say for example that you would like to change the format of the bar. You would do that like so:
+
+```ruby
+# spec_helper.rb
+
+RSpec.configure do |config|
+  config.fuubar_progress_bar_options = { :format => 'My Fuubar! <%B> %p%% %a' }
+end
+```
+
+would make it so that, when Fuubar is output, it would look something like:
+
+    My Fuubar! <================================                  > 53.44% 00:12:31
+
+Issues
+--------------------------------
+
+If you have problems, please create a [Github issue](https://github.com/jeffkreeftmeijer/fuubar/issues).
+
+Credits
+--------------------------------
+
+fuubar was created by [Jeff Kreeftmeijer](https://github.com/jeffkreeftmeijer)
+fuubar is maintained by [Jeff Kreeftmeijer](https://github.com/jeffkreeftmeijer) and [The Kompanee, Ltd.](http://www.thekompanee.com)
+
+Contributing
+--------------------------------------------------------------------------------
+
+Found an issue? Have a great idea? Want to help? Great! Create an issue [issue](http://github.com/jeffkreeftmeijer/fuubar/issues) for it, or even better; fork the project and fix the problem yourself. Pull requests are always welcome. :)
+
+License
+--------------------------------
+
+fuubar is Copyright &copy; 2010-2013 Jeff Kreeftmeijer and Jeff Felchner. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/lib/fuubar.rb

@@ -1,70 +1,102 @@
+require 'rspec'
 require 'rspec/core/formatters/base_text_formatter'
 require 'ruby-progressbar'
-require 'rspec/instafail'
+
+RSpec.configuration.add_setting :fuubar_progress_bar_options, :default => {}
 
 class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
+  DEFAULT_PROGRESS_BAR_OPTIONS = { :format => ' %c/%C |%w>%i| %e ' }
 
-  def start(example_count)
+  attr_accessor :progress
+
+  def initialize(*args)
     super
-    @progress_bar   = ProgressBar.create(:format => ' %c/%C |%w>%i| %e ', :total => example_count, :output => output)
+
+    progress_bar_options =  DEFAULT_PROGRESS_BAR_OPTIONS.
+                              merge(:throttle_rate  => continuous_integration? ? 1.0 : nil).
+                              merge(configuration.fuubar_progress_bar_options).
+                              merge(:total          => example_count,
+                                    :output         => output,
+                                    :autostart      => false)
+
+    self.progress = ProgressBar.create(progress_bar_options)
   end
 
-  def increment
-    with_color do
-      @progress_bar.increment
-    end
+  def start(example_count)
+    super
+
+    progress.total = example_count
+
+    with_current_color { progress.start }
   end
 
   def example_passed(example)
     super
+
     increment
   end
 
   def example_pending(example)
     super
-    @state = :yellow unless @state == :red
+
     increment
   end
 
   def example_failed(example)
     super
-    @state = :red
 
-    output.print "\e[K"
-    instafail.example_failed(example)
+    progress.clear
+
+    dump_failure    example, failed_examples.size - 1
+    dump_backtrace  example
+
     output.puts
 
     increment
   end
 
-  def dump_failures
-    # don't!
-  end
-
   def message(string)
-    if @progress_bar.respond_to? :log
-      @progress_bar.log(string)
+    if progress.respond_to? :log
+      progress.log(string)
     else
       super
     end
   end
 
-  def instafail
-    @instafail ||= RSpec::Instafail.new(output)
+  def dump_failures
+    #
+    # We output each failure as it happens so we don't need to output them en
+    # masse at the end of the run.
+    #
   end
 
-  def with_color
-    output.print "\e[#{colors[state]}m" if color_enabled?
+  private
+
+  def increment
+    with_current_color { progress.increment }
+  end
+
+  def with_current_color
+    output.print "\e[#{color_code_for(current_color)}m" if color_enabled?
     yield
-    output.print "\e[0m" if color_enabled?
+    output.print "\e[0m"                                if color_enabled?
   end
 
-  def state
-    @state ||= :green
+  def color_enabled?
+    super && !continuous_integration?
   end
 
-  def colors
-    { :red => 31, :green => 32, :yellow => 33 }
+  def current_color
+    if failed_examples.size > 0
+      configuration.failure_color
+    elsif pending_examples.size > 0
+      configuration.pending_color
+    else
+      configuration.success_color
+    end
   end
 
+  def continuous_integration?
+    @continuous_integration ||= !(ENV['CONTINUOUS_INTEGRATION'].nil? || ENV['CONTINUOUS_INTEGRATION'] == '' || ENV['CONTINUOUS_INTEGRATION'] == 'false')
+  end
 end

data/spec/fuubar_spec.rb

@@ -1,127 +1,241 @@
-require 'spec_helper'
+require 'fuubar'
 require 'stringio'
 
 describe Fuubar do
-  let(:output) { StringIO.new }
+  let(:output) do
+    io = StringIO.new
 
-  let(:formatter) do
-    formatter = Fuubar.new(output)
-    formatter.start(2)
+    allow(io).to  receive(:tty?).
+                  and_return(true)
 
-    formatter
+    io
   end
 
-  let(:progress_bar) { formatter.instance_variable_get(:@progress_bar) }
-  let(:example) { RSpec::Core::ExampleGroup.describe.example }
+  let(:formatter) { Fuubar.new(output) }
+  let(:progress)  { formatter.instance_variable_get(:@progress) }
+  let(:example)   { RSpec::Core::ExampleGroup.describe.example }
 
+  let(:failed_example) do
+    exception = RuntimeError.new('Test Fuubar Error')
+    exception.set_backtrace [
+      "/my/filename.rb:4:in `some_method'",
+    ]
 
-  describe 'start' do
+    example = RSpec::Core::ExampleGroup.describe.example
 
-    it 'should create a new ProgressBar' do
-      progress_bar.should be_instance_of ProgressBar::Base
+    example.instance_variable_set(:@metadata, {
+      :file_path        => '/my/example/spec.rb',
+      :execution_result => {
+        :exception => exception },
+    } )
+
+    example
+  end
+
+  let(:fuubar_results) do
+    output.rewind
+    output.read
+  end
+
+  before(:each) do
+    RSpec.configuration.fuubar_progress_bar_options = {
+      :length        => 40,
+      :throttle_rate => 0.0,
+    }
+
+    ENV.delete('CONTINUOUS_INTEGRATION')
+  end
+
+  context 'when it is created' do
+    it 'does not start the bar until the formatter is started' do
+      expect(progress).to be_stopped
+
+      formatter.start(2)
+
+      expect(progress).not_to be_stopped
     end
 
-    it 'should set the format of the bar' do
-      progress_bar.instance_variable_get(:@format_string).should == ' %c/%C |%w>%i| %e '
+    it 'creates a new ProgressBar' do
+      expect(progress).to be_instance_of ProgressBar::Base
     end
 
-    it 'should set the total amount of specs' do
-      progress_bar.total.should == 2
+    it 'sets the format of the bar' do
+      expect(progress.instance_variable_get(:@format_string)).to eql ' %c/%C |%w>%i| %e '
     end
 
-    it 'should set the output' do
-      progress_bar.send(:output).should == formatter.output
+    it 'sets the total to the number of examples' do
+      expect(progress.total).to be_zero
     end
 
-    it 'should set the bar mark to =' do
-      progress_bar.instance_variable_get(:@bar).progress_mark.should == '='
+    it 'sets the bar\'s output' do
+      expect(progress.send(:output)).to eql formatter.output
+      expect(progress.send(:output)).to eql output
     end
 
-  end
+    context 'and continuous integration is enabled' do
+      before do
+        RSpec.configuration.fuubar_progress_bar_options = {:length => 40}
+        ENV['CONTINUOUS_INTEGRATION'] = 'true'
+      end
 
-  describe 'passed, pending and failed' do
+      it 'throttles the progress bar at one second' do
+        throttle      = progress.instance_variable_get(:@throttle)
+        throttle_rate = throttle.instance_variable_get(:@period)
 
-    before do
-      formatter.stub!(:increment)
-    end
+        expect(throttle_rate).to eql 1.0
+      end
 
-    describe 'example_passed' do
+      context 'when processing an example' do
+        before do
+          throttle      = progress.instance_variable_get(:@throttle)
+          throttle_rate = throttle.instance_variable_set(:@period, 0.0)
 
-      it 'should call the increment method' do
-        formatter.should_receive :increment
-        formatter.example_passed(example)
-      end
+          formatter.start(2)
 
-    end
+          output.rewind
 
-    describe 'example_pending' do
+          formatter.example_passed(example)
+        end
 
-      it 'should call the increment method' do
-        formatter.should_receive :increment
-        formatter.example_pending(example)
+        it 'does not output color codes' do
+          expect(fuubar_results).to start_with " 1/2 |== 50 ==>        |  ETA: 00:00:00 \r"
+        end
       end
+    end
 
-      it 'should set the state to :yellow' do
-        formatter.example_pending(example)
-        formatter.state.should == :yellow
+    context 'and continuous integration is not enabled' do
+      before do
+        RSpec.configuration.fuubar_progress_bar_options = {:length => 40}
+        ENV['CONTINUOUS_INTEGRATION'] = 'false'
       end
 
-      it 'should not set the state to :yellow when it is :red already' do
-        formatter.instance_variable_set(:@state, :red)
-        formatter.example_pending(example)
-        formatter.state.should == :red
+      it 'throttles the progress bar at the default rate' do
+        throttle      = progress.instance_variable_get(:@throttle)
+        throttle_rate = throttle.instance_variable_get(:@period)
+
+        expect(throttle_rate).to eql 0.01
       end
 
+      context 'when processing an example' do
+        before do
+          throttle      = progress.instance_variable_get(:@throttle)
+          throttle_rate = throttle.instance_variable_set(:@period, 0.0)
+
+          formatter.start(2)
+
+          output.rewind
+
+          formatter.example_passed(example)
+        end
+
+        it 'does not output color codes' do
+          expect(fuubar_results).to start_with "\e[32m 1/2 |== 50 ==>        |  ETA: 00:00:00 \r\e[0m"
+        end
+      end
     end
+  end
 
-    describe 'example_failed' do
+  context 'when it is started' do
+    before { formatter.start(2) }
 
+    it 'sets the total to the number of examples' do
+      expect(progress.total).to eql 2
+    end
+
+    context 'and an example passes' do
       before do
-        formatter.instafail.stub!(:example_failed)
+        output.rewind
+
+        formatter.example_passed(example)
       end
 
-      it 'should call the increment method' do
-        formatter.should_receive :increment
-        formatter.example_failed(example)
+      it 'outputs the proper bar information' do
+        expect(fuubar_results).to start_with "\e[32m 1/2 |== 50 ==>        |  ETA: 00:00:00 \r\e[0m"
       end
+    end
+
+    context 'and an example pends' do
+      before do
+        output.rewind
 
-      it 'should call instafail.example_failed' do
-        formatter.instafail.should_receive(:example_failed).with(example)
-        formatter.example_failed(example)
+        formatter.example_pending(example)
       end
 
-      it 'should set the state to :red' do
-        formatter.example_failed(example)
-        formatter.state.should == :red
+      it 'outputs the proper bar information' do
+        expect(fuubar_results).to start_with "\e[33m 1/2 |== 50 ==>        |  ETA: 00:00:00 \r\e[0m"
       end
 
+      context 'and then an example succeeds' do
+        before do
+          output.rewind
+
+          formatter.example_pending(example)
+        end
+
+        it 'outputs the pending bar' do
+          expect(fuubar_results).to start_with "\e[33m 2/2 |===== 100 ======>| Time: 00:00:00 \n\e[0m"
+        end
+      end
     end
 
-  end
+    context 'and an example fails' do
+      it 'outputs the proper bar information' do
+        output.rewind
 
-  describe 'increment' do
+        formatter.example_failed(failed_example)
 
-    it 'should increment the progress bar' do
-      progress_bar.should_receive(:increment)
-      formatter.increment
-    end
+        expect(fuubar_results).to end_with "\e[31m 1/2 |== 50 ==>        |  ETA: 00:00:00 \r\e[0m"
+      end
 
-  end
+      it 'dumps the failure' do
+        allow(formatter).to receive(:dump_failure).
+                            and_return('dump failure')
 
-  describe 'instafail' do
+        allow(formatter).to receive(:dump_backtrace).
+                            and_return('dump backtrace')
 
-    it 'should be an instance of RSpec::Instafail' do
-      formatter.instafail.should be_instance_of(RSpec::Instafail)
-    end
+        formatter.example_failed(failed_example)
 
-  end
+        expect(formatter).to have_received(:dump_failure).
+                             with(failed_example, 0)
+
+        expect(formatter).to have_received(:dump_backtrace).
+                             with(failed_example)
+      end
 
-  describe 'state' do
+      context 'and then an example succeeds' do
+        before do
+          formatter.example_failed(failed_example)
+
+          output.rewind
+
+          formatter.example_passed(example)
+        end
+
+        it 'outputs the failed bar' do
+          expect(fuubar_results).to start_with "\e[31m 2/2 |===== 100 ======>| Time: 00:00:00 \n\e[0m"
+        end
+      end
 
-    it 'should be :green by default' do
-      formatter.state.should == :green
+      context 'and then an example pends' do
+        before do
+          formatter.example_failed(failed_example)
+
+          output.rewind
+
+          formatter.example_pending(example)
+        end
+
+        it 'outputs the failed bar' do
+          expect(fuubar_results).to start_with "\e[31m 2/2 |===== 100 ======>| Time: 00:00:00 \n\e[0m"
+        end
+      end
     end
 
-  end
+    it 'can properly log messages' do
+      formatter.message 'My Message'
 
+      expect(fuubar_results).to end_with "My Message\n 0/2 |>                |  ETA: ??:??:?? \r"
+    end
+  end
 end

metadata

@@ -1,57 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: fuubar
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
 - Nicholas Evans
 - Jeff Kreeftmeijer
+- jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: ruby-progressbar
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
+        version: 2.14.0
+    - - <
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.14.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec-instafail
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,28 +50,26 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.3'
 description: the instafailing RSpec progress bar formatter
 email:
 - jeff@kreeftmeijer.nl
 executables: []
 extensions: []
-extra_rdoc_files: []
-files:
-- .gitignore
-- .rspec
-- Gemfile
+extra_rdoc_files:
+- README.md
 - LICENSE
-- README.textile
-- Rakefile
-- fuubar.gemspec
+files:
 - lib/fuubar.rb
+- README.md
+- LICENSE
 - spec/fuubar_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/jeffkreeftmeijer/fuubar
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --charset
+- UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -103,5 +92,4 @@ specification_version: 3
 summary: the instafailing RSpec progress bar formatter
 test_files:
 - spec/fuubar_spec.rb
-- spec/spec_helper.rb
 has_rdoc: 

data/.gitignore

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

data/.rspec

@@ -1,2 +0,0 @@
---color
---format Fuubar

data/Gemfile

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in fuubar.gemspec
-gemspec
-
-gem 'rake'

data/README.textile

@@ -1,24 +0,0 @@
-h1. Fuubar !https://travis-ci.org/jeffkreeftmeijer/fuubar.png!:https://travis-ci.org/jeffkreeftmeijer/fuubar
-
-Fuubar is an instafailing "RSpec":http://github.com/rspec formatter that uses a progress bar instead of a string of letters and dots as feedback. Here's "a video of Fuubar in action":http://vimeo.com/16845253.
-
-h2. Installation
-
-Installing Fuubar is easy. Just put it in your @Gemfile@ and run your specs like this from now on:
-
-bc. $ rspec --format Fuubar --color spec
-
-If you want to use Fuubar as your default formatter, simply put the options in your @.rspec@ file:
-
-bc. --format Fuubar
---color
-
-h3. Rspec-1
-
-Use the "fuubar-legacy":https://rubygems.org/gems/fuubar-legacy gem:
-
-bc. gem 'fuubar-legacy'
-
-h2. Contributing
-
-Found an issue? Have a great idea? Want to help? Great! Create an issue "issue":http://github.com/jeffkreeftmeijer/fuubar/issues for it, or even better; fork the project and fix the problem yourself. Pull requests are always welcome. :)

data/Rakefile

@@ -1,6 +0,0 @@
-require 'rake'
-
-task :default => :spec
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new

data/fuubar.gemspec

@@ -1,23 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name        = "fuubar"
-  s.version     = '1.2.1'
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Nicholas Evans", "Jeff Kreeftmeijer"]
-  s.email       = ["jeff@kreeftmeijer.nl"]
-  s.homepage    = "https://github.com/jeffkreeftmeijer/fuubar"
-  s.summary     = %q{the instafailing RSpec progress bar formatter}
-  s.description = %q{the instafailing RSpec progress bar formatter}
-
-  s.rubyforge_project = "fuubar"
-
-  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_dependency('rspec', ["~> 2.0"])
-  s.add_dependency('ruby-progressbar', ["~> 1.0"])
-  s.add_dependency('rspec-instafail', ["~> 0.2.0"])
-end

data/spec/spec_helper.rb

@@ -1 +0,0 @@
-require 'fuubar'