minitest-stately 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a4c3d450336f7408db315d24711c8fef8817c1e
-  data.tar.gz: 650c0031d535b36c429ba5988406ce07e3a36306
+  metadata.gz: 12d3996442703d16e374be803829c02fb3a49509
+  data.tar.gz: 1408bb41ba72f4578647327a970b31ba3ed2f086
 SHA512:
-  metadata.gz: 37b34454ad059078bd7215b2ac23e651dc9617e3962effc15daa091412e4f16d3b924844ce597ba75379676fa8b71a99edc82b09d55c54581f6e45024e7df282
-  data.tar.gz: 09bb894ba6d9350194625a86090987979f1a5d6946a6262e28f6f7c9377ab2a47e97d9fdde2076ef32c65ac4a62b585f5a8c204c22b9a6c106db4706d525ff81
+  metadata.gz: 003e6b9131129781909fd63c65f763e7be08eb41d6963dd19da5b0f2970f87612770522bc2ea97ae0c91dfa85e5bf92046a0d46e995c72eec9e7192c90a25471
+  data.tar.gz: 5f9c984ec2b43e75ee8f810c49f7a302fe37983882e9000f5a7a31baad101fc99cb886cf34f03243919dc9cc32d5dad58cb91cda01fad17509342a8f4d7b3855

data/README.md

@@ -21,14 +21,15 @@ Ruby 1.8.7 and REE are not supported. Sorry retro-Ruby fans!
 ## Usage
 
 ### Minitest::Stately.watch
-Early in your test run (typically from `test_helper.rb`), call to set up the
-conditions to watch for changes in. The condition block is run immediately to
-set a default value, and then run and compared after each test executes to look
-for changes.
+Early in your test run (typically from `test_helper.rb`), set up the condition
+blocks you want to watch for changes. The condition blocks run immediately to
+set default values, and then after each test the blocks are executed again and
+compared for changes. The name provided to watch is used strictly for output
+in the final change report.
 
 ```
 # Watch for freshly started threads
-Minitest::Stately.watch("condition name") do
+Minitest::Stately.watch("thread count") do
   Thread.list.count
 end
 ```
@@ -40,11 +41,10 @@ like the following:
 ******************************
 Minitest::Stately Changes!!!
 ******************************
-Minitest::StatelyPluginTest#test_again: $boo changed from '0' to '1'
-Minitest::StatelyPluginTest#test_defined: $boo changed from '1' to '2'
+Minitest::StatelyPluginTest#test_again: thread count changed from '1' to '2'
+Minitest::StatelyPluginTest#test_defined: thread count changed from '2' to '3'
 ```
 
-
 ### Minitest::Stately.run
 Minitest::Stately can also register `run` blocks to be executed after each
 test. This can be useful for clearing out leaked state between all tests in a
@@ -56,9 +56,28 @@ Minitest::Stately.run do
 end
 ```
 
+### Minitest::Stately.fail_if
+Minitest::Stately also allows you to write conditions which will globally fail
+any test if they become true.
+
+```
+# Fail if we get too many threads
+Minitest::Stately.fail_if("so many threads") do
+  Thread.list.count > 10
+end
+```
+
+If this condition was violated, you'd see a test failure like:
+
+```
+  1) Failure:
+Minitest::StatelyPluginTest#test_again [.../watcher.rb:54]:
+so many threads
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/minitest-stately/fork )
+1. Fork it ( https://github.com/jasonrclark/minitest-stately/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/minitest/stately/after_teardown.rb

@@ -0,0 +1,9 @@
+module Minitest
+  module Stately
+    module AfterTeardown
+      def after_teardown
+        Minitest::Stately.watcher.record(self)
+      end
+    end
+  end
+end

data/lib/minitest/stately/reporter.rb

@@ -5,10 +5,6 @@ module Minitest
         super(options.delete(:io) || $stdout, options)
       end
 
-      def record(result)
-        Minitest::Stately.watcher.record(result)
-      end
-
       def report
         io.puts(Minitest::Stately.watcher.report)
       end

data/lib/minitest/stately/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Stately
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/minitest/stately/watcher.rb

@@ -2,34 +2,40 @@ module Minitest
   module Stately
     class Watcher
       def initialize
-        @watch   = {}
-        @run     = []
+        @watch    = {}
+        @run      = []
+        @failures = {}
 
         @results = {}
         @report  = []
       end
 
       def watch(name, &blk)
-        @watch[name]  = blk
-        @results[blk] = blk.call
+        @watch[name]   = blk
+        @results[name] = blk.call(nil)
       end
 
       def run(&blk)
         @run << blk
       end
 
+      def fail_if(name,&blk)
+        @failures[name] = blk
+      end
+
       def record(result)
         record_changes(result)
         run_blocks()
+        check_failures(result)
       end
 
       def record_changes(result)
         @watch.each do |name, blk|
-          value = blk.call
-          if value_changed?(blk, value)
-            @report << message(result, name, blk, value)
+          value = blk.call(result)
+          if value_changed?(name, value)
+            @report << message(result, name, value)
           end
-          @results[blk] = value
+          @results[name] = value
         end
       end
 
@@ -39,12 +45,21 @@ module Minitest
         end
       end
 
-      def value_changed?(blk, value)
-        @results[blk] != value
+      def check_failures(result)
+        failed = []
+        @failures.each do |name, blk|
+          failed << name if blk.call
+        end
+
+        result.flunk("#{failed.join(",")}") if failed.any?
+      end
+
+      def value_changed?(name, value)
+        @results[name] != value
       end
 
-      def message(result, name, blk, value)
-        "#{result.class.name}\##{result.name}: #{name} changed from '#{@results[blk]}' to '#{value}'"
+      def message(result, name, value)
+        "#{result.class.name}\##{result.name}: #{name} changed from #{@results[name].inspect} to #{value.inspect}"
       end
 
       HEADER = <<-EOS

data/lib/minitest/stately_plugin.rb

@@ -1,3 +1,4 @@
+require 'minitest/stately/after_teardown'
 require 'minitest/stately/reporter'
 require 'minitest/stately/watcher'
 
@@ -16,6 +17,14 @@ module Minitest
     def self.run(&blk)
       @watcher.run(&blk)
     end
+
+    def self.fail_if(name, &blk)
+      @watcher.fail_if(name, &blk)
+    end
+  end
+
+  class ::Minitest::Test
+    include Minitest::Stately::AfterTeardown
   end
 
   def self.plugin_stately_init(options)

data/test/minitest/stately/watcher_test.rb

@@ -46,6 +46,22 @@ module Minitest
         assert_changes(name, 2, 3)
       end
 
+      def test_multiple_watches_last_one_wins
+        first  = 0
+        second = 0
+
+        @watcher.watch("hey") { first  += 1 }
+        @watcher.watch("hey") { second += 1 }
+
+        # Reset before we record so initial defaulting is wiped
+        first  = 0
+        second = 0
+        @watcher.record(self)
+
+        assert_equal(0, first)
+        assert_equal(1, second)
+      end
+
       def test_run
         @boo = 1
         @watcher.run do
@@ -56,9 +72,32 @@ module Minitest
         assert_nil @boo
       end
 
+      def test_fail_if
+        @watcher.fail_if("true") do
+          true
+        end
+
+        result = Minitest::Mock.new
+        result.expect(:flunk, nil, [String])
+        @watcher.record(result)
+
+        result.verify
+      end
+
+      def test_doesnt_fail
+        @watcher.fail_if("won't fail") do
+          false
+        end
+
+        result = Minitest::Mock.new
+        @watcher.record(result)
+
+        result.verify
+      end
+
       def assert_changes(name, old, new)
         assert_includes @watcher.report, name
-        assert_includes @watcher.report, "'#{old}' to '#{new}'"
+        assert_includes @watcher.report, "#{old.inspect} to #{new.inspect}"
       end
     end
   end

data/test/minitest/stately_plugin_test.rb

@@ -10,6 +10,11 @@ Minitest::Stately.run do
   $clear_me = nil
 end
 
+Minitest::Stately.fail_if("too false to fail") do
+  # This condition should never fail
+  false
+end
+
 class Minitest::StatelyPluginTest < Minitest::Test
   def test_defined
     assert_nil $clear_me

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-stately
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason R. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -85,6 +85,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/minitest/stately/after_teardown.rb
 - lib/minitest/stately/reporter.rb
 - lib/minitest/stately/version.rb
 - lib/minitest/stately/watcher.rb