errgonomic 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b0c152c2da68e05379b49921b5c1daad165f8322533b162712e090b01ee13e
-  data.tar.gz: 23122f0746864b8b8f35c105279a6f825a9fb35791a33dd8bb754b78f8609b0f
+  metadata.gz: a07fce97adead2a0d6b77c83f0c80c06d6ecb6633193f61454d961bea1a4acf2
+  data.tar.gz: c6c66f5a03d8bea908b6b68cbe76c69f724012313348c3563bade4932946acc8
 SHA512:
-  metadata.gz: b27d4be530cc22d8ed186a732e5fb3b8051b0e6586ddcabb321ece29393457402bd991e9e1ef415ac44fcf30d496ff1504d1078278fc7ad49867b8078ddce7ac
-  data.tar.gz: 7e4849a426e904b6fcb2a516bf99cf13ff9205920f6265361ec5b0203e242af0f386df67a476c5fb241f372d377303a8ba09b75602d5685113b759a2dd7aad8c
+  metadata.gz: 8d6d7dbac95eeea0d1fcb1bade820a2c7ba83e464dda0d79052a7beee9f9a67bc4c53c1b87b38256189ffd8f8d6bf0e8f40dc2055db1395f2bc227c30a2075bf
+  data.tar.gz: 522f8e75d45b543d1d8762be130d6a625dac1b8ac47a7b3eae5729649afedd8d0e493ecbb885b1aef42a887fc6a4a8ab4461ab0fd615d40d413b91da93da6ebf

data/gemset.nix

@@ -269,7 +269,7 @@
       path = ./.;
       type = "path";
     };
-    version = "0.4.2";
+    version = "0.5.0";
   };
   erubi = {
     groups = ["default" "development"];

data/lib/errgonomic/option.rb

@@ -321,6 +321,26 @@ module Errgonomic
         Some(other)
       end
 
+      # Refuse to serialize an unwrapped Option as a String. Options must be
+      # correctly handled to access their inner value.
+      #
+      # @example
+      #   None().to_s # => raise Errgonomic::SerializeError, "cannot serialize an unwrapped Option"
+      def to_s
+        raise Errgonomic::SerializeError, 'cannot serialize an unwrapped Option'
+      end
+
+      # Refuse to serialize an unwrapped Option as JSON. Not only should we
+      # require that options be correctly handled to access their inner value,
+      # but without this we will get undefined structures from default
+      # Object#to_json implementations.
+      #
+      # @example
+      #   None().to_json # => raise Errgonomic::SerializeError, "cannot serialize an unwrapped Option"
+      def to_json(*_args)
+        raise Errgonomic::SerializeError, 'cannot serialize an unwrapped Option'
+      end
+
       # filter
       # xor
       # insert

data/lib/errgonomic/rails/active_record_optional.rb

@@ -53,20 +53,12 @@ module Errgonomic
       delegate :marked_for_destruction?, to: :value
       delegate :persisted?, to: :value
       delegate :touch_later, to: :value
-
-      def to_s
-        raise "Attempted to convert Some to String, please use Option API to safely work with internal value -- #{value}"
-      end
     end
 
     class None
       def nil?
         true
       end
-
-      def to_s
-        raise 'Cannot convert None to String - please use Option API to safely work with internal value'
-      end
     end
   end
 end

data/lib/errgonomic/result.rb

@@ -252,6 +252,28 @@ module Errgonomic
         @value = block.call(value)
         self
       end
+
+      # Refuse to serialize an unwrapped Result as a String. Results must be
+      # correctly handled to access their inner value.
+      #
+      # @example
+      #   Ok("").to_s # => raise Errgonomic::SerializeError, "cannot serialize an unwrapped Result"
+      #   Err("").to_s # => raise Errgonomic::SerializeError, "cannot serialize an unwrapped Result"
+      def to_s
+        raise Errgonomic::SerializeError, 'cannot serialize an unwrapped Result'
+      end
+
+      # Refuse to serialize an unwrapped Result as JSON. Not only should we
+      # require that Results be correctly handled to access their inner value,
+      # but without this we will get undefined structures from default
+      # Object#to_json implementations.
+      #
+      # @example
+      #   Ok("").to_json # => raise Errgonomic::SerializeError, "cannot serialize an unwrapped Result"
+      #   Err("").to_json # => raise Errgonomic::SerializeError, "cannot serialize an unwrapped Result"
+      def to_json(*_args)
+        raise Errgonomic::SerializeError, 'cannot serialize an unwrapped Result'
+      end
     end
 
     # The Ok variant.

data/lib/errgonomic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Errgonomic
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/errgonomic.rb

@@ -23,9 +23,11 @@ require_relative 'errgonomic/rails' if defined?(Rails::Railtie)
 module Errgonomic
   class Error < StandardError; end
 
+  class TypeError < ::TypeError; end
+
   class NotPresentError < Error; end
 
-  class TypeMismatchError < Error; end
+  class TypeMismatchError < TypeError; end
 
   class UnwrapError < Error
     def initialize(msg, value)
@@ -42,6 +44,8 @@ module Errgonomic
 
   class NotComparableError < StandardError; end
 
+  class SerializeError < TypeError; end
+
   # A little bit of control over how pedantic we are in our runtime type checks.
   def self.give_me_ambiguous_downstream_errors?
     @give_me_ambiguous_downstream_errors || true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errgonomic
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Nick Zadrozny