sleeping_king_studios-tools 1.3.0 → 1.4.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db132e865ddd63a80d234f0d134be3d908e2003425f643fe387db2ba2c1069eb
-  data.tar.gz: 2c577e47d0c1a1b6a7a954b573051ad4826a966a3d02ea3ceba2cd174deea904
+  metadata.gz: d1f7af7edc3cd3e319188aa4f03eaa99bc5819d916401a1d005dd7c77a543dbe
+  data.tar.gz: 27145205ab33397a8836491c290d7c1fdfc40f3bbccc513299ce5b340c634881
 SHA512:
-  metadata.gz: 36068c304414d42aa1f592602f5a34944fd17e93c75502ce22871ac64168fc28b05e92c896c2b19d72602538ec401b9f0bd6dfe3d58c192c37bd015d4ba92c4a
-  data.tar.gz: 534ae4c0a5da550af2e80d6de8c7ec9aa7d9cc1f09e5c6a655f581540ebbf68b8e81388880b56af6061543575673494590cfc99e941a0d8ddfe26fe0eafba713
+  metadata.gz: 3d0cae267831f06774aaeff7a3de65ea36f7ed04bc2a6f7b6275cbc0a710d3ff9333dd34d5578b50f937a0f7b01a7fdc643e3fa93255eed34dfb85f127dd7a53
+  data.tar.gz: 4b8280a92271a1f8117da678847c78b47c873fb61037289d6a599e96fc17aa038d060ae830ebeb4661ef3f55b46bb5c845a684ef6cef080ed598164aba05a231

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## 1.4.0
+
+### Heritable Data
+
+Refactored `HeritableData` internals.
+
+- Nested `HeritableData` classes now inherit properly, defining a correct chain of `ancestors`.
+- Some approaches to defining a heritable Data class are now deprecated and will print a warning:
+  - Defining class methods or including modules indirectly using the `included` lifecycle hook. Define class methods and include modules directly in the block. Starting on version 2.0, the `included` hook **will not be called**.
+  - Calling `HeritableData.define` (or `.define` on a generated subclass) with a `lambda` that does not accept any parameters. Starting on version 2.0, this will raise an `ArgumentError`.
+
+> Special thanks to `@havenwood` from the Ruby Discord on the solution here.
+
+> **Note:** This change will cause a regression in the specific case where code expects the **parent class** of the generated `HeritableData` class to be `Data`. This is no longer true for nested Data subclasses.
+
+### Tools
+
+#### Assertions
+
+Implemented predicate methods:
+
+- `#blank?(value)` checks if the value is `nil` or `#empty?`.
+- `#boolean?(value)` checks if the value is `true` or `false`.
+- `#name?(value)` checks if the value is a non-empty `String` or `Symbol`.
+- `#present?(value)` checks if the value is not `nil` and not `#empty?`.
+
+#### Messages
+
+Updated `Messages::Strategy`:
+
+- Implemented `Messages::Strategy#get`, `#fetch` methods to query raw message templates.
+- Added `:default` keyword to `Messages::Strategy#call`.
+- Added `:reraise_exceptions` option to `Messages::Strategy#call`.
+- Added internal support for `false` values when resolving templates.
+
+Updated `Messages::HashStrategy`, `FileStrategy`:
+
+- Added `:flatten_templates` keyword to `HashStrategy#initialize`: set to `false` to allow querying for `Hash` values using the `#get` or `#fetch` methods.
+- Added `:validate_values` keyword to `HashStrategy#initialize`: set to `false` to disable validation, or pass a `Proc` to customize the validation (a value will fail the validation if the Proc returns an error message when called with the value).
+
 ## 1.3.0
 
 ### Tools

data/README.md

@@ -15,8 +15,6 @@ SleepingKingStudios::Tools is tested against MRI Ruby 3.2 through 4.0.
 
 ### Documentation
 
-Method and class documentation is available courtesy of RubyDoc.
-
 Documentation is generated using [YARD](https://yardoc.org/), and can be generated locally using the `yard` gem.
 
 ### License

data/lib/sleeping_king_studios/tools/assertions/messages_strategy.rb

@@ -8,7 +8,7 @@ module SleepingKingStudios::Tools
   # Defines its own internal message templates, and automatically handles value
   # name option (:as option) when generating messages.
   class Assertions::MessagesStrategy < SleepingKingStudios::Tools::Messages::Strategies::HashStrategy
-    # rubocop:disable Layout/HashAlignment
+    # Message fragments used to generate error messages for failed assertions.
     ERROR_MESSAGES =
       {
         'blank' =>
@@ -51,7 +51,6 @@ module SleepingKingStudios::Tools
         'presence' =>
           "can't be blank"
       }.freeze
-    # rubocop:enable Layout/HashAlignment
 
     def initialize
       templates =

data/lib/sleeping_king_studios/tools/assertions.rb

@@ -31,10 +31,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the block does not return a truthy value.
     #
     # @example
-    #   Assertions.assert { true == false }
+    #   assertions.assert { true == false }
     #   #=> raises an AssertionError with message 'block returned a falsy value'
     #
-    #   Assertions.assert { true == true }
+    #   assertions.assert { true == true }
     #   #=> does not raise an exception
     def assert(error_class: AssertionError, message: nil, &block)
       return if block.call
@@ -46,6 +46,9 @@ module SleepingKingStudios::Tools
 
     # Asserts that the value is either nil or empty.
     #
+    # A value is blank if it is nil, or if the value responds to #empty? and the
+    # #empty? method returns true.
+    #
     # @param value [Object] the value to assert on.
     # @param as [String] the name of the asserted value.
     # @param error_class [Class] the exception class to raise on a failure.
@@ -57,16 +60,16 @@ module SleepingKingStudios::Tools
     #   to #empty? or value.empty returns false.
     #
     # @example
-    #   Assertions.assert_blank(nil)
+    #   assertions.assert_blank(nil)
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_blank(Object.new)
+    #   assertions.assert_blank(Object.new)
     #   #=> raises an AssertionError with message 'value must be nil or empty'
     #
-    #   Assertions.assert_blank([])
+    #   assertions.assert_blank([])
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_blank([1, 2, 3])
+    #   assertions.assert_blank([1, 2, 3])
     #   #=> raises an AssertionError with message 'value must be nil or empty'
     def assert_blank(
       value,
@@ -74,8 +77,7 @@ module SleepingKingStudios::Tools
       error_class: AssertionError,
       message:     nil
     )
-      return if value.nil?
-      return if value.respond_to?(:empty?) && value.empty?
+      return if blank?(value)
 
       message ||= error_message_for('blank', as:)
 
@@ -95,16 +97,16 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value is not true or false.
     #
     # @example
-    #   Assertions.assert_boolean(nil)
+    #   assertions.assert_boolean(nil)
     #   #=> raises an AssertionError with message 'value must be true or false'
     #
-    #   Assertions.assert_boolean(Object.new)
+    #   assertions.assert_boolean(Object.new)
     #   #=> raises an AssertionError with message 'value must be true or false'
     #
-    #   Assertions.assert_boolean(false)
+    #   assertions.assert_boolean(false)
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_boolean(true)
+    #   assertions.assert_boolean(true)
     #   #=> does not raise an exception
     def assert_boolean(
       value,
@@ -135,10 +137,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value is not a Class.
     #
     # @example
-    #   Assertions.assert_class(Object.new)
+    #   assertions.assert_class(Object.new)
     #   #=> raises an AssertionError with message 'value is not a class'
     #
-    #   Assertions.assert_class(String)
+    #   assertions.assert_class(String)
     #   #=> does not raise an exception
     def assert_class(
       value,
@@ -169,10 +171,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value is one of the expected values.
     #
     # @example
-    #   Assertions.assert_exclusion('get', expected: %w[get post put])
+    #   assertions.assert_exclusion('get', expected: %w[get post put])
     #   #=> raises an AssertionError with message 'value is is one of "get", "post", "put"'
     #
-    #   Assertions.assert_exclusion('delete', expected: %w[get post put])
+    #   assertions.assert_exclusion('delete', expected: %w[get post put])
     #   #=> does not raise an exception
     def assert_exclusion(
       value,
@@ -205,7 +207,7 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if any of the assertions fail.
     #
     # @example
-    #   Assertions.assert_group do |group|
+    #   assertions.assert_group do |group|
     #     group.assert_name(nil, as: 'label')
     #     group.assert_instance_of(0.0, expected: Integer, as: 'quantity')
     #   end
@@ -240,10 +242,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value is not one of the expected values.
     #
     # @example
-    #   Assertions.assert_inclusion('get', expected: %w[get post put])
+    #   assertions.assert_inclusion('get', expected: %w[get post put])
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_inclusion('delete', expected: %w[get post put])
+    #   assertions.assert_inclusion('delete', expected: %w[get post put])
     #   #=> raises an AssertionError with message 'value is is one of "get", "post", "put"'
     def assert_inclusion( # rubocop:disable Metrics/ParameterLists
       value,
@@ -282,13 +284,13 @@ module SleepingKingStudios::Tools
     #   have the given ancestor.
     #
     # @example
-    #   Assertions.assert_inherits_from(:foo, expected: StandardError)
+    #   assertions.assert_inherits_from(:foo, expected: StandardError)
     #   #=> raises an AssertionError with message 'value is not a Class or Module'
     #
-    #   Assertions.assert_inherits_from(RuntimeError, expected: StandardError)
+    #   assertions.assert_inherits_from(RuntimeError, expected: StandardError)
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_inherits_from(Array, expected: Enumerable)
+    #   assertions.assert_inherits_from(Array, expected: Enumerable)
     #   #=> does not raise an exception
     def assert_inherits_from( # rubocop:disable Metrics/ParameterLists
       value,
@@ -332,10 +334,10 @@ module SleepingKingStudios::Tools
     #   class.
     #
     # @example
-    #   Assertions.assert_instance_of(:foo, expected: String)
+    #   assertions.assert_instance_of(:foo, expected: String)
     #   #=> raises an AssertionError with message 'value is not an instance of String'
     #
-    #   Assertions.assert_instance_of('foo', expected: String)
+    #   assertions.assert_instance_of('foo', expected: String)
     #   #=> does not raise an exception
     def assert_instance_of( # rubocop:disable Metrics/ParameterLists
       value,
@@ -371,10 +373,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value does not match the expected object.
     #
     # @example
-    #   Assertions.assert_matches('bar', expected: /foo/)
+    #   assertions.assert_matches('bar', expected: /foo/)
     #   #=> raises an AssertionError with message 'value does not match the pattern /foo/'
     #
-    #   Assertions.assert_matches('foo', expected: /foo/)
+    #   assertions.assert_matches('foo', expected: /foo/)
     #   #=> does not raise an exception
     def assert_matches( # rubocop:disable Metrics/ParameterLists
       value,
@@ -406,19 +408,19 @@ module SleepingKingStudios::Tools
     #   the value is empty.
     #
     # @example
-    #   Assertions.assert_name(nil)
+    #   assertions.assert_name(nil)
     #   #=> raises an AssertionError with message "value can't be blank"
     #
-    #   Assertions.assert_name(Object.new)
+    #   assertions.assert_name(Object.new)
     #   #=> raises an AssertionError with message 'value is not a String or a Symbol'
     #
-    #   Assertions.assert_name('')
+    #   assertions.assert_name('')
     #   #=> raises an AssertionError with message "value can't be blank"
     #
-    #   Assertions.assert_name('foo')
+    #   assertions.assert_name('foo')
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_name(:bar)
+    #   assertions.assert_name(:bar)
     #   #=> does not raise an exception
     def assert_name( # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       value,
@@ -460,10 +462,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value is not nil.
     #
     # @example
-    #   Assertions.assert_nil(nil)
+    #   assertions.assert_nil(nil)
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_nil(Object.new)
+    #   assertions.assert_nil(Object.new)
     #   #=> raises an AssertionError with message 'value must be nil'
     def assert_nil(
       value,
@@ -490,10 +492,10 @@ module SleepingKingStudios::Tools
     # @raise [AssertionError] if the value is nil.
     #
     # @example
-    #   Assertions.assert_not_nil(nil)
+    #   assertions.assert_not_nil(nil)
     #   #=> raises an AssertionError with message 'value must not be nil'
     #
-    #   Assertions.assert_not_nil(Object.new)
+    #   assertions.assert_not_nil(Object.new)
     #   #=> does not raise an exception
     def assert_not_nil(
       value,
@@ -510,6 +512,9 @@ module SleepingKingStudios::Tools
 
     # Asserts that the value is not nil and not empty.
     #
+    # A value is present if it is not nil, and if the value responds to #empty?
+    # then the #empty? method must returns false.
+    #
     # @param value [Object] the value to assert on.
     # @param as [String] the name of the asserted value.
     # @param error_class [Class] the exception class to raise on a failure.
@@ -522,16 +527,16 @@ module SleepingKingStudios::Tools
     #   #empty? and value.empty is true.
     #
     # @example
-    #   Assertions.assert_presence(nil)
+    #   assertions.assert_presence(nil)
     #   #=> raises an AssertionError with message "can't be blank"
     #
-    #   Assertions.assert_presence(Object.new)
+    #   assertions.assert_presence(Object.new)
     #   #=> does not raise an exception
     #
-    #   Assertions.assert_presence([])
+    #   assertions.assert_presence([])
     #   #=> raises an AssertionError with message "can't be blank"
     #
-    #   Assertions.assert_presence([1, 2, 3])
+    #   assertions.assert_presence([1, 2, 3])
     #   #=> does not raise an exception
     def assert_presence(
       value,
@@ -555,6 +560,57 @@ module SleepingKingStudios::Tools
       handle_error(error_class:, message:)
     end
 
+    # Checks if the value is either nil or empty.
+    #
+    # A value is blank if it is nil, or if the value responds to #empty? and the
+    # #empty? method returns true.
+    #
+    # @param value [Object] the value to assert on.
+    #
+    # @return [true, false] true if the value is nil or empty, otherwise returns
+    #   false.
+    #
+    # @example
+    #   assertions.blank?(nil)
+    #   #=> true
+    #
+    #   assertions.blank?(Object.new)
+    #   #=> false
+    #
+    #   assertions.blank?([])
+    #   #=> true
+    #
+    #   assertions.blank?([1, 2, 3])
+    #   #=> false
+    def blank?(value)
+      return true if value.nil?
+
+      value.respond_to?(:empty?) && value.empty?
+    end
+
+    # Checks if value is either true or false.
+    #
+    # @param value [Object] the value to assert on.
+    #
+    # @return [true, false] true if the value is either true or false, otherwise
+    #   returns false.
+    #
+    # @example
+    #   assertions.boolean?(nil)
+    #   #=> false
+    #
+    #   assertions.boolean?(Object.new)
+    #   #=> false
+    #
+    #   assertions.boolean?(false)
+    #   #=> true
+    #
+    #   assertions.boolean?(true)
+    #   #=> true
+    def boolean?(value)
+      true == value || false == value # rubocop:disable Style/MultipleComparison, Style/YodaCondition
+    end
+
     # Generates an error message for a failed validation.
     #
     # @param key [String] the message key.
@@ -582,6 +638,62 @@ module SleepingKingStudios::Tools
       toolbelt.messages.message(key, as:, parameters:, scope:)
     end
 
+    # Asserts that the value is a non-empty String or Symbol.
+    #
+    # @param value [Object] the value to assert on.
+    #
+    # @return [true, false] true if the value is a non-empty String or Symbol,
+    #   otherwise returns false.
+    #
+    # @example
+    #   assertions.name?(nil)
+    #   #=> false
+    #
+    #   assertions.name?(Object.new)
+    #   #=> false
+    #
+    #   assertions.name?('')
+    #   #=> false
+    #
+    #   assertions.name?('foo')
+    #   #=> true
+    #
+    #   assertions.name?(:bar)
+    #   #=> true
+    def name?(value)
+      return false unless value.is_a?(String) || value.is_a?(Symbol)
+
+      !value.empty?
+    end
+
+    # Checks if the value is not nil and not empty.
+    #
+    # A value is present if it is not nil, and if the value responds to #empty?
+    # then the #empty? method must returns false.
+    #
+    # @param value [Object] the value to assert on.
+    #
+    # @return [true, false] true if the value is nil and not empty, otherwise
+    #   returns false.
+    #
+    # @example
+    #   assertions.present?(nil)
+    #   #=> false
+    #
+    #   assertions.present?(Object.new)
+    #   #=> true
+    #
+    #   assertions.present?([])
+    #   #=> false
+    #
+    #   assertions.present?([1, 2, 3])
+    #   #=> true
+    def present?(value)
+      return false if value.nil?
+
+      !(value.respond_to?(:empty?) && value.empty?)
+    end
+
     # Asserts that the block returns a truthy value.
     #
     # @param message [String] the exception message to raise on a failure.
@@ -594,10 +706,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the block does not return a truthy value.
     #
     # @example
-    #   Assertions.validate { true == false }
+    #   assertions.validate { true == false }
     #   #=> raises an ArgumentError with message 'block returned a falsy value'
     #
-    #   Assertions.validate { true == true }
+    #   assertions.validate { true == true }
     #   #=> does not raise an exception
     def validate(message: nil, &)
       assert(
@@ -619,16 +731,16 @@ module SleepingKingStudios::Tools
     #   to #empty? or value.empty returns false.
     #
     # @example
-    #   Assertions.validate_blank(nil)
+    #   assertions.validate_blank(nil)
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_blank(Object.new)
+    #   assertions.validate_blank(Object.new)
     #   #=> raises an ArgumentError with message 'value must be nil or empty'
     #
-    #   Assertions.validate_blank([])
+    #   assertions.validate_blank([])
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_blank([1, 2, 3])
+    #   assertions.validate_blank([1, 2, 3])
     #   #=> raises an ArgumentError with message 'value must be nil or empty'
     def validate_blank(value, as: 'value', message: nil)
       assert_blank(
@@ -651,16 +763,16 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value is not true or false.
     #
     # @example
-    #   Assertions.validate_boolean(nil)
+    #   assertions.validate_boolean(nil)
     #   #=> raises an ArgumentError with message 'value must be true or false'
     #
-    #   Assertions.validate_boolean(Object.new)
+    #   assertions.validate_boolean(Object.new)
     #   #=> raises an ArgumentError with message 'value must be true or false'
     #
-    #   Assertions.validate_boolean(false)
+    #   assertions.validate_boolean(false)
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_boolean(true)
+    #   assertions.validate_boolean(true)
     #   #=> does not raise an exception
     def validate_boolean(value, as: 'value', message: nil, optional: false)
       assert_boolean(
@@ -684,10 +796,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value is not a Class.
     #
     # @example
-    #   Assertions.validate_class(Object.new)
+    #   assertions.validate_class(Object.new)
     #   #=> raises an ArgumentError with message 'value is not a class'
     #
-    #   Assertions.validate_class(String)
+    #   assertions.validate_class(String)
     #   #=> does not raise an exception
     def validate_class(value, as: 'value', message: nil, optional: false)
       assert_class(
@@ -711,10 +823,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value is one of the expected values.
     #
     # @example
-    #   Assertions.validate_exclusion('get', expected: %w[get post put])
+    #   assertions.validate_exclusion('get', expected: %w[get post put])
     #   #=> raises an ArgumentError with message 'value is is one of "get", "post", "put"'
     #
-    #   Assertions.validate_exclusion('delete', expected: %w[get post put])
+    #   assertions.validate_exclusion('delete', expected: %w[get post put])
     #   #=> does not raise an exception
     def validate_exclusion(
       value,
@@ -743,7 +855,7 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if any of the validations fail.
     #
     # @example
-    #   Assertions.validate_group do |group|
+    #   assertions.validate_group do |group|
     #     group.validate_name(nil, as: 'label')
     #     group.validate_instance_of(0.0, expected: Integer, as: 'quantity')
     #   end
@@ -770,10 +882,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value is not one of the expected values.
     #
     # @example
-    #   Assertions.validate_inclusion('get', expected: %w[get post put])
+    #   assertions.validate_inclusion('get', expected: %w[get post put])
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_inclusion('delete', expected: %w[get post put])
+    #   assertions.validate_inclusion('delete', expected: %w[get post put])
     #   #=> raises an ArgumentError with message 'value is is one of "get", "post", "put"'
     def validate_inclusion(
       value,
@@ -807,13 +919,13 @@ module SleepingKingStudios::Tools
     #   have the given ancestor.
     #
     # @example
-    #   Assertions.validate_inherits_from(:foo, expected: StandardError)
+    #   assertions.validate_inherits_from(:foo, expected: StandardError)
     #   #=> raises an ArgumentError with message 'value is not a Class or Module'
     #
-    #   Assertions.validate_inherits_from(RuntimeError, expected: StandardError)
+    #   assertions.validate_inherits_from(RuntimeError, expected: StandardError)
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_inherits_from(Array, expected: Enumerable)
+    #   assertions.validate_inherits_from(Array, expected: Enumerable)
     #   #=> does not raise an exception
     def validate_inherits_from(
       value,
@@ -847,10 +959,10 @@ module SleepingKingStudios::Tools
     #   class or module.
     #
     # @example
-    #   Assertions.validate_instance_of(:foo, expected: String)
+    #   assertions.validate_instance_of(:foo, expected: String)
     #   #=> raises an AssertionError with message 'value is not an instance of String'
     #
-    #   Assertions.validate_instance_of('foo', expected: String)
+    #   assertions.validate_instance_of('foo', expected: String)
     #   #=> does not raise an exception
     def validate_instance_of(
       value,
@@ -882,10 +994,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value does not match the expected object.
     #
     # @example
-    #   Assertions.validate_matches('bar', expected: /foo/)
+    #   assertions.validate_matches('bar', expected: /foo/)
     #   #=> raises an ArgumentError with message 'value does not match the pattern /foo/'
     #
-    #   Assertions.validate_matches('foo', expected: /foo/)
+    #   assertions.validate_matches('foo', expected: /foo/)
     #   #=> does not raise an exception
     def validate_matches(
       value,
@@ -917,19 +1029,19 @@ module SleepingKingStudios::Tools
     #   value is empty.
     #
     # @example
-    #   Assertions.validate_name(nil)
+    #   assertions.validate_name(nil)
     #   #=> raises an ArgumentError with message "value can't be blank"
     #
-    #   Assertions.validate_name(Object.new)
+    #   assertions.validate_name(Object.new)
     #   #=> raises an AssertionError with message 'value is not a String or a Symbol'
     #
-    #   Assertions.validate_name('')
+    #   assertions.validate_name('')
     #   #=> raises an ArgumentError with message "value can't be blank"
     #
-    #   Assertions.validate_name('foo')
+    #   assertions.validate_name('foo')
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_name(:bar)
+    #   assertions.validate_name(:bar)
     #   #=> does not raise an exception
     def validate_name(
       value,
@@ -957,10 +1069,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value is not nil.
     #
     # @example
-    #   Assertions.validate_nil(nil)
+    #   assertions.validate_nil(nil)
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_nil(Object.new)
+    #   assertions.validate_nil(Object.new)
     #   #=> raises an ArgumentError with message 'value must be nil'
     def validate_nil(
       value,
@@ -986,10 +1098,10 @@ module SleepingKingStudios::Tools
     # @raise [ArgumentError] if the value is nil.
     #
     # @example
-    #   Assertions.validate_not_nil(nil)
+    #   assertions.validate_not_nil(nil)
     #   #=> raises an ArgumentError with message 'value must not be nil'
     #
-    #   Assertions.validate_not_nil(Object.new)
+    #   assertions.validate_not_nil(Object.new)
     #   #=> does not raise an exception
     def validate_not_nil(
       value,
@@ -1017,16 +1129,16 @@ module SleepingKingStudios::Tools
     #   #empty? and value.empty is true.
     #
     # @example
-    #   Assertions.validate_presence(nil)
+    #   assertions.validate_presence(nil)
     #   #=> raises an ArgumentError with message "can't be blank"
     #
-    #   Assertions.validate_presence(Object.new)
+    #   assertions.validate_presence(Object.new)
     #   #=> does not raise an exception
     #
-    #   Assertions.validate_presence([])
+    #   assertions.validate_presence([])
     #   #=> raises an ArgumentError with message "can't be blank"
     #
-    #   Assertions.validate_presence([1, 2, 3])
+    #   assertions.validate_presence([1, 2, 3])
     #   #=> does not raise an exception
     def validate_presence(value, as: 'value', message: nil, optional: false)
       assert_presence(