smartest 0.6.2.alpha1 → 0.6.2.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb327b86d510c4cf4e8ebdf31fcd7be3fe1b78c9109528ac99af08c3af1f9e4
-  data.tar.gz: 7937fde33ac1e62adb5f4bc39b54b938138af915008fcc350742f66420df5848
+  metadata.gz: f0718af27aa3da16e50c8172fab0145ec41de84435c1f662af9f404ad81d2ed1
+  data.tar.gz: 861107ab2de4d07fa3b47c5a09ab39648b253567f17557ddb036c1bca1df7fc1
 SHA512:
-  metadata.gz: 8b011cea66dfec275fe790c0ced127819c23a18e70878bb9f4519d0e87b05e47c06b2b7bbc5de771ff3782cbb032409cb57be50ca2a2211fe79150a15a46b224
-  data.tar.gz: a77eb822acc8bb07f4f3b38a5f09bf3ca573fabb4542bc03b2e49120b110aad749042fe8004e38c733b0f4629f77673c371011382d7ab2d5e0881364c7a48595
+  metadata.gz: 6b8e1a64faff9721e48a787841bff898c3b2a52fccc70808b4f298b22ecfe2473ae0d43a066c19267cecd8e640e8266ae81aa79a1097e72f070ab0aec2b0bde3
+  data.tar.gz: 3d3330b9b3087ae3c8d32775a4bfd0b082f1f0f42954bac03a00ab44b54930d999a4b787fcd768ce507dcea708d6f42878cee805165bb7026f28b19ed18dcba6

data/README.md

@@ -333,7 +333,10 @@ This makes fixture usage explicit and avoids relying on positional argument orde
 
 Smartest also ships RBS signatures for the public DSL, including `test`,
 `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 signatures
+model `Smartest::DSL` as prepended into `Kernel`, matching how
+`smartest/autorun` installs the top-level DSL over Ruby's built-in
+`Kernel#test` file-test helper.
 
 ## Skipping and pending tests
 

data/lib/smartest/dsl.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
 module Smartest
+  # Top-level Smartest test definition DSL.
+  #
+  # Smartest installs this module into Kernel when `smartest/autorun` is
+  # required. The module intentionally overrides Ruby's built-in `Kernel#test`
+  # file-test helper while Smartest tests are being loaded.
   module DSL
+    # Define a named Smartest test.
+    #
+    # Test fixtures are requested with required keyword block parameters:
+    #
+    #   test("opens the home page") do |page:|
+    #     page.goto("/")
+    #   end
+    #
+    # @param name [String, Symbol] human-readable test name
+    # @param metadata [Hash] optional metadata kept with the test case
+    # @yield test body; required keyword parameters request fixtures
+    # @return [void]
     def test(name, **metadata, &block)
       location = caller_locations(1, 1).first
 
@@ -16,12 +33,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 +63,42 @@ module Smartest
     private :test, :around_suite, :around_test
   end
 end
+
+module Kernel
+  # @!method test(name, **metadata, &block)
+  #   Define a named Smartest test.
+  #
+  #   Fixture values are requested with required keyword block parameters:
+  #
+  #     test("opens the home page") do |page:|
+  #       page.goto("/")
+  #     end
+  #
+  #   Smartest installs this method by prepending `Smartest::DSL` into Kernel,
+  #   so it overrides Ruby's built-in `Kernel#test` file-test helper while
+  #   Smartest tests are being loaded.
+  #
+  #   @param name [String, Symbol] human-readable test name
+  #   @param metadata [Hash] optional metadata kept with the test case
+  #   @yield test body; required keyword parameters request fixtures
+  #   @return [void]
+  #
+  # @!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.alpha2"
 end

data/sig/smartest.rbs

@@ -147,17 +147,5 @@ module Smartest
 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
-
-  # Register a test hook for tests declared after this hook in the same file.
-  # The block receives a run target and must call `test.run` exactly once.
-  def around_test: () { (Smartest::TestRun) -> untyped } -> void
+  prepend Smartest::DSL
 end

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.alpha2
 platform: ruby
 authors:
 - Yusuke Iwaki