kapnismology 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55ff0fd8235f398c2d5228907fcc22cd4ed67329
-  data.tar.gz: 97c555355873882b3b089c2371548c70d2a9530b
+  metadata.gz: dbd621f0387cf288bfa32a43784b7ba92b020f6e
+  data.tar.gz: 6a1c5b6146fe86811c77a9aad9fb3adc9b88b5b9
 SHA512:
-  metadata.gz: ef567cd772e4660eedab61a8c23d7cf15ea4e6a86bf1966faee6cdbff5d180e5d6740371a212cb733198b9342e2305798b71f6008c88ea38567848dcd86be313
-  data.tar.gz: 69c992fbc2e8403e7aa86bc341e1b18fe743cbc3646efc6478ee73141c07ae1d50f829d8904d5ccbece9e472d6be594c17ea9fef2fc7ccf21b53e520c87b8db0
+  metadata.gz: 13d340c969350eba069680e6b8bcb8a9327ce05c63b31fc366f52c31de57aaf588ba95c038672a358c8d0748dc6dbc3680522332efa9218a4bd1c81091c6c294
+  data.tar.gz: c7c5f8096788f20db177cb30b7f4902f87c8d8879534a7553b57d36e1376c2442d973d439f434b3d1bc6c47f23b26ecb9a2b634eb6f7183efecdcaf243a003d3

data/README.md

@@ -151,12 +151,13 @@ end
 def user_from_remote
   get_user
 rescue => e
-  raise SmokeTestFailed.new({class: e.class, message: e.message}, "Error raised when accessing user")
+  raise SmokeTestFailed.new(e, "Error raised when accessing user")
 end
  ...
 ```
 
 Using small methods that raise SmokeTestFailed when failed will help you write an easy to read `result` method.
+You can pass your own data to SmokeTestFailed or you can pass an exception which will be properly formatted.
 
 
 ## Testing

data/app/controllers/kapnismology/smoke_tests_controller.rb

@@ -4,7 +4,7 @@ module Kapnismology
   class SmokeTestsController < ApplicationController
     def index
       evaluations = SmokeTestCollection.evaluations(allowed_tags, blacklist)
-      render text: evaluations.to_json, status: status(evaluations)
+      render json: evaluations.to_json, status: status(evaluations)
     end
 
     private

data/lib/kapnismology/evaluation.rb

@@ -13,10 +13,6 @@ module Kapnismology
       @result.passed?
     end
 
-    def null_result?
-      @result.is_a?(NullResult)
-    end
-
     def as_json(_options = nil)
       { @name => @result.to_hash }
     end

data/lib/kapnismology/evaluation_collection.rb

@@ -1,7 +1,7 @@
 require 'json'
 
 module Kapnismology
-  # A collection of the results of the smoke tests
+  # A collection of the evaluations of the smoke tests
   class EvaluationCollection
     include Enumerable
 
@@ -20,7 +20,7 @@ module Kapnismology
     end
 
     def to_json
-      evaluations.delete_if(&:null_result?).to_json
+      evaluations.to_json
     end
 
     private

data/lib/kapnismology/result.rb

@@ -48,7 +48,7 @@ eos
   # * message: String with an extra message to provide human readable information
   class Result < BaseResult
     def initialize(passed, data, message)
-      raise ArgumentError, 'passed must be true or false' unless !!passed == passed
+      raise ArgumentError, 'passed argument must be true or false' unless !!passed == passed
       @passed = passed
       @data = data
       @message = message
@@ -56,6 +56,8 @@ 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
     def initialize(data, message = 'The result could not be determined')
       @passed = true
@@ -63,6 +65,20 @@ eos
       @message = message
       @extra_messages = []
     end
+
+    # Redefining to have our own unique output
+    def to_hash
+      { 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
+    end
   end
 
   # Use this class when your test is not valid in the current situation

data/lib/kapnismology/smoke_test.rb

@@ -1,19 +1,8 @@
 require 'kapnismology/result'
 require 'kapnismology/smoke_test_collection'
+require 'kapnismology/smoke_test_failed'
 
 module Kapnismology
-
-  # This class can be raised to make Kapnismology create a failed result from your smoke test
-  class SmokeTestFailed < StandardError
-    def initialize(data, message)
-      @data = data
-      @message = message
-    end
-
-    def result
-      Kapnismology::Result.new(false, @data, @message)
-    end
-  end
   #
   # This is the base class for all the smoke tests.
   # Inherit from this class and implement the result and self.name method
@@ -31,9 +20,10 @@ module Kapnismology
     def result
     end
 
+    # Internally Kapnismology is calling this method. We are handling exceptions under the hood herer
     def __result__
       result_object = result
-      unless result_object.is_a?(Kapnismology::BaseResult)
+      unless result_object.class.ancestors.include?(Kapnismology::BaseResult)
         message = "Smoke test #{self.class}, returned #{result_object.class} instead of a Result"
         result_object = Result.new(false, { returned_class: result_object.class }, message)
       end

data/lib/kapnismology/smoke_test_failed.rb

@@ -0,0 +1,18 @@
+module Kapnismology
+
+  # This class can be raised to make Kapnismology create a failed result from your smoke test
+  class SmokeTestFailed < StandardError
+    def initialize(data, message)
+      @data = if data.class.ancestors.include?(Exception)
+        { exception: data.class, message: data.message }
+      else
+        data
+      end
+      @message = message
+    end
+
+    def result
+      Kapnismology::Result.new(false, @data, @message)
+    end
+  end
+end

data/lib/kapnismology/terminal.rb

@@ -1,5 +1,6 @@
 module Kapnismology
   class Terminal
+
     def self.green(msg)
       "\e[32m\e[1m#{msg}\e[0m"
     end
@@ -8,6 +9,10 @@ module Kapnismology
       "\e[31m\e[1m#{msg}\e[0m"
     end
 
+    def self.yellow(msg)
+      "\e[33m\e[1m#{msg}\e[0m"
+    end
+
     def self.bold(msg)
       "\e[1m#{msg}\e[0m"
     end

data/lib/kapnismology/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapnismology
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Jordi Polo Carres
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -155,6 +155,7 @@ files:
 - lib/kapnismology/result.rb
 - lib/kapnismology/smoke_test.rb
 - lib/kapnismology/smoke_test_collection.rb
+- lib/kapnismology/smoke_test_failed.rb
 - lib/kapnismology/spec_helper.rb
 - lib/kapnismology/terminal.rb
 - lib/kapnismology/version.rb