cutest 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bc022132fb8435fd081485e6649717148b2907f
-  data.tar.gz: 51720cbf6e686d549bcb0db4b93aa427be3d1acc
+  metadata.gz: 9798d232220c6c693812a9db18c885a6e390b92a
+  data.tar.gz: b889afb1b6d810ec6dab549bb39ccd392573483b
 SHA512:
-  metadata.gz: 030a88a3567dba1ac8d88e74c4121c921bc64ea1a0f9086764bc479ddd65ed7157dfe9026ca9bac7465546e57392866e3a1e8c9ec81f1d7c05f73425fb3bbc6c
-  data.tar.gz: 355faf07ae61e2bac11b81943ce3953d4ac8a59eb0a043e4695f1afb7475ef0fa2f0c6c5f4708b517ca03a7e222f2aa4cac0ed64e24952d443971d590c265337
+  metadata.gz: 1ab94395a730e10588229f383ffa20515b8ac0816d9b381b86bd1029f3677d5a243cefead153d2f76db62831b84bb138f8a33945fee876b3aa0ff83b110a3436
+  data.tar.gz: 0529d8e1e97010ead35df62724de100b3ad3062ae1e570fdd217a19a6e90a7775a2bfa70bec523807661a224c1920d06ec503c562959dde0b11d0184568dcf47

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+1.2.3 - 2015-12-04
+==================
+
+* `assert_raise` now works with lower-level exceptions.
+
+* `assert` can now receive a custom failure message, which should help write
+  better custom assertions.
+
+* `cutest -v` now exits after printing the version number.
+
 1.2.2 - 2014-11-05
 ==================
 

data/Makefile

@@ -0,0 +1,6 @@
+TESTS=$(shell ls test/*.rb)
+
+test:
+	ruby -W2 bin/cutest $(TESTS)
+
+.PHONY: test

data/README.markdown

@@ -1,6 +1,8 @@
 Cutest
 =======
 
+[![Gem Version](https://badge.fury.io/rb/cutest.svg)](https://badge.fury.io/rb/cutest)
+
 Forking tests.
 
 Description
@@ -38,6 +40,10 @@ equal; and `assert_raise`, that executes a passed block and compares the raised
 exception to the expected one. In all cases, if the expectation is no met, an
 `AssertionFailed` exception is raised.
 
+You can customize the output of `assert` by providing a second argument with
+a string you want to get as an error report if the assertion is not fulfilled.
+This can also be used as a simple building block to build custom assertions.
+
 Usage
 -----
 
@@ -47,83 +53,99 @@ In your terminal:
 
 In your tests:
 
-    setup do
-      {:a => 23, :b => 43}
-    end
+````ruby
+setup do
+  {:a => 23, :b => 43}
+end
 
-    test "should receive the result of the setup block as a parameter" do |params|
-      assert params == {:a => 23, :b => 43}
-    end
+test "should receive the result of the setup block as a parameter" do |params|
+  assert params == {:a => 23, :b => 43}
+end
 
-    test "should evaluate the setup block before each test" do |params|
-      params[:a] = nil
-    end
+test "should evaluate the setup block before each test" do |params|
+  params[:a] = nil
+end
 
-    test "should preserve the original values from the setup" do |params|
-      assert 23 == params[:a]
-    end
+test "should preserve the original values from the setup" do |params|
+  assert 23 == params[:a]
+end
+```
 
 An example working with a prepare block:
+````ruby
+prepare do
+  Ohm.flush
+end
 
-    prepare do
-      Ohm.flush
-    end
+setup do
+  Ohm.redis.get("foo")
+end
 
-    setup do
-      Ohm.redis.get("foo")
-    end
-
-    test do |foo|
-      assert foo.nil?
-    end
+test do |foo|
+  assert foo.nil?
+end
+````
 
 And working with scopes:
-
-    setup do
-      @foo = true
-    end
-
-    @bar = true
-
-    scope do
-      test "should not share instance variables" do |foo|
-        assert !defined?(@foo)
-        assert !defined?(@bar)
-        assert foo == true
-      end
-    end
+````ruby
+setup do
+  @foo = true
+end
+
+@bar = true
+
+scope do
+  test "should not share instance variables" do |foo|
+    assert !defined?(@foo)
+    assert !defined?(@bar)
+    assert foo == true
+  end
+end
+````
 
 The tests in these two examples will pass.
 
 Unlike other testing frameworks, Cutest does not compile all the tests before
 running them.
 
+A simple example for adding a custom `empty` assertion:
+````ruby
+def assert_empty(string)
+  assert(string.empty?, "not empty")
+end
+
+test "failed custom assertion" do
+  assert_empty "foo"
+end
+````
+
 Handling errors
 ---------------
 
 If you get an error when running the tests, this is what you will see:
-
-    Exception: assert_equal 24, params[:a] # 24 != 23
-    test/setup.rb +14
-
+````bash
+Exception: assert_equal 24, params[:a] # 24 != 23
+test/setup.rb +14
+````
 Running the build
 -----------------
 
 Using Rake:
+````ruby
+task :test do
+  exec "cutest test/*.rb"
+end
 
-    task :test do
-      exec "cutest test/*.rb"
-    end
-
-    task :default => :test
+task :default => :test
+````
 
 Using Make:
+````yml
+.PHONY: test
 
-    .PHONY: test
-
-    test:
-      cutest test/*.rb
-
+test:
+  cutest test/*.rb
+````
 Command-line interface
 ----------------------
 

data/bin/cutest

@@ -12,7 +12,7 @@ files = Clap.run ARGV,
   "-r"      => lambda { |file| require file },
   "-o"      => lambda { |name| cutest[:only] = name },
   "-s"      => lambda { |name| cutest[:scope] = name },
-  "-v"      => lambda { puts Cutest::VERSION }
+  "-v"      => lambda { puts Cutest::VERSION; exit }
 
 if files.any?
   success = Cutest.run(Dir[*files])

data/lib/cutest.rb

@@ -1,6 +1,6 @@
 class Cutest
   unless defined?(VERSION)
-    VERSION = "1.2.2"
+    VERSION = "1.2.3"
     FILTER = %r[/(ruby|jruby|rbx)[-/]([0-9\.])+]
     CACHE = Hash.new { |h, k| h[k] = File.readlines(k) }
   end
@@ -92,7 +92,7 @@ private
     Thread.current[:cutest]
   end
 
-  # Create a class where the block will be evaluated. Recommended to improve
+  # Create an instance where the block will be evaluated. Recommended to improve
   # isolation between tests.
   def scope(name = nil, &block)
     if !cutest[:scope] || cutest[:scope] == name
@@ -149,34 +149,33 @@ private
   end
 
   # Assert that value is not nil or false.
-  def assert(value)
-    flunk("expression returned #{value.inspect}") unless value
+  def assert(value, msg = "expression returned #{value.inspect}")
+    flunk(msg) unless value
     success
   end
 
-  # Assert that two values are equal.
-  def assert_equal(value, other)
-    flunk("#{value.inspect} != #{other.inspect}") unless value == other
-    success
+  # Assert that actual and expected values are equal.
+  def assert_equal(actual, expected)
+    assert(actual == expected, "#{actual.inspect} != #{expected.inspect}")
   end
 
-  # Assert that the block doesn't raise the expected exception.
+  # Assert that the block raises an expected exception.
   def assert_raise(expected = Exception)
     begin
       yield
-    rescue => exception
+    rescue expected => exception
       exception
     ensure
-      flunk("got #{exception.inspect} instead") unless exception.kind_of?(expected)
-      success
+      assert(exception.kind_of?(expected), "got #{exception.inspect} instead")
     end
   end
 
   # Stop the tests and raise an error where the message is the last line
   # executed before flunking.
   def flunk(message = nil)
+    backtrace = caller.find { |line| line.include? 'top (required)' }
     exception = Cutest::AssertionFailed.new(message)
-    exception.set_backtrace([caller[1]])
+    exception.set_backtrace(backtrace)
 
     raise exception
   end

data/test/assert_raise.rb

@@ -1,9 +1,27 @@
+test "catches default exception" do
+  assert_raise do
+    raise
+  end
+end
+
 test "catches the right exception" do
   assert_raise(RuntimeError) do
     raise RuntimeError
   end
 end
 
+test "catches exceptions lower than StandardError" do
+  assert_raise(NotImplementedError) do
+    raise NotImplementedError
+  end
+end
+
+test "raises if nothing raised" do
+  assert_raise(Cutest::AssertionFailed) do
+    assert_raise {}
+  end
+end
+
 test "raises if the expectation is not met" do
   assert_raise(Cutest::AssertionFailed) do
     assert_raise(RuntimeError) do
@@ -20,3 +38,8 @@ test "returns the exception" do
   assert_equal "error", exception.message
 end
 
+test "catches a custom exception" do
+  assert_raise do
+    raise Class.new(Exception)
+  end
+end

data/test/fixtures/fail_custom_assertion.rb

@@ -1,6 +1,5 @@
 def assert_empty(string)
-  flunk("not empty") unless string.empty?
-  success
+  assert(string.empty?, "not empty")
 end
 
 test "failed custom assertion" do

data/test/fixtures/fail_custom_message.rb

@@ -0,0 +1,3 @@
+test "failed with custom message" do
+  assert("hello".empty?, "not empty")
+end

data/test/run.rb

@@ -41,11 +41,23 @@ test "exit code of failed run" do
   assert $?.to_i != 0
 end
 
+test "output of an assertion with custom message" do
+  expected = "\n" +
+             "  test: failed with custom message\n" +
+             "  line: assert(\"hello\".empty?, \"not empty\")\n" +
+             "  file: test/fixtures/fail_custom_message.rb +2\n\n" +
+             "Cutest::AssertionFailed: not empty\n\n"
+
+  out = %x{./bin/cutest test/fixtures/fail_custom_message.rb}
+
+  assert_equal(expected, out)
+end
+
 test "output of custom assertion" do
   expected = "\n" +
              "  test: failed custom assertion\n" +
              "  line: assert_empty \"foo\"\n" +
-             "  file: test/fixtures/fail_custom_assertion.rb +7\n\n" +
+             "  file: test/fixtures/fail_custom_assertion.rb +6\n\n" +
              "Cutest::AssertionFailed: not empty\n\n"
 
   out = %x{./bin/cutest test/fixtures/fail_custom_assertion.rb}
@@ -88,3 +100,11 @@ test "runs by given scope and test names" do
 
   assert_equal 0, $?.to_i
 end
+
+test "only prints the version" do
+  expected = "#{Cutest::VERSION}\n"
+
+  out = %x{./bin/cutest test/fixtures/success.rb -v}
+
+  assert_equal(expected, out)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cutest
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Damian Janowski
@@ -10,20 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Run tests in separate processes to avoid shared state.
@@ -36,11 +36,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - CHANGELOG.md
 - LICENSE
+- Makefile
 - README.markdown
-- Rakefile
 - bin/cutest
 - cutest.gemspec
 - lib/cutest.rb
@@ -49,6 +49,7 @@ files:
 - test/assert_raise.rb
 - test/fixtures/exception.rb
 - test/fixtures/fail_custom_assertion.rb
+- test/fixtures/fail_custom_message.rb
 - test/fixtures/failure.rb
 - test/fixtures/failure_in_loaded_file.rb
 - test/fixtures/only_run_given_scope_name.rb
@@ -68,17 +69,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Forking tests.

data/Rakefile

@@ -1,9 +0,0 @@
-require File.expand_path("../lib/cutest", __FILE__)
-
-$VERBOSE = true
-
-task :test do
-  Cutest.run(Dir["test/*.rb"])
-end
-
-task :default => :test