fuubar 2.4.1 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f33c75eecd40f56ed951ba0271450860b3ebebbb0bbd1176f77a78de206b28f6
-  data.tar.gz: 185aa80a3b147b9c6178871c09474e7ffe9231219e3b4cb48cdf0262678dfcfb
+  metadata.gz: 1fd1a2c4590312a74d9626c64fc2ddd353ff5ebd351a74e3643087646c60462a
+  data.tar.gz: 46a97b176a9c504e0f20553a94f304be2bb97b171258e7350c5d460ff6d83fb8
 SHA512:
-  metadata.gz: d8d30b539b96fe08156290d6ac407cea29a062e1b29eaf8fa39e041a8844abbb221775a0678e6644c0b1568b8996a5995ed84d23fc11729b0613b102af712d5c
-  data.tar.gz: e6f41f9692280dae28a8c44daf08f9df19a59b083579ea195d29a166d63bf68a88816137d7d9b17f4733556e2087756b04363990cd1a1f2aa5387db0959f99ec
+  metadata.gz: 8545ad87bb3cf36a508feaa26f3d5cdbb82bf362187dd7fc522c92255d9b8456a98a436dc6da6288568655842567bd132b2418aab297d410b41e92404a7da194
+  data.tar.gz: ea0f79a6c37344dabf5bbbd23d273148856bd5e4220af3785155a7f9a748f3314eee8391f37f4c5c615f0f7ae5b90e4b360f0eb4a09fd13aae5bc247800a0242

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 The Kompanee, Ltd
+Copyright (c) 2010-2019 The Kompanee, Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,29 @@
 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)
+
+<div align="center">
+  <a href="https://rubygems.org/gems/fuubar" alt="RubyGems Version">
+    <img src="https://img.shields.io/gem/v/fuubar.svg?style=flat-square&label=current-version" alt="RubyGems Version" />
+  </a>
+
+  <a href="https://rubygems.org/gems/fuubar" alt="RubyGems Rank Overall">
+    <img src="https://img.shields.io/gem/rt/fuubar.svg?style=flat-square&label=total-rank" alt="RubyGems Rank Overall" />
+  </a>
+
+  <a href="https://rubygems.org/gems/fuubar" alt="RubyGems Rank Daily">
+    <img src="https://img.shields.io/gem/rd/fuubar.svg?style=flat-square&label=daily-rank" alt="RubyGems Rank Daily" />
+  </a>
+
+  <a href="https://rubygems.org/gems/fuubar" alt="RubyGems Downloads">
+    <img src="https://img.shields.io/gem/dt/fuubar.svg?style=flat-square&label=total-downloads" alt="RubyGems Downloads" />
+  </a>
+
+  <a href="https://github.com/thekompanee/fuubar/actions?query=workflow%3ABuild" alt="Build Status">
+    <img src="https://img.shields.io/github/workflow/status/jfelchner/fuubar/Build?label=CI&style=flat-square&logo=github" alt="Build Status" />
+  </a>
+</div>
+
+<br>
 
 fuubar is an instafailing [RSpec][rspec] formatter that uses
 a progress bar instead of a string of letters and dots as feedback.
@@ -23,22 +46,22 @@ Usage
 
 In order to use fuubar, you have three options.
 
-### Option 1: Invoke It Manually Via The Command Line ###
+### Option 1: Invoke It Manually Via The Command Line
 
-```
+```bash
 rspec --format Fuubar --color
 ```
 
-### Option 2: Add It To Your Local `.rspec` File ###
+### Option 2: Add It To Your Local `.rspec` File
 
-```
+```text
 # .rspec
 
 --format Fuubar
 --color
 ```
 
-### Option 3: Add It To Your `spec_helper.rb` ###
+### Option 3: Add It To Your `spec_helper.rb`
 
 ```ruby
 # spec/spec_helper.rb
@@ -51,7 +74,7 @@ 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
@@ -59,7 +82,7 @@ fuubar exposes an RSpec configuration variable called
 the [ruby-progressbar documentation][rpb-docs] for details on all of the options
 you can pass in.
 
-#### Example ####
+#### Example
 
 Let's say for example that you would like to change the format of the bar. You
 would do that like so:
@@ -74,9 +97,11 @@ end
 
 would make it so that, when fuubar is output, it would look something like:
 
-    My Fuubar! <================================                  > 53.44% 00:12:31
+```text
+My Fuubar! <================================                  > 53.44% 00:12:31
+```
 
-### Hiding Pending/Skipped Spec Summary ###
+### Hiding Pending/Skipped Spec Summary
 
 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
@@ -84,7 +109,7 @@ 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.
 
-#### Example ####
+#### Example
 
 ```ruby
 # spec/spec_helper.rb
@@ -94,42 +119,72 @@ RSpec.configure do |config|
 end
 ```
 
-### 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.
+### Enabling Auto-Refresh
 
-#### Example ####
+By default fuubar refreshes the bar only between each spec.
+You can enable an auto-refresh feature that will keep refreshing the bar (and
+therefore the ETA) every second.
+You can enable the feature as follows:
 
 ```ruby
 # spec/spec_helper.rb
 
 RSpec.configure do |config|
-  config.fuubar_auto_refresh = false
+  config.fuubar_auto_refresh = true
 end
 ```
 
+#### Undesirable Effects
+
+Unfortunately this option doesn't play well with things like debuggers, as
+having a bar show up every second would be undesireable (which is why the
+feature is disabled by default). Depending on what you are using, you may be
+given ways to work around this problem.
+
+##### Pry
+
+[Pry][pry] provides hooks that can be used to disable fuubar during a debugging
+session, you could for example add the following to your spec helper:
+
+```ruby
+# spec/spec_helper.rb
+
+Pry.config.hooks.add_hook(:before_session, :disable_fuubar_auto_refresh) do |_output, _binding, _pry|
+  RSpec.configuration.fuubar_auto_refresh = false
+end
+
+Pry.config.hooks.add_hook(:after_session, :restore_fuubar_auto_refresh) do |_output, _binding, _pry|
+  RSpec.configuration.fuubar_auto_refresh = true
+end
+```
+
+##### Byebug
+
+Unfortunately [byebug][byebug] does not provide hooks, so your best bet is to
+disable auto-refresh manually before calling `byebug`.
+
+```ruby
+RSpec.configuration.fuubar_auto_refresh = false
+byebug
+```
+
 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
+* 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)
-```
+  ```bash
+  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.
+* Install fuubar telling it to use security checks when possible.
 
-```
-gem install fuubar -P MediumSecurity
-```
+  ```bash
+  gem install fuubar -P MediumSecurity
+  ```
 
 > **Note:** The `MediumSecurity` trust profile will verify signed gems, but
 > allow the installation of unsigned dependencies.
@@ -152,7 +207,7 @@ The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
 License
 --------------------------------------------------------------------------------
 
-fuubar is Copyright &copy; 2010-2019 Jeff Kreeftmeijer and Jeff Felchner. It is
+fuubar is Copyright &copy; 2010-2021 Jeff Kreeftmeijer and Jeff Felchner. It is
 free software, and may be redistributed under the terms specified in the
 [LICENSE][license] file.
 

data/lib/fuubar/output.rb

@@ -2,9 +2,9 @@
 
 require 'delegate'
 
-class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
+class Fuubar < ::RSpec::Core::Formatters::BaseTextFormatter
 class Output < ::Delegator
-  def initialize(output, force_tty = false)
+  def initialize(output, force_tty = false) # rubocop:disable Style/OptionalBooleanParameter, Lint/MissingSuper
     @raw_output = output
     @force_tty  = force_tty
   end

data/lib/fuubar.rb

@@ -5,34 +5,24 @@ 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_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
+::RSpec.configuration.add_setting :fuubar_progress_bar_options,   :default => {}
+::RSpec.configuration.add_setting :fuubar_auto_refresh,           :default => false
+::RSpec.configuration.add_setting :fuubar_output_pending_results, :default => true
 
-class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
+class Fuubar < ::RSpec::Core::Formatters::BaseTextFormatter
   DEFAULT_PROGRESS_BAR_OPTIONS = { :format => ' %c/%C |%w>%i| %e ' }.freeze
 
-  RSpec::Core::Formatters.register self,
-                                   :close,
-                                   :dump_failures,
-                                   :dump_pending,
-                                   :example_failed,
-                                   :example_passed,
-                                   :example_pending,
-                                   :message,
-                                   :start
-
-  attr_accessor :example_tick_thread,
-                :example_tick_lock,
+  ::RSpec::Core::Formatters.register self,
+                                     :close,
+                                     :dump_failures,
+                                     :dump_pending,
+                                     :example_failed,
+                                     :example_passed,
+                                     :example_pending,
+                                     :message,
+                                     :start
+
+  attr_accessor :example_tick_lock,
                 :progress,
                 :passed_count,
                 :pending_count,
@@ -41,8 +31,8 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
   def initialize(*args)
     super
 
-    self.example_tick_lock = Mutex.new
-    self.progress = ProgressBar.create(
+    self.example_tick_lock = ::Mutex.new
+    self.progress = ::ProgressBar.create(
                       DEFAULT_PROGRESS_BAR_OPTIONS.
                         merge(:throttle_rate => continuous_integration? ? 1.0 : nil).
                         merge(:total     => 0,
@@ -59,19 +49,10 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
                                    :output    => output,
                                    :autostart => false)
 
-    self.progress            = ProgressBar.create(progress_bar_options)
-    self.passed_count        = 0
-    self.pending_count       = 0
-    self.failed_count        = 0
-    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
+    self.progress      = ::ProgressBar.create(progress_bar_options)
+    self.passed_count  = 0
+    self.pending_count = 0
+    self.failed_count  = 0
 
     super
 
@@ -111,6 +92,18 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
     end
   end
 
+  def example_tick_thread
+    ::Thread.new do
+      loop do
+        sleep(1)
+
+        if configuration.fuubar_auto_refresh
+          example_tick(notification)
+        end
+      end
+    end
+  end
+
   def message(notification)
     if progress.respond_to? :log
       progress.log(notification.message)
@@ -132,11 +125,9 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
     super
   end
 
-  # rubocop:disable Naming/MemoizedInstanceVariableName
   def output
-    @fuubar_output ||= Fuubar::Output.new(super, configuration.tty?)
+    @fuubar_output ||= ::Fuubar::Output.new(super, configuration.tty?) # rubocop:disable Naming/MemoizedInstanceVariableName
   end
-  # rubocop:enable Naming/MemoizedInstanceVariableName
 
   private
 
@@ -169,11 +160,11 @@ class Fuubar < RSpec::Core::Formatters::BaseTextFormatter
   end
 
   def color_code_for(*args)
-    RSpec::Core::Formatters::ConsoleCodes.console_code_for(*args)
+    ::RSpec::Core::Formatters::ConsoleCodes.console_code_for(*args)
   end
 
   def configuration
-    RSpec.configuration
+    ::RSpec.configuration
   end
 
   def continuous_integration?

metadata

@@ -1,43 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: fuubar
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.1
 platform: ruby
 authors:
 - Nicholas Evans
 - Jeff Kreeftmeijer
 - jfelchner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEdjCCAt6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdhY2Nv
-  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMTgwODAzMjEz
-  NjUzWhcNMTkwODAzMjEzNjUzWjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
+  MIIEGDCCAoCgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdhY2Nv
+  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMjAxMjI2MjIy
+  NTE5WhcNMjExMjI2MjIyNTE5WjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
   cy9EQz10aGVrb21wYW5lZS9EQz1jb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAw
-  ggGKAoIBgQDR6ma5Z4B2Qz+ykVUKn2CoWwoJ3vStZLDNc6nIOUTUDFS5rg43XwwB
-  nnHCLhHZ9QeNflBpJObMwIUwDqxfZoxhmEILzUfv/yuoBj90zmnf7K2mmsPuT44a
-  aTyZjYGid+yyTbzIpR4CCBHyvGNVm9ss64C2XXPNXrlLO3eAxgB9zNYkxOeJatZp
-  d1h5FZIkAqgw7rx65W+e4HUSNnUvzUmZKoO0u/yMlnc4NcK05RdgHZ5FcXgSAZG/
-  MRzJ0rIdEk7wT8fBJ6w9oeFca8qW7C9M/ONJ4WiS+HoquCRcR+FiNAS3LQtQbiaR
-  ADVS0CBzc2/6zBxWf/+C6wv8vEkoIDSgJ4T07IV2oEJH2ox1z0PYLcNQ9KIrz9iW
-  +Q2DPjjO2+ymR3QOBpOrDr4keYS25tfUiSkBXemHj94Bm95/Szi8At8ywCtBVWUx
-  AumxK9WPjr7WFDk5o71NX4SZft99Ey5XBeZ1+I2v4+ozio/cqOFz9UTarQryCf0e
-  2uJLFPBPkzcCAwEAAaOBljCBkzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
-  HQ4EFgQUUTthhLkcr6+8JU1/B/dxKYaYnKUwLAYDVR0RBCUwI4EhYWNjb3VudHMr
-  cnVieWdlbXNAdGhla29tcGFuZWUuY29tMCwGA1UdEgQlMCOBIWFjY291bnRzK3J1
-  YnlnZW1zQHRoZWtvbXBhbmVlLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAED2U/MD3
-  PHRHyeh9Ge3JTKJ/bjZLYquJWQr+ei4rsNk8oO2O6CcoiC84oNEnpnENHX9KiZu8
-  h7ylKO7u6vKJl9p9IV2YR0uOnXbSApYr5olDDlEz7HNGL3xUCJJhJBf09C4AkaAn
-  kfaOv9Nkko0izYPpKsGlyKvbWBIzT3urBMRNbv95DzhBdNI6RF0q13eCePPqXPGe
-  RaikE1dUWcVsW29XzO/RINmuMcKU6k0caC7X4kTD657Nf74oGUXHxYPmfUmYmppg
-  uAF3jK5824uMvxofLysxqXhrUlTuCVndaexDm3bYK+YrTnZJEu6CimpMYa2u6JEE
-  sWLZKmDLUxEUs/5jVGuypZbSBJBDb6VnmCkoEr3Fmh4O/FH4IZ+Gd3QdYCohLoKd
-  09JNgxpgZHCDuKwoycU+wXdWVSzMtchMQygnEu6th1SY5qHj4ISipBEBtKG0MdgB
-  L3AbMAHTztj5YI+gvmpuV1B4Zv1QZjZWOeNSnLZdrnOQbyyDBzJyXmNV
+  ggGKAoIBgQD0Z84PxtE0iiWCMTQbnit6D4w55GGBQZnhpWUCJwC0SpQ/jnT0Fsma
+  g8oAIdDclLvLC9jzqSAmkOujlpkJMb5NabgkhKFwHi6cVW/gz/cVnISAv8LQTIM5
+  c1wyhwX/YhVFaNYNzMizB//kZOeXnv6x0tqV9NY7urHcT6mCwyLeNJIgf44i1Ut+
+  mKtXxEyXNbfWQLVY95bVoVg3GOCkycerZN4Oh3zSJM1s+cZRBFlg7GR1AE3Xqs6k
+  RhE7yp8ufeghC3bbxgnQrkk8W8Fkkl0/+2JAENpdE4OUepC6dFzDlLZ3UvSk7VHf
+  NBRKSuO15kpPo2G55N0HLy8abUzbu5cqjhSbIk9hzD6AmdGCT4DqlsdHI5gOrGP0
+  BO6VxGpRuRETKoZ4epPCsXC2XAwk3TJXkuuqYkgdcv8ZR4rPW2CiPvRqgG1YVwWj
+  SrIy5Dt/dlMvxdIMiTj6ytAQP1kfdKPFWrJTIA2tspl/eNB+LiYsVdj8d0UU/KTY
+  y7jqKMpOE1UCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO/l0LjdONn2Rr8y4WGyMA37MWVfMA0GCSqGSIb3DQEBCwUAA4IBgQDBGn+T
+  HS7SCuLgjCimsT5e3v+Q0VaML1+yJPPqvIVM+HMyTYDpV2ogdAcX1I0lNbUHT9w7
+  5y8pQ7BtYq8LDX6D8EufjvlgpJzunuPpNVh2QQdtkYC2zGabTnk+BJC5scYckBxW
+  PxYXSuOxjXAkFe1r9RhPzeMY8lPVh6aEQKNLVkzbpIjoGzUgAPGPZG/ylKSWycwE
+  qfHiDXzCAqMzSsb3sMQO1+0euciY1oTOyYCHYKo+gemWEI/p8PyJe/qB2tWC9GYs
+  m+we5ul7O4Sq8qKnX0KCqHneqaXakcbuEkhViW6Def432jH8JjYums6EW2mg9570
+  pHS20TH4u9o0+5DIhayfGrmAtdtQutQNCclONqBlk7r3/16Y8Lr376dDHrISZlwd
+  fdbUKgJXqJeb4GYhiKV07l67XExVjmAklMuA6bcB7mk+aSYUkoWNic4ZYGNjVv88
+  AapqLKNG/UPfrJhdhTtFR4ARb8f54rgzONhTaAqVk23Bdp1yoDXaulFCkmU=
   -----END CERTIFICATE-----
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -103,7 +101,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: the instafailing RSpec progress bar formatter
 test_files: []