rspec-candy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb539726790eb4bce8711473b8d0a427d1efb63628d1b481bb5e32c80ebc2d84
+  data.tar.gz: 82fe832e4fbfe9261fdc089da5ddd708d71757e866f8a0d3daffabbfca0786d2
+SHA512:
+  metadata.gz: b48d2a468638db3c12ac89f5f5dd0d26ef2197e71cc65f64372e5e2663af85c93f8e5e47983714971d4b7ce2df9a75e4f6b48ba599cecd11c7d51c40b1dd530d
+  data.tar.gz: 92222aef2a3a63af58517433e938f213117c45faff38b69c202040e94c32884507fd7f8e1084feb920267c5c69c8168e2abb32804c0055eadfb812f128d0a0b5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Adam Ladachowski
+
+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,78 @@
+# RSpec::Candy
+
+[![Gem Version](https://badge.fury.io/rb/rspec-candy.svg)](https://badge.fury.io/rb/rspec-candy)
+[![CI](https://github.com/aladac/rspec-candy/actions/workflows/main.yml/badge.svg)](https://github.com/aladac/rspec-candy/actions/workflows/main.yml)
+
+Eye candy for RSpec: beautiful progress bars and coverage reports.
+
+## Features
+
+- **TTY Progress Bar** - Rich progress bar with ETA, rate, and percentage
+- **Colored Output** - Green for pass, red for fail, yellow for pending
+- **Coverage Table** - Automatically displays if SimpleCov data exists
+- **Non-TTY Fallback** - Dots/characters when not in a terminal
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+group :test do
+  gem "rspec-candy"
+end
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Add to `.rspec`:
+
+```
+--require rspec/candy
+--format RSpec::Candy::Formatter
+```
+
+Then just run:
+
+```bash
+bundle exec rspec
+```
+
+You get a progress bar, test results, and coverage table (if SimpleCov is configured) - all in one.
+
+## Screenshot
+
+```
+Running 42 examples...
+
+[██████████████████████████████████████░░░░░░░░░░] 38/42 90% │ 00:01
+
+✓ 42 examples, 0 failures
+Finished in 0.73s
+
+┌─────────────┬────────┬────────────────┬───────┐
+│ File        │ Lines  │ Coverage       │ %     │
+├─────────────┼────────┼────────────────┼───────┤
+│ cli.rb      │ 85/100 │ █████████████░ │ 85.0% │
+│ builder.rb  │ 38/50  │ ███████████░░░ │ 76.0% │
+│ remote.rb   │ 22/40  │ ████████░░░░░░ │ 55.0% │
+└─────────────┴────────┴────────────────┴───────┘
+
+Total: 145/190 (76.3%)
+4 files at 100% (not shown)
+```
+
+## Requirements
+
+- Ruby >= 3.2.0
+- RSpec >= 3.0
+- SimpleCov (for coverage reports)
+
+## License
+
+MIT License. See [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/rspec/candy/coverage.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "json"
+require "pastel"
+require "tty-table"
+require "tty-progressbar"
+
+module RSpec
+  module Candy
+    class Coverage
+      DEFAULT_COVERAGE_PATH = "coverage/.resultset.json"
+
+      def initialize(coverage_path: nil, lib_filter: "lib/")
+        @coverage_path = coverage_path || DEFAULT_COVERAGE_PATH
+        @lib_filter = lib_filter
+        @pastel = Pastel.new
+      end
+
+      def report(silent: false)
+        unless File.exist?(@coverage_path)
+          return true if silent
+          warn @pastel.red("Coverage data not found at #{@coverage_path}")
+          warn @pastel.dim("Run your tests first to generate coverage data")
+          return false
+        end
+
+        data = JSON.parse(File.read(@coverage_path))
+        coverage = data.values.first["coverage"]
+
+        results = parse_results(coverage)
+        return true if results.empty?
+
+        print_table(results)
+        true
+      end
+
+      private
+
+      def parse_results(coverage)
+        coverage.filter_map do |file, cov_data|
+          next unless file.include?(@lib_filter)
+
+          lines = cov_data["lines"]
+          name = file.sub(%r{.*/#{Regexp.escape(@lib_filter)}}, @lib_filter)
+          total = lines.count { |l| l.is_a?(Integer) }
+          covered = lines.count { |l| l.is_a?(Integer) && l.positive? }
+          pct = total.positive? ? (covered.to_f / total * 100).round(1) : 100.0
+
+          [name, covered, total, pct]
+        end
+      end
+
+      def print_table(results)
+        full_coverage_count = results.count { |r| r[3] == 100.0 }
+        incomplete = results.reject { |r| r[3] == 100.0 }.sort_by { |r| -r[3] }
+        totals = results.reduce([0, 0]) { |acc, r| [acc[0] + r[1], acc[1] + r[2]] }
+        total_pct = (totals[0].to_f / totals[1] * 100).round(1)
+
+        rows = incomplete.map do |name, covered, total, pct|
+          short = name.sub(%r{^#{Regexp.escape(@lib_filter)}}, "")
+          bar = progress_bar(pct)
+          [short, "#{covered}/#{total}", bar, "#{pct}%"]
+        end
+
+        table = TTY::Table.new(
+          header: [@pastel.bold("File"), @pastel.bold("Lines"), @pastel.bold("Coverage"), @pastel.bold("%")],
+          rows: rows
+        )
+
+        puts
+        puts table.render(:unicode, padding: [0, 1]) { |r| r.border.style = :dim }
+        puts
+        puts @pastel.bold("Total: ") + "#{totals[0]}/#{totals[1]} (#{total_pct}%)"
+        puts @pastel.dim("#{full_coverage_count} files at 100% (not shown)")
+      end
+
+      def progress_bar(pct, width: 20)
+        filled = (pct / 100.0 * width).round
+        empty = width - filled
+        color = if pct >= 80
+          :green
+        elsif pct >= 50
+          :yellow
+        else
+          :red
+        end
+        @pastel.decorate("█" * filled, color) + @pastel.dim("░" * empty)
+      end
+    end
+  end
+end

data/lib/rspec/candy/formatter.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+require "tty-progressbar"
+require "pastel"
+
+module RSpec
+  module Candy
+    class Formatter
+      ::RSpec::Core::Formatters.register self,
+        :start, :example_passed, :example_failed, :example_pending, :stop, :dump_summary
+
+      def initialize(output)
+        @output = output
+        @failed = []
+        @pending = []
+        @pastel = Pastel.new(enabled: output.tty?)
+        @tty = output.tty?
+      end
+
+      def start(notification)
+        @total = notification.count
+        @current = 0
+        @output.puts @pastel.cyan("Running #{@total} examples...")
+        @output.puts
+        return unless @tty
+
+        require "tty-screen"
+        term_width = TTY::Screen.width rescue 140
+        bar_width = [term_width - 45, 80].min
+        @bar = TTY::ProgressBar.new(
+          "[:bar] :current/:total :percent │ :eta_time │ :rate/s",
+          total: @total,
+          width: bar_width,
+          complete: @pastel.green("█"),
+          incomplete: @pastel.dim("░"),
+          output: @output,
+          hide_cursor: true,
+          frequency: 10
+        )
+        @bar.start
+      end
+
+      def example_passed(_notification)
+        @current += 1
+        @tty ? @bar.advance : @output.print(@pastel.green("."))
+      end
+
+      def example_failed(notification)
+        @current += 1
+        @failed << notification
+        @tty ? @bar.advance : @output.print(@pastel.red("F"))
+      end
+
+      def example_pending(notification)
+        @current += 1
+        @pending << notification
+        @tty ? @bar.advance : @output.print(@pastel.yellow("*"))
+      end
+
+      def stop(_notification)
+        @bar&.finish
+        @output.puts
+      end
+
+      def dump_summary(summary)
+        @output.puts
+        print_failures if @failed.any?
+
+        status = if @failed.any?
+          @pastel.red.bold("✗ #{summary.example_count} examples, #{@failed.size} failures")
+        else
+          @pastel.green.bold("✓ #{summary.example_count} examples, 0 failures")
+        end
+        status += @pastel.yellow(" (#{@pending.size} pending)") if @pending.any?
+        @output.puts status
+        @output.puts @pastel.dim("Finished in #{summary.duration.round(2)}s")
+
+        print_coverage if coverage_available?
+      end
+
+      private
+
+      def coverage_available?
+        File.exist?(Coverage::DEFAULT_COVERAGE_PATH)
+      end
+
+      def print_coverage
+        Coverage.new.report(silent: true)
+      end
+
+      def print_failures
+        @output.puts @pastel.red.bold("\nFailures:\n")
+        @failed.each_with_index do |failure, idx|
+          @output.puts "  #{idx + 1}) #{failure.example.full_description}"
+          @output.puts @pastel.red("     #{failure.exception.message}")
+          if failure.exception.backtrace&.first
+            @output.puts @pastel.dim("     #{failure.exception.backtrace.first}")
+          end
+          @output.puts
+        end
+      end
+    end
+  end
+end

data/lib/rspec/candy/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Candy
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/candy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "candy/version"
+require_relative "candy/formatter"
+require_relative "candy/coverage"
+
+module RSpec
+  module Candy
+    class Error < StandardError; end
+  end
+end

data/sig/rspec/candy.rbs

@@ -0,0 +1,6 @@
+module Rspec
+  module Candy
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rspec-candy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Ladachowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-10 00:00:00.000000000 Z
+dependencies:
+- !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: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A beautiful RSpec formatter with TTY progress bars, colored output, and
+  a stunning coverage report table.
+email:
+- adam.ladachowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/candy.rb
+- lib/rspec/candy/coverage.rb
+- lib/rspec/candy/formatter.rb
+- lib/rspec/candy/version.rb
+- sig/rspec/candy.rbs
+homepage: https://github.com/aladac/rspec-candy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aladac/rspec-candy
+  source_code_uri: https://github.com/aladac/rspec-candy
+  changelog_uri: https://github.com/aladac/rspec-candy/blob/main/CHANGELOG.md
+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.5.22
+signing_key:
+specification_version: 4
+summary: 'Eye candy for RSpec: pretty progress bars and coverage reports'
+test_files: []