minitest-flash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45843ba5a15f1ed1ac8b516a3c98b37db272d6d151b52920a94b1d274c5a301a
+  data.tar.gz: 579b725590cda01c4e5fc251757615972eef9188eb4c2d941953655eec43bff8
+SHA512:
+  metadata.gz: 45e33fc268707560c25097c7cee70085e7007de8265d741c7dd4188fa6492bb299e5b74bed0f56a94ed6115c5e4ef9acf34fbfe7d29618e1f448bd055d9ff3b2
+  data.tar.gz: 8a404161ea44fbb6c4293f4e0edd58c637eecfc77d479cb562e492d9b415858c392b3862593d76964d861f2e3fcfb90dd08b29c20afba238a2c27ac6cc1a3614

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Main
+
+Nothing so far
+
+## 0.1.0
+
+#### Initial Implementation
+* Require Ruby 3
+* Reporter which calls `minitest-flash` executable if present
+* Demo sound effects

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sven Schwyn
+
+MIT License
+
+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,114 @@
+[![Version](https://img.shields.io/gem/v/minitest-flash.svg?style=flat)](https://rubygems.org/gems/minitest-flash)
+[![Tests](https://img.shields.io/github/actions/workflow/status/svoop/minitest-flash/test.yml?style=flat&label=tests)](https://github.com/svoop/minitest-flash/actions?workflow=Test)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/svoop/minitest-flash.svg?style=flat)](https://codeclimate.com/github/svoop/minitest-flash/)
+[![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
+
+# Minitest::Flash
+
+Simple Minitest reporter to indicate the result of test runs in as fancy a way you like. Here's how I like it: Flash the macOS menu bar in green or red and play a short and mutable sound effect.
+
+* [Homepage](https://github.com/svoop/minitest-flash)
+* [API](https://www.rubydoc.info/gems/minitest-flash)
+* Author: [Sven Schwyn - Bitcetera](https://bitcetera.com)
+
+## Install
+
+This gem is [cryptographically signed](https://guides.rubygems.org/security/#using-gems) in order to assure it hasn't been tampered with. Unless already done, please add the author's public key as a trusted certificate now:
+
+```
+gem cert --add <(curl -Ls https://raw.github.com/svoop/minitest-flash/main/certs/svoop.pem)
+```
+
+Add the following to the <tt>Gemfile</tt> or <tt>gems.rb</tt> of your [Bundler](https://bundler.io) powered Ruby project:
+
+```ruby
+gem 'minitest-flash'
+```
+
+And then install the bundle:
+
+```
+bundle install --trust-policy MediumSecurity
+```
+
+Finally, require this gem in your `test_helper.rb` or `spec_helper.rb`:
+
+```ruby
+require 'minitest/flash'
+```
+
+## Usage
+
+After every test run, the reporter simply invokes the `minitest-flash` executable:
+
+* `minitest-flash green` if the run passed
+* `minitest-flash red` if the run failed or has errors
+
+It's your job to create the `minitest-flash` executable to your liking and to place it somewhere in the `PATH`.
+
+Other people might work on the same code and prefer not use `minitest-flash`. This is no problem as it won't do a thing unless a `minitest-flash` executable exists.
+
+## Example
+
+I'm on macOS and like things to be as obvious and unobtrusive as possible: Flash the menu bar either in green or red and optionally play a sound effect.
+
+![Screenshot](https://github.com/svoop/minitest-flash/raw/main/doc/screenshot.gif)
+
+Here's what my `/usr/local/bin/minitest-flash` executable looks like:
+
+```zsh
+#!/bin/zsh
+
+declare -A colors
+colors[red]=bb0000
+colors[green]=00bb00
+
+if [ -z "$MINITEST_FLASH_NO_SOUND" ]; then
+  mpg123 $0.d/$1.mp3 2>/dev/null &
+fi
+
+for i in {1..2}; do
+  $0.d/ChangeMenuBarColor SolidColor "$colors[$1]" >/dev/null
+  $0.d/ChangeMenuBarColor SolidColor "000000" >/dev/null
+done
+```
+
+As you see, the sound effects can easily be muted with:
+
+```zsh
+export MINITEST_FLASH_NO_SOUND=1
+```
+
+For the above to work, you have to install `mpg123` easiest through [Homebrew](https://brew.sh/):
+
+```zsh
+brew install mpg123
+```
+
+A few support files are also necessary, let's create the directory for them:
+
+```zsh
+sudo mkdir /usr/local/bin/minitest-flash.d
+```
+
+In there you have to put three files:
+
+* the latest binary release of [ChangeMenuBarColor](https://github.com/igorkulman/ChangeMenuBarColor)
+* a [sound file `green.mp3`](https://github.com/svoop/minitest-flash/raw/main/doc/green.mp3) for successful runs
+* a [sound file `red.mp3`](https://github.com/svoop/minitest-flash/raw/main/doc/red.mp3) for failed or errored runs
+
+## Development
+
+To install the development dependencies and then run the test suite:
+
+```
+bundle install
+bundle exec rake    # run tests once
+bundle exec guard   # run tests whenever files are modified
+```
+
+You're welcome to [submit issues](https://github.com/svoop/minitest-flash/issues) and contribute code by [forking the project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/minitest/flash/reporter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Flash
+    class Reporter < StatisticsReporter
+      def report
+        super
+        begin
+          `minitest-flash #{test_color}`
+        rescue Errno::ENOENT
+        end
+      end
+
+      def test_color
+        errors == 0 && failures == 0 ? :green : :red
+      end
+
+      # When using the following methods together with `minitest-reporters`,
+      # they are required.
+      def add_defaults(defaults); end
+      def before_test(test); end
+      def after_test(test); end
+    end
+  end
+end

data/lib/minitest/flash/version.rb

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

data/lib/minitest/flash.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'flash/version'

data/lib/minitest/flash_plugin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'flash'
+require_relative 'flash/reporter'
+
+module Minitest
+  def self.plugin_flash_init(*)
+    self.reporter << Minitest::Flash::Reporter.new
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: minitest-flash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sven Schwyn
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDODCCAiCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhydWJ5
+  L0RDPWJpdGNldGVyYS9EQz1jb20wHhcNMjIxMTA2MTIzNjUwWhcNMjMxMTA2MTIz
+  NjUwWjAjMSEwHwYDVQQDDBhydWJ5L0RDPWJpdGNldGVyYS9EQz1jb20wggEiMA0G
+  CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDcLg+IHjXYaUlTSU7R235lQKD8ZhEe
+  KMhoGlSUonZ/zo1OT3KXcqTCP1iMX743xYs6upEGALCWWwq+nxvlDdnWRjF3AAv7
+  ikC+Z2BEowjyeCCT/0gvn4ohKcR0JOzzRaIlFUVInlGSAHx2QHZ2N8ntf54lu7nd
+  L8CiDK8rClsY4JBNGOgH9UC81f+m61UUQuTLxyM2CXfAYkj/sGNTvFRJcNX+nfdC
+  hM9r2kH1+7wsa8yG7wJ2IkrzNACD8v84oE6qVusN8OLEMUI/NaEPVPbw2LUM149H
+  PVa0i729A4IhroNnFNmw4wOC93ARNbM1+LW36PLMmKjKudf5Exg8VmDVAgMBAAGj
+  dzB1MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSfK8MtR62mQ6oN
+  yoX/VKJzFjLSVDAdBgNVHREEFjAUgRJydWJ5QGJpdGNldGVyYS5jb20wHQYDVR0S
+  BBYwFIEScnVieUBiaXRjZXRlcmEuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQAYG2na
+  ye8OE2DANQIFM/xDos/E4DaPWCJjX5xvFKNKHMCeQYPeZvLICCwyw2paE7Otwk6p
+  uvbg2Ks5ykXsbk5i6vxDoeeOLvmxCqI6m+tHb8v7VZtmwRJm8so0eSX0WvTaKnIf
+  CAn1bVUggczVdNoBXw9WAILKyw9bvh3Ft740XZrR74sd+m2pGwjCaM8hzLvrVbGP
+  DyYhlBeRWyQKQ0WDIsiTSRhzK8HwSTUWjvPwx7SEdIU/HZgyrk0ETObKPakVu6bH
+  kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
+  fwIwU1MKlFBdsjkd
+  -----END CERTIFICATE-----
+date: 2023-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Simple Minitest reporter to indicate the result of test runs. After every
+  test run, the reporter invokes the `minitest-flash` executable (created by
+  you and to your liking) with either the argument "green" or "red" to reflect
+  the result of the run.
+email:
+- ruby@bitcetera.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/minitest/flash.rb
+- lib/minitest/flash/reporter.rb
+- lib/minitest/flash/version.rb
+- lib/minitest/flash_plugin.rb
+homepage: https://github.com/svoop/minitest-flash
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/svoop/minitest-flash
+  changelog_uri: https://github.com/svoop/minitest-flash/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/svoop/minitest-flash
+  documentation_uri: https://www.rubydoc.info/gems/minitest-flash
+  bug_tracker_uri: https://github.com/svoop/minitest-flash/issues
+post_install_message:
+rdoc_options:
+- "--title"
+- Minitest::Flash
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.18
+signing_key:
+specification_version: 4
+summary: Simple Minitest reporter to indicate the result of test runs in as fancy
+  a way you like
+test_files: []