clean_reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5aeb30c43cd57e2acc51984540baec2e656445bb4f4d1f0f1e0acef2e3722d9a
+  data.tar.gz: c408d6feb3de0ae1c7a44b4e44fc4620e13867d67011bff9d05be2128b880507
+SHA512:
+  metadata.gz: adeb89f6691b5a5e1fb5c3733797d903f86d1b4335951900461d0454a27b71f5f646576773796b474f66e31d87721ff1e8d4e0600bded7fdfefaab4f1b8cb7d4
+  data.tar.gz: 061baff79ad5f49add237f2383ddf0f4d384f4095cf5bd30a7273abc2b262e9818cc7f9944a5b8400ad89ca7d48f2e55ec66d60bdfe62e2eef2403f3fbf7a3fc

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Andy Waite
+
+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,51 @@
+# clean_reporter
+
+This gem is an opinionated reporter for minitest with the intention of reducing visual clutter.
+
+By default minitest will show the test duration to 6 decimal places, along with statistics on the test run.
+
+```
+Finished in 0.005735s, 3836.0942 runs/s, 3836.0942 assertions/s.
+```
+
+While that information might be occasionally useful, usually we are just interested to know if the tests are passing or not.
+
+clean_reporter reduces the above output to just:
+
+```
+Finished tests in 0.0s
+```
+
+(I have idea for improvements, but that's all for this initial release)
+
+## Implementation Notes
+
+For convenience this is built this on top of [minitest-reporters](https://github.com/minitest-reporters/minitest-reporters) but it should be possible to re-write it without that dependency.
+
+## Installation
+
+Add `clean_reporter` as a development dependency in your `Gemfile`.
+
+Then in your `test_helper.rb` add:
+
+```ruby
+require "clean_reporter"
+```
+
+## Usage
+
+Run your tests in the normal way.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/andyw8/clean_reporter.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/clean_reporter/version.rb

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

data/lib/clean_reporter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "clean_reporter/version"
+require "minitest/reporters"
+
+module CleanReporter
+  class Error < StandardError; end
+
+  class Reporter < Minitest::Reporters::DefaultReporter
+    def on_report
+      status_line = "Finished tests in %.1fs" % [total_time]
+
+      puts
+      puts
+      puts colored_for(suite_result, status_line)
+      puts
+
+      unless @fast_fail
+        tests.reject(&:passed?).each do |test|
+          print_failure(test)
+        end
+      end
+
+      if @slow_count > 0
+        slow_tests = tests.sort_by(&:time).reverse.take(@slow_count)
+
+        puts
+        puts "Slowest tests:"
+        puts
+
+        slow_tests.each do |test|
+          puts "%.6fs %s#%s" % [test.time, test.name, test_class(test)]
+        end
+      end
+
+      if @slow_suite_count > 0
+        slow_suites = @suite_times.sort_by { |x| x[1] }.reverse.take(@slow_suite_count)
+
+        puts
+        puts "Slowest test classes:"
+        puts
+
+        slow_suites.each do |slow_suite|
+          puts "%.6fs %s" % [slow_suite[1], slow_suite[0]]
+        end
+      end
+
+      puts
+      print colored_for(suite_result, result_line)
+      puts
+    end
+  end
+end
+
+Minitest::Reporters.use!([CleanReporter::Reporter.new(color: true)])

data/sig/clean_reporter.rbs

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: clean_reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Waite
+bindir: exe
+cert_chain: []
+date: 2025-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+email:
+- andyw8@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/clean_reporter.rb
+- lib/clean_reporter/version.rb
+- sig/clean_reporter.rbs
+homepage: https://github.com/andyw8/clean_reporter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/andyw8/clean_reporter
+  source_code_uri: https://github.com/andyw8/clean_reporter
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A clean reporter for minitest
+test_files: []