oktest 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e79b6abcb74066a35308ed22341f6fff30b2c9a5bd485e2850c5428db9843f1
-  data.tar.gz: a2fef95c6c2207b9732a31bd25b61d3b43389e84f55f55399e465511ce55ea4a
+  metadata.gz: 71a8ad713c8536b57d4ed59541ea7a734da36187f502566aefee6479b3858e5f
+  data.tar.gz: e55ae061182626cab3b75559a0353d13fdbe5042f119a035474e6c28be311798
 SHA512:
-  metadata.gz: 60e20c0564717185d9291ea5beca7bf09a55e924c259847660a5519831124213db4ddb8945711bc21f7ea6bae69c8e24f089fc9e15e1aab6047dc50fcfe46bf8
-  data.tar.gz: fef79a96010440ea673342ec1a76bc313d88b0ed1f8d400a7832ddfbb23157b08addd96aa84ae43b523cfd96a6fa9aadc4548435d34705b67dae507d9bd6e97c
+  metadata.gz: 579a24fb8c2847bbd53805367d36176cd09fbeacc2b5690212589108517ba19f809fea79a6bfb2b07e87ff83925ef8ea9aa18a0eb420a775683f1876bf60f3e8
+  data.tar.gz: 0a3f94d919a328d8d8bfdc19da5e512e2896252df6dba80d2775fc5fedaed245b1465553c56541c110eb79cd2b68dd3cb5aea0685fe89e7b555b02efa7a2fcde

data/README.md

@@ -77,7 +77,12 @@ Oktest.rb requires Ruby 2.4 or later.
     * <a href="#fixture-keyword-argument"><code>fixture:</code> keyword argument</a>
     * <a href="#global-scope">Global Scope</a>
   * <a href="#helpers">Helpers</a>
+    * <a href="#capture_stdio"><code>capture_stdio()</code></a>
     * <a href="#capture_sio"><code>capture_sio()</code></a>
+    * <a href="#capture_stdout"><code>capture_stdout()</code></a>
+    * <a href="#capture_stderr"><code>capture_stderr()</code></a>
+    * <a href="#capture_command"><code>capture_command()</code></a>
+    * <a href="#capture_command-1"><code>capture_command!()</code></a>
     * <a href="#dummy_file"><code>dummy_file()</code></a>
     * <a href="#dummy_dir"><code>dummy_dir()</code></a>
     * <a href="#dummy_values"><code>dummy_values()</code></a>
@@ -91,6 +96,8 @@ Oktest.rb requires Ruby 2.4 or later.
     * <a href="#complex-example">Complex Example</a>
     * <a href="#helper-methods-for-json-matcher">Helper Methods for JSON Matcher</a>
   * <a href="#tips">Tips</a>
+    * <a href="#oktesttopic"><code>Oktest.topic()</code></a>
+    * <a href="#topic-target">Topic target</a>
     * <a href="#ok--in-minitest"><code>ok {}</code> in MiniTest</a>
     * <a href="#testing-rack-application">Testing Rack Application</a>
     * <a href="#environment-variale-oktest_rb">Environment Variale <code>$OKTEST_RB</code></a>
@@ -823,7 +830,7 @@ ok {exc.class}   == NoMethodError
 ok {exc.message} == "undefined method `len' for \"abc\":String"
 
 ## assert that procedure does NOT raise any exception
-ok {pr}.raise_nothing? # (>= Oktest 1.3)
+ok {pr}.raise_nothing? # (Oktest >= 1.4)
 ok {pr}.NOT.raise?     # no exception class nor error message
 not_ok {pr}.raise?     # same as above
 
@@ -1303,9 +1310,9 @@ end
 ## Helpers
 
 
-### `capture_sio()`
+### `capture_stdio()`
 
-`capture_sio()` captures standard I/O.
+`capture_stdio()` captures standard I/O.
 
 test/example31_test.rb:
 
@@ -1318,7 +1325,7 @@ Oktest.scope do
 
     spec "example spec" do
       data = nil
-      sout, serr = capture_sio("blabla") do            # !!!!!
+      sout, serr = capture_stdio("blabla") do          # !!!!!
         data = $stdin.read()     # read from stdin
         puts "fooo"              # write into stdout
         $stderr.puts "baaa"      # write into stderr
@@ -1333,17 +1340,113 @@ Oktest.scope do
 end
 ```
 
-* The first argument of `capture_sio()` represents data from `$stdin`.
-  If it is not necessary, you can omit it like `caputre_sio() do ... end`.
+* The first argument of `capture_stdio()` represents data from `$stdin`.
+  If it is not necessary, you can omit it like `caputre_stdio() do ... end`.
 * If you need `$stdin.tty? == true` and `$stdout.tty? == true`,
-  call `capture_sio(tty: true) do ... end`.
+  call `capture_stdio(tty: true) do ... end`.
+* Available on Oktest >= 1.4.
+
+
+### `capture_sio()`
+
+`capture_sio()` is an alias of `capture_stdio()`.
+This is provided for backward compatibility.
+
+(`capture_stdio()` is provided as `capture_sio()` on Oktest < 1.4,
+ and `capture_sio()` is renamed to `capture_stdio()` since Oktest 1.4.)
+
+
+### `capture_stdout()`
+
+`capture_stdout()` captures output of $stdout.
+If output of $stderr is not empty, assertion error will be raised.
+
+`capture_stdout()` is almost same as the following.
+
+```ruby
+def capture_stdout(*args, **kwargs, &b)
+  sout, serr = capture_stdio(*args, **kwargs, &b)
+  ok {serr} == ""
+  return sout
+end
+```
+
+* Available on Oktest >= 1.4.
+
+
+### `capture_stderr()`
+
+`capture_stderr()` captures output of $stderr.
+If output of $stdout is not empty, assertion error will be raised.
+
+`capture_stderr()` is almost same as the following.
+
+```ruby
+def capture_stderr(*args, **kwargs, &b)
+  sout, serr = capture_stdio(*args, **kwargs, &b)
+  ok {sout} == ""
+  return serr
+end
+```
+
+* Available on Oktest >= 1.4.
+
+
+### `capture_command()`
+
+`capture_command()` executes a command and returns output of stdout and stderr.
+
+test/example32_test.rb:
+
+```ruby
+require 'oktest'
+
+Oktest.scope do
+
+  topic "Capturing" do
+
+    spec "example spec" do
+      input = "AAA\nBBB\n"
+      sout, serr = capture_command("cat -n", input)     # !!!!!
+      ok {sout} == "     1\tAAA\n     2\tBBB\n"
+      ok {serr} == ""
+    end
+
+    spec "skip if command not installed" do
+      begin
+        sout, serr = capture_command "foobar"
+      rescue Errno::ENOENT
+        skip_when true, "command `foobar` not installed."
+      end
+    end
+
+  end
+
+end
+```
+
+* The second argument of `capture_command()` represents `$stdin` data.
+  It is optional.
+* `capture_command()` raises RuntimeError if command failed.
+* `capture_command()` accepts error handler block. The block will be called only when command failed. If error handler block is specified, `capture_command()` doesn't raise RuntimeError even if command failed.
+* `capture_command()` raises `Errno::ENOENT` exception if command not found. This exception will not be handled by error handler block.
+* Keyword parameter `tty: true` is not available.
+* Available on Oktest >= 1.4.
+
+
+### `capture_command!()`
+
+`capture_command!()` is similar to `capture_command()` but not raise error
+when command failed.
+
+* Available on Oktest >= 1.4.
 
 
 ### `dummy_file()`
 
 `dummy_file()` creates a dummy file temporarily.
 
-test/example32_test.rb:
+test/example33_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1383,7 +1486,7 @@ end
 
 `dummy_dir()` creates a dummy directory temporarily.
 
-test/example33_test.rb:
+test/example34_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1425,7 +1528,7 @@ end
 
 `dummy_values()` changes hash values temporarily.
 
-test/example34_test.rb:
+test/example35_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1477,7 +1580,7 @@ end
 
 `dummy_attrs()` changes object attribute values temporarily.
 
-test/example35_test.rb:
+test/example36_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1532,7 +1635,7 @@ end
 
 `dummy_ivars()` changes instance variables in object with dummy values temporarily.
 
-test/example36_test.rb:
+test/example37_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1589,7 +1692,7 @@ end
 See [Benry::Recorder README](https://github.com/kwatch/benry-ruby/blob/ruby/benry-recorder/README.md)
 for detals.
 
-test/example37_test.rb:
+test/example38_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1803,8 +1906,8 @@ Oktest.scope do
         "id":       1000..9999,             # range object
         "age":      Integer,                # class object
         "email":    /^\w+@example\.com$/,   # regexp
-        "gender":   Set.new(["M", "F"]),    # Set object ("M" or "F")
-        "deleted":  Set.new([true, false]), # boolean (true or false)
+        "gender":   Set["M", "F"],          # Set object ("M" or "F")
+        "deleted":  Set[true, false],       # boolean (true or false)
         "tags":     [/^\w+$/].each,         # Enumerator object (!= Array obj)
         "twitter?": /^@\w+$/,               # key 'xxx?' means optional value
       }
@@ -1879,7 +1982,7 @@ Oktest.scope do
           {
             "team": String,
             "members": [
-              {"id": 1000..9999, "name": String, "gender": Set.new(["M", "F"])}
+              {"id": 1000..9999, "name": String, "gender": Set["M", "F"]}
             ].each,                     # Enumerator object (!= Array obj)
             "leader?": String,           # key 'xxx?' means optional value
           }
@@ -1960,7 +2063,7 @@ ok {JSON({"val": 99 })} === {"val": 1..100}    # implies Integer value
 
 Oktest.rb provides some helper methods and objects:
 
-* `Enum(x, y, z)` is almost same as `Set.new([x, y, z])`.
+* `Enum(x, y, z)` is almost same as `Set[x, y, z]`.
 * `Bool()` is same as `Enum(true, false)`.
 * `Length(3)` matches to length 3, and `Length(1..3)` matches to length 1..3.
 
@@ -1970,7 +2073,7 @@ test/example44_test.rb:
 ```ruby
   actual = {"gender": "M", "deleted": false, "code": "ABCD1234"}
   ok {JSON(actual)} == {
-    "gender":  Enum("M", "F"),        # same as Set.new(["M", "F"])
+    "gender":  Enum("M", "F"),        # same as Set["M", "F"]
     "deleted": Bool(),                # same as Enum(true, false)
     "code":    Length(6..10),         # code length should be 6..10
   }
@@ -1981,6 +2084,41 @@ test/example44_test.rb:
 ## Tips
 
 
+### `Oktest.topic()`
+
+If you want to reduce nested block depth, `Oktest.topic()` will help you.
+
+```ruby
+## This...
+Oktest.topic HelloClass do
+  ...
+end
+
+## ...is equivarent to...
+Oktest.scope do
+  Oktest.toic HelloClass do
+    ...
+  end
+end
+```
+
+(Since Oktest >= 1.5)
+
+
+### Topic target
+
+`topic()` passes an target argument to the block.
+
+```ruby
+  topic '/api/orders/{id}' do |urlpath|
+    p urlpath   #=> "/api/orders/{id}"
+    ...
+  end
+```
+
+(Since Oktest >= 1.5)
+
+
 ### `ok {}` in MiniTest
 
 If you want to use `ok {actual} == expected` style assertion in MiniTest,

data/Rakefile.rb

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

data/benchmark/run_all.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 Dir.glob(File.join(File.dirname(__FILE__), '*_test.rb')).each do |x|
   #load x

data/bin/oktest

@@ -1,3 +1,6 @@
 #!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'oktest'
 Oktest.main()