test_notifier 2.0.3 → 3.0.0

data/test/test_notifier_test.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestNotifierTest < Minitest::Test
+  setup { unsupport_all_notifiers }
+  teardown { TestNotifier.default_notifier = :hud }
+
+  test "uses default notifier" do
+    Notifier::Knotify.stubs(:supported?).returns(true)
+    Notifier::Snarl.stubs(:supported?).returns(true)
+    TestNotifier.default_notifier = :snarl
+
+    assert_equal Notifier::Snarl, TestNotifier.notifier
+  end
+
+  test "outputs error message to when there's no supported notifier" do
+    Notifier.stubs(:notifier).returns(Notifier::Noop)
+    TestNotifier.silence_no_notifier_warning = false
+
+    _, err = capture_io do
+      TestNotifier.notify status: :fail, message: "You have failed!"
+    end
+
+    assert_includes err, TestNotifier::NO_NOTIFIERS_MESSAGE
+  end
+
+  test "doesn't output error message when silence is enabled" do
+    TestNotifier.silence_no_notifier_warning = true
+
+    $stderr.expects(:<<).never
+    Notifier::Noop.expects(:notify).at_least(1)
+
+    TestNotifier.notify status: :fail, message: "You have failed!"
+  end
+
+  test "sends notification to supported notifier" do
+    args = {
+      status: :fail,
+      message: "You have failed!",
+      title: TestNotifier::TITLES[:fail],
+      image: TestNotifier::IMAGES[:fail],
+      color: TestNotifier::COLORS[:fail]
+    }
+
+    Notifier::Snarl.stubs(:supported?).returns(true)
+    Notifier::Snarl.expects(:notify).with(args)
+
+    TestNotifier.notify status: :fail, message: "You have failed!"
+  end
+
+  test "sets symbol name for hud notifier (failed)" do
+    args = {
+      message: "You have failed!",
+      title: "Failed!",
+      image: "exclamationmark.triangle",
+      color: "orange",
+      status: :fail
+    }
+
+    Notifier::Hud.stubs(:supported?).returns(true)
+    Notifier::Hud.expects(:notify).with(args)
+
+    TestNotifier.notify status: :fail, message: "You have failed!"
+  end
+
+  test "sets symbol name for hud notifier (success)" do
+    args = {
+      message: "You passed!",
+      title: "Passed!",
+      image: "checkmark.circle",
+      color: "green",
+      status: :success
+    }
+
+    Notifier::Hud.stubs(:supported?).returns(true)
+    Notifier::Hud.expects(:notify).with(args)
+
+    TestNotifier.notify status: :success, message: "You passed!"
+  end
+
+  test "sets symbol name for hud notifier (error)" do
+    args = {
+      message: "You have errored!",
+      title: "Error!",
+      image: "xmark.octagon",
+      color: "red",
+      status: :error
+    }
+
+    Notifier::Hud.stubs(:supported?).returns(true)
+    Notifier::Hud.expects(:notify).with(args)
+
+    TestNotifier.notify status: :error, message: "You have errored!"
+  end
+end

data/test_notifier.gemspec

@@ -1,27 +1,33 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "test_notifier/version"
+# frozen_string_literal: true
+
+require_relative "lib/test_notifier/version"
 
 Gem::Specification.new do |s|
   s.name        = "test_notifier"
-  s.version     = "#{TestNotifier::Version::STRING}"
+  s.version     = TestNotifier::Version::STRING.to_s
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Nando Vieira"]
-  s.email       = ["fnando.vieira@gmail.com"]
+  s.required_ruby_version = ">= 3.4"
+  s.email       = ["me@fnando.com"]
   s.homepage    = "http://rubygems.org/gems/test_notifier"
-  s.summary     = "Display system notifications (dbus, growl and snarl) after running tests."
-  s.description = <<-DESC
-Display system notifications (dbus, growl and snarl) after
-running tests. It works on Mac OS X, Linux and Windows. Powerful when used
-with Autotest ZenTest gem and alike for Rails apps.
-DESC
+  s.summary     = "Display system notifications (dbus, terminal notifier, " \
+                  "snarl, and more) after running tests."
+  s.description = "Display system notifications after running tests. It " \
+                  "works on Mac OS X, Linux and Windows. Powerful when used " \
+                  "with autotest or guard."
 
+  s.metadata["rubygems_mfa_required"] = "true"
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
   s.require_paths = ["lib"]
 
   s.add_dependency "notifier"
-  s.add_development_dependency "rspec", ">= 3.0.0"
+  s.add_development_dependency "minitest-utils"
+  s.add_development_dependency "mocha"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-fnando"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: test_notifier
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notifier
@@ -25,19 +24,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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
@@ -52,48 +65,82 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  Display system notifications (dbus, growl and snarl) after
-  running tests. It works on Mac OS X, Linux and Windows. Powerful when used
-  with Autotest ZenTest gem and alike for Rails apps.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: rubocop-fnando
+  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: Display system notifications after running tests. It works on Mac OS
+  X, Linux and Windows. Powerful when used with autotest or guard.
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
+- ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
-- README.rdoc
+- README.md
 - Rakefile
+- lib/minitest/test_notifier_plugin.rb
 - lib/test_notifier.rb
 - lib/test_notifier/runner.rb
-- lib/test_notifier/runner/autotest.rb
 - lib/test_notifier/runner/minitest.rb
 - lib/test_notifier/runner/rspec.rb
-- lib/test_notifier/runner/rspec2.rb
-- lib/test_notifier/runner/rspec3.rb
-- lib/test_notifier/runner/spec.rb
-- lib/test_notifier/runner/test_unit.rb
 - lib/test_notifier/stats.rb
 - lib/test_notifier/version.rb
 - resources/error.png
 - resources/fail.png
-- resources/register-growl.scpt
 - resources/success.png
-- spec/spec_helper.rb
-- spec/stats/minitest_spec.rb
-- spec/stats/rspec1_spec.rb
-- spec/stats/rspec_spec.rb
-- spec/stats/test_unit_spec.rb
-- spec/test_notifier_spec.rb
+- test/fixtures/minitest_sample_test.rb
+- test/fixtures/rspec_sample_spec.rb
+- test/test_helper.rb
+- test/test_notifier/stats_minitest_test.rb
+- test/test_notifier/stats_rspec_test.rb
+- test/test_notifier_test.rb
 - test_notifier.gemspec
 homepage: http://rubygems.org/gems/test_notifier
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -101,23 +148,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
-summary: Display system notifications (dbus, growl and snarl) after running tests.
-test_files:
-- spec/spec_helper.rb
-- spec/stats/minitest_spec.rb
-- spec/stats/rspec1_spec.rb
-- spec/stats/rspec_spec.rb
-- spec/stats/test_unit_spec.rb
-- spec/test_notifier_spec.rb
-has_rdoc: 
+summary: Display system notifications (dbus, terminal notifier, snarl, and more) after
+  running tests.
+test_files: []

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    test_notifier (2.0.3)
-      notifier
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    notifier (0.5.0)
-    rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.0)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.1)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake
-  rspec (>= 3.0.0)
-  test_notifier!

data/README.rdoc

@@ -1,74 +0,0 @@
-= Test Notifier
-
-Inspired by http://railstips.org/2007/7/23/autotest-growl-pass-fail-notifications
-
-After using Growl notification, I decided to write my own plugin because I have
-to work on Ubuntu and Mac OS X and I missed the notification on my Linux box.
-This plugin works with Linux, Mac OS X and Windows. All you need to do is
-install the specific notification library for your OS.
-
-Instead of displaying lots of notifications for each failure, I prefer to be
-notified about the whole test result (you'll have to check your log
-file anyway in order to clean up the failures/errors).
-
-== Installation
-
-  gem install test_notifier
-
-Check http://github.com/fnando/notifier to see how you can configure a notifier for your OS.
-
-== Usage
-
-If you're using Test::Unit you should add <tt>require "test_notifier/runner/test_unit"</tt> to your <tt>test_helper.rb</tt> file.
-
-If you're using RSpec you should add <tt>require "test_notifier/runner/spec"</tt> to your <tt>spec_helper.rb</tt> file. If you're using RSpec 2-3, you need to add <tt>require "test_notifier/runner/rspec"</tt> instead.
-
-If you're using Autotest you should add <tt>require "test_notifier/runner/autotest"</tt> to
-the file <tt>~/.autotest</tt>
-
-If you're using MiniTest you should add <tt>require "test_notifier/runner/minitest"</tt> to your <tt>test_helper.rb</tt> file.
-
-You can define your notifier.
-
-  TestNotifier.default_notifier = :growl
-
-The available notifiers are <tt>:growl</tt>, <tt>:kdialog</tt>, <tt>:knotify</tt>, <tt>:notify_send</tt>, <tt>:osd_cat</tt>, and <tt>:snarl</tt>.
-
-If you'd like to make Test Notifier optional for your project:
-
-  TestNotifier.silence_no_notifier_warning = true
-
-== Maintainer
-
-* Nando Vieira - http://simplesideias.com.br
-
-== Collaborators
-
-* Szymon (jeznet) Jeż - http://github.com/jeznet
-* Steve Halasz - http://github.com/woodchuck
-* Khaja Minhajuddin - http://minhajuddin.com/
-* Steve Sloan - http://github.com/CodeMonkeySteve
-* Jordan Byron - http://jordanbyron.com
-
-== 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/lib/test_notifier/runner/autotest.rb

@@ -1,36 +0,0 @@
-require "test_notifier"
-
-Autotest.add_hook :ran_command do |at|
-  begin
-    content = at.results.to_s
-
-    rspec_matches = content.match(/(\d+) examples?, (\d+) failures?(, (\d+) pendings?)?/)
-    test_unit_matches = content.match(/(\d+) tests, (\d+) assertions, (\d+) failures, (\d+) errors/)
-
-    if rspec_matches
-      _, examples, failures, _, pending = *rspec_matches
-
-      stats = TestNotifier::Stats.new(:spec, {
-        :count    => examples,
-        :failures => failures,
-        :pending  => pending
-      })
-
-      TestNotifier.notify(:status => stats.status, :message => stats.message) unless examples.to_i.zero?
-    elsif test_unit_matches
-      _, tests, assertions, failures, errors = *test_unit_matches
-
-      stats = TestNotifier::Stats.new(:test_unit, {
-        :count      => tests,
-        :assertions => assertions,
-        :failures   => failures,
-        :errors     => errors
-      })
-
-      TestNotifier.notify(:status => stats.status, :message => stats.message) unless tests.to_i.zero?
-    end
-  rescue => e
-    puts e
-    puts e.backtrace
-  end
-end

data/lib/test_notifier/runner/rspec2.rb

@@ -1,29 +0,0 @@
-require "test_notifier"
-require "rspec/core/formatters/base_text_formatter"
-
-class RSpec::Core::Formatters::BaseTextFormatter
-  alias dump_summary_original dump_summary
-
-  def dump_summary(duration, example_count, failure_count, pending_count)
-    dump_summary_original(duration, example_count, failure_count, pending_count)
-
-    return if example_count.zero?
-
-    failure_filter = proc {|e|
-      e.instance_variable_get("@exception").class.name == "RSpec::Expectations::ExpectationNotMetError"
-    }
-
-    error_filter = proc {|e|
-      %w[RSpec::Expectations::ExpectationNotMetError NilClass].include?(e.instance_variable_get("@exception").class.name)
-    }
-
-    stats = TestNotifier::Stats.new(:rspec, {
-      :count    => example_count,
-      :failures => examples.select(&failure_filter).count,
-      :pending  => pending_count,
-      :errors   => examples.reject(&error_filter).count
-    })
-
-    TestNotifier.notify(:status => stats.status, :message => stats.message)
-  end
-end

data/lib/test_notifier/runner/rspec3.rb

@@ -1,35 +0,0 @@
-require "test_notifier"
-require "rspec/core"
-require "rspec/core/formatters/base_text_formatter"
-
-class RSpec::Core::Formatters::BaseTextFormatter
-  alias dump_summary_original dump_summary
-
-  def dump_summary(options)
-    dump_summary_original(options)
-
-    example_count = options.example_count
-    failure_count = options.failure_count
-    pending_count = options.pending_count
-    examples = options.examples
-
-    return if example_count.zero?
-
-    failure_filter = proc {|e|
-      e.instance_variable_get("@exception").class.name == "RSpec::Expectations::ExpectationNotMetError"
-    }
-
-    error_filter = proc {|e|
-      %w[RSpec::Expectations::ExpectationNotMetError NilClass].include?(e.instance_variable_get("@exception").class.name)
-    }
-
-    stats = TestNotifier::Stats.new(:rspec, {
-      :count    => example_count,
-      :failures => examples.select(&failure_filter).count,
-      :pending  => pending_count,
-      :errors   => examples.reject(&error_filter).count
-    })
-
-    TestNotifier.notify(:status => stats.status, :message => stats.message)
-  end
-end

data/lib/test_notifier/runner/spec.rb

@@ -1,21 +0,0 @@
-require "test_notifier"
-require "spec/runner/formatter/base_text_formatter"
-
-class Spec::Runner::Formatter::BaseTextFormatter
-  alias dump_summary_original dump_summary
-
-  def dump_summary(duration, example_count, failure_count, pending_count)
-    dump_summary_original(duration, example_count, failure_count, pending_count)
-
-    return if example_count.zero?
-
-    stats = TestNotifier::Stats.new(:spec, {
-      :count    => example_count,
-      :failures => failure_count,
-      :pending  => pending_count,
-      :errors   => nil
-    })
-
-    TestNotifier.notify(:status => stats.status, :message => stats.message)
-  end
-end

data/lib/test_notifier/runner/test_unit.rb

@@ -1,29 +0,0 @@
-require "test_notifier"
-require "test/unit/ui/console/testrunner"
-
-class Test::Unit::UI::Console::TestRunner
-  alias finished_original finished
-
-  def finished(elapsed_time)
-    finished_original(elapsed_time)
-
-    begin
-      re = /(\d+) tests, (\d+) assertions, (\d+) failures, (\d+) errors/
-      _, tests, assertions, failures, errors = *@result.to_s.match(re)
-      return if tests.to_i.zero?
-
-
-      stats = TestNotifier::Stats.new(:test_unit, {
-        :count      => tests,
-        :assertions => assertions,
-        :failures   => failures,
-        :errors     => errors
-      })
-
-      TestNotifier.notify(:status => stats.status, :message => stats.message)
-    rescue => e
-      puts e
-      puts e.backtrace
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-require "test_notifier"
-
-module SpecHelpers
-  def unsupport_all_notifiers
-    Notifier.notifiers.each do |notifier|
-      allow(notifier).to receive(:supported?).and_return(false) unless notifier == Notifier::Placebo
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include SpecHelpers
-end

data/spec/stats/minitest_spec.rb

@@ -1,26 +0,0 @@
-require "spec_helper"
-
-describe TestNotifier::Stats, "MiniTest" do
-  subject(:stats) { TestNotifier::Stats.new(:minitest) }
-
-  it "returns success message" do
-    stats.options = { :count => 10, :assertions => 20 }
-    expect(stats.message).to eql("10 tests, 20 assertions")
-  end
-
-  it "message with failing examples" do
-    stats.options = { :count => 10, :assertions => 20, :failures => 5 }
-    expect(stats.message).to eql("10 tests, 20 assertions, 5 failed")
-  end
-
-  it "message with error examples" do
-    stats.options = { :count => 10, :assertions => 20, :errors => 5 }
-    expect(stats.message).to eql("10 tests, 20 assertions, 5 errors")
-  end
-
-  it "message with all types" do
-    stats.options = { :count => 6, :failures => 2, :errors => 3, :assertions => 20 }
-    expect(stats.message).to eql("6 tests, 20 assertions, 2 failed, 3 errors")
-  end
-end
-

data/spec/stats/rspec1_spec.rb

@@ -1,25 +0,0 @@
-require "spec_helper"
-
-describe TestNotifier::Stats, "RSpec 1" do
-  subject(:stats) { TestNotifier::Stats.new(:spec) }
-
-  it "returns success message" do
-    stats.options = { :count => 10 }
-    expect(stats.message).to eql("10 examples")
-  end
-
-  it "returns message with failing examples" do
-    stats.options = { :count => 10, :failures => 5 }
-    expect(stats.message).to eql("10 examples, 5 failed")
-  end
-
-  it "returns message with pending examples" do
-    stats.options = { :count => 10, :pending => 5 }
-    expect(stats.message).to eql("10 examples, 5 pending")
-  end
-
-  it "returns message with all types" do
-    stats.options = { :count => 6, :failures => 2, :pending => 3 }
-    expect(stats.message).to eql("6 examples, 2 failed, 3 pending")
-  end
-end