smartest 0.6.2.alpha1 → 0.6.2.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb327b86d510c4cf4e8ebdf31fcd7be3fe1b78c9109528ac99af08c3af1f9e4
-  data.tar.gz: 7937fde33ac1e62adb5f4bc39b54b938138af915008fcc350742f66420df5848
+  metadata.gz: 1443bebc805a4e69172dfca1294ad15f8cf79d7285c6496c63002280dddbf79e
+  data.tar.gz: 1b6277394636d37045d71dbaa566f820411d21b0fed517e257981278f4ad9f4d
 SHA512:
-  metadata.gz: 8b011cea66dfec275fe790c0ced127819c23a18e70878bb9f4519d0e87b05e47c06b2b7bbc5de771ff3782cbb032409cb57be50ca2a2211fe79150a15a46b224
-  data.tar.gz: a77eb822acc8bb07f4f3b38a5f09bf3ca573fabb4542bc03b2e49120b110aad749042fe8004e38c733b0f4629f77673c371011382d7ab2d5e0881364c7a48595
+  metadata.gz: 9b65c8950634a64d22072ed9ee926a45e1cd5250735f946b7f8a8d554ffad93bca933ca6ea692225c1c9521fffb01aa9163ff175c5391f444ab172cb0bfc5dc9
+  data.tar.gz: 5a3d0758ad87ccfb17c54234fb0b21c97b86a33dc87b7e1492660d9b97bb22ad2bf53a8b51890264c0bb0dacb3e0d2dbbeebfbd3817c06ae6e42054386afb4cc

data/README.md

@@ -331,9 +331,11 @@ end
 
 This makes fixture usage explicit and avoids relying on positional argument order.
 
-Smartest also ships RBS signatures for the public DSL, including `test`,
+Smartest also ships RBS signatures for the public DSL, including
 `around_suite`, `around_test`, `fixture`, `suite_fixture`, `on_teardown`,
-`expect`, and hook registration methods such as `use_fixture`.
+`expect`, and hook registration methods such as `use_fixture`. The `test`
+method is intentionally not defined in RBS because it conflicts with Ruby's
+built-in `Kernel#test` file-test helper in some editors.
 
 ## Skipping and pending tests
 

data/lib/smartest/dsl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Smartest
+  # Top-level Smartest test definition DSL.
   module DSL
     def test(name, **metadata, &block)
       location = caller_locations(1, 1).first
@@ -16,12 +17,27 @@ module Smartest
       )
     end
 
+    # Register a hook that wraps the whole suite.
+    #
+    # The block receives a `Smartest::SuiteRun` object and must call
+    # `suite.run` exactly once.
+    #
+    # @yieldparam suite [Smartest::SuiteRun] suite run target
+    # @return [void]
     def around_suite(&block)
       raise ArgumentError, "around_suite block is required" unless block
 
       Smartest.suite.around_suite_hooks << block
     end
 
+    # Register a hook that wraps tests declared after this hook in the same file.
+    #
+    # The block receives a `Smartest::TestRun` object and must call `test.run`
+    # exactly once. The hook wraps fixture setup, the test body, and fixture
+    # teardown.
+    #
+    # @yieldparam test [Smartest::TestRun] test run target
+    # @return [void]
     def around_test(&block)
       raise ArgumentError, "around_test block is required" unless block
 
@@ -31,3 +47,24 @@ module Smartest
     private :test, :around_suite, :around_test
   end
 end
+
+module Kernel
+  # @!method around_suite(&block)
+  #   Register a hook that wraps the whole suite.
+  #
+  #   The block receives a `Smartest::SuiteRun` object and must call
+  #   `suite.run` exactly once.
+  #
+  #   @yieldparam suite [Smartest::SuiteRun] suite run target
+  #   @return [void]
+  #
+  # @!method around_test(&block)
+  #   Register a hook that wraps tests declared after this hook in the same file.
+  #
+  #   The block receives a `Smartest::TestRun` object and must call `test.run`
+  #   exactly once. The hook wraps fixture setup, the test body, and fixture
+  #   teardown.
+  #
+  #   @yieldparam test [Smartest::TestRun] test run target
+  #   @return [void]
+end

data/lib/smartest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Smartest
-  VERSION = "0.6.2.alpha1"
+  VERSION = "0.6.2.alpha3"
 end

data/sig/smartest.rbs

@@ -14,10 +14,6 @@ module Smartest
   module DSL
     private
 
-    # Define a named test. Fixture values are requested from the block with
-    # required keyword arguments, for example `do |page:|`.
-    def test: (String | Symbol, **untyped) { (*untyped, **untyped) -> untyped } -> void
-
     # Wrap the whole suite. The block receives a run target and must call
     # `suite.run` exactly once.
     def around_suite: () { (SuiteRun) -> untyped } -> void
@@ -149,10 +145,6 @@ end
 module Kernel
   private
 
-  # Define a named Smartest test. Fixture values are requested with keyword
-  # block parameters, for example `test("opens page") do |page:|`.
-  def test: (String | Symbol, **untyped) { (*untyped, **untyped) -> untyped } -> void
-
   # Register a suite hook. The block receives a run target and must call
   # `suite.run` exactly once.
   def around_suite: () { (Smartest::SuiteRun) -> untyped } -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartest
 version: !ruby/object:Gem::Version
-  version: 0.6.2.alpha1
+  version: 0.6.2.alpha3
 platform: ruby
 authors:
 - Yusuke Iwaki