errgonomic 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e21646c1a4fefc2d70df2089a912fce14df157b543f16b712c63d6dfdf5630c
-  data.tar.gz: 3732b419a1fbee854590a5fbdb700917c2a079880be10ff9b95520dc4102ef69
+  metadata.gz: f5b329e5d25e517ff65724ceca5d9ad3e226740e90e57e5ac21917de5f926845
+  data.tar.gz: 2878a2c35bff61a7b57cb5d4a3ec476dd98e42a2ebe21fba3423b6180f8fc68e
 SHA512:
-  metadata.gz: 1384fea58251177994a31855f6e99ebc15d8cbf173860063cb0d8b53b04f57ec6679e848d98bdd0c37a712f13e34540e4bc7f9908e6a8874bfe891d8f37e6db8
-  data.tar.gz: 229368094740e527915793df1d05b58c82b0da41e04c1fd47924abca7cf98dff7ea5de2dee4e28d3ef3ccf03d0d2950a648d000885813903b5aea9b5d9671ccc
+  metadata.gz: 4b39914d663d14df9816265d5ce5cef11fec14527cdc2a4400e7c1a9424e4d32e65705e6e79493fb1a8c2102ad02d94bf7b0001b11b4855f6310c6041c40f7ff
+  data.tar.gz: d16813545c25785abfd2e3064a51ec80ed5e07c8e9715c349f11c426223a53e40e8976e53c26fb76be9805d2012359d90a2c9a1db08879ca59a8256eab3b6ca1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-05-01
+
+- Type assertions: `type_or_raise!`, `type_or`
+
 ## [0.2.0] - 2025-03-28
 
 - Introduce (most of) Result and Option

data/gemset.nix

@@ -57,7 +57,7 @@
       path = ./.;
       type = "path";
     };
-    version = "0.2.0";
+    version = "0.3.0";
   };
   jaro_winkler = {
     groups = ["default"];

data/lib/errgonomic/type.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class Object
+  # Returns the receiver if it matches the expected type, otherwise raises a TypeMismatchError.
+  # This is useful for enforcing type expectations in method arguments.
+  #
+  # @param type [Class] The expected type or module the receiver should be.
+  # @param message [String] Optional error message to raise if type doesn't match.
+  # @return [Object] The receiver if it is of the expected type.
+  # @example
+  #   'hello'.type_or_raise!(String) #=> "hello"
+  #   123.type_or_raise!(String, "We need a string!") #=> raise Errgonomic::TypeMismatchError, "We need a string!"
+  #   123.type_or_raise!(String) #=> raise Errgonomic::TypeMismatchError, "Expected String but got Integer"
+  def type_or_raise!(type, message = nil)
+    message ||= "Expected #{type} but got #{self.class}"
+    raise Errgonomic::TypeMismatchError, message unless is_a?(type)
+
+    self
+  end
+
+  alias type_or_raise type_or_raise!
+
+  # Returns the receiver if it matches the expected type, otherwise returns the default value.
+  #
+  # @param type [Class] The expected type or module the receiver should be.
+  # @param default [Object] The value to return if type doesn't match.
+  # @return [Object] The receiver if it is of the expected type, otherwise the default value.
+  # @example
+  #   'hello'.type_or(String, 'default')  # => "hello"
+  #   123.type_or(String, 'default')      # => "default"
+  def type_or(type, default)
+    return self if is_a?(type)
+
+    default
+  end
+
+  # Returns the receiver if it matches the expected type, otherwise returns the result of the block.
+  # Useful when constructing the default value is expensive.
+  #
+  # @param type [Class] The expected type or module the receiver should be.
+  # @param block [Proc] The block to call if type doesn't match.
+  # @return [Object] The receiver if it is of the expected type, otherwise the block result.
+  # @example
+  #   'hello'.type_or_else(String) { 'default' }  # => "hello"
+  #   123.type_or_else(String) { 'default' }      # => "default"
+  def type_or_else(type, &block)
+    return self if is_a?(type)
+
+    block.call
+  end
+
+  # Returns the receiver if it does not match the expected type, otherwise raises a TypeMismatchError.
+  #
+  # @param type [Class] The type or module the receiver should not be.
+  # @param message [String] Optional error message to raise if type matches.
+  # @return [Object] The receiver if it is not of the specified type.
+  # @example
+  #   'hello'.not_type_or_raise!(Integer) #=> "hello"
+  #   123.not_type_or_raise!(Integer, "We dont want an integer!") #=> raise Errgonomic::TypeMismatchError, "We dont want an integer!"
+  #   123.not_type_or_raise!(Integer) #=> raise Errgonomic::TypeMismatchError, "Expected anything but Integer but got Integer"
+  def not_type_or_raise!(type, message = nil)
+    message ||= "Expected anything but #{type} but got #{self.class}"
+    raise Errgonomic::TypeMismatchError, message if is_a?(type)
+
+    self
+  end
+end

data/lib/errgonomic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Errgonomic
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/errgonomic.rb

@@ -5,6 +5,9 @@ require_relative 'errgonomic/version' unless defined?(Errgonomic::VERSION)
 # A more opinionated blend with Rails presence.
 require_relative 'errgonomic/presence'
 
+# Bring in a subtle and manual type checker.
+require_relative 'errgonomic/type'
+
 # Bring in our Option and Result.
 require_relative 'errgonomic/option'
 require_relative 'errgonomic/result'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errgonomic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nick Zadrozny
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -79,6 +79,7 @@ files:
 - lib/errgonomic/option.rb
 - lib/errgonomic/presence.rb
 - lib/errgonomic/result.rb
+- lib/errgonomic/type.rb
 - lib/errgonomic/version.rb
 - sig/errgonomic.rbs
 homepage: https://omc.io/