decoding 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91611249210837a0a3b5140bd19bd53d5862bf4ab7f56249797da3e9348c5712
-  data.tar.gz: 518d2eee3ff13717a2170b2c008d297a7c60986886e3281ef0b5d883e7b077b8
+  metadata.gz: e42aa2335c51607c8da6110d0bec04cfef6b2af82365e003b51d54db365e091a
+  data.tar.gz: 50d36892d40a7a3ca152125a0265cd7c4ac2f87da78c236f7ca98844f83bd81a
 SHA512:
-  metadata.gz: 01d88efba9c04b704763945e87c70a18e437a64313b944382eac83fd795fa293bb20618d92c513babfd17f6a1c51efdb2c039fa2aab7d914608a8115ef30501c
-  data.tar.gz: a02ca210632cdb66dd15e0f0b14aae449b43aace345988a38a94abd626f87c1f37bd5b66dfdd2d29202ff0ac2ce850012b18d522844d31239839d73c66626cf4
+  metadata.gz: 561b13185e19d9402fc8b416e8cb851f8dea4eb0bf0ad337151e5e43eb6eb97fe76211b2d85aebbbb44ce7111aa852a1bb61015585dab1af68fc4afe250d055d
+  data.tar.gz: 356c32052eba205c3ff07395d20afd87d5b4c6c564ce50e7727a2bffba6cb1a43f537e1a92ca33bd628ab819ad01ac643ad30f700387f78914d056e9b8246ce7

data/.rubocop.yml

@@ -1,5 +1,5 @@
 ---
-require:
+plugins:
   - rubocop-rspec
   - rubocop-performance
   - rubocop-rake

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.0]
+
+* Add `Decoding::Data` for creating decodable data classes
+
+## [0.2.6]
+
+* Add `Decoding::Result#unwrap!`
+
 ## [0.2.5]
 
 * Report all error messages in the `any` decoder

data/lib/decoding/data.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "decoders"
+
+module Decoding
+  # Wrapper around Ruby's `Data` class, providing a way to both define a new
+  # data class as usual but including a decoder to decode a value into such a
+  # data value.
+  #
+  # @example
+  #   User = Decoding::Data.define(
+  #     name: field("postName", string),
+  #     age: field("yearsOld", integer)
+  #   ) do
+  #    def greet
+  #      "Hello, my name is #{name} and I am #{age} years old."
+  #    end
+  #  end
+  #  payload = { "postName" => "John", "yearsOld" => 30 }
+  #  Decoding.decode(User.decoder, payload) => Decoding::Ok(user)
+  #  user.greet # => "Hello, my name is John and I am 30 years old."
+  # @return [Class]
+  module Data
+    # @param attributes [Hash<Symbol, Decoding::Decoder>] A hash of attribute
+    #   names and decoders
+    # @see ::Data.define
+    # @return [Class] A new data class with a `decoder` method.
+    def self.define(attributes, &)
+      # First ensure we have a hash of attribute names and decoders
+      attributes = attributes.to_h do |key, value|
+        [key.to_sym, value.to_decoder]
+      end
+
+      # Define the data class as usual
+      data_class = ::Data.define(*attributes.keys, &)
+
+      # Add a special `decode` method to use the provided decoders to decode a
+      # value as hash and build a new instance with it
+      data_class.define_singleton_method(:decoder) do
+        Decoding::Decoders.map(
+          Decoding::Decoders.decode_hash(attributes)
+        ) { |attrs| new(**attrs) }
+      end
+
+      # Adapt to `to_decoder` protocol
+      data_class.define_singleton_method(:to_decoder) { decoder }
+
+      # Return the data class so regular assignment like
+      # `User = ::Data.define(...)` works.
+      data_class
+    end
+  end
+end

data/lib/decoding/decoders.rb

@@ -233,6 +233,8 @@ module Decoding
     #   # => Decode::Ok({ id: 1 })
     # @return Decoding::Decoder
     def decode_hash(decoders)
+      return succeed({}) if decoders.empty?
+
       map(*decoders.values) do |*values|
         decoders.keys.zip(values).to_h
       end

data/lib/decoding/result.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Decoding
+  # Raised when calling {Result#unwrap!} on an `Err` value.
+  class UnwrapError < StandardError; end
+
   # A result represent the outcome of some computation that can succeed or fail.
   # The results are represented with two subclasses of `Result`: `Ok` and `Err`.
   # Each hold a single result value.
@@ -83,6 +86,14 @@ module Decoding
     # @return [Object]
     def unwrap(default_value) = default_value
 
+    # Extract the value out of a `Result` value. In case of an `Ok`, this
+    # returns the result's value. In case of an `Err`, a {UnwrapError} is
+    # raised with the error value as its message.
+    #
+    # @raise [Decoding::UnwrapError] if the result is an `Err` value.
+    # @return [Object]
+    def unwrap! = raise(UnwrapError, value.to_s)
+
     # 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.
@@ -142,6 +153,7 @@ module Decoding
 
     def ok? = true
     def unwrap(_) = value
+    def unwrap! = value
     def map = self.class.new(yield value)
 
     def and(other)

data/lib/decoding/version.rb

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

data/lib/decoding.rb

@@ -2,6 +2,7 @@
 
 require_relative "decoding/version"
 require_relative "decoding/decoders"
+require_relative "decoding/data"
 
 # Decoding is a library to help transform unknown external data into neat values
 # with known shapes. Consider calling an HTTP API: you might pull in whatever

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decoding
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Arjan van der Gaag
@@ -28,6 +28,7 @@ files:
 - README.md
 - Rakefile
 - lib/decoding.rb
+- lib/decoding/data.rb
 - lib/decoding/decoder.rb
 - lib/decoding/decoders.rb
 - lib/decoding/decoders/and_then.rb