oktest 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c65e47a706541792e7ba1e9705dc03af1c2fe46c87141472659fb811463e76
-  data.tar.gz: c405d466c9b63eb3897754716d220f884af655cceba5cc7c644e742caf22b465
+  metadata.gz: 66c4df474c029dfbb1e598274d8959e742fab20f1e158d53ac8c4d6a1bb815ce
+  data.tar.gz: 4e9b1c680b335a2ae4fcc8b4e698ace15ab5df9f42a143e998c7b2556b5f8f15
 SHA512:
-  metadata.gz: 496909751ed5b3035d07091c0dc362af3586e85e144177603f15035e178fa5f1d9e31c70bd1da7c60059efd8c3275c781e5876af45ac144f4d56fccf444fea20
-  data.tar.gz: e7d440c6dcdbccefe33e99be638dc0f70aae187ee49f0fc091ea631f55e93da822b22804bfa57d570bf9190440c248783564724fa7998df4b0e9b0a6eb0f7ed3
+  metadata.gz: c35a5ede9c4b9ce53c458bb18f4871782078ff933f6133b369b1058bd122a2f4d0e0f823b0e2f8e6a81fb42560d3c4a6710cead958db4ae1d9c0a53c97131255
+  data.tar.gz: b739cc6de446f83a92e87119c29c53022376b18495e211c555c03d2f16e82d03f465b343709b93c320f0718c3df585cca5f33d189770d37f84ad77840d5aeca3

data/README.md

@@ -4,7 +4,7 @@
 
 Oktest.rb is a new-style testing library for Ruby.
 
-* `ok {actual} == expected` style [assertion](#assertions).
+* `ok {actual} == expected` style [assertions](#assertions).
 * [Fixture injection](#fixture-injection) inspired by dependency injection.
 * Structured test specifications like RSpec.
 * [JSON Matcher](#json-matcher) similar to JSON Schema.
@@ -43,7 +43,7 @@ Oktest.scope do                      #
 end                                  #
 ```
 
-Oktest.rb requires Ruby 2.0 or later.
+Oktest.rb requires Ruby 2.4 or later.
 
 
 
@@ -77,7 +77,12 @@ Oktest.rb requires Ruby 2.0 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>
@@ -823,7 +828,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 +1308,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 +1323,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 +1338,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 +1484,7 @@ end
 
 `dummy_dir()` creates a dummy directory temporarily.
 
-test/example33_test.rb:
+test/example34_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1425,7 +1526,7 @@ end
 
 `dummy_values()` changes hash values temporarily.
 
-test/example34_test.rb:
+test/example35_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1477,7 +1578,7 @@ end
 
 `dummy_attrs()` changes object attribute values temporarily.
 
-test/example35_test.rb:
+test/example36_test.rb:
 
 ```ruby
 require 'oktest'
@@ -1532,7 +1633,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 +1690,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'

data/Rakefile.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.3.0 $
+### $Release: 1.4.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()