kapnismology 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f774766ca0fb68f1ce0dbb2f81581654a002a8d
-  data.tar.gz: 883937951485cfd3fbb1d3b20da6e29ccb879d5d
+  metadata.gz: d27de09be6c9595f860e7054e7a87d8424c616e7
+  data.tar.gz: 0ddb6a39122a5ff180f1aae24f9d407eef5d02eb
 SHA512:
-  metadata.gz: 28f921c8f93814503aa67f119bb9880acc09afc41a74a2397f4dca40b7235815a3a63888edea896aa48d7db7f7dcd262e7bc4fcbcb4d2d336c9267217cb11e17
-  data.tar.gz: 147495374e5821784b739413893f1dc569635669c8acb27f9a10e822f0fcc7ffd86a477e734c27bbd92a4b70ae5a293c9046b54a23de8c4a81f425a3dcc957d2
+  metadata.gz: d7014adec5ead6a8002bc58a34bc021e6f81da4c8fbb3aecb3a9e1ec2ff3280fd44114ed856d69bf0a322d701cde632368f87191211957a8dbcc69c8db64c822
+  data.tar.gz: 8c873c5b0387c083269a05b4a7c0e472daaeb881af725ab5aea8bfdb73650393ada8f698b375a6e5be33989805dac4854bca689adba890657b091271f156c735

data/README.md

@@ -7,7 +7,7 @@ Kapnismology 'the study of smoke', is a gem which contains an engine to easily c
 Kapnismology only supports Rails.
 In the Gemfile write:
 ```
-gem 'kapnismology', '~> 0.1'
+gem 'kapnismology', '~> 0.2'
 ```
 
 In your config/routes write:
@@ -27,29 +27,26 @@ Create a class like this:
 ```
 class MySmokeTest < Kapnismology::SmokeTest
 
-  def self.name
-    'my_test'
-  end
-
   def result
-    "BOOO"
+    Kapnismology::Result.new(true, {connection: 'good'}, "Connected!")
   end
 end
 ```
 
 The class must:
 - Inherit from `Kapnismology::SmokeTest`
-- Have a method `self.name` returning a string
 - Have an instance method `result` returning a Kapnismology::Result object
 
 Any class created this way will be called and its result will be added to a resulting hash.
 In this case the result of this class would be added to the result as:
 ```
-{'my_test' => 'BOOO'}
+{'MySmokeTest': { passed: true, data: { connection: 'good' }, message: 'Connected!' }}
 ```
 
+If you want to change the name of the test, define self.name in your
+smoke test class.
+
 ## TODO
 
-- rspecs
 - Automount routes
 - Hypermedia output

data/lib/kapnismology/evaluation.rb

@@ -4,16 +4,31 @@ module Kapnismology
 
   # Mapping of test_name => result for each smoke test
   class Evaluation
-    extend Forwardable
-    attr_reader :test_name
-    def_delegators :@result, :data, :passed, :message
+    def initialize(test_class)
+      @name = test_class.name.split("::").last
+      @result = test_class.new.result || unavailable_result
+    end
+
+    def passed?
+      @result.passed?
+    end
+
+    def as_json(_options = nil)
+      { @name => @result.to_hash }
+    end
+
+    def to_s
+      "The smoke test #{@name} #{passed_or_failed_text}\n #{@result.message}"
+    end
+
+    private
 
-    def initialize(test_name, result)
-      @test_name, @result = test_name, result
+    def unavailable_result
+      Result.new(false, {}, "This test has not returned any result.")
     end
 
-    def to_json(_options = nil)
-      {test_name => @result.to_hash}.to_json
+    def passed_or_failed_text
+      passed? ? "passed" : "failed"
     end
   end
 end

data/lib/kapnismology/evaluation_collection.rb

@@ -4,8 +4,8 @@ module Kapnismology
   class EvaluationCollection
     include Enumerable
 
-    def initialize(smoke_tests)
-      @smoke_tests = smoke_tests
+    def initialize(test_classes)
+      @smoke_tests_classes = test_classes
     end
 
     def each(&block)
@@ -15,7 +15,7 @@ module Kapnismology
     end
 
     def passed?
-     evaluations.all?{|evaluation| evaluation.passed}
+     evaluations.all?{|evaluation| evaluation.passed?}
     end
 
     def to_json
@@ -25,10 +25,9 @@ module Kapnismology
     private
 
     def evaluations
-      @evaluations ||= @smoke_tests.map do |smoke_test|
-        result = smoke_test.new.result
-        Evaluation.new(smoke_test.name, result) if result
-      end.compact
+      @evaluations ||= @smoke_tests_classes.map do |klass|
+        Evaluation.new(klass)
+      end
     end
   end
 

data/lib/kapnismology/rake_task.rb

@@ -3,15 +3,10 @@ module Kapnismology
     def output
       evaluations = SmokeTest.evaluations
       evaluations.each do |evaluation|
-        puts "The smoke test #{evaluation.test_name} #{passed_or_failed(evaluation.passed)}"
-        puts evaluation.message
+        puts evaluation.to_s
         puts
       end
       fail 'We have some failures in our smoke tests' unless evaluations.passed?
     end
-
-    def passed_or_failed(passed)
-      passed ? "passed" : "failed"
-    end
   end
 end

data/lib/kapnismology/result.rb

@@ -3,18 +3,23 @@ module Kapnismology
   # This is the result of each smoke test.
   # This class makes sense to enforce smoke test to return something known
   # Params of the constructor:
-  # * data   : Typically Array or Hash representing the result of the test
   # * passed : Boolean: true -> test passed, false -> test failed
-  # * message: String: extra message set by the test if it wants to provide more information
+  # * data   : Typically Array or Hash representing the result of the test
+  # * message: String with an extra message set by the test to provide human readable information
   class Result
-    attr_reader :data, :passed, :message
+    attr_reader :data, :message
+
+    def initialize(passed, data, message)
+      raise ArgumentError, "passed must be true or false" unless !!passed == passed
+      @passed, @data, @message = passed, data, message
+    end
 
-    def initialize(data, passed, message)
-      @data, @passed, @message = data, passed, message
+    def passed?
+      !!@passed
     end
 
     def to_hash
-      {result: @data, passed: @passed, message: @message}
+      {passed: passed?, data: @data, message: @message}
     end
   end
-end
+end

data/lib/kapnismology/smoke_test.rb

@@ -11,10 +11,6 @@ module Kapnismology
       raise 'this method has to be implemented in inherited classes'
     end
 
-    def self.name
-      raise 'this method has to be implemented in inherited classes'
-    end
-
     class << self
 
       def inherited(klass)

data/lib/kapnismology/version.rb

@@ -1,3 +1,3 @@
 module Kapnismology
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapnismology
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordi Polo Carres
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: mutant
   requirement: !ruby/object:Gem::Requirement