rspec-fuubar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04bfd7327af20d94156d340dcb5a270ddaf077ff6e87f042d2a661458e976346
+  data.tar.gz: 46e785e54befce76f3ea61d5c3ee766dd2e9eea97c4a7a934365622939509f63
+SHA512:
+  metadata.gz: 38ecff3bd3530f922d85b7802c9add7694657d804c3e13304f277c7431924395470dd1d12d8210a06d2f673cfa3709058b3cb93b650c677c7a5e00603f4b6a85
+  data.tar.gz: 68d792dae5e54aec07617e37becf32f0be6d6bf9cc7b0a847d9fa322b637e87939a5c23f7dd47ab856bb2510da5b7d2b059321dbd7e739a916c786c2fdd44cb2

data/LICENSE.txt

@@ -0,0 +1,19 @@
+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
+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,224 @@
+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.
+
+![examples][example-gif]
+
+Installation
+--------------------------------------------------------------------------------
+
+```ruby
+gem install fuubar
+
+# or in your Gemfile
+
+gem 'fuubar'
+```
+
+Usage
+--------------------------------------------------------------------------------
+
+In order to use fuubar, you have three options.
+
+### Option 1: Invoke It Manually Via The Command Line
+
+```bash
+rspec --format Fuubar --color
+```
+
+### Option 2: Add It To Your Local `.rspec` File
+
+```text
+# .rspec
+
+--format Fuubar
+--color
+```
+
+### Option 3: Add It To Your `spec_helper.rb`
+
+```ruby
+# spec/spec_helper.rb
+
+RSpec.configure do |config|
+  config.add_formatter 'Fuubar'
+end
+```
+
+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][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.
+
+#### 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/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:
+
+```text
+My Fuubar! <================================                  > 53.44% 00:12:31
+```
+
+### 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
+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
+
+```ruby
+# spec/spec_helper.rb
+
+RSpec.configure do |config|
+  config.fuubar_output_pending_results = false
+end
+```
+
+### Enabling Auto-Refresh
+
+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 = 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:
+
+* Add my public key (if you haven’t already) as a trusted certificate
+
+  ```bash
+  gem cert --add <(curl -Ls https://raw.github.com/thekompanee/fuubar/master/certs/thekompanee.pem)
+  ```
+
+* Install fuubar telling it to use security checks when possible.
+
+  ```bash
+  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
+--------------------------------------------------------------------------------
+
+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-2021 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

@@ -0,0 +1,5 @@
+# Backward compatibility - require the new location
+require "rspec/fuubar"
+
+# Alias at top level for backward compatibility
+Fuubar = RSpec::Fuubar

data/lib/rspec/fuubar.rb

@@ -0,0 +1,147 @@
+require "rspec/core"
+require "rspec/core/formatters/base_formatter"
+require "ruby-progressbar"
+
+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
+
+module RSpec
+  class Fuubar < Core::Formatters::BaseFormatter
+    Core::Formatters.register self,
+      :start,
+      :example_passed,
+      :example_failed,
+      :example_pending,
+      :message,
+      :dump_pending,
+      :dump_failures,
+      :dump_summary,
+      :seed,
+      :close
+
+    DEFAULT_PROGRESS_BAR_OPTIONS = { format: " %c/%C |%w>%i| %e " }.freeze
+
+    attr_reader :progress, :passed_count, :pending_count, :failed_count
+
+    def initialize(output)
+      super
+      @passed_count = 0
+      @pending_count = 0
+      @failed_count = 0
+    end
+
+    def start(notification)
+      @passed_count = 0
+      @pending_count = 0
+      @failed_count = 0
+
+      progress_options = DEFAULT_PROGRESS_BAR_OPTIONS
+                         .merge(throttle_rate: continuous_integration? ? 1.0 : nil)
+                         .merge(RSpec.configuration.fuubar_progress_bar_options)
+                         .merge(total: notification.count,
+                           output:,
+                           autostart: false)
+
+      @progress = ProgressBar.create(progress_options)
+
+      with_current_color { @progress.start }
+    end
+
+    def example_passed(_notification)
+      @passed_count += 1
+      increment
+    end
+
+    def example_pending(_notification)
+      @pending_count += 1
+      increment
+    end
+
+    def example_failed(notification)
+      @failed_count += 1
+
+      # Clear progress bar and output failure immediately
+      @progress&.clear
+
+      output.puts
+      output.puts notification.fully_formatted(@failed_count)
+      output.puts
+
+      increment
+    end
+
+    def message(notification)
+      if @progress.respond_to?(:log)
+        @progress.log(notification.message)
+      else
+        output.puts notification.message
+      end
+    end
+
+    def dump_pending(notification)
+      return unless RSpec.configuration.fuubar_output_pending_results
+      return if notification.pending_examples.empty?
+
+      output.puts
+      output.puts notification.fully_formatted_pending_examples
+    end
+
+    def dump_failures(_notification)
+      # We output failures immediately as they happen
+    end
+
+    def dump_summary(notification)
+      output.puts
+      output.puts notification.fully_formatted
+    end
+
+    def seed(notification)
+      return unless notification.seed_used?
+
+      output.puts notification.fully_formatted
+    end
+
+    def close(_notification)
+      @progress&.stop
+    end
+
+    private
+
+    def increment
+      return unless @progress
+
+      with_current_color { @progress.increment }
+    end
+
+    def with_current_color
+      return yield unless color_enabled?
+
+      output.print "\e[#{color_code_for(current_color)}m"
+      yield
+      output.print "\e[0m"
+    end
+
+    def color_enabled?
+      RSpec.configuration.color_enabled? && output.tty? && !continuous_integration?
+    end
+
+    def current_color
+      if @failed_count.positive?
+        :failure
+      elsif @pending_count.positive?
+        :pending
+      else
+        :success
+      end
+    end
+
+    def color_code_for(symbol)
+      Core::Formatters::ConsoleCodes.console_code_for(symbol)
+    end
+
+    def continuous_integration?
+      ENV["CI"] == "true" || ENV["CONTINUOUS_INTEGRATION"] == "true"
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rspec-fuubar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mikael Henriksson
+- mhenrixon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: the instafailing RSpec progress bar formatter
+email:
+- mikael@mhenrixon.com
+- mikael@zoolutions.llc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/fuubar.rb
+- lib/rspec/fuubar.rb
+homepage: https://github.com/mhenrixon/rspec-fuubar
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/mhenrixon/rspec-fuubar/issues
+  changelog_uri: https://github.com/mhenrixon/rspec-fuubar/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/mhenrixon/rspec-fuubar/tree/releases/v1.0.0
+  homepage_uri: https://github.com/mhenrixon/rspec-fuubar
+  source_code_uri: https://github.com/mhenrixon/rspec-fuubar
+  wiki_uri: https://github.com/mhenrixon/rspec-fuubar/wiki
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: the instafailing RSpec progress bar formatter
+test_files: []