smartest 0.3.3.alpha3 → 0.3.3.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46365bf842594d74023e6c47da5b98f28e2f8ad765a035de09a54f5d127db2ee
-  data.tar.gz: 53134bcd0052d5cd8b495b36a9ba8bb1344c6dcb0626d0547dfa49bf6eff005e
+  metadata.gz: 75e3f0538afd3f490c37121ae4eee497a4691f35926ff50201e035acb64d2314
+  data.tar.gz: 53fea3bdbbb788167d13c6a7b6c18a9258de42b971c4f2a1f36906176f75813a
 SHA512:
-  metadata.gz: a5ffe755697e79babe4e54e52d9a2e2a13aee1ade7306dfa7adffd7d9ea6ca75b7b96825b05c713261f420f35b28e980a85b068a94823109bffc0a54774d864a
-  data.tar.gz: c030cd6bfcfb44f8273348f99a36a6213c237c9bd580cd49287351b4bf9b70a04af3b6b7889287f12ffbda747dfd7d6a450b9954bf51f8c2bdf5fb71768027ba
+  metadata.gz: ba646897bc5994e7caf30fc9b1127a1ad72f2545a4ed8734820c5eeeca3e5e1e7e0302394b38916fbc9d9c153dccfdae96496093dce1f23af172fa74a01cbd75
+  data.tar.gz: 5c12f0c3532da8eb44c3e832d28e479b1f8a54f5797a4c67c61c865bbbedf31e2225fe441c1f433d8de6ce3b2246c374de998d2aae9b2cfa8a7ea63f043ed949

data/DEVELOPMENT.md

@@ -46,6 +46,7 @@ smartest/
       expectation_target.rb
       matchers.rb
       simple_stub.rb
+      constant_stub_helpers.rb
 
       runner.rb
       test_result.rb

data/README.md

@@ -637,16 +637,16 @@ end
 ```
 
 Use `simple_stub(Time, :now) { fixed_time }` for singleton methods such as class
-methods. Use `simple_stub_const("AppConfig::PAYMENT_PROVIDER", "fake")` for
-constants. Constant stubs are process-global; avoid concurrent tests that stub
-the same constant.
+methods.
+
+Use `simple_stub_const("AppConfig::PAYMENT_PROVIDER", "fake") { ... }` for
+constants in test bodies, `around_test`, or `around_suite`. Constant stubs are
+process-global; avoid concurrent tests that stub the same constant.
 
 The method stub helpers call `Smartest::SimpleStub` internally, apply the stub,
 register `cleanup { stub.reset }`, and return the stub object.
-`simple_stub_const` records the previous constant value, replaces it, and
-restores or removes it during cleanup. These helpers are available inside
-`Smartest::Fixture` fixture blocks because they need cleanup to tie the stub
-lifetime to the fixture scope.
+`simple_stub_const` records the previous constant value, replaces it, yields to
+the block, and restores or removes the constant with `ensure`.
 
 `Smartest::SimpleStub#apply` and `#reset` are idempotent in the current Fiber.
 `apply!` raises
@@ -880,7 +880,7 @@ Smartest currently focuses on a small runner API:
 - fixture dependencies through keyword arguments
 - fixture cleanup
 - suite-scoped fixtures through `suite_fixture`
-- fixture-scoped method and constant stubs
+- fixture-scoped method stubs and block-scoped constant stubs
 - suite hooks with `around_suite`
 - test hooks with `around_test`
 - skipped and pending tests through `skip` and `pending`

data/lib/smartest/constant_stub_helpers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Smartest
+  module ConstantStubHelpers
+    private
+
+    def simple_stub_const(constant_path, value)
+      raise ArgumentError, "simple_stub_const block is required" unless block_given?
+
+      owner, constant_name = resolve_simple_stub_constant(constant_path)
+      original_defined = owner.const_defined?(constant_name, false)
+      original_value = owner.const_get(constant_name, false) if original_defined
+
+      owner.__send__(:remove_const, constant_name) if original_defined
+      owner.const_set(constant_name, value)
+
+      yield
+    ensure
+      if owner && constant_name
+        owner.__send__(:remove_const, constant_name) if owner.const_defined?(constant_name, false)
+        owner.const_set(constant_name, original_value) if original_defined
+      end
+    end
+
+    def resolve_simple_stub_constant(constant_path)
+      unless constant_path.is_a?(String) || constant_path.is_a?(Symbol)
+        raise ArgumentError, "constant path must be a String or Symbol"
+      end
+
+      names = constant_path.to_s.split("::")
+      names.shift if names.first == ""
+      raise ArgumentError, "constant path must not be empty" if names.empty?
+
+      names.each do |name|
+        raise ArgumentError, "invalid constant path: #{constant_path}" unless name.match?(/\A[A-Z]\w*\z/)
+      end
+
+      constant_name = names.pop.to_sym
+      owner = names.reduce(Object) { |namespace, name| namespace.const_get(name, false) }
+      raise ArgumentError, "constant owner must be a Module or Class" unless owner.is_a?(Module)
+
+      [owner, constant_name]
+    end
+  end
+end

data/lib/smartest/execution_context.rb

@@ -4,6 +4,7 @@ module Smartest
   class ExecutionContext
     include Expectations
     include Matchers
+    include ConstantStubHelpers
 
     def initialize(run_state: TestRunState.new)
       @run_state = run_state

data/lib/smartest/fixture.rb

@@ -2,7 +2,7 @@
 
 module Smartest
   class Fixture
-    RESERVED_CONTEXT_METHODS = %i[skip pending].freeze
+    RESERVED_CONTEXT_METHODS = %i[skip pending simple_stub_const].freeze
 
     class << self
       def fixture(name, scope: :test, &block)
@@ -73,48 +73,12 @@ module Smartest
       apply_simple_stub(SimpleStub.new(object.singleton_class, method_name, &block))
     end
 
-    def simple_stub_const(constant_path, value)
-      owner, constant_name = resolve_simple_stub_constant(constant_path)
-      original_defined = owner.const_defined?(constant_name, false)
-      original_value = owner.const_get(constant_name, false) if original_defined
-
-      owner.__send__(:remove_const, constant_name) if original_defined
-      owner.const_set(constant_name, value)
-
-      cleanup do
-        owner.__send__(:remove_const, constant_name) if owner.const_defined?(constant_name, false)
-        owner.const_set(constant_name, original_value) if original_defined
-      end
-
-      value
-    end
-
     def apply_simple_stub(stub)
       stub.apply!
       cleanup { stub.reset }
       stub
     end
 
-    def resolve_simple_stub_constant(constant_path)
-      unless constant_path.is_a?(String) || constant_path.is_a?(Symbol)
-        raise ArgumentError, "constant path must be a String or Symbol"
-      end
-
-      names = constant_path.to_s.split("::")
-      names.shift if names.first == ""
-      raise ArgumentError, "constant path must not be empty" if names.empty?
-
-      names.each do |name|
-        raise ArgumentError, "invalid constant path: #{constant_path}" unless name.match?(/\A[A-Z]\w*\z/)
-      end
-
-      constant_name = names.pop.to_sym
-      owner = names.reduce(Object) { |namespace, name| namespace.const_get(name, false) }
-      raise ArgumentError, "constant owner must be a Module or Class" unless owner.is_a?(Module)
-
-      [owner, constant_name]
-    end
-
     def method_missing(method_name, *args, &block)
       return super if RESERVED_CONTEXT_METHODS.include?(method_name)
 

data/lib/smartest/hook_contexts.rb

@@ -2,6 +2,8 @@
 
 module Smartest
   class AroundSuiteContext
+    include ConstantStubHelpers
+
     def initialize(suite)
       @suite = suite
     end
@@ -30,6 +32,8 @@ module Smartest
   end
 
   class AroundTestContext
+    include ConstantStubHelpers
+
     def initialize(test_run, run_state:)
       @test_run = test_run
       @run_state = run_state

data/lib/smartest/version.rb

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

data/lib/smartest.rb

@@ -3,6 +3,7 @@
 require_relative "smartest/version"
 require_relative "smartest/errors"
 require_relative "smartest/simple_stub"
+require_relative "smartest/constant_stub_helpers"
 require_relative "smartest/parameter_extractor"
 require_relative "smartest/test_case"
 require_relative "smartest/test_registry"

data/smartest/simple_stub_test.rb

@@ -158,64 +158,101 @@ test("simple_stub applies and resets singleton methods from fixture cleanup") do
   expect(status).to eq(0)
 end
 
-test("simple_stub_const applies and resets existing constants from fixture cleanup") do
-  fixture_class = Class.new(Smartest::Fixture) do
-    fixture :stubbed_provider do
-      simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :stubbed_provider)
+test("simple_stub_const applies and resets existing constants in test body blocks") do
+  result = simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :stubbed_provider) do
+    expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:stubbed_provider)
+    :block_result
+  end
+
+  expect(result).to eq(:block_result)
+  expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:original_provider)
+end
+
+test("simple_stub_const removes newly defined constants after test body blocks") do
+  simple_stub_const("SimpleStubSelfTestConfig::MISSING_PROVIDER", :stubbed_missing_provider) do
+    expect(SimpleStubSelfTestConfig::MISSING_PROVIDER).to eq(:stubbed_missing_provider)
+  end
+
+  expect(SimpleStubSelfTestConfig.const_defined?(:MISSING_PROVIDER, false)).to eq(false)
+end
+
+test("simple_stub_const restores constants when the block raises") do
+  error = SimpleStubSelfTest.capture_error(RuntimeError) do
+    simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :stubbed_provider) do
+      expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:stubbed_provider)
+      raise "stubbed block failed"
     end
   end
 
+  expect(error.message).to eq("stubbed block failed")
+  expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:original_provider)
+end
+
+test("simple_stub_const requires a block") do
+  error = SimpleStubSelfTest.capture_error(ArgumentError) do
+    simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :stubbed_provider)
+  end
+
+  expect(error.message).to eq("simple_stub_const block is required")
+end
+
+test("simple_stub_const wraps around_test hooks") do
   suite = Smartest::Suite.new
-  suite.fixture_classes.add(fixture_class)
+  suite.around_test_hooks << proc do |test_run|
+    simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :around_test_provider) do
+      test_run.run
+    end
+  end
   suite.tests.add(
     SimpleStubSelfTest.test_case(
-      "uses constant stub fixture",
-      proc do |stubbed_provider:|
-        expect(stubbed_provider).to eq(:stubbed_provider)
-        expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:stubbed_provider)
-      end
+      "uses around_test constant stub",
+      proc { expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:around_test_provider) }
     )
   )
+
+  status, = SimpleStubSelfTest.run_suite(suite)
+
+  expect(status).to eq(0)
+  expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:original_provider)
+end
+
+test("simple_stub_const wraps around_suite hooks") do
+  suite = Smartest::Suite.new
+  suite.around_suite_hooks << proc do |suite_run|
+    simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :around_suite_provider) do
+      suite_run.run
+    end
+  end
   suite.tests.add(
     SimpleStubSelfTest.test_case(
-      "sees restored constant",
-      proc { expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:original_provider) }
+      "uses around_suite constant stub",
+      proc { expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:around_suite_provider) }
     )
   )
 
   status, = SimpleStubSelfTest.run_suite(suite)
 
   expect(status).to eq(0)
+  expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:original_provider)
 end
 
-test("simple_stub_const removes newly defined constants from fixture cleanup") do
+test("simple_stub_const is not available inside fixture blocks") do
   fixture_class = Class.new(Smartest::Fixture) do
-    fixture :stubbed_missing_provider do
-      simple_stub_const("SimpleStubSelfTestConfig::MISSING_PROVIDER", :stubbed_missing_provider)
+    fixture :bad_constant_stub do
+      simple_stub_const("SimpleStubSelfTestConfig::PROVIDER", :fixture_provider) { :fixture_provider }
     end
   end
 
   suite = Smartest::Suite.new
   suite.fixture_classes.add(fixture_class)
-  suite.tests.add(
-    SimpleStubSelfTest.test_case(
-      "uses new constant stub fixture",
-      proc do |stubbed_missing_provider:|
-        expect(stubbed_missing_provider).to eq(:stubbed_missing_provider)
-        expect(SimpleStubSelfTestConfig::MISSING_PROVIDER).to eq(:stubbed_missing_provider)
-      end
-    )
-  )
-  suite.tests.add(
-    SimpleStubSelfTest.test_case(
-      "sees removed constant",
-      proc { expect(SimpleStubSelfTestConfig.const_defined?(:MISSING_PROVIDER, false)).to eq(false) }
-    )
-  )
+  suite.tests.add(SimpleStubSelfTest.test_case("uses bad fixture", proc { |bad_constant_stub:| bad_constant_stub }))
 
-  status, = SimpleStubSelfTest.run_suite(suite)
+  status, output = SimpleStubSelfTest.run_suite(suite)
 
-  expect(status).to eq(0)
+  expect(status).to eq(1)
+  expect(output).to include("NoMethodError")
+  expect(output).to include("simple_stub_const")
+  expect(SimpleStubSelfTestConfig::PROVIDER).to eq(:original_provider)
 end
 
 test("simple stub preserves receiver self and method blocks") do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartest
 version: !ruby/object:Gem::Version
-  version: 0.3.3.alpha3
+  version: 0.3.3.alpha4
 platform: ruby
 authors:
 - Yusuke Iwaki
@@ -44,6 +44,7 @@ files:
 - lib/smartest.rb
 - lib/smartest/autorun.rb
 - lib/smartest/cli_arguments.rb
+- lib/smartest/constant_stub_helpers.rb
 - lib/smartest/dsl.rb
 - lib/smartest/errors.rb
 - lib/smartest/execution_context.rb