fuubar 2.3.2 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc131d5dbd7aa378742d9358d78351fa7ed928083faac077f2b0a553cd2e4018
-  data.tar.gz: 771c6d140e875296f0bcdefdfb7904b42723f6f66bdc92511311a08d49fb783c
+  metadata.gz: f33c75eecd40f56ed951ba0271450860b3ebebbb0bbd1176f77a78de206b28f6
+  data.tar.gz: 185aa80a3b147b9c6178871c09474e7ffe9231219e3b4cb48cdf0262678dfcfb
 SHA512:
-  metadata.gz: b05503c671beaf5a2d9a4184f9d3c0e216c4f1cdf31732db26de0a9f323b57325bc4fe5959d3c324e124cfb7374bc7b2d93b1d5acace372d58bf7ec7bd2907a6
-  data.tar.gz: d537243787d29fc734dc9180b570c659785f6103be90169d61c2ebabcbd835fbe990445cedc7daebc0e0ddc3630be0d11a44d18067ffa8d64eff19ce41bc50bf
+  metadata.gz: d8d30b539b96fe08156290d6ac407cea29a062e1b29eaf8fa39e041a8844abbb221775a0678e6644c0b1568b8996a5995ed84d23fc11729b0613b102af712d5c
+  data.tar.gz: e6f41f9692280dae28a8c44daf08f9df19a59b083579ea195d29a166d63bf68a88816137d7d9b17f4733556e2087756b04363990cd1a1f2aa5387db0959f99ec

data/README.md

@@ -1,108 +1,169 @@
-#Fuubar
-
+Fuubar
+================================================================================
 [![Gem Version](https://img.shields.io/gem/v/fuubar.svg)](https://rubygems.org/gems/fuubar) ![Rubygems Rank Overall](https://img.shields.io/gem/rt/fuubar.svg) ![Rubygems Rank Daily](https://img.shields.io/gem/rd/fuubar.svg) ![Rubygems Downloads](https://img.shields.io/gem/dv/fuubar/stable.svg) [![Build Status](https://img.shields.io/travis/thekompanee/fuubar/master.svg)](http://travis-ci.org/thekompanee/fuubar) [![Code Climate](https://codeclimate.com/github/thekompanee/fuubar.svg)](https://codeclimate.com/github/thekompanee/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.
-
-[![gif](http://i.imgur.com/GIiA53s.gif)](http://vimeo.com/16845253).
+fuubar is an instafailing [RSpec][rspec] formatter that uses
+a progress bar instead of a string of letters and dots as feedback.
 
-Supported Rubies
---------------------------------
-* MRI Ruby 1.8.7
-* MRI Ruby 1.9.2
-* MRI Ruby 1.9.3
-* MRI Ruby 2.0.x
-* MRI Ruby 2.1.x
-* MRI Ruby 2.2.x
-* MRI Ruby 2.3.x
-* MRI Ruby 2.4.x
-* JRuby (in 1.8 compat mode)
-* JRuby (in 1.9 compat mode)
+![examples][example-gif]
 
 Installation
 --------------------------------------------------------------------------------
 
-First:
-
 ```ruby
 gem install fuubar
-```
 
-or in your Gemfile
+# or in your Gemfile
 
-```ruby
 gem 'fuubar'
 ```
 
-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:
+Usage
+--------------------------------------------------------------------------------
 
-    --format Fuubar
-    --color
+In order to use fuubar, you have three options.
 
-Security
---------------------------------------------------------------------------------
+### Option 1: Invoke It Manually Via The Command Line ###
 
-fuubar is cryptographically signed. To be sure the gem you install hasn’t been
-tampered with:
+```
+rspec --format Fuubar --color
+```
 
-* Add my public key (if you haven’t already) as a trusted certificate
+### Option 2: Add It To Your Local `.rspec` File ###
 
 ```
-gem cert --add <(curl -Ls https://raw.github.com/thekompanee/fuubar/master/certs/thekompanee.pem)
+# .rspec
+
+--format Fuubar
+--color
 ```
 
-* gem install fuubar -P MediumSecurity
+### Option 3: Add It To Your `spec_helper.rb` ###
 
-The `MediumSecurity` trust profile will verify signed gems, but allow the
-installation of unsigned dependencies.
+```ruby
+# spec/spec_helper.rb
 
-This is necessary because not all of fuubar has a dependency on RSpec which
-isn't signed, so we cannot use `HighSecurity`.
+RSpec.configure do |config|
+  config.add_formatter 'Fuubar'
+end
+```
 
 Advanced Usage
 --------------------------------
 
-### Customizing the Bar ###
+### 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.
+fuubar exposes an RSpec configuration variable called
+`fuubar_progress_bar_options` which, when set will be passed directly to
+[ruby-progressbar][rpb-github] which does all the heavy lifting.  Take a look at
+the [ruby-progressbar documentation][rpb-docs] 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:
+#### Example ####
+
+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
+# spec/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:
+would make it so that, when fuubar is output, it would look something like:
 
     My Fuubar! <================================                  > 53.44% 00:12:31
 
-Issues
---------------------------------
+### Hiding Pending/Skipped Spec Summary ###
 
-If you have problems, please create a [Github issue](https://github.com/jeffkreeftmeijer/fuubar/issues).
+By default fuubar follows RSpec's lead and will dump out a summary of all of the
+pending specs in the suite once the test run is over.  This is a good idea
+because the additional noise is a nudge to fix those tests.  We realize however
+that not all teams have the luxury of implementing all of the pending specs and
+therefore fuubar gives you the option of supressing that summary.
 
-Credits
---------------------------------
+#### Example ####
+
+```ruby
+# spec/spec_helper.rb
 
-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)
+RSpec.configure do |config|
+  config.fuubar_output_pending_results = false
+end
+```
 
-Contributing
+### Disabling Auto-Refresh ###
+
+By default fuubar will automatically refresh the bar (and therefore the ETA)
+every second.  Unfortunately this doesn't play well with things like debuggers.
+When you're debugging, having a bar show up every second is undesireable.
+[Pry][pry] gives us hooks so that we can automatically disable the refresh when
+it's used. Unfortunately [byebug][byebug] does not and disabling the bar must be
+done manually.
+
+#### Example ####
+
+```ruby
+# spec/spec_helper.rb
+
+RSpec.configure do |config|
+  config.fuubar_auto_refresh = false
+end
+```
+
+Security
+--------------------------------------------------------------------------------
+
+fuubar is cryptographically signed. To be sure the gem you install hasn’t been
+tampered with, follow these steps:
+
+1. Add my public key (if you haven’t already) as a trusted certificate
+
+```
+gem cert --add <(curl -Ls https://raw.github.com/thekompanee/fuubar/master/certs/thekompanee.pem)
+```
+
+2. Install fuubar telling it to use security checks when possible.
+
+```
+gem install fuubar -P MediumSecurity
+```
+
+> **Note:** The `MediumSecurity` trust profile will verify signed gems, but
+> allow the installation of unsigned dependencies.
+>
+> This is necessary because fuubar has a dependency on RSpec which isn't signed,
+> and therefore we cannot use `HighSecurity`, which requires signed gems.
+
+Credits
 --------------------------------------------------------------------------------
 
-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. :)
+fuubar was written by [Jeff Felchner][jefff-profile] and [Jeff
+Kreeftmeijer][jeffk-profile]
+
+![The Kompanee][kompanee-logo]
+
+fuubar is maintained and funded by [The Kompanee, Ltd.][kompanee-site]
+
+The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
 
 License
---------------------------------
+--------------------------------------------------------------------------------
 
-fuubar is Copyright &copy; 2010-2016 Jeff Kreeftmeijer and Jeff Felchner. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+fuubar is Copyright &copy; 2010-2019 Jeff Kreeftmeijer and Jeff Felchner. It is
+free software, and may be redistributed under the terms specified in the
+[LICENSE][license] file.
+
+[byebug]:        https://github.com/deivid-rodriguez/byebug
+[example-gif]:   https://kompanee-public-assets.s3.amazonaws.com/readmes/fuubar-examples.gif
+[jefff-profile]: https://github.com/jfelchner
+[jeffk-profile]: https://github.com/jeffkreeftmeijer
+[kompanee-logo]: https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png
+[kompanee-site]: http://www.thekompanee.com
+[license]:       https://github.com/thekompanee/fuubar/blob/master/LICENSE.txt
+[pry]:           https://github.com/pry/pry
+[rpb-docs]:      https://github.com/jfelchner/ruby-progressbar/wiki/Options
+[rpb-github]:    https://github.com/jfelchner/ruby-progressbar
+[rspec]:         https://github.com/rspec

data/lib/fuubar.rb

@@ -5,7 +5,18 @@ require 'rspec/core/formatters/base_text_formatter'
 require 'ruby-progressbar'
 require 'fuubar/output'
 
-RSpec.configuration.add_setting :fuubar_progress_bar_options, :default => {}
+RSpec.configuration.add_setting :fuubar_progress_bar_options,   :default => {}
+RSpec.configuration.add_setting :fuubar_auto_refresh,           :default => true
+RSpec.configuration.add_setting :fuubar_output_pending_results, :default => true
+
+if Object.const_defined?('Pry')
+  Pry.
+    config.
+    hooks.
+    add_hook(:when_started, :fuubar_kill_refresh) do |_target, _opt, _|
+      RSpec.configuration.fuubar_auto_refresh = false
+    end
+end
 
 class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
   DEFAULT_PROGRESS_BAR_OPTIONS = { :format => ' %c/%C |%w>%i| %e ' }.freeze
@@ -13,6 +24,7 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
   RSpec::Core::Formatters.register self,
                                    :close,
                                    :dump_failures,
+                                   :dump_pending,
                                    :example_failed,
                                    :example_passed,
                                    :example_pending,
@@ -51,16 +63,15 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
     self.passed_count        = 0
     self.pending_count       = 0
     self.failed_count        = 0
-    self.example_tick_thread = start_tick_thread(notification)
-
-    if Object.const_defined?('Pry')
-      Pry.
-        config.
-        hooks.
-        add_hook(:when_started, :fuubar_kill_refresh) do |_target, _opt, _|
-          example_tick_thread.kill
-        end
-    end
+    self.example_tick_thread = Thread.new do
+                                 loop do
+                                   sleep(1)
+
+                                   if configuration.fuubar_auto_refresh
+                                     example_tick(notification)
+                                   end
+                                 end
+                               end # rubocop:disable Layout/BlockAlignment
 
     super
 
@@ -115,6 +126,12 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
     #
   end
 
+  def dump_pending(notification)
+    return unless configuration.fuubar_output_pending_results
+
+    super
+  end
+
   # rubocop:disable Naming/MemoizedInstanceVariableName
   def output
     @fuubar_output ||= Fuubar::Output.new(super, configuration.tty?)
@@ -163,14 +180,4 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
     @continuous_integration ||= \
       ![nil, '', 'false'].include?(ENV['CONTINUOUS_INTEGRATION'])
   end
-
-  def start_tick_thread(notification)
-    Thread.new do
-      loop do
-        sleep(1)
-
-        example_tick(notification)
-      end
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuubar
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.1
 platform: ruby
 authors:
 - Nicholas Evans
@@ -37,7 +37,7 @@ cert_chain:
   09JNgxpgZHCDuKwoycU+wXdWVSzMtchMQygnEu6th1SY5qHj4ISipBEBtKG0MdgB
   L3AbMAHTztj5YI+gvmpuV1B4Zv1QZjZWOeNSnLZdrnOQbyyDBzJyXmNV
   -----END CERTIFICATE-----
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -73,42 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: chamber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.7'
 description: the instafailing RSpec progress bar formatter
 email:
 - jeff@kreeftmeijer.nl
@@ -125,7 +97,12 @@ homepage: https://github.com/thekompanee/fuubar
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/thekompanee/fuubar/issues
+  changelog_uri: https://github.com/thekompanee/fuubar/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/thekompanee/fuubar/tree/releases/v2.4.0
+  homepage_uri: https://github.com/thekompanee/fuubar
+  source_code_uri: https://github.com/thekompanee/fuubar
+  wiki_uri: https://github.com/thekompanee/fuubar/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,8 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: the instafailing RSpec progress bar formatter