rspec-progress_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d83a41d2b9557dbd158d675d1232192918fa195009d64097d39952ce95b2051a
+  data.tar.gz: 19523044b6d631bbe61fc5c580e81d301cb17da5d1954bbe2682cf3118d3598a
+SHA512:
+  metadata.gz: fd77f8b65909818ee9e24b094c32d3ecf0370f8e511e23a2f2364252ff23008fabfd4eaf603d5ed7ef5b0a8ffa6e6ac27bca65b419db676929dc1d35670a95c0
+  data.tar.gz: 7d90ce013ff8f5391fdf2554aa7726052635956a2615eb4ee2c30fa1c831ce33d5c686edeb5d74d8db16b61658abce8a13f797e0f4516480fb693c3fb055e42d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,133 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - node_modules/**/*
+  NewCops: enable
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/EmptyLinesAroundAccessModifier:
+  EnforcedStyle: only_before
+
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+    - "**/*.rake"
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/KeywordParametersOrder:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+    '%w': '()'
+    '%r': '()'
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.3.2
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-progress_table.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.75"

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    rspec-progress_table (0.1.0)
+      concurrent-ruby (~> 1.3)
+      tty-table (~> 0.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    concurrent-ruby (1.3.5)
+    diff-lcs (1.5.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.75.8)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-color (0.6.0)
+    tty-screen (0.8.2)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unicode-display_width (2.6.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-progress_table!
+  rubocop (~> 1.75)
+
+BUNDLED WITH
+   2.6.6

data/README.md

@@ -0,0 +1,46 @@
+# Rspec::ProgressTable
+
+![Example](doc/exmple.png)
+
+RSpec::ProgressTable is an RSpec formatter that displays test progress in a table format during RSpec runs.
+
+## Usage
+
+    bundle add rspec-progress_table
+    bin/rspec --require rspec/progress_table --format RSpec::ProgressTable::Formatter spec
+
+
+Since it's a hassle to specify the options every time, you can add the following to your `.rspec` file and simply run `bin/rspec spec`:
+
+    --require rspec/progress_table --format RSpec::ProgressTable::Formatter
+
+## Using with test-queue
+
+When using it together with [tmm1/test-queue](https://github.com/tmm1/test-queue), configure it like this:
+
+```ruby
+# ...
+
+# Start the progress output server
+# Suppress default output
+require "rspec/progress_table/test_queue"
+RSpec::ProgressTable::TestQueue.use
+
+class FooRunner < TestQueue::Runner::RSpec
+  # Send total number of spec files and current progress to the progress output server
+  include ::RSpec::ProgressTable::TestQueue::Runner
+end
+
+FooRunner.new.execute
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/labocho/rspec-progress_table.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/progress_table"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/progress_table/formatter.rb

@@ -0,0 +1,58 @@
+require "rspec"
+require "drb/drb"
+
+module RSpec
+  module ProgressTable
+    class Formatter < RSpec::Core::Formatters::ProgressFormatter
+      RSpec::Core::Formatters.register self, :example_started, :example_passed, :example_pending, :example_failed, :start, :dump_failures, :dump_pending, :dump_summary
+
+      attr_reader :server
+
+      def initialize(output)
+        super
+        DRb.start_service
+        @server = if ENV["RSPEC_PROGRESS_TABLE_SERVER"]
+          DRbObject.new_with_uri(ENV["RSPEC_PROGRESS_TABLE_SERVER"])
+        else
+          Server.start
+          DRbObject.new_with_uri(DEFAULT_SERVER_URL)
+        end
+      end
+
+      def start(notification)
+        server.update_total(Process.pid, notification.count)
+      end
+
+      def example_started(_)
+      end
+
+      def example_passed(_)
+        server.passed(Process.pid)
+      end
+
+      def example_failed(_)
+        server.failed(Process.pid)
+      end
+
+      def example_pending(_)
+        server.pending(Process.pid)
+      end
+
+      def dump_failures(notification)
+        return if notification.failure_notifications.empty?
+
+        server.dump(notification.fully_formatted_failed_examples)
+      end
+
+      def dump_pending(notification)
+        return if notification.pending_examples.empty?
+
+        server.dump(notification.fully_formatted_pending_examples)
+      end
+
+      def dump_summary(summary)
+        server.dump(summary.fully_formatted)
+      end
+    end
+  end
+end

data/lib/rspec/progress_table/server.rb

@@ -0,0 +1,88 @@
+require "tty/table"
+require "drb/drb"
+require "concurrent"
+
+module RSpec
+  module ProgressTable
+    class Server
+      Progress = Struct.new(:pid, :passed, :failed, :pending, :total)
+      attr_reader :progresses, :output, :number_of_queue_shifted, :queue_size, :show_total
+      attr_accessor :previous_rendered_lines
+
+      def self.start(url = DEFAULT_SERVER_URL)
+        DRb.start_service(url, new)
+      end
+
+      def initialize(output = $stdout)
+        @progresses = Concurrent::Map.new {|m, pid|
+          m[pid] = Progress.new(pid, 0, 0, 0, 0)
+        }
+        @previous_rendered_lines = 0
+        @output = output
+        @queue_size = 0
+        @number_of_queue_shifted = 0
+        @show_total = false
+      end
+
+      def passed(pid)
+        progresses[pid].passed += 1
+        render
+      end
+
+      def failed(pid)
+        progresses[pid].failed += 1
+        render
+      end
+
+      def pending(pid)
+        progresses[pid].pending += 1
+        render
+      end
+
+      def update_total(pid, n)
+        progresses[pid].total = n
+        @show_total = true if n > 0
+      end
+
+      def dump(s)
+        puts s
+        self.previous_rendered_lines = 0
+      end
+
+      def update_queue_size(n)
+        @queue_size = n
+      end
+
+      def queue_shifted
+        @number_of_queue_shifted += 1
+      end
+
+      def render
+        table = TTY::Table.new(header: %w(PID Passed Failed Pending) + (show_total ? ["Total"] : []))
+        progresses.each_value do |progress|
+          table << (
+            [
+              progress.pid,
+              RSpec::Core::Formatters::ConsoleCodes.wrap(progress.passed, :success),
+              RSpec::Core::Formatters::ConsoleCodes.wrap(progress.failed, :failure),
+              RSpec::Core::Formatters::ConsoleCodes.wrap(progress.pending, :pending),
+            ] + (show_total ? [progress.total] : [])
+          )
+        end
+
+        s = table.render(:unicode, padding: [0, 1, 0, 1], alignments: [:left, :right, :right, :right, :right])
+        line_count = s.lines.count
+
+        output.write("\e[1A" * previous_rendered_lines) if previous_rendered_lines > 0
+        output.puts(s)
+
+        unless queue_size.zero?
+          r = format("%.2f", number_of_queue_shifted / queue_size.to_f * 100)
+          puts "Queue: #{number_of_queue_shifted} / #{queue_size} (#{r}%)"
+          line_count += 1
+        end
+        self.previous_rendered_lines = line_count
+      end
+    end
+  end
+end

data/lib/rspec/progress_table/test_queue.rb

@@ -0,0 +1,51 @@
+module RSpec
+  module ProgressTable
+    module TestQueue
+      class << self
+        attr_reader :server
+
+        def use(server_url = DEFAULT_SERVER_URL)
+          # Example 名と処理時間の表示を抑制
+          RSpec::Core::QueueRunner.include(
+            Module.new do
+              def print(s)
+                # nop
+              end
+
+              def puts(s)
+                # nop
+              end
+            end,
+          )
+
+          RSpec::ProgressTable::Server.start(server_url)
+          @server = DRbObject.new_with_uri(server_url)
+          ENV["RSPEC_PROGRESS_TABLE_SERVER"] = server_url
+        end
+      end
+
+      module Runner
+        module PrependingMethods
+          def prepare(concurrency)
+            ::RSpec::ProgressTable::TestQueue.server.update_queue_size(@queue.size)
+            @queue.singleton_class.prepend(
+              Module.new {
+                def shift
+                  ::RSpec::ProgressTable::TestQueue.server.queue_shifted
+                  super
+                end
+              },
+            )
+            super
+          end
+        end
+
+        def self.included(base)
+          base.class_eval do
+            prepend PrependingMethods
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/progress_table/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module ProgressTable
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/rspec/progress_table.rb

@@ -0,0 +1,12 @@
+require "rspec/progress_table/version"
+
+module RSpec
+  module ProgressTable
+    class Error < StandardError; end
+
+    DEFAULT_SERVER_URL = "druby://localhost:8787".freeze
+  end
+end
+
+require_relative "progress_table/server"
+require_relative "progress_table/formatter"

data/rspec-progress_table.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/rspec/progress_table/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-progress_table"
+  spec.version       = Rspec::ProgressTable::VERSION
+  spec.authors       = ["labocho"]
+  spec.email         = ["labocho@penguinlab.jp"]
+
+  spec.summary       = "RSpec formatter that shows progress in a table format."
+  spec.description   = "RSpec formatter that shows progress in a table format."
+  spec.homepage      = "https://gitub.com/socioart/rspec-progress_table"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitub.com/socioart/rspec-progress_table"
+  spec.metadata["changelog_uri"] = "https://github.com/socioart/rspec-progress_table/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r(^exe/)) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "concurrent-ruby", "~> 1.3"
+  spec.add_dependency "tty-table", "~> 0.12.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rspec-progress_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- labocho
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: RSpec formatter that shows progress in a table format.
+email:
+- labocho@penguinlab.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- lib/rspec/progress_table.rb
+- lib/rspec/progress_table/formatter.rb
+- lib/rspec/progress_table/server.rb
+- lib/rspec/progress_table/test_queue.rb
+- lib/rspec/progress_table/version.rb
+- rspec-progress_table.gemspec
+homepage: https://gitub.com/socioart/rspec-progress_table
+licenses: []
+metadata:
+  homepage_uri: https://gitub.com/socioart/rspec-progress_table
+  source_code_uri: https://gitub.com/socioart/rspec-progress_table
+  changelog_uri: https://github.com/socioart/rspec-progress_table/blob/main/CHANGELOG.md
+  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: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: RSpec formatter that shows progress in a table format.
+test_files: []