bridgetown-foundation 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1478f1ce19153ecd82462705924320ec0af273470daa8db76878a69d5df8ef79
-  data.tar.gz: d9e027cedf68e3be388cd2c0dca6f8eb911d2169b6630bac8db2372650f42e78
+  metadata.gz: 7bac229d28262dd95ff12ab4ae435921d01b135a97e451901671f1b34d30a373
+  data.tar.gz: 6d65ba98e9d6407ea0e78af33f5de51ecc1b53d55d72425f300abf46e5142aca
 SHA512:
-  metadata.gz: eb8ef2c9e5aa68647fcd034539f250be7eaa2ad116f864b7f1e407a0abc6bfa5b7e2d15e25812b95280b6acb9f899d01b64b97a9690dadf62f1a5884e3468e59
-  data.tar.gz: b18d156f3d6d9f7dfa4e380ba4c42beb1492aed9a98866c18ac6d9d753cc94dea2a080cfd24f0054f7a97a83a2d89941dc9ffca5690cf5bb642dd61646abb772
+  metadata.gz: f13037d4cf6c30e40ed40f7ba3cf4c590d7b5771065c5b7759566f0f6faa2c24a1d5e97e2c680afd5912d6c2aa2ec90ce708edf6e8b64cebbda48f8d18abe157
+  data.tar.gz: 30c9dffa6f4ef76ba7e57b88f8150d79b696be9fe54f54aeedb08f36ccef3f3cb33b1d07686b7de249ac05061629468b5da8535f58c40be9fc9d7c1258e23530

data/.rubocop.yml

@@ -5,3 +5,7 @@ AllCops:
   Exclude:
     - "*.gemspec"
     - "script/console"
+
+Lint/Void:
+  Exclude:
+    - test/**/*.rb

data/lib/bridgetown/foundation/intuitive_expectations.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require "bridgetown/foundation/refine_ext/object"
+
+module Bridgetown::Foundation
+  # This module provides a set of Ruby syntax-inspired mechanism for writing expectations
+  # which wrap the native statements within `Minitest::Expectation`.
+  #
+  # Generally the methods here return self, so you can chain multiple expectations together
+  # for a single object.
+  module IntuitiveExpectations
+    using Bridgetown::Foundation::RefineExt::Object
+
+    # Use this in your main test helper to enrich `Minitest::Expectation`, or something akin to it
+    #
+    # @param [Module(Minitest)]
+    def self.enrich(mod)
+      mod::Expectation.include self
+      filter_exp = %r!bridgetown/foundation/intuitive_expectations\.rb!
+      if mod.backtrace_filter.respond_to?(:add_filter)
+        mod.backtrace_filter.add_filter filter_exp
+      else
+        mod.backtrace_filter = mod::BacktraceFilter.new(%r!#{mod::BacktraceFilter::MT_RE}|#{filter_exp}!)
+      end
+    end
+
+    # Expect the object to be a truthy value
+    # @return [Minitest::Expectation]
+    def truthy?(msg = nil)
+      ctx.assert target, msg
+      self
+    end
+    alias_method :true?, :truthy?
+
+    # Expect the object to be a falsy value
+    # @return [Minitest::Expectation]
+    def falsy?(msg = nil)
+      ctx.refute target, msg
+      self
+    end
+    alias_method :falsey?, :falsy?
+    alias_method :false?, :falsy?
+
+    # Expect the object to return a truthy value from a predicate, e.g.
+    # `expect(new_user).is? :new?`
+    # @return [Minitest::Expectation]
+    def is?(sym, msg = nil)
+      must_be(sym, Minitest::Assertions::UNDEFINED, msg)
+      self
+    end
+
+    # Expect the object to return a falsy value from a predicate, e.g.
+    # `expect(saved_user).isnt? :new?`
+    # @return [Minitest::Expectation]
+    def isnt?(sym, msg = nil)
+      wont_be(sym, Minitest::Assertions::UNDEFINED, msg)
+      self
+    end
+
+    # Expect the object to equal a value
+    # @return [Minitest::Expectation]
+    def equal?(other, msg = nil)
+      must_equal(other, msg)
+      self
+    end
+    alias_method :==, :equal?
+
+    # Expect the object not to equal a value
+    # @return [Minitest::Expectation]
+    def not_equal?(other, msg = nil)
+      wont_equal(other, msg)
+      self
+    end
+    alias_method :!=, :not_equal?
+
+    # Expect the object to be within another value (as defined by the `within?`
+    # object refinement)
+    # @return [Minitest::Expectation]
+    def within?(other, msg = nil)
+      msg = ctx.message(msg) { "Expected #{ctx.mu_pp target} to be within #{ctx.mu_pp other}" }
+      ctx.assert target.within?(other), msg
+      self
+    end
+
+    # Expect the object not to be within another value (as defined by the `within?`
+    # object refinement)
+    # @return [Minitest::Expectation]
+    def not_within?(other, msg = nil)
+      msg = ctx.message(msg) { "Expected #{ctx.mu_pp target} to not be within #{ctx.mu_pp other}" }
+      ctx.refute target.within?(other), msg
+      self
+    end
+
+    # Expect the object to be nil
+    # @return [Minitest::Expectation]
+    def nil?(msg = nil)
+      must_be_nil(msg)
+      self
+    end
+
+    # Expect the object not to be nil
+    # @return [Minitest::Expectation]
+    def not_nil?(msg = nil)
+      wont_be_nil(msg)
+      self
+    end
+
+    # Expect the object (like a string, array, etc.) to be empty
+    # @return [Minitest::Expectation]
+    def empty?(msg = nil)
+      must_be_empty(msg)
+      self
+    end
+
+    # Expect the object (like a string, array, etc.) not to be empty
+    # @return [Minitest::Expectation]
+    def not_empty?(msg = nil)
+      wont_be_empty(msg)
+      self
+    end
+    alias_method :filled?, :not_empty?
+
+    # Expect the object (like a string, array, etc.) to include another value
+    # @return [Minitest::Expectation]
+    def include?(other, msg = nil)
+      must_include(other, msg)
+      self
+    end
+    alias_method :<<, :include?
+
+    # Expect the object (like a string, array, etc.) not to include another value
+    # @return [Minitest::Expectation]
+    def exclude?(other, msg = nil)
+      wont_include(other, msg)
+      self
+    end
+    alias_method :not_include?, :exclude?
+
+    # Expect the object to match a regular expression
+    # @return [Minitest::Expectation]
+    def match?(other, msg = nil)
+      must_match(other, msg)
+      self
+    end
+    alias_method :=~, :match?
+
+    # Expect the object not to match a regular expression
+    # @return [Minitest::Expectation]
+    def not_match?(other, msg = nil)
+      wont_match(other, msg)
+      self
+    end
+
+    # Expect the object to be an instance of a class (or a subclass)
+    # @return [Minitest::Expectation]
+    def is_a?(klass, msg = nil)
+      must_be_kind_of(klass, msg)
+      self
+    end
+    alias_method :kind_of?, :is_a?
+
+    # Expect the object not to be an instance of a class (or a subclass)
+    # @return [Minitest::Expectation]
+    def not_a?(klass, msg = nil)
+      wont_be_kind_of(klass, msg)
+      self
+    end
+    alias_method :isnt_a?, :not_a?
+    alias_method :is_not_a?, :not_a?
+    alias_method :not_kind_of?, :not_a?
+
+    # Expect the block not to raise the exception
+    # @return [Minitest::Expectation]
+    def raise?(exception, msg = nil)
+      Warning.warn "Calling `#{__callee__}` for the same block re-executes the block" if @block_ran
+      @block_ran ||= true
+      # we need this ternary operator because `must_raise` takes a variable number of arguments
+      msg ? must_raise(exception, msg) : must_raise(exception)
+      self
+    end
+
+    # Expect the block to send output to stdout and/or stderr
+    # @param stdout [String, Regexp]
+    # @param stderr [String, Regexp]
+    # @return [Minitest::Expectation]
+    def output?(stdout = nil, stderr = nil)
+      Warning.warn "Calling `#{__callee__}` for the same block re-executes the block" if @block_ran
+      @block_ran ||= true
+      must_output stdout, stderr
+      self
+    end
+
+    # Expect the block not to send output to stdout and stderr
+    # @return [Minitest::Expectation]
+    def not_output?
+      Warning.warn "Calling `#{__callee__}` for the same block re-executes the block" if @block_ran
+      @block_ran ||= true
+      must_be_silent
+      self
+    end
+    alias_method :silent?, :not_output?
+  end
+end

data/lib/bridgetown/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
   CODE_NAME = "River City"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-foundation
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-18 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_with_dot_access
@@ -65,6 +65,7 @@ files:
 - lib/bridgetown-foundation.rb
 - lib/bridgetown/foundation/core_ext/class.rb
 - lib/bridgetown/foundation/core_ext/string.rb
+- lib/bridgetown/foundation/intuitive_expectations.rb
 - lib/bridgetown/foundation/packages/ansi.rb
 - lib/bridgetown/foundation/packages/pid_tracker.rb
 - lib/bridgetown/foundation/packages/safe_translations.rb