oktest 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c60ec7ce654d0f50f7f2cb6523e2f27f4e843b7e88e37d886a694553805f2d7e
-  data.tar.gz: 559d192eaa5a321a59db95defbc2e7e4ec271bc8d3b97aeba2b8658a61a1b0d9
+SHA1:
+  metadata.gz: 85ba9a1ce70926dbbda6667f83b5a906dac24920
+  data.tar.gz: 8f0df1c0b9c5e64489acca1623a29f3408ef8e63
 SHA512:
-  metadata.gz: 73e39ea5796c682696127b34bff655870458b509aec487b2420276e8bd892a6a60c82a74895c0be89aa2160a231ef08eb92aff8b5a998ca335e735efbb410487
-  data.tar.gz: 8795c2227f46c7137d3456fa1040aaff0de3d020748c553439d39c7852a66cd0af7d81150cd26ef4c68907d503501de5c7cd3ec3eb3bfa6bdfe1bf2e4c9d5435
+  metadata.gz: 754daad82635ae4567fcd25b2642800ade34dd8bd039a32094f33d4020b89b54d41756a119ed2bf6e8d4d40cfba06c01277a90a8af8c774054dd373ee6fb9ba7
+  data.tar.gz: 3485c071be7c77beac3a64a34871f4063cf3fb1d91797f2b180fc8db28e685dd9f9a6bfa905c8185764f876bb1b736d5599c1a5cec1f4f74c25e53893712adb2

data/README.md

@@ -54,7 +54,7 @@ Oktest.rb requires Ruby 2.3 or later.
     * <a href="#install">Install</a>
     * <a href="#basic-example">Basic Example</a>
     * <a href="#assertion-failure-and-error">Assertion Failure, and Error</a>
-    * <a href="#skip-and-todo">Skip, and Todo</a>
+    * <a href="#skip-and-todo">Skip and Todo</a>
     * <a href="#reporting-style">Reporting Style</a>
     * <a href="#run-all-test-scripts-under-directory">Run All Test Scripts Under Directory</a>
     * <a href="#tag-and-filtering">Tag and Filtering</a>
@@ -172,6 +172,10 @@ $ oktest test/example01_test.rb   # or: ruby test/example01_test.rb
 ## total:2 (pass:2, fail:0, error:0, skip:0, todo:0) in 0.000s
 ```
 
+For accessibility reason, Oktest.rb prints passed test cases in blue color
+instead of green color.
+See https://accessibility.psu.edu/color/colorcoding/#RB for details.
+
 
 ### Assertion Failure, and Error
 
@@ -207,14 +211,14 @@ $ oktest test/example02_test.rb   # or: ruby test/example02_test.rb
   - [ERROR] example of something error
 ----------------------------------------------------------------------
 [Fail] other examples > example of assertion failure
-    tmp/test/example02_test.rb:9:in `block (3 levels) in <main>'
+    test/example02_test.rb:9:in `block (3 levels) in <main>'
         ok {1+1} == 0     # FAIL
 $<actual> == $<expected>: failed.
     $<actual>:   2
     $<expected>: 0
 ----------------------------------------------------------------------
 [ERROR] other examples > example of something error
-    tmp/test/example02_test.rb:13:in `block (3 levels) in <main>'
+    test/example02_test.rb:13:in `block (3 levels) in <main>'
         x = foobar        # NameError
 NameError: undefined local variable or method `foobar' for #<#<Class:...>:...>
 ----------------------------------------------------------------------
@@ -222,7 +226,7 @@ NameError: undefined local variable or method `foobar' for #<#<Class:...>:...>
 ```
 
 
-### Skip, and Todo
+### Skip and Todo
 
 test/example03_test.rb:
 
@@ -317,15 +321,15 @@ very useful for large project which contains large number of test cases.
 How to run test scripts under `test` directory:
 
 ```terminal
-$ ls test
+$ ls test/
 example01_test.rb       example02_test.rb       example03_test.rb
 
 $ oktest -s simple test  # or: ruby -r oktest -e 'Oktest.main' -- test -s simple
-tmp/test/example01_test.rb: ..
-tmp/test/example02_test.rb: fE
+test/example01_test.rb: ..
+test/example02_test.rb: fE
 ----------------------------------------------------------------------
 [Fail] other examples > example of assertion failure
-    tmp/test/example02_test.rb:9:in `block (3 levels) in <top (required)>'
+    test/example02_test.rb:9:in `block (3 levels) in <top (required)>'
         ok {1+1} == 0     # FAIL
     -e:1:in `<main>'
 $<actual> == $<expected>: failed.
@@ -333,12 +337,12 @@ $<actual> == $<expected>: failed.
     $<expected>: 0
 ----------------------------------------------------------------------
 [ERROR] other examples > example of something error
-    tmp/test/example02_test.rb:13:in `block (3 levels) in <top (required)>'
+    test/example02_test.rb:13:in `block (3 levels) in <top (required)>'
         x = foobar        # NameError
     -e:1:in `<main>'
 NameError: undefined local variable or method `foobar' for #<#<Class:...>:...>
 ----------------------------------------------------------------------
-tmp/test/example03_test.rb: st
+test/example03_test.rb: st
 ## total:6 (pass:2, fail:1, error:1, skip:1, todo:1) in 0.000s
 ```
 
@@ -348,7 +352,8 @@ Test script filename should be `test_xxx.rb` or `xxx_test.rb`
 
 ### Tag and Filtering
 
-`topic()` and `spec()` accepts tag name, for example 'obsolete' or 'experimental'.
+`scope()`, `topic()`, and `spec()` accepts tag name, for example 'obsolete'
+or 'experimental'.
 
 test/example04_test.rb:
 
@@ -388,16 +393,16 @@ Oktest.scope do
 end
 ```
 
-It is possible to filter topics and specs by tag name (pattern).
+It is possible to filter topics and specs by tag name or pattern.
+Pattern (!= regular expression) supports `*`, `?`, `[]` and `{}`.
 
 ```terminal
-$ oktest -F tag=exp         tests/     # filter by tag name
-$ oktest -F tag='*exp*'     tests/     # filter by tag name pattern
-$ oktest -F tag='{exp,old}' tests/     # filter by multiple tag names
+$ oktest -F tag=exp         test/      # filter by tag name
+$ oktest -F tag='*exp*'     test/      # filter by tag name pattern
+$ oktest -F tag='{exp,old}' test/      # filter by multiple tag names
 ```
 
 It is also possible to filter topics or specs by name.
-Pattern (!= regular expression) supports `*`, `?`, `[]`, and `{}`.
 
 ```terminal
 $ oktest -F topic='*Integer*' test/    # filter topics by pattern
@@ -407,8 +412,8 @@ $ oktest -F spec='*#[1-3]'    test/    # filter specs by pattern
 If you need negative filter, use `!=` instead of `=`.
 
 ```terminal
-$ oktest -F spec!='*#5'      tests/    # exclude spec 'example #5'
-$ oktest -F tag!='{exp,old}' tests/    # exclude tag='exp' or tag='old'
+$ oktest -F spec!='*#5'      test/     # exclude spec 'example #5'
+$ oktest -F tag!='{exp,old}' test/     # exclude tag='exp' or tag='old'
 ```
 
 
@@ -466,7 +471,7 @@ $ ruby test/example05_test.rb
 
 ### Optional: Unary Operators
 
-`topic()` accepts unary `+` operator and `spec()` accepts unary `-` operator.
+`topic()` accepts unary plus (`+`) and `spec()` accepts unary minus (`-`).
 This makes test scripts more readable.
 
 <!--
@@ -500,7 +505,7 @@ end
 
 ### Generate Test Code Skeleton
 
-`oktest -G` (or `oktest --generate`) generates test code skeleton from ruby file.
+`oktest --generate` (or `oktest -G`) generates test code skeleton from ruby file.
 Comment line starting with `#;` is regarded as spec description.
 
 hello.rb:
@@ -523,7 +528,7 @@ end
 Generate test code skeleton:
 
 ```terminal
-$ oktest -G hello.rb > test/hello_test.rb
+$ oktest --generate hello.rb > test/hello_test.rb
 ```
 
 test/hello_test.rb:
@@ -608,7 +613,7 @@ Oktest.scope do
     end
 
     spec "example" do
-      s = hello()               # call method in spec block
+      s = hello()               # call it in spec block
       ok {s} == "Hello!"
     end
 
@@ -701,7 +706,7 @@ ok {a}.item(key, e)      # alias of `ok {a}.keyval(key, e)`
 ok {a}.length(e)         # fail unless a.length == e
 ```
 
-It is possible to chan method call of `.attr()` and `.keyval()`.
+It is possible to chain method call of `.attr()` and `.keyval()`.
 
 <!--
 test/example11b_test.rb:
@@ -873,7 +878,7 @@ end
 ```
 
 To catch subclass of error class, invoke `.raise!` instead of `.raise?`.
-For example: `ok {pr}.raise!(NameError, /foobar/, subclass: true)`.
+For example: `ok {pr}.raise!(NameError, /foobar/)`.
 
 <!--
 test/example14f_test.rb:
@@ -1075,7 +1080,7 @@ Oktest.scope do
 end
 ```
 
-* `at_end()` can be called multiple times.
+* `at_end()` can be called multiple times in a spec.
 * Registered blocks are invoked in reverse order at end of test case.
 * Registered blocks of `at_end()` are invoked prior to block of `after()`.
 * If something error raised in `at_end()`, test script execution will be
@@ -1085,7 +1090,7 @@ end
 ### Named Fixtures
 
 `fixture() { ... }` in topic or scope block defines fixture builder,
-and `fixture()` in scope block returns fixture data.
+and `fixture()` in spec block returns fixture data.
 
 test/example23_test.rb:
 
@@ -1144,7 +1149,7 @@ Oktest.scope do
 end
 ```
 
-* Fixtures can be defined in block of `topic()` as well as block of `Object.scope()`.
+* Fixture builders can be defined in `topic()` block as well as `Oktest.scope()` block.
 * If fixture requires clean-up operation, call `at_end()` in `fixture()` block.
 
 ```ruby
@@ -1267,7 +1272,7 @@ Oktest.scope do
 end
 ```
 
-* First argument of `capture_sio()` represents data from `$stdin`.
+* The first argument of `capture_sio()` represents data from `$stdin`.
   If it is not necessary, you can omit it like `caputre_sio() do ... end`.
 * If you need `$stdin.tty? == true` and `$stdout.tty? == true`,
   call `capture_sio(tty: true) do ... end`.
@@ -1275,7 +1280,7 @@ end
 
 ### `dummy_file()`
 
-`dummy_file()` creates dummy file temporarily.
+`dummy_file()` creates a dummy file temporarily.
 
 test/example32_test.rb:
 
@@ -1310,12 +1315,12 @@ Oktest.scope do
 end
 ```
 
-* If first argument of `dummy_file()` is nil, then it generates temporary file name automatically.
+* If the first argument of `dummy_file()` is nil, then it generates temporary file name automatically.
 
 
 ### `dummy_dir()`
 
-`dummy_dir()` creates dummy directory temporarily.
+`dummy_dir()` creates a dummy directory temporarily.
 
 test/example33_test.rb:
 
@@ -1352,7 +1357,7 @@ Oktest.scope do
 end
 ```
 
-* If first argument of `dummy_dir()` is nil, then it generates temorary directory name automatically.
+* If the first argument of `dummy_dir()` is nil, then it generates temorary directory name automatically.
 
 
 ### `dummy_values()`
@@ -1519,7 +1524,7 @@ end
 
 ### `recorder()`
 
-`recorder()` returns Benry::Recorder object.
+`recorder()` returns `Benry::Recorder` object.
 See [Benry::Recorder README](https://github.com/kwatch/benry-ruby/blob/ruby/benry-recorder/README.md)
 for detals.
 
@@ -1648,7 +1653,7 @@ Oktest.scope do
 end
 ```
 
-Defining helper method per topic may help you.
+Defining helper methods per topic may help you.
 
 ```ruby
 $http = http                                   # !!!!
@@ -1826,10 +1831,8 @@ ruby run_all.rb | tail -5
 
 ### `--faster` Option
 
-`ok {}` is slightly slower than `assert()` in MiniTest.
-In almost case, you don't need to care about it.  But if you are working in
-very larget project and you want to run test scripts as fast as possible,
-try `--faster` option of `oktest` command.
+If you are working in very larget project and you want to run test scripts
+as fast as possible, try `--faster` option of `oktest` command.
 
 ```terminal
 $ oktest -s quiet --faster test/        ## only for very large project

data/Rakefile.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/lib/oktest.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -10,7 +10,7 @@
 module Oktest
 
 
-  VERSION = '$Release: 1.0.0 $'.split()[1]
+  VERSION = '$Release: 1.0.1 $'.split()[1]
 
 
   class OktestError < StandardError
@@ -891,11 +891,20 @@ module Oktest
   end
 
   def self.scope(tag: nil, &block)
-    #; [!vxoy1] creates new scope object.
-    #; [!rsimc] adds scope object as child of THE_GLOBAL_SCOPE.
+    #; [!kem4y] detects test script filename.
     location = caller(1).first  # caller() makes performance slower, but necessary.
     filename = location =~ /:\d+/ ? $` : nil
-    filename = filename.sub(/\A\.\//, '')
+    #; [!6ullm] changes test script filename from absolute path to relative path.
+    if filename
+      pwd = Dir.pwd()
+      if filename.start_with?(pwd)
+        filename = filename[pwd.length..-1].sub(/\A\//, '')
+      elsif filename.start_with?('./')
+        filename = filename[2..-1]
+      end
+    end
+    #; [!vxoy1] creates new scope object.
+    #; [!rsimc] adds scope object as child of THE_GLOBAL_SCOPE.
     scope = ScopeNode.new(THE_GLOBAL_SCOPE, filename, tag: tag)
     #; [!jmc4q] raises error when nested called.
     self.__scope(scope, &block)

data/oktest.gemspec

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $License: MIT License $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ###
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.name        = "oktest"
   s.author      = "kwatch"
   s.email       = "kwatch@gmail.com"
-  s.version     = "$Release: 1.0.0 $".split()[1]
+  s.version     = "$Release: 1.0.1 $".split()[1]
   s.license     = "MIT"
   s.platform    = Gem::Platform::RUBY
   s.homepage    = "https://github.com/kwatch/oktest/tree/ruby"

data/test/assertion_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/filter_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/fixture_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/generator_test.rb

@@ -1,5 +1,5 @@
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/helper_test.rb

@@ -1,5 +1,5 @@
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/initialize.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/mainapp_test.rb

@@ -1,5 +1,5 @@
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -241,7 +241,7 @@ END
     end
 
     it "[!qqizl] '--version' option prints version number." do
-      expected = '$Release: 1.0.0 $'.split()[1] + "\n"
+      expected = '$Release: 1.0.1 $'.split()[1] + "\n"
       #
       ret, sout, serr = run("--version")
       assert_eq ret, 0

data/test/misc_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/node_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -315,6 +315,25 @@ class ScopeFunctions_TC < TC
     Oktest::THE_GLOBAL_SCOPE.clear_children()
   end
 
+  def with_dummy_location(location)
+    $_dummy_location = location
+    Oktest.module_eval do
+      class << self
+        def caller(n)
+          return [$_dummy_location]
+        end
+      end
+    end
+    yield
+  ensure
+    Oktest.module_eval do
+      class << self
+        remove_method :caller
+      end
+    end
+    $_dummy_location = nil
+  end
+
   describe 'Oktest.scope()' do
     it "[!vxoy1] creates new scope object." do
       x = Oktest.scope() { nil }
@@ -341,6 +360,20 @@ class ScopeFunctions_TC < TC
       assert_eq Oktest::THE_GLOBAL_SCOPE.has_child?, true
       assert_eq Oktest::THE_GLOBAL_SCOPE.each_child.to_a, [so]
     end
+    it "[!kem4y] detects test script filename." do
+      sc = Oktest.scope() { nil }
+      assert_eq sc.filename, "test/node_test.rb"
+    end
+    it "[!6ullm] changes test script filename from absolute path to relative path." do
+      with_dummy_location(Dir.pwd + "/tests/foo_test.rb:123") do
+        sc = Oktest.scope() { nil }
+        assert_eq sc.filename, "tests/foo_test.rb"
+      end
+      with_dummy_location("./t/bar_test.rb:456") do
+        sc = Oktest.scope() { nil }
+        assert_eq sc.filename, "t/bar_test.rb"
+      end
+    end
   end
 
   describe '#global_scope()' do

data/test/reporter_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/runner_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/util_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/visitor_test.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.0.1 $
 ### $Copyright: copyright(c) 2011-2021 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oktest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - kwatch
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -82,7 +82,7 @@ homepage: https://github.com/kwatch/oktest/tree/ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +97,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
 specification_version: 4
 summary: new style testing library
 test_files: