rspec_pending_filter_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0991b6f09b018e66d408767dcd32c89c7c490dbf89711e51814f969dd7c7355b'
+  data.tar.gz: 9f2e13b7ec05fdc6f83aed01f35e83bb3d0d19756f9b59de3fc3df49e212ab20
+SHA512:
+  metadata.gz: a618de086936943bf18c3baf94ee4f115f93ec4577897f97a2bde53dbb666c68215e62cd3d44dabe7c7fb9d440814f47e22d10e673431016714a5e4e29f2a484
+  data.tar.gz: c3f2c3d5f9bcc4c232fc1375c37620da20b9d8944c77d34b53cc0d5478db7a22a83dc5dc864d3783d89a7dfeccf09530dca8fff6701fa403527504812f381209

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-11-20
+
+### Added
+- Initial release
+- Custom RSpec formatter that filters pending test details
+- Shows only count of pending tests in summary
+- Displays "*" character during test execution for pending tests
+- Based on `ProgressFormatter` for familiar output style

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 willnet
+
+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,104 @@
+# RSpec Pending Filter Formatter
+
+A custom RSpec formatter that suppresses detailed pending test output and shows only the count in the summary.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_pending_filter_formatter'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rspec_pending_filter_formatter
+```
+
+## Usage
+
+You can use this formatter by specifying it on the command line:
+
+```bash
+rspec --format RSpecPendingFilterFormatter::Formatter
+```
+
+Or configure it in your `.rspec` file:
+
+```
+--format RSpecPendingFilterFormatter::Formatter
+```
+
+Or in your `spec/spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  config.formatter = RSpecPendingFilterFormatter::Formatter
+end
+```
+
+## What it does
+
+This formatter extends the standard `ProgressFormatter` and modifies the behavior for pending tests:
+
+- **During test execution**: Pending tests show the "*" character as usual
+- **No detailed output**: File paths, line numbers, and reasons for pending tests are not displayed
+- **Summary**: The count of pending tests is shown only in the final RSpec summary line
+
+### Standard RSpec output (with pending details)
+
+```
+..*..F
+
+Pending: (Failures listed here)
+  1) User registration validates email format
+     # Not yet implemented
+     # ./spec/user_spec.rb:15
+
+Failures:
+  ...
+
+Finished in 0.5 seconds
+5 examples, 1 failure, 1 pending
+```
+
+### With this formatter
+
+```
+..*..F
+
+Failures:
+  ...
+
+Finished in 0.5 seconds
+5 examples, 1 failure, 1 pending
+```
+
+## Why use this?
+
+This formatter is useful when:
+
+- You have many pending tests that clutter the output
+- You want to focus on failures and successes during test execution
+- You only need to know the count of pending tests in the summary, not the detailed reasons
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/willnet/rspec-pending-filter-formatter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rspec_pending_filter_formatter/formatter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rspec/core/formatters/progress_formatter"
+
+module RSpecPendingFilterFormatter
+  class Formatter < RSpec::Core::Formatters::ProgressFormatter
+    RSpec::Core::Formatters.register self, :dump_pending
+
+    # Override to suppress pending examples output
+    def dump_pending(_notification)
+      # Do nothing - the pending count will be displayed elsewhere
+    end
+  end
+end

data/lib/rspec_pending_filter_formatter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RSpecPendingFilterFormatter
+  VERSION = "0.1.0"
+end

data/lib/rspec_pending_filter_formatter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "rspec_pending_filter_formatter/version"
+require_relative "rspec_pending_filter_formatter/formatter"
+
+module RSpecPendingFilterFormatter
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rspec_pending_filter_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- willnet
+bindir: exe
+cert_chain: []
+date: 1980-01-02 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.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: A custom RSpec formatter that suppresses detailed pending test output
+  and shows only the count in the summary
+email:
+- netwillnet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec_pending_filter_formatter.rb
+- lib/rspec_pending_filter_formatter/formatter.rb
+- lib/rspec_pending_filter_formatter/version.rb
+homepage: https://github.com/willnet/rspec_pending_filter_formatter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/willnet/rspec_pending_filter_formatter
+  source_code_uri: https://github.com/willnet/rspec_pending_filter_formatter
+  changelog_uri: https://github.com/willnet/rspec_pending_filter_formatter/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RSpec formatter that filters out detailed pending test information
+test_files: []