decoding 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f462705ab2cc82507ed66b66274dd6f9167ade6b3bab3e8d12dc329f8f564fb
-  data.tar.gz: 2a16abba19d6b9f8cb68d7db943e55627c439925b40090f96dc3c8b6dc27e65e
+  metadata.gz: b3b7725a14c0738d4860f46509eb8e2ce781f6298bb9253797c0dad84f769564
+  data.tar.gz: '07785a90e96fe8a56bcbb2986d0cdd61aca6e75541f084e1a5c7be5799261912'
 SHA512:
-  metadata.gz: 918dae4e293d0585afd44aa092fd95a295d3ed5153fd9a5f4acf041a551fdc97a8ca14f030f038c7507f0b7de799b6cb6076dcbb3bac8b18f024e45ed05fd068
-  data.tar.gz: 818550ca01578f9ba869bf54bb875f962ac22ee179f12c23e7565ab4923e733aaa629325561c73f5c1659c290857200b5dd1bb3b3d4eafad00e445c8ff291385
+  metadata.gz: 4c253b152f0f82f95fb3a5a77c84acf741686c776492418967b5a9ca11800f1296351af373126f9d1efaeba8dd2418d3bbbdbdc1ad88e77c314489442b9af1a6
+  data.tar.gz: ddba1656e7e7cec32423d0c1e6ada7494972b620666e1dc3daa70b7bf5c1210a0ad50911778b74e8c06d2f4befbe3f644c44bf38b05c8b97a266fdf3d0afd49f

data/.rubocop.yml

@@ -19,6 +19,10 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 140
 
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.2] - 2025-10-25
+
+* Added `Result#unwrap_err`
+
+## [0.2.1] - 2025-10-25
+
+* Fixed missed error not returning `Decoding::Failure`
+
 ## [0.2.0] - 2025-10-25
 
 * Added `decode_hash`, `regexp` and `original` decoders

data/lib/decoding/decoders/field.rb

@@ -23,10 +23,10 @@ module Decoding
           if value.key?(@key)
             @decoder.call(value.fetch(@key)).map_err { _1.push(@key) }
           else
-            err("expected a Hash with key #{@key}")
+            err(failure("expected a Hash with key #{@key}"))
           end
         else
-          err("expected a Hash, got: #{value.inspect}")
+          err(failure("expected a Hash, got: #{value.inspect}"))
         end
       end
     end

data/lib/decoding/decoders/pass.rb

@@ -2,6 +2,10 @@
 
 module Decoding
   module Decoders
+    # Decoder that returns the original value as-is. You are not likely to need
+    # this that often, as it kind of defeats the point of decoding -- but it
+    # might be useful to inspect the original input value for logging or
+    # debguging purposes.
     class Pass < Decoder
       def call(value) = ok(value)
     end

data/lib/decoding/decoders.rb

@@ -33,7 +33,7 @@ module Decoding
     # @param re [Regexp, String]
     # @return [Decoding::Decoder<String>]
     # @see Decoding::Decoders::Match
-    def regexp(re) = Decoders::Match.new(Regexp.new(re))
+    def regexp(regex) = Decoders::Match.new(Regexp.new(regex))
 
     # Decode any integer value.
     #

data/lib/decoding/failure.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 module Decoding
+  # A failure is an error message, much like a string, but with an added stack
+  # of earlier messages.
+  #
+  # This is useful to create clearer error messages when using compound
+  # decoders, such as `array(string)`. If the `string` decoder fails with an
+  # error, the `array` decoder can push `3` to the stack to indicate that
+  # happened at index 3 in its input value.
   class Failure
-    protected attr_reader :msg
-    protected attr_reader :path
-
     # @paramn msg [String]
     def initialize(msg)
       @msg = msg
@@ -20,11 +24,6 @@ module Decoding
 
     # Add segments to the stack of errors.
     #
-    # This is useful to create clearer error messages when using compound
-    # decoders, such as `array(string)`. If the `string` decoder fails with an
-    # error, the `array` decoder can push `3` to the stack to indicate that
-    # happened at index 3 in its input value.
-    #
     # @param segment [String]
     # @return [Decoding::Failure]
     def push(segment)
@@ -39,5 +38,9 @@ module Decoding
         @msg
       end
     end
+
+    protected
+
+    attr_reader :msg, :path
   end
 end

data/lib/decoding/result.rb

@@ -79,6 +79,14 @@ module Decoding
     # @return [Object]
     def unwrap(default_value) = default_value
 
+    # Extract the error value out of a `Result` value. In case of an `Err`, this
+    # returns the result's value. In case of an `Ok`, the given `default_value`
+    # is returned.
+    #
+    # @param default_value [Object]
+    # @return [Object]
+    def unwrap_err(default_value) = default_value
+
     # Create a new `Result` value for the result of the block applied to this
     # result's `value`. `Err` values are returned as-is.
     #
@@ -149,5 +157,6 @@ module Decoding
 
     def err? = true
     def map_err = self.class.new(yield value)
+    def unwrap_err(_) = value
   end
 end

data/lib/decoding/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decoding
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Arjan van der Gaag