decoding 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05a711dfeb38945b0d8f57745f9555cd0a8a01b8e74a119aafddb9b74e3f4ccc
-  data.tar.gz: 5faa5cc2848bb269bf1bf65766dfed1fd80f6f74e39b48c3cfcddc9b9ede1946
+  metadata.gz: f89de33cb9abd7e09600ac7622500813a93478e9e57fcadbe678688df0e2d1e2
+  data.tar.gz: 34dfd51a4642e580312863aa856d220562b9281db70023e5011396c5b3b897f5
 SHA512:
-  metadata.gz: 6822f9f59e3da74225b435131991b9e903bfd77206c1edd0620849d74d89db509572550eb184ec49c1ec5ef4ef1729072a93f104b6bf05fa300ffe2853dfbdee
-  data.tar.gz: 30d2caa4fa4ff49fab9f4327eada6daf088204f392e87765048decc5b6c3534ebc629850d8d0aff5a7b43228afc8f9bbe58fd121a6466e515e1dd8b4b69b96b7
+  metadata.gz: e45131fe22a31c0200a31ff0160648a74cb7ef5ee3121475a55bbb3be3933f1101127f258cdd49702c38c5587879864d00e7b1613f34f6ee65d52f2346271481
+  data.tar.gz: 76b3a9c08511bbf3f067e41cb7ef7a8d2216665ed56e96c5e72da3057f78ef2b95fe7b0cdcc0bcecd70e2fccbd9eb5041869531e61506514f8270715f0520cb6

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.3]
+
+* Implement `Decoding::Result#deconstruct` to support pattern matching on result values.
+
+## [0.2.2] - 2025-10-25
+
+* Added `Result#unwrap_err`
+
 ## [0.2.1] - 2025-10-25
 
 * Fixed missed error not returning `Decoding::Failure`

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

@@ -52,6 +52,10 @@ module Decoding
       freeze
     end
 
+    def deconstruct
+      [value]
+    end
+
     def eql?(other)
       other.is_a?(self.class) && value == other.value
     end
@@ -79,6 +83,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 +161,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.1"
+  VERSION = "0.2.3"
 end

metadata

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