minitest-bonus-assertions 2.0 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bb8c4387ba54e4575d49e45cd8103bc70b1ea4c
-  data.tar.gz: 6cd36802e22704ea0e698352589392d19d140c6b
+  metadata.gz: 17f766351988c0089b1651becf011c006b7267e8
+  data.tar.gz: 1ee36b549b5e7a9209bddef79ecae633fd355c84
 SHA512:
-  metadata.gz: 587007bba2f0d47fed2ab3559b0a244cc2077c2c502a3c9a38fdd1fa756ec00d58f28713421138f84affdc89a52ec1cd65da72dde93cbd695666e80bbfd1dec7
-  data.tar.gz: b6773e5c6bb397bc4299864f3781a2b74a12232de8d43d3c25b4be3f0bc5655983439f0ddc527a9053021020b430abd81c6c1b8e83c463207dd47da62314bec6
+  metadata.gz: e7eceaee5c7286a851013d0c6ef13d88e7323f03d7d27a15d95c9cf5a56da6edda961eb039c835acc802cd390962fa5924a771be84e94b30df7fe02e951588f7
+  data.tar.gz: de21954797dfcad1ad1b769b7796b9ce7cd729b085a21a6b15187243ffde548363df02d6c7457250beaef9e871e2b9b0c46810e8cd6d55476c0fd10f0bde1b67

data/.autotest

@@ -1,27 +1,5 @@
-# -*- ruby -*-
-
-require "autotest/restart"
+# -*- ruby encoding: utf-8 -*-
 
 Autotest.add_hook :initialize do |at|
-  # .minitest.rb ensures that the gem version of minitest is used.
-  at.testlib = ".minitest.rb"
-  # at.testlib = "minitest/unit"
-  #
-  # at.extra_files << "../some/external/dependency.rb"
-  #
-  # at.libs << ":../some/external"
-  #
-  # at.add_exception "vendor"
-  #
-  # at.add_mapping(/dependency.rb/) do |f, _|
-  #   at.files_matching(/test_.*rb$/)
-  # end
-  #
-  # %w(TestA TestB).each do |klass|
-  #   at.extra_class_map[klass] = "test/test_misc.rb"
-  # end
+  at.testlib = ".minitest"
 end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/.travis.yml

@@ -1,29 +1,22 @@
 ---
 language: ruby
 rvm:
+  - 2.4.1
+  - 2.3.4
   - 2.2.3
   - 2.1.7
-  - 2.0.0-p647
+  - 2.0.0
+  - jruby-9.0.5.0
+  - jruby-9.1.6.0
   - ruby-head
-  - jruby-9.0
-  - jruby-19mode
-  - jruby-head
-  - rbx-2
 matrix:
   allow_failures:
-    - rvm: 1.9.3
-    - rvm: rbx-2
     - rvm: jruby-head
     - rvm: ruby-head
+  fast_finish: true
 gemfile:
   - Gemfile
 before_script:
-  - |
-    case "${TRAVIS_RUBY_VERSION}" in
-      rbx*)
-        gem install psych
-        ;;
-    esac
   - rake travis:before -t
 script: rake travis
 after_script:

data/History.rdoc

@@ -1,3 +1,16 @@
+=== 3.0 / 2017-04-26
+
+* 1 major enhancement
+
+  * Dropped support for Ruby 1.9.
+
+* 1 minor enhancement
+
+  * Added assertion +assert_result_equal+ (expectation +must_equal_result+) to
+    be ready for Minitest 6. This will allow those who have legitimate cases
+    where they do not know whether the expected is nil or not to have a
+    meaningful test and silence deprecation warnings.
+
 === 2.0 / 2015-10-19
 
 * 1 major enhancement

data/Licence.rdoc

@@ -2,7 +2,7 @@
 
 This software is available under an MIT-style licence.
 
-* Copyright 2015 Austin Ziegler
+* Copyright 2015–2017 Austin Ziegler
 * Copyright 2012 Ben Somers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -10,7 +10,11 @@ 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.
+so, subject to the following conditions:
+
+* The names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

data/README.rdoc

@@ -7,7 +7,7 @@ continuous integration :: {<img src="https://travis-ci.org/halostatue/minitest-b
 == Description
 
 Bonus assertions for {Minitest}[https://github.com/seattlerb/minitest],
-providing assertions I use frequently.
+providing assertions I use frequently, supporting only Ruby 2.0 or better.
 
 == Features
 
@@ -30,6 +30,8 @@ New assertions:
   values. (+must_equal_set+)
 * +refute_set_equal+: requires that the actual enumerable *not* have the same
   values as the expected enumerable. (+must_not_equal_set+)
+* +assert_result_equal+: requires that the actual is equal to the result of
+  evaluating an expression.
 
 I am also providing the Minitest-tester code I use as something that can be
 required by other developers. This should *only* be used to test Minitest

data/Rakefile

@@ -14,32 +14,51 @@ Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
 spec = Hoe.spec 'minitest-bonus-assertions' do
   developer('Austin Ziegler', 'halostatue@gmail.com')
 
+  license 'MIT'
+
+  require_ruby_version '>= 2.0'
+
   self.history_file = 'History.rdoc'
   self.readme_file = 'README.rdoc'
   self.extra_rdoc_files = FileList["*.rdoc"].to_a -
     %w(History.rdoc README.rdoc)
 
-  license "MIT"
-
-  self.need_tar = true
-  self.require_ruby_version '>= 1.9.2'
-
-  self.extra_dev_deps << ['hoe-doofus', '~> 1.0']
-  self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
-  self.extra_dev_deps << ['hoe-git', '~> 1.5']
-  self.extra_dev_deps << ['hoe-travis', '~> 1.2']
-  self.extra_dev_deps << ['minitest', '~> 5.8']
-  self.extra_dev_deps << ['minitest-around', '~> 0.3']
-  self.extra_dev_deps << ['minitest-autotest', '~> 1.0']
-  self.extra_dev_deps << ['minitest-bisect', '~> 1.2']
-  self.extra_dev_deps << ['minitest-focus', '~> 1.1']
-  self.extra_dev_deps << ['minitest-moar', '~> 0.0']
-  self.extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
-  self.extra_dev_deps << ['rake', '>= 10.0']
-  self.extra_dev_deps << ['simplecov', '~> 0.7']
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.8']
+  extra_dev_deps << ['minitest-around', '~> 0.3']
+  extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-bisect', '~> 1.2']
+  extra_dev_deps << ['minitest-bonus-assertions', '~> 2.0']
+  extra_dev_deps << ['minitest-focus', '~> 1.1']
+  extra_dev_deps << ['minitest-moar', '~> 0.0']
+  extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
+  extra_dev_deps << ['rake', '~> 10.0']
+  extra_dev_deps << ['simplecov', '~> 0.7']
+  extra_dev_deps << ['coveralls', '~> 0.7']
 end
 
 namespace :test do
+  if ENV['CI'] or ENV['TRAVIS']
+    desc "Submit test coverage to Coveralls"
+    task :coveralls do
+      spec.test_prelude = [
+        'require "psych"',
+        'require "simplecov"',
+        'require "coveralls"',
+        'SimpleCov.formatter = Coveralls::SimpleCov::Formatter',
+        'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+        'gem "minitest"'
+      ].join('; ')
+      Rake::Task['test'].execute
+    end
+
+      Rake::Task['travis'].prerequisites.replace(%w(test:coveralls))
+  end
+
+  desc "Runs test coverage. Only works Ruby 1.9+ and assumes 'simplecov' is installed."
   task :coverage do
     spec.test_prelude = [
       'require "simplecov"',
@@ -48,6 +67,7 @@ namespace :test do
     ].join('; ')
     Rake::Task['test'].execute
   end
+
   CLOBBER << 'coverage'
 end
 

data/lib/minitest-bonus-assertions.rb

@@ -1,6 +1,6 @@
 module Minitest
   module BonusAssertions # :nodoc:
-    VERSION = '2.0' # :nodoc:
+    VERSION = '3.0' # :nodoc:
   end
 
   module Assertions
@@ -105,6 +105,39 @@ module Minitest
       }
       refute_equal Set.new(expected), Set.new(actual), msg
     end
+
+    ##
+    # Fails unless +actual+ is the same value as the result of evaluating
+    # +expr+ in the context of the test case through instance_eval (when +expr+
+    # is a String) or instance_exec (when +expr+ is a callable).
+    #
+    # If +expr+ results in +nil+, this test delegates to #assert_nil, otherwise
+    # it delegates to #assert_equal.
+    #
+    # This assertion exists because Minitest 6 is changing #assert_equal so
+    # that it fails when comparing against +nil+.
+    #
+    #   assert_result_equal -> { model.department }, response[:department]
+    #   assert_result_equal 'model.department', response[:department]
+    def assert_result_equal expr, actual, msg = nil
+      result = if expr.respond_to?(:call)
+                 instance_exec(&expr)
+               else
+                 instance_eval(expr)
+               end
+
+      if result.nil?
+        msg = message(msg) {
+          "nil expected (expr #{mu_pp(expr)}) but was #{mu_pp(actual)}"
+        }
+        assert_nil actual, msg
+      else
+        msg = message(msg) {
+          "#{mu_pp(result)} expected (expr #{mu_pp(expr)}) but was #{mu_pp(actual)}"
+        }
+        assert_equal result, actual, msg
+      end
+    end
   end
 
   module Expectations
@@ -178,12 +211,20 @@ module Minitest
     infect_an_assertion :assert_set_equal, :must_equal_set, :unary
 
     ##
-    # See Minitest::refuteions#refute_set_equal
+    # See Minitest::Assertions#refute_set_equal
     #
     #    %w(a b c).must_equal_set %(c b a)
     #
     # :method: must_equal_set
 
     infect_an_assertion :refute_set_equal, :must_not_equal_set, :unary
+
+    ##
+    # See Minitest::Assertions#assert_result_equal
+    #
+    #   response[:department].must_equal_result 'model.department'
+    #   response[:department].must_equal_result -> { model.department }
+
+    infect_an_assertion :assert_result_equal, :must_equal_result, :unary
   end
 end

data/test/test_minitest-bonus-assertions.rb

@@ -6,7 +6,7 @@ describe Minitest::BonusAssertions do
   include Minitest::AssertionTests
 
   describe '.assert_true' do
-    it 'return true for true' do
+    it 'returns true for true' do
       assert_expected_assertions do
         assert_equal true, tc.assert_true(true), 'returns true for true'
       end
@@ -34,7 +34,7 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.assert_false' do
-    it 'return true for false' do
+    it 'returns true for false' do
       assert_expected_assertions do
         assert_equal true, tc.assert_false(false), 'returns true for false'
       end
@@ -58,13 +58,13 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.assert_between' do
-    it 'return true for basic integers' do
+    it 'returns true for basic integers' do
       assert_expected_assertions do
         assert_equal true, tc.assert_between(1, 10, 5), 'returns true for 1 to 10 and 5'
       end
     end
 
-    it 'return true for the range case' do
+    it 'returns true for the range case' do
       assert_expected_assertions do
         assert_equal true, tc.assert_between((1..10), 5), 'returns true for 1..10 with 5'
       end
@@ -76,7 +76,7 @@ describe Minitest::BonusAssertions do
       end
     end
 
-    it 'return false for values outside the bounds' do
+    it 'returns false for values outside the bounds' do
       assert_expected_assertions do
         assert_assertion_triggered 'Expected 100 to be between 1 and 10.' do
           tc.assert_between(1, 10, 100)
@@ -108,7 +108,7 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.assert_has_keys' do
-    it 'return true if the keys are present' do
+    it 'returns true if the keys are present' do
       assert_expected_assertions do
         assert_equal true, tc.assert_has_keys({ 'a' => 1 }, 'a'),
           %q(returns true for key 'a' in { 'a' => 1 })
@@ -135,7 +135,7 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.assert_missing_keys' do
-    it 'return true if the keys are missing' do
+    it 'returns true if the keys are missing' do
       assert_expected_assertions do
         assert_equal true, tc.assert_missing_keys({ 'a' => 1 }, 'b'),
           %q(returns true for key 'b' missing from { 'a' => 1 })
@@ -162,7 +162,7 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.assert_raises_with_message' do
-    it 'return the matched exception if the exception and message match' do
+    it 'returns the matched exception if the exception and message match' do
       assert_expected_assertions 2 do
         res = tc.assert_raises_with_message(ArgumentError, %q(Don't have a cow, man!)) do
           raise ArgumentError, %q(Don't have a cow, man!)
@@ -194,7 +194,7 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.assert_set_equal' do
-    it 'return true if the sets are equal' do
+    it 'returns true if the sets are equal' do
       assert_expected_assertions do
         assert_equal true, tc.assert_set_equal(%w(a b c), %w(c b a)),
           %q(returns true for sets %w(a b c) and %w(c b a))
@@ -211,7 +211,7 @@ describe Minitest::BonusAssertions do
   end
 
   describe '.refute_set_equal' do
-    it 'return true if the sets are not equal' do
+    it 'returns true if the sets are not equal' do
       assert_expected_assertions do
         assert_equal false, tc.refute_set_equal(%w(a b c), %w(c b)),
           %q(returns true for sets %w(a b c) and %w(c b))
@@ -226,4 +226,128 @@ describe Minitest::BonusAssertions do
       end
     end
   end
+
+  describe '.assert_result_equal' do
+    describe 'when expr is a string' do
+      let(:expr) { 'expected' }
+
+      describe 'when expr yields nil' do
+        before do
+          tc.define_singleton_method(:expected) { nil }
+          spec.define_singleton_method(:expected) { nil }
+        end
+
+        it 'returns true if the actual is nil' do
+          assert_expected_assertions do
+            assert_equal true, tc.assert_result_equal('expected', nil),
+              %q(returns true for expr-string result nil and nil)
+          end
+        end
+
+        it 'returns true if the actual is nil' do
+          assert_expected_assertions do
+            assert_equal true, tc.assert_result_equal('expected', nil),
+              %q(returns true for expr-string result nil and nil)
+          end
+        end
+
+        it 'is triggered if the actual is not nil' do
+          assert_expected_assertions do
+            assert_assertion_triggered %Q(nil expected (expr \"expected\") but was 3.\nExpected 3 to be nil.) do
+              assert_equal true, tc.assert_result_equal('expected', 3),
+                %q(returns true for expr-string result nil and nil)
+            end
+          end
+        end
+      end
+
+      describe 'when expr yields a non-nil value' do
+        before do
+          tc.define_singleton_method(:expected) { 3 }
+        end
+
+        it 'returns true if the actual is equal' do
+          assert_expected_assertions do
+            assert_equal true, tc.assert_result_equal('expected', 3),
+              %q(returns true for expr-string result 3 and 3)
+          end
+        end
+
+        it 'is triggered if the actual is nil' do
+          assert_expected_assertions do
+            assert_assertion_triggered %Q(3 expected (expr \"expected\") but was nil.\nExpected: 3\n  Actual: nil) do
+              assert_equal true, tc.assert_result_equal('expected', nil),
+                %q(returns true for expr-string result 3 and 3)
+            end
+          end
+        end
+
+        it 'is triggered if the actual is not equal' do
+          assert_expected_assertions do
+            assert_assertion_triggered %Q(3 expected (expr \"expected\") but was 5.\nExpected: 3\n  Actual: 5) do
+              assert_equal true, tc.assert_result_equal('expected', 5),
+                %q(returns true for expr-string result 3 and 3)
+            end
+          end
+        end
+      end
+    end
+
+    describe 'when expr is a proc' do
+      let(:expr) { -> { expected } }
+
+      describe 'when expr yields nil' do
+        before do
+          tc.define_singleton_method(:expected) { nil }
+        end
+
+        it 'returns true if the actual is nil' do
+          assert_expected_assertions do
+            assert_equal true, tc.assert_result_equal('expected', nil),
+              %q(returns true for expr-proc result nil and nil)
+          end
+        end
+
+        it 'is triggered if the actual is not nil' do
+          assert_expected_assertions do
+            assert_assertion_triggered %Q(nil expected (expr \"expected\") but was 3.\nExpected 3 to be nil.) do
+              assert_equal true, tc.assert_result_equal('expected', 3),
+                %q(returns true for expr-proc result nil and nil)
+            end
+          end
+        end
+      end
+
+      describe 'when expr yields a non-nil value' do
+        before do
+          tc.define_singleton_method(:expected) { 3 }
+        end
+
+        it 'returns true if the actual is equal' do
+          assert_expected_assertions do
+            assert_equal true, tc.assert_result_equal('expected', 3),
+              %q(returns true for expr-proc result 3 and 3)
+          end
+        end
+
+        it 'is triggered if the actual is nil' do
+          assert_expected_assertions do
+            assert_assertion_triggered %Q(3 expected (expr \"expected\") but was nil.\nExpected: 3\n  Actual: nil) do
+              assert_equal true, tc.assert_result_equal('expected', nil),
+                %q(returns true for expr-proc result 3 and 3)
+            end
+          end
+        end
+
+        it 'is triggered if the actual is not equal' do
+          assert_expected_assertions do
+            assert_assertion_triggered %Q(3 expected (expr \"expected\") but was 5.\nExpected: 3\n  Actual: 5) do
+              assert_equal true, tc.assert_result_equal('expected', 5),
+                %q(returns true for expr-proc result 3 and 3)
+            end
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-bonus-assertions
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '3.0'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: hoe-doofus
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: hoe-travis
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-bonus-assertions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -182,14 +182,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -206,23 +206,51 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.16'
 description: |-
   Bonus assertions for {Minitest}[https://github.com/seattlerb/minitest],
-  providing assertions I use frequently.
+  providing assertions I use frequently, supporting only Ruby 2.0 or better.
 email:
 - halostatue@gmail.com
 executables: []
@@ -267,7 +295,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -275,9 +303,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Bonus assertions for {Minitest}[https://github.com/seattlerb/minitest], providing
-  assertions I use frequently.
+  assertions I use frequently, supporting only Ruby 2.0 or better.
 test_files: []