oktest 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c4df474c029dfbb1e598274d8959e742fab20f1e158d53ac8c4d6a1bb815ce
-  data.tar.gz: 4e9b1c680b335a2ae4fcc8b4e698ace15ab5df9f42a143e998c7b2556b5f8f15
+  metadata.gz: 71a8ad713c8536b57d4ed59541ea7a734da36187f502566aefee6479b3858e5f
+  data.tar.gz: e55ae061182626cab3b75559a0353d13fdbe5042f119a035474e6c28be311798
 SHA512:
-  metadata.gz: c35a5ede9c4b9ce53c458bb18f4871782078ff933f6133b369b1058bd122a2f4d0e0f823b0e2f8e6a81fb42560d3c4a6710cead958db4ae1d9c0a53c97131255
-  data.tar.gz: b739cc6de446f83a92e87119c29c53022376b18495e211c555c03d2f16e82d03f465b343709b93c320f0718c3df585cca5f33d189770d37f84ad77840d5aeca3
+  metadata.gz: 579a24fb8c2847bbd53805367d36176cd09fbeacc2b5690212589108517ba19f809fea79a6bfb2b07e87ff83925ef8ea9aa18a0eb420a775683f1876bf60f3e8
+  data.tar.gz: 0a3f94d919a328d8d8bfdc19da5e512e2896252df6dba80d2775fc5fedaed245b1465553c56541c110eb79cd2b68dd3cb5aea0685fe89e7b555b02efa7a2fcde

data/README.md

@@ -96,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>
@@ -1904,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
       }
@@ -1980,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
           }
@@ -2061,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.
 
@@ -2071,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
   }
@@ -2082,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.4.0 $
+### $Release: 1.5.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/lib/oktest.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 ###
-### $Release: 1.4.0 $
+### $Release: 1.5.0 $
 ### $Copyright: copyright(c) 2011-2024 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -13,7 +13,7 @@ require 'set'
 module Oktest
 
 
-  VERSION = '$Release: 1.4.0 $'.split()[1]
+  VERSION = '$Release: 1.5.0 $'.split()[1]
 
 
   class OktestError < StandardError
@@ -1125,6 +1125,13 @@ END
     attr_reader :target
     attr_writer :_prefix
 
+    def run_block_in_context_class(&block)
+      #; [!i2kvj] run block in context class.
+      #; [!pr3vj] run block with topic target as an argument.
+      target = @target
+      @context_class.class_exec(target, &block)
+    end
+
     def _prefix
       @_prefix || '*'
     end
@@ -1234,6 +1241,13 @@ END
     @_in_scope = false
   end
 
+  def self.topic(target, &block)
+    #; [!c5j3f] same as `Oktest.scope do topic target do ... end end`.
+    self.scope do
+      topic(target, &block)
+    end
+  end
+
 
   module SpecHelper
 
@@ -2168,9 +2182,6 @@ END
   end
 
 
-  REPORTER_CLASS = VerboseReporter
-
-
   REPORTER_CLASSES = {
     'verbose' => VerboseReporter,  'v' => VerboseReporter,
     'simple'  => SimpleReporter,   's' => SimpleReporter,
@@ -2179,10 +2190,22 @@ END
     'quiet'   => QuietReporter,    'q' => QuietReporter,
   }
 
+  DEFAULT_REPORTING_STYLE = 'verbose'
+
+  def self.DEFAULT_REPORTING_STYLE=(style)
+    #; [!lbufd] raises error if unknown style specified.
+    REPORTER_CLASSES.key?(style)  or
+      raise ArgumentError, "#{style}: Unknown reporting style."
+    #; [!dsbmo] changes value of default reporting style.
+    remove_const :DEFAULT_REPORTING_STYLE
+    const_set    :DEFAULT_REPORTING_STYLE, style
+  end
+
 
   def self.run(reporter: nil, style: nil)
     #; [!6xn3t] creates reporter object according to 'style:' keyword arg.
-    klass = (style ? REPORTER_CLASSES[style] : REPORTER_CLASS)  or
+    style ||= DEFAULT_REPORTING_STYLE
+    klass = REPORTER_CLASSES[style]  or
       raise ArgumentError, "#{style.inspect}: unknown style."
     reporter ||= klass.new
     #; [!mn451] run test cases.
@@ -2490,12 +2513,12 @@ END
     public
 
     def filter_children!(node)
-      _filter_children!(node)
+      _filter_children!(node, 0)
     end
 
     private
 
-    def _filter_children!(node)   #:nodoc:
+    def _filter_children!(node, _depth)   #:nodoc:
       #; [!r6g6a] supports negative filter by topic.
       #; [!doozg] supports negative filter by spec.
       #; [!ntv44] supports negative filter by tag name.
@@ -2516,7 +2539,7 @@ END
           removes << i unless positive
         #; [!mz6id] can filter nested topics.
         elsif item.is_a?(Node)
-          removes << i unless _filter_children!(item)
+          removes << i unless _filter_children!(item, _depth+1)
         #; [!1jphf] can filter specs from nested topics.
         elsif item.is_a?(SpecLeaf)
           removes << i if positive

data/oktest.gemspec

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 1.4.0 $
+### $Release: 1.5.0 $
 ### $License: MIT License $
 ### $Copyright: copyright(c) 2011-2024 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.4.0 $".split()[1]
+  s.version     = "$Release: 1.5.0 $".split()[1]
   s.license     = "MIT"
   s.platform    = Gem::Platform::RUBY
   s.homepage    = "https://github.com/kwatch/oktest/tree/ruby/ruby"
@@ -41,5 +41,5 @@ END
   s.files       = files
   s.executables = ['oktest']
   s.bindir      = 'bin'
-  s.test_file   = 'test/run_all.rb'
+  s.test_file   = 'test/all.rb'
 end