test_notifier 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d8fd6d8f3c507c644caa30c41ecc00286ed974b
-  data.tar.gz: c6985dcc140c2b59dded50c59bcc538a217778aa
+SHA256:
+  metadata.gz: a4b46a9c384eb5f3be2092410e47fc46908be2cb8d43cf91921ad77b414b8ed3
+  data.tar.gz: 0faba90248d756a52211df5e83553256e15996e0e092729a63cac91d6a9b803c
 SHA512:
-  metadata.gz: ef1b1773a57e18902b2264e41464f08998fb72cbb4c74cb9b4688fb79d4572f646ab085f82646047e654182b97527bcaffba8889bbea4ec7f2b945c01118e387
-  data.tar.gz: 905c8b9129e4ca416ac8d0734beeb11cebcef1bb0c77e051596f22e34ef2aa05a4cf93236c633db52254ee13137a7c40ce900bdcc79afbd2948c7a9c30ca178b
+  metadata.gz: aac8c5ae3acc691ee740a4db73fa09a18d440e89d5532c11b57563e5bf98681ac1d12470faa1f570155969a2a5b88d2538deddae6fe6461565ffaef88966a654
+  data.tar.gz: fc03272885566e612f757b21dba81f6297e7fc6907ab61b60b675b6ce2628cec2b263edac21a8adc186daf6c0de08c5e73a29906f3216c6965f2d1ae16a64b03

data/.gitignore

@@ -1,3 +1,5 @@
 *.gem
 pkg
-nbproject
+nbproject
+*.lock
+hud.xcworkspace/xcuserdata

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+
+Minitest/UselessAssertion:
+  Exclude:
+    - test/fixtures/*

data/Gemfile

@@ -1,2 +1,4 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -0,0 +1,58 @@
+# Test Notifier
+
+Display notifications when tests run. Supports Minitest and RSpec.
+
+## Installation
+
+```
+gem install test_notifier
+```
+
+Check <https://github.com/fnando/notifier> to see how you can configure a
+notifier for your OS.
+
+## Usage
+
+You can set the default notifier, in case you want to use an specific one.
+
+```ruby
+TestNotifier.default_notifier = :terminal_notifier
+```
+
+The available notifiers are `:terminal_notifier`, `:hud`, `:kdialog`,
+`:knotify`, `:notify_send`, `:osd_cat`, and `:snarl`.
+
+If you'd like to make Test Notifier optional for your project:
+
+```ruby
+TestNotifier.silence_no_notifier_warning = true
+```
+
+## Maintainer
+
+- Nando Vieira - https://nandovieira.com
+
+## Collaborators
+
+https://github.com/fnando/test_notifier/graphs/contributors
+
+## License
+
+(The 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/Rakefile

@@ -1,5 +1,19 @@
+# frozen_string_literal: true
+
 require "bundler"
 Bundler::GemHelper.install_tasks
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
+# require "rspec/core/rake_task"
+# RSpec::Core::RakeTask.new
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/minitest/test_notifier_plugin.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minitest
+  def self.plugin_test_notifier_init(_options)
+    reporter << TestNotifier::MinitestReporter.new
+  end
+end

data/lib/test_notifier/runner/minitest.rb

@@ -1,15 +1,64 @@
+# frozen_string_literal: true
+
 require "test_notifier"
-require "minitest/unit"
+require "minitest"
+
+module TestNotifier
+  class MinitestReporter < Minitest::AbstractReporter
+    attr_reader :count, :assertions, :failures, :errors, :pending
+
+    def initialize(*)
+      super
+      @assertions = 0
+      @count = 0
+      @failures = 0
+      @errors = 0
+      @pending = 0
+    end
+
+    def start
+    end
+
+    def prerecord(*)
+    end
 
-MiniTest::Unit.after_tests do
-  runner = MiniTest::Unit.runner
+    def record(result)
+      flunked = result.failures.count { flunk?(it) }
 
-  stats = TestNotifier::Stats.new(:minitest, {
-    :count      => runner.test_count,
-    :assertions => runner.assertion_count,
-    :failures   => runner.failures,
-    :errors     => runner.errors
-  })
+      @count += 1
+      @assertions += result.assertions
+      @assertions -= flunked if flunked.nonzero?
+      @errors += result.failures.count { error?(it) }
+      @failures += result.failures.count { failure?(it) }
+      @pending += flunked
+    end
 
-  TestNotifier.notify(:status => stats.status, :message => stats.message)
+    def flunk?(failure)
+      (failure.backtrace_locations || [])
+        .any? { it.label == "Minitest::Assertions#flunk" }
+    end
+
+    def failure?(failure)
+      failure.is_a?(Minitest::Assertion) && !flunk?(failure)
+    end
+
+    def error?(failure)
+      failure.is_a?(Minitest::UnexpectedError)
+    end
+
+    def report
+      stats = TestNotifier::Stats.new(
+        :minitest,
+        count:,
+        assertions:,
+        failures:,
+        errors:,
+        pending:
+      )
+
+      TestNotifier.notify(status: stats.status, message: stats.message)
+    end
+  end
 end
+
+Minitest.load(:test_notifier)

data/lib/test_notifier/runner/rspec.rb

@@ -1,7 +1,49 @@
-require "rspec/core/version"
+# frozen_string_literal: true
 
-if RSpec::Core::Version::STRING >= "3.0.0"
-  require "test_notifier/runner/rspec3"
-else
-  require "test_notifier/runner/rspec2"
+require "test_notifier"
+require "rspec/core"
+require "rspec/core/formatters/base_text_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      class BaseTextFormatter
+        alias dump_summary_original dump_summary
+
+        def error_filter
+          proc do |error|
+            error.exception.is_a?(UncaughtThrowError)
+          end
+        end
+
+        def failure_filter
+          proc do |error|
+            error.exception
+                 .instance_of?(RSpec::Expectations::ExpectationNotMetError)
+          end
+        end
+
+        def dump_summary(options)
+          dump_summary_original(options)
+
+          count = options.example_count
+          pending = options.pending_count
+          errors = options.failed_examples.count(&error_filter)
+          failures = options.failed_examples.size - errors
+
+          return if count.zero?
+
+          stats = TestNotifier::Stats.new(
+            :rspec,
+            count:,
+            failures:,
+            pending:,
+            errors:
+          )
+
+          TestNotifier.notify(status: stats.status, message: stats.message)
+        end
+      end
+    end
+  end
 end

data/lib/test_notifier/runner.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module TestNotifier
   module Runner
     autoload :RSpec,    "test_notifier/runner/rspec"
-    autoload :Spec,     "test_notifier/runner/spec"
-    autoload :TestUnit, "test_notifier/runner/test_unit"
+    autoload :Minitest, "test_notifier/runner/minitest"
   end
 end

data/lib/test_notifier/stats.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TestNotifier
   class Stats
     attr_accessor :adapter, :options
@@ -17,15 +19,14 @@ module TestNotifier
       send("message_for_#{adapter}")
     end
 
-    private
-    def normalize(options)
-      [:count, :success, :failures, :pending, :errors, :assertions].inject({}) do |buffer, key|
-        buffer[key] = options[key].to_i
-        buffer
-      end
+    private def normalize(options)
+      %i[count success failures pending errors assertions]
+        .each_with_object({}) do |key, buffer|
+          buffer[key] = options[key].to_i
+        end
     end
 
-    def status_for_minitest
+    private def status_for_rspec
       if options[:errors].nonzero?
         :error
       elsif options[:failures].nonzero?
@@ -35,17 +36,22 @@ module TestNotifier
       end
     end
 
-    def status_for_test_unit
-      if options[:errors].nonzero?
-        :error
-      elsif options[:failures].nonzero?
-        :fail
-      else
-        :success
+    private def message_for_rspec
+      options[:success] =
+        options[:count] - (options[:failures] + options[:errors])
+
+      text = []
+      text << ("#{options[:count]} " + pluralize(options[:count], "example"))
+      text << "#{options[:failures]} failed" unless options[:failures].zero?
+      text << "#{options[:pending]} pending" unless options[:pending].zero?
+      unless options[:errors].zero?
+        text << ("#{options[:errors]} " + pluralize(options[:errors],
+                                                    "error"))
       end
+      text.join(", ")
     end
 
-    def status_for_rspec
+    private def status_for_minitest
       if options[:errors].nonzero?
         :error
       elsif options[:failures].nonzero?
@@ -55,53 +61,25 @@ module TestNotifier
       end
     end
 
-    def status_for_spec
-      if options[:failures].nonzero?
-        :fail
-      else
-        :success
-      end
-    end
-
-    def message_for_rspec
-      options[:success] = options[:count] - (options[:failures] + options[:errors])
-
+    private def message_for_minitest
       text = []
-      text << "#{options[:count]} " + pluralize(options[:count], "example")
+      text << ("#{options[:count]} " + pluralize(options[:count], "test"))
+      text << ("#{options[:assertions]} " + pluralize(options[:assertions],
+                                                      "assertion"))
       text << "#{options[:failures]} failed" unless options[:failures].zero?
-      text << "#{options[:pending]} pending" unless options[:pending].zero?
-      text << "#{options[:errors]} " + pluralize(options[:errors], "error") unless options[:errors].zero?
-      text.join(", ")
-    end
 
-    def message_for_spec
-      text = []
-      text << "#{options[:count]} " + pluralize(options[:count], "example")
-      text << "#{options[:failures]} failed" unless options[:failures].zero?
-      text << "#{options[:pending]} pending" unless options[:pending].zero?
-      text.join(", ")
-    end
+      unless options[:errors].zero?
+        text << ("#{options[:errors]} " + pluralize(options[:errors],
+                                                    "error"))
+      end
 
-    def message_for_test_unit
-      text = []
-      text << "#{options[:count]} " + pluralize(options[:count], "test")
-      text << "#{options[:assertions]} " + pluralize(options[:assertions], "assertion")
-      text << "#{options[:failures]} failed" unless options[:failures].zero?
-      text << "#{options[:errors]} " + pluralize(options[:errors], "error") unless options[:errors].zero?
-      text.join(", ")
-    end
+      text << "#{options[:pending]} pending" unless options[:pending].zero?
 
-    def message_for_minitest
-      text = []
-      text << "#{options[:count]} " + pluralize(options[:count], "test")
-      text << "#{options[:assertions]} " + pluralize(options[:assertions], "assertion")
-      text << "#{options[:failures]} failed" unless options[:failures].zero?
-      text << "#{options[:errors]} " + pluralize(options[:errors], "error") unless options[:errors].zero?
       text.join(", ")
     end
 
-    def pluralize(count, text)
-      count > 1 ? "#{text}s" : text
+    private def pluralize(count, text)
+      count == 1 ? text : "#{text}s"
     end
   end
 end

data/lib/test_notifier/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TestNotifier
   module Version
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 0
-    PATCH = 3
-    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze
   end
 end

data/lib/test_notifier.rb

@@ -1,42 +1,53 @@
+# frozen_string_literal: true
+
 require "notifier"
 
 module TestNotifier
-  class << self
-    attr_accessor :silence_no_notifier_warning
-  end
-
   extend self
 
-  NO_NOTIFIERS_MESSAGE = "[TEST NOTIFIER] You have no supported notifiers installed. Please read documentation.\n"
+  NO_NOTIFIERS_MESSAGE = "[TEST NOTIFIER] You have no supported notifiers " \
+                         "installed. Please read documentation.\n"
 
   IMAGES = {
-    :fail    => File.dirname(__FILE__) + "/../resources/fail.png",
-    :error   => File.dirname(__FILE__) + "/../resources/error.png",
-    :success => File.dirname(__FILE__) + "/../resources/success.png"
-  }
+    fail: File.expand_path("#{__dir__}/../resources/fail.png"),
+    error: File.expand_path("#{__dir__}/../resources/error.png"),
+    success: File.expand_path("#{__dir__}/../resources/success.png")
+  }.freeze
+
+  HUD_SYMBOLS = {
+    fail: "exclamationmark.triangle",
+    error: "xmark.octagon",
+    success: "checkmark.circle"
+  }.freeze
 
   TITLES = {
-    :fail    => "Failed!",
-    :success => "Passed!",
-    :error   => "Error!"
-  }
+    fail: "Failed!",
+    success: "Passed!",
+    error: "Error!"
+  }.freeze
 
   COLORS = {
-    :fail    => "orange",
-    :success => "green",
-    :error   => "red"
-  }
+    fail: "orange",
+    success: "green",
+    error: "red"
+  }.freeze
+
+  attr_accessor :silence_no_notifier_warning
 
   def default_notifier=(notifier)
     Notifier.default_notifier = notifier
   end
 
   def notify(options)
-    options.merge!({
-      :title => TITLES[options[:status]],
-      :image => IMAGES[options[:status]],
-      :color => COLORS[options[:status]]
-    })
+    options = options.merge(
+      title: TITLES[options[:status]],
+      image: IMAGES[options[:status]],
+      color: COLORS[options[:status]]
+    )
+
+    if Notifier.notifier == Notifier::Hud
+      options[:image] = HUD_SYMBOLS[options[:status]]
+    end
 
     notifier.notify(options)
   end
@@ -44,13 +55,14 @@ module TestNotifier
   def notifier
     notifier = Notifier.notifier
 
-    if notifier == Notifier::Placebo && !silence_no_notifier_warning
-      STDERR << NO_NOTIFIERS_MESSAGE
+    if notifier == Notifier::Noop && !silence_no_notifier_warning
+      $stderr << NO_NOTIFIERS_MESSAGE
     end
 
     notifier
   end
 
-  require "test_notifier/runner"
   require "test_notifier/stats"
+  require "test_notifier/runner/minitest" if defined?(Minitest)
+  require "test_notifier/runner/rspec" if defined?(RSpec)
 end

data/test/fixtures/minitest_sample_test.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "minitest/autorun"
+require "test_notifier"
+
+class MinitestSample < Minitest::Test
+  def test_passes
+    assert true
+    assert true
+  end
+
+  def test_fails
+    refute true
+  end
+
+  def test_errors
+    raise "foo"
+  end
+
+  def test_flunks
+    flunk "this is pending"
+  end
+end
+
+class MinitestSample2 < Minitest::Test
+  def test_passes
+    assert true
+  end
+end

data/test/fixtures/rspec_sample_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rspec/autorun"
+require "test_notifier"
+
+describe "test" do
+  it "passes" do
+    expect(true).to be
+  end
+
+  it "passes too" do
+    expect(true).to be
+  end
+
+  it "fails" do
+    expect(false).to be
+  end
+
+  it "pending" do
+    expect(true).to be
+  end
+
+  it "raises" do
+    throw "error"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "minitest/utils"
+require "minitest/autorun"
+require "test_notifier"
+
+module Minitest
+  class Test
+    def unsupport_all_notifiers
+      Notifier.notifiers.each do |notifier|
+        next if notifier == Notifier::Noop
+
+        notifier.stubs(:supported?).returns(false)
+      end
+    end
+  end
+end

data/test/test_notifier/stats_minitest_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class StatsMinitestTest < Minitest::Test
+  let(:stats) { TestNotifier::Stats.new(:minitest) }
+
+  test "returns success message" do
+    stats.options = {count: 10, assertions: 20}
+
+    assert_equal "10 tests, 20 assertions", stats.message
+  end
+
+  test "message with failing tests" do
+    stats.options = {count: 10, assertions: 20, failures: 5}
+
+    assert_equal "10 tests, 20 assertions, 5 failed", stats.message
+  end
+
+  test "message with error tests" do
+    stats.options = {count: 10, assertions: 20, errors: 5}
+
+    assert_equal "10 tests, 20 assertions, 5 errors", stats.message
+  end
+
+  test "message with pending tests" do
+    stats.options = {count: 10, assertions: 20, pending: 5}
+
+    assert_equal "10 tests, 20 assertions, 5 pending", stats.message
+  end
+
+  test "message with all types" do
+    stats.options = {
+      count: 6,
+      failures: 2,
+      errors: 3,
+      assertions: 20,
+      pending: 4
+    }
+
+    expected = "6 tests, 20 assertions, 2 failed, 3 errors, 4 pending"
+
+    assert_equal expected, stats.message
+  end
+end

data/test/test_notifier/stats_rspec_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class StatsTest < Minitest::Test
+  let(:stats) { TestNotifier::Stats.new(:rspec) }
+
+  test "returns success message" do
+    stats.options = {count: 10}
+
+    assert_equal "10 examples", stats.message
+  end
+
+  test "returns message with failing examples" do
+    stats.options = {count: 10, failures: 5}
+
+    assert_equal "10 examples, 5 failed", stats.message
+  end
+
+  test "returns message with pending examples" do
+    stats.options = {count: 10, pending: 5}
+
+    assert_equal "10 examples, 5 pending", stats.message
+  end
+
+  test "returns message with error examples" do
+    stats.options = {count: 10, failures: 5, errors: 5}
+
+    assert_equal "10 examples, 5 failed, 5 errors", stats.message
+  end
+
+  test "returns message with all types" do
+    stats.options = {count: 6, failures: 3, errors: 2, pending: 3}
+
+    assert_equal "6 examples, 3 failed, 3 pending, 2 errors", stats.message
+  end
+end