tet 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc5e7a16c8fec8cf15d0cc6e7b87c242a2231984
-  data.tar.gz: 67a7ca617271c9830b8e07a6bb2e572ae90973a1
+  metadata.gz: 77d0239f2921f33e38b177f8c80d34a3b81ae1f1
+  data.tar.gz: b6122266f7d0d5bee82c9e76a761b39994228989
 SHA512:
-  metadata.gz: 934900975f00590e80c56ca2df4daff59449e43d85cda520736557b770f22773ec0d073648dad9f8ac9ad5b958452c28599e6d5d1c9e140a8eb6593c07a92316
-  data.tar.gz: b9ac41a49766a32206d09a08ed11f02921b4d7003fc55cb17db09eae862754dc8b41818af0172ee99de167a214d9eb0c89b31463539a595b8d0bb852df3ffa6c
+  metadata.gz: 76b1653b796d3eb7c581eddcc057e7e80e9919e7840c7e2a6add135a223860bb88a751c4d0811dc8e7d2a6f3a54aa7b585f79909edfb6f98642d7e3be18532d2
+  data.tar.gz: 9eb495447fef64e050bc0c4b83c0adf42e07bd6729136cfea8b7808b3b0bd6306cf5510ab1d9af8b3b94373a6f5faf391c362c58b7a0c54950ddd628a8cc1359

data/lib/tests.rb

@@ -5,139 +5,117 @@
 # terms of the three-clause BSD license. See LICENSE.txt
 # (located in root directory of this project) for details.
 
-require_relative './tet'
+require_relative "./tet"
 
-puts 'EXPECTED Results:'
-puts '.....F!F!FF.F......F.F.F.!'
-puts '11 out of 26 failed'
-puts "\nACTUAL Results:"
+puts <<-END
+Expected results:
+.F!..F.F.F!..F.F.!.F.......FF.FF.F!
+16 out of 35 failed
 
-group 'Passing' do
-  group '#assert' do
-    group 'truthy blocks pass' do
-      assert { 'this is truthy' }
-    end
-  end
+Actual results:
+END
 
-  group '#deny' do
-    group 'falsy blocks pass' do
-      deny { nil }
-    end
-  end
+# Wraps the block in a group to label it as an example instead of a real test.
+def fails
+  group("INTENDED FAILURE") { result = yield }
+end
 
-  group '#err' do
-    group 'passes when there is an error' do
-      err { not_a_method }
-    end
+group "#assert" do
+  assert("truthy blocks pass") { true }
 
-    group 'allows you to specify an exception class' do
-      err(NameError) { not_a_method }
-    end
+  fails do
+    assert("falsy blocks fail") { nil }
+    assert("errors are caught and count as failures") { not_a_method }
+  end
 
-    group 'allows you to specify a parent exception class' do
-      err(Exception) { not_a_method }
-    end
+  assert "passing returns true" do
+    assert { true }.equal?(true)
   end
+
+  assert "failing returns false" do
+    fails { assert { nil }.equal?(false) }
+  end
+
+  fails { assert("Can have a name") { nil } }
 end
 
-group 'Failing' do
-  group '#assert' do
-    group 'falsy blocks fail' do
-      assert { nil }
-    end
+group "#deny" do
+  deny("falsey blocks pass") { nil }
 
-    group 'errors are caught and count as failures' do
-      assert { not_a_method }
-    end
+  fails do
+    deny("truthy blocks fail") { :truthy }
+    deny("errors are caught and count as failures") { not_a_method }
   end
 
-  group '#deny' do
-    group 'truthy blocks fail' do
-      deny { 'this is truthy' }
-    end
+  assert "passing returns true" do
+    deny { nil }.equal?(true)
+  end
 
-    group 'errors are caught and count as failures' do
-      deny { not_a_method }
-    end
+  assert "failing returns false" do
+    fails { deny { :truthy }.equal?(false) }
   end
 
-  group '#err' do
-    group 'fails when there is no error' do
-      err { 1 + 1 }
-    end
+  fails { deny("Can have a name") { :truthy } }
+end
 
-    group 'fails given wrong error class' do
-      err(ArgumentError) { not_a_method }
-    end
+group "#group" do
+  assert "returns output of block" do
+    group("EXAMPLE") { "example ouput" } == "example ouput"
   end
-end
 
-group 'Output' do
-  group '#group' do
-    group 'returns output of block' do
-      assert do
-        group('EXAMPLE') {'example ouput'} == 'example ouput'
-      end
-    end
+  return_value = fails { group("catches errors") { raise "Example Error" } }
 
-    group 'this test fails to see what giving a Class as name looks like' do
-      group String do
-        assert { false }
-      end
-    end
+  assert "returns nil when an assertion returns an error" do
+    return_value.nil?
   end
 
-  # Test if the output of a block is a given Class.
-  # Wraps the block in a group to label it as an example instead of a real test.
-  def output_is_a? klass
-    result = nil
+  group "can have classes for names" do
+    group String do
+      fails { assert { false } }
+    end
+  end
+end
 
-    group('EXAMPLE') { result = yield }
+group "#err" do
+  group "passes when there is an error" do
+    err { not_a_method }
 
-    result.is_a?(klass)
+    assert "... and returns true" do
+      err { not_a_method }.equal?(true)
+    end
   end
 
-  group 'passing returns true' do
-    group '#assert' do
-      assert do
-        output_is_a?(TrueClass) { assert {"this passes"} }
-      end
-    end
+  group "allows you to specify an exception class" do
+    err(expect: NameError) { not_a_method }
 
-    group '#deny' do
-      assert do
-        output_is_a?(TrueClass) { deny {nil} }
-      end
+    group "... or a parent exception class" do
+      err(expect: Exception) { not_a_method }
     end
 
-    group '#err' do
-      assert do
-        output_is_a?(TrueClass) { err {not_a_method} }
-      end
+    assert "... and returns true" do
+      err(expect: NameError) { not_a_method }.equal?(true)
     end
   end
 
-  group 'failing returns false' do
-    group '#assert' do
-      assert do
-        output_is_a?(FalseClass) { assert {nil} }
-      end
-    end
+  group "fails when there is no error" do
+    fails { err { 1+1 } }
 
-    group '#deny' do
-      assert do
-        output_is_a?(FalseClass) { deny {"this fails"} }
-      end
+    assert "... and returns false" do
+      fails { err { 1+1 } }.equal?(false)
     end
+  end
 
-    group '#err' do
-      assert do
-        output_is_a?(FalseClass) { err {"this fails"} }
-      end
+  group "fails given wrong error class" do
+    fails { err(expect: ArgumentError) { not_a_method } }
+
+    assert "... and returns false" do
+      fails { err(expect: ArgumentError) { not_a_method } }.equal?(false)
     end
   end
 
-  group '"Did you mean?" messages look nice' do
-    assert { 1.to_ss }
-  end
+  fails { err("Can have a name") { 1+1 } }
+end
+
+group "'Did you mean?' error messages look nice" do
+  fails { assert { 1.to_z } }
 end

data/lib/tet.rb

@@ -6,58 +6,67 @@
 # (located in root directory of this project) for details.
 
 # Label all tests within a block.
-def group name
+def group name = nil
   Tet.in_group(name) { yield }
 end
 
 # Declare that a block will return a truthy value.
 # If it doesn't or if it has an error, the assertion will be logged as failing.
-def assert
-  result = false
+def assert name = nil
+  Tet.in_group(name) do
+    result = false
 
-  begin
-    result = yield
+    begin
+      result = yield
 
-    if result
-      Tet.pass
-    else
-      Tet.fail
+      if result
+        Tet.pass
+      else
+        Tet.fail
+      end
+    rescue StandardError => error
+      Tet.error(error)
     end
-  rescue StandardError => error
-    Tet.error(error)
-  end
 
-  !!result
+    !!result
+  end
 end
 
 # Declare that a block will return a falsy value.
 # If it doesn't or if it has an error, the assertion will be logged as failing.
-def deny
-  assert { !yield }
+def deny name = nil
+  assert(name) { !yield }
 end
 
 # Declare that a block will have an error.
 # If it doesn't the assertion will be logged as failing.
-def err expect = StandardError
-  result = false
-
-  begin
-    yield
-    Tet.fail
-  rescue StandardError => error
-    if expect >= error.class
-      result = true
-      Tet.pass
-    else
-      Tet.wrong_error(expected: expect, got: error)
+def err name = nil, expect: StandardError
+  Tet.in_group(name) do
+    result = false
+
+    begin
+      yield
+      Tet.fail
+    rescue StandardError => error_object
+      if expect >= error_object.class
+        result = true
+        Tet.pass
+      else
+        Tet.wrong_error(expected: expect, got: error_object)
+      end
     end
-  end
 
-  result
+    result
+  end
 end
 
 # A namespace for all of the helper methods.
 module Tet
+  PassChar       = "."
+  FailChar       = "F"
+  ErrorChar      = "!"
+  GroupSeperator = "  |  "
+
   @current_group = []
   @fail_messeges = []
   @total_asserts = 0
@@ -66,29 +75,38 @@ module Tet
   class << self
     # Store the group name for the duration of calling the given block.
     def in_group name
-      @current_group.push(name)
-      yield.tap { @current_group.pop }
+      result = nil
+      @current_group.push(name) if name
+
+      begin
+        result = yield
+      rescue StandardError => error_object
+        error error_object, "ERROR IN GROUP"
+      end
+
+      @current_group.pop if name
+      result
     end
 
     # Log a passing assertion.
     def pass
-      print '.'
+      print PassChar
 
       @total_asserts += 1
     end
 
     # Log a failing assertion.
-    def fail *messeges, letter: 'F'
+    def fail *messeges, letter: FailChar
       print letter
 
       @total_asserts += 1
       @total_fails   += 1
-      @fail_messeges << @current_group.join('  :  ') << messeges
+      @fail_messeges << @current_group.join(GroupSeperator) << messeges
     end
 
     # Log an assertion error.
-    def error error
-      fail *format_error(error), letter: '!'
+    def error error_object, *messages
+      fail *messages, *format_error(error_object), letter: ErrorChar
     end
 
     # Log an assertion which had the wrong error.
@@ -98,17 +116,20 @@ module Tet
 
     private
 
-    def format_error error
+    # Format an error message so #indent will render it properly
+    def format_error error_object
       [
-        "ERROR: #{error.class}",
-        ["#{error.message}", error.backtrace]
+        "ERROR: #{error_object.class}",
+        ["#{error_object.message}", error_object.backtrace]
       ]
     end
 
+    # Format an array of strings by joining them with \n and indenting nested
+    # arrays deeper than their parents.
     def indent input, amount = 0
       case input
       when String
-        input.gsub(/^/, '  ' * amount)
+        input.gsub(/^/, "  " * amount)
       when Array
         input.reject(&:empty?)
              .map { |part| indent(part, amount + 1) }

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: tet
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Colin Fulton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies: []
 description: A very minimal test framework designed for simple projects. A couple
   of features, relatively nice looking output, and nothing else. Does the world need
-  another test framework? No. Is Tet the product boredom and yak shaving? Yes.
+  another test framework? No. Is Tet the product of boredom and yak shaving? Yes.
 email: justcolin@gmail.com
 executables: []
 extensions: []