kapnismology 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbd621f0387cf288bfa32a43784b7ba92b020f6e
-  data.tar.gz: 6a1c5b6146fe86811c77a9aad9fb3adc9b88b5b9
+  metadata.gz: 6775943c47bb7c69f3f3992daa5431b6b65cb8d2
+  data.tar.gz: 1055c6ce7d0bad4a245c15116f31db3ada41bb95
 SHA512:
-  metadata.gz: 13d340c969350eba069680e6b8bcb8a9327ce05c63b31fc366f52c31de57aaf588ba95c038672a358c8d0748dc6dbc3680522332efa9218a4bd1c81091c6c294
-  data.tar.gz: c7c5f8096788f20db177cb30b7f4902f87c8d8879534a7553b57d36e1376c2442d973d439f434b3d1bc6c47f23b26ecb9a2b634eb6f7183efecdcaf243a003d3
+  metadata.gz: 7b7d56da91f8eee7adee9d8ce22351a75f5f8bbd5760110980dfcdc9d06cfa1486a615f24d962aa5b1ad386e0ce6cddbfa0e6ff02f71304324dd48e1131874ee
+  data.tar.gz: 66a2ecc1ab381a48fa6094a100bd15e83cccae02d194c4068b19707d2802cb4a9a5950f785a0e401bf9dc54d34608ac103f165d76cc1372e446a0e6f28507813

data/README.md

@@ -80,17 +80,17 @@ Will produce:
 
 ## Not runnable tests
 
-If your test find a situation when it does not make sense, then you can return a `NullResult` instead of a `Result`. Like:
-```
+If your check finds a situation when it does not make sense to test, you can return a `InfoResult` instead of a `Result`. Like:
+```ruby
 if (File.exist?('necessary file'))
   Result.new(....)
 else
-  NullResult.new
+  InfoResult.new({}, 'There is no need to run this test')
 end
 ```
 
-Be very careful of not returning NullResult when you should be returning a failing Result.
-NullResult do not need any parameter but you can optionally pass a message.
+Be very careful of not returning InfoResult when you should be returning a failing Result.
+
 
 ## Tagging and running tags
 

data/lib/kapnismology/result.rb

@@ -56,9 +56,9 @@ eos
     end
   end
 
-  # This class can be returned when a check do not want to return an assertion on if
-  # it passed or not.
-  class NullResult < BaseResult
+  # This class can be returned when a check do not want to assert if it passed or not.
+  # Instead it can return certain information about the check or the system.
+  class InfoResult < BaseResult
     def initialize(data, message = 'The result could not be determined')
       @passed = true
       @data = data
@@ -71,16 +71,17 @@ eos
       { data: @data, message: @message, extra_messages: @extra_messages }
     end
 
-    # Redefining for unique output
-    def to_s(name)
-      <<-eos
-#{Terminal.yellow('Skipped')}: #{name}
-#{format_extra_messages(@extra_messages)}#{Terminal.bold(@message)}
-   #{@data}
-eos
+    private
+
+    def format_passed(_passed)
+      Terminal.yellow('Skipped')
     end
   end
 
+  # Deprecated NullResult class provided for compatibility.
+  class NullResult < InfoResult
+  end
+
   # Use this class when your test is not valid in the current situation
   # For instance when you have a test for deployments that have not happen, etc.
   class Success < BaseResult

data/lib/kapnismology/smoke_test.rb

@@ -58,6 +58,8 @@ module Kapnismology
     # These classes makes it very simple to implementors of results to use them without the module name
     class Result < Kapnismology::Result
     end
+    class InfoResult < Kapnismology::InfoResult
+    end
     class NullResult < Kapnismology::NullResult
     end
     class Success < Kapnismology::Success

data/lib/kapnismology/version.rb

@@ -1,3 +1,3 @@
 module Kapnismology
-  VERSION = '1.9.0'.freeze
+  VERSION = '1.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapnismology
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Jordi Polo Carres
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails