decoding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95c32106911949f49f3b50dc46f744912cc9abf75405cd7e20248de3dd0b1668
+  data.tar.gz: 492fbe3bf3d64cfe954da4b7016dabb5287d19d140bbf662146cff678dbe7ca6
+SHA512:
+  metadata.gz: 7ad3271531ef17b985ecacf39e480baa8c117170d6d3d69b0e2bb1f231663f9ad10a41a390e740ff951600dac7f2d7163ac817d3f1928979cea03898249b8a77
+  data.tar.gz: 95b14f9f7bd57df7f537d6c3402b2eafd46ef397686ac343b2239e76732189d606896e26b606838c403436d1738007deee3e51880880f6839ab77308d7d80a90

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,48 @@
+---
+require:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 140
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/MethodLength:
+  Max: 17
+
+Style/SignalException:
+  Enabled: false
+
+Style/NumberedParametersLimit:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/IdenticalEqualityAssertion:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/.yardopts

@@ -0,0 +1,7 @@
+--title Decoding
+--markup markdown
+--no-stats
+--no-progress
+lib/**/*.rb
+--readme README.md -
+CHANGELOG.md CODE_OF_CONDUCT.md LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at arjan@arjanvandergaag.nl. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Arjan van der Gaag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# Decoding
+
+Decoding is a library to help transform unknown external data into neat values
+with known shapes.
+
+## Installation
+
+TODO: Replace `decoding` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add decoding
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install decoding
+
+## Usage
+
+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
+value. After passing it through decoder, you will have a value with a known
+shape -- or a sensible error message.
+
+For example, call an API to get some JSON value:
+
+    body = JSON.parse(Net::HTTP.get("https://api.placeholderjson.dev/shipments/7EBWXB5"))
+
+How do you safely work with `body`? If parsing the response body as JSON has
+worked, you know you have some kind of Ruby value -- but you're not sure of
+its structure. This can lead to cryptic error messages far removing of making
+this HTTP call where values are of unexpected types, hashes turn out not to
+have certain keys or the nesting of data is different from what you expected.
+
+Assume the response body, parsed as JSON, results in a value like this:
+
+    {
+      "orderID" => "7EBWXB5",
+      "orderDate" => "1595674680",
+      "estimatedDeliveryDate" => "1596365935",
+      "deliveryDate" => null,
+      "delayed" => false,
+      "status" => {
+        "orderPlaced" => true,
+        "orderShipped" => true,
+        "outForDelivery" => true,
+        "orderDelivered" => false
+      }
+    }
+
+We can use decoders to extract exactly those pieces from this payload that we need,
+making assertions along the way of what the data looks like and generating helpful errors
+when reality does not match our expectations.
+
+For example, we could parse the above payload like so:
+
+    Order = Data.define(:id, :date, :status)
+    D = Decoding::Decoders
+    order_decoder = D.map(
+      D.field("orderID", D.string),
+      D.map(D.field("orderDate", D.string)) { Time.at(_1.to_i) },
+      D.hash(D.string, D.boolean)
+    ) { Order.new(*args) }
+    Decoding.decode(order_decoder, body)
+    # => Decoding::Ok(#<data Order
+      id: '7EBWXB5',
+      date: 2020-07-25 12:58:00 +0200,
+      status: {"orderPlaced"=>true,"orderShipped"=>true,"outForDelivery"=>true,"orderDelivered"=>false}>)
+
+Decoders take an input value and generate an output value from it. There are
+decoders for basic Ruby types, compound types such as arrays and hashes,
+decoders for trying out various decoders and, finally, there is the `map`
+decoder for decoding one or more output values from a given input value and
+applying a transformation to them with a block. All these decoders can be
+composed together into new, more complex decoders.
+
+A decoder is, in essence, a function that returns a result based on an input value. Consider
+how, roughly, the `string` decoder is implemented:
+
+    string_decoder = ->(input_value) do
+      if input_value.is_a?(String)
+        Decoding::Result.ok(input_value)
+      else
+        Decoding::Result.err("expected String, got #{input_value.class}")
+      end
+    end
+
+You can use the base decoders along with `map` to write more complex decoder. For example, you could
+extract a `time_decoder` from the example above:
+
+    time_decoder = D.map(D.string) { Time.at(_1.to_i) }
+
+When the shape of the incoming data is unknown, you can try out various
+decoders in a row to find the first that succeeds using `any`:
+
+    string_or_integer = D.any(D.string, D.integer)
+    Decoding.decode(string_or_integer, 1) # => Decoding::Ok(1)
+    Decoding.decode(string_or_integer, '1') # => Decoding::Ok('1')
+
+You can also base one decoder on a previously decoded value. For example, a
+payload might contain a version number describing its format. Use `and_then`
+to decode one value and then construct a new decoder to run against the same
+input using that value:
+
+    multiple_version_decoder = D.and_then(D.field("version", D.string)) do |version|
+      if version == "1"
+        D.field("name", D.string)
+      else
+        D.field("fullName", D.string)
+      end
+    end
+
+Now, you have a decoder that can work inputs using format version 1 and 2:
+
+    Decoding.decode(multiple_version_decoder, "version" => "1", "name" => "John")
+    # => "John"
+    Decoding.decode(multiple_version_decoder, "version" => "2", "fullName" => "Paul")
+    # => "Paul"
+
+The return values of decoding are `Decoding::Result` values, which come in
+`Ok` and `Err` subclasses. These describe how the decoding either succeeded or
+failed. The `Ok` values contain the decoded result, while the `Err` values
+always contain a string error message. It is up to you, as a developer, to
+decide how to deal with unsuccessful decoding.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/avdgaag/decoding. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/avdgaag/decoding/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Decoding project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/avdgaag/decoding/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new
+
+task default: %i[spec rubocop yard]

data/lib/decoding/decoder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require_relative "result"
+
+module Decoding
+  # A decoder is a callable object that reads any input value and returns an
+  # optionally transformed value.
+  #
+  # @abstract
+  class Decoder
+    extend Forwardable
+    def_delegators "Decoding::Result", :all, :ok, :err
+
+    # @param value [Object]
+    # @return [Decoding::Result<Object>]
+    def call(value); end
+
+    # @return [Decoding::Decoder<a>]
+    def to_decoder = self
+  end
+end

data/lib/decoding/decoders/and_then.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # Create a decoder that depends on a previously decoded value.
+    #
+    # @see Decoding::Decoders.and_then
+    class AndThen < Decoder
+      # @param decoder [Decoding::Decoder<a>]
+      # @yieldparam [a]
+      # @yieldreturn [Decoding::Decoder<b>]
+      # @return [Decoding::Decoder<b>]
+      def initialize(decoder, &block)
+        @decoder = decoder.to_decoder
+        @block = block
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Result<b>]
+      def call(value)
+        @decoder.call(value).and_then do |decoded_value|
+          @block.call(decoded_value).call(value)
+        end
+      end
+    end
+  end
+end

data/lib/decoding/decoders/any.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../result"
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # A decoder wrapping any number of decoders, finding the first one that
+    # matches the given value and returning its result.
+    #
+    # @see Decoding::Decoders.any
+    class Any < Decoder
+      # @private
+      Err = Result.err("None of the decoders matched")
+
+      # @param decoder [Decoding::Decoder<Object>]
+      # @param decoders [Decoding::Decoder<Object>]
+      def initialize(decoder, *decoders)
+        @decoders = [decoder, *decoders].map(&:to_decoder)
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Result<Object>]
+      def call(value)
+        @decoders.lazy.map { _1.call(value) }.find(-> { Err }, &:ok?)
+      end
+    end
+  end
+end

data/lib/decoding/decoders/array.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../result"
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # Decode an array where all values match a given decoder.
+    #
+    # @see Decoding::Decoders.array
+    class Array < Decoder
+      # @param decoder [Decoding::Decoder<a>]
+      def initialize(decoder)
+        @decoder = decoder.to_decoder
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Result<a>]
+      def call(value)
+        if value.is_a?(::Array)
+          value
+            .each_with_index
+            .map { |v, i| @decoder.call(v).map_err { |e| "error decoding array item #{i}: #{e}" } }
+            .then { all _1 }
+        else
+          err("expected an Array, got: #{value.class}")
+        end
+      end
+    end
+  end
+end

data/lib/decoding/decoders/field.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # Decode a value from key in a given hash.
+    #
+    # @see Decoding::Decoders.field
+    class Field < Decoder
+      # @param key [Object]
+      # @param decoder [Decoding::Decoder<a>]
+      def initialize(key, decoder)
+        @key = key.to_str
+        @decoder = decoder.to_decoder
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Deceoding::Result<a>]
+      def call(value)
+        if value.is_a?(::Hash)
+          if value.key?(@key)
+            @decoder.call(value.fetch(@key))
+          else
+            err("expected a Hash with key #{@key}")
+          end
+        else
+          err("expected a Hash, got: #{value.inspect}")
+        end
+      end
+    end
+  end
+end

data/lib/decoding/decoders/hash.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # Decode an arbitrary hash using decoders for keys and values.
+    #
+    # @see Decoding::Decoders.hash
+    class Hash < Decoder
+      # @param key_decoder [Decoding::Decoder<a>]
+      # @param value_decoder [Decoding::Decoder<b>]
+      def initialize(key_decoder, value_decoder)
+        @key_decoder = key_decoder.to_decoder
+        @value_decoder = value_decoder.to_decoder
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Result<Hash<a, b>>]
+      def call(value)
+        if value.is_a?(::Hash)
+          key_value_pairs = value.map do |k, v|
+            all(
+              [
+                @key_decoder
+                  .call(k)
+                  .map_err { |e| "error decoding key #{k.inspect}: #{e}" },
+
+                @value_decoder
+                  .call(v)
+                  .map_err { |e| "error decoding value for key #{k.inspect}: #{e}" }
+              ]
+            )
+          end
+          all(key_value_pairs).map(&:to_h)
+        else
+          err("expected Hash, got #{value.class}")
+        end
+      end
+    end
+  end
+end

data/lib/decoding/decoders/index.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../result"
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # Decode the element at a specific offset in an array.
+    #
+    # @see Decoding::Decoders.index
+    class Index < Decoder
+      # @private
+      Err = Result.err("error decoding array: index is out of bounds")
+
+      # @param index [Integer]
+      # @param decoder [Decoding::Decoder<Object>]
+      def initialize(index, decoder)
+        @index = index.to_int
+        @decoder = decoder.to_decoder
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Decoder<Object>]
+      def call(value)
+        return err("expected an Array, got: #{value.class}") unless value.is_a?(::Array)
+
+        @decoder
+          .call(value.fetch(@index))
+          .map_err { "error decoding array item #{@index}: #{_1}" }
+      rescue IndexError => e
+        err("error decoding array: #{e}")
+      end
+    end
+  end
+end

data/lib/decoding/decoders/map.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # A decoder that decodes a value and then applies a transformation to it, if
+    # successful.
+    #
+    # @see Decoding::Decoders.map
+    class Map < Decoder
+      # @param decoder [Decoding::Decoder<a>]
+      # @yieldparam value [a]
+      # @yieldreturn [b]
+      def initialize(decoder, *rest, &block)
+        @decoders = [decoder, *rest].map(&:to_decoder)
+        @block = block
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Result<b>]
+      def call(value)
+        Result
+          .all(@decoders.map { _1.call(value) })
+          .map { @block.call(*_1) }
+      end
+    end
+  end
+end

data/lib/decoding/decoders/match.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../decoder"
+
+module Decoding
+  module Decoders
+    # Decoder that matches values using the `===` operator. This will work with
+    # regular expressions or classes.
+    class Match < Decoder
+      # @param pattern [#===]
+      def initialize(pattern)
+        @pattern = pattern
+        super()
+      end
+
+      # @param value [Object]
+      # @return [Decoding::Result<a>]
+      def call(value)
+        if @pattern === value
+          ok(value)
+        elsif @pattern.is_a?(Class)
+          err("expected #{@pattern}, got #{value.class}")
+        else
+          err("expected value matching #{@pattern.inspect}, got: #{value.inspect}")
+        end
+      end
+    end
+  end
+end

data/lib/decoding/decoders.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require_relative "decoders/match"
+require_relative "decoders/map"
+require_relative "decoders/any"
+require_relative "decoders/field"
+require_relative "decoders/array"
+require_relative "decoders/index"
+require_relative "decoders/hash"
+require_relative "decoders/and_then"
+require_relative "result"
+
+module Decoding
+  # Decoders are composable functions for deconstructing unknown input values
+  # into known output values.
+  module Decoders
+    module_function
+
+    # @!group Simple decoders
+
+    # Decode any string value.
+    #
+    # @example
+    #   decode(string, "foo") # => Decoding::Ok("foo")
+    # @return [Decoding::Decoder<String>]
+    # @see Decoding::Decoders::Match
+    def string = Decoders::Match.new(String)
+
+    # Decode any integer value.
+    #
+    # @example
+    #   decode(integer, 1) # => Decoding::Ok(1)
+    # @return [Decoding::Decoder<Integer>]
+    # @see Decoding::Decoders::Match
+    def integer = Decoders::Match.new(Integer)
+
+    # Decode any float value.
+    #
+    # @example
+    #   decode(float, 0.5) # => Decoding::Ok(0.5)
+    # @return [Decoding::Decoder<Float>]
+    # @see Decoding::Decoders::Match
+    def float = Decoders::Match.new(Float)
+
+    # Decode any numeric value (includes both integers and floats).
+    #
+    # @example
+    #   decode(numeric, 1) # => Decoding::Ok(1)
+    #   decode(numeric, 1.5) # => Decoding::Ok(1.5)
+    # @return [Decoding::Decoder<Numeric>]
+    # @see Decoding::Decoders::Match
+    def numeric = Decoders::Match.new(Numeric)
+
+    # Decode a `nil` value.
+    #
+    # @example
+    #   decode(Decoders.nil, nil) # => Decoding::Ok(nil)
+    # @return [Decoding::Decoder<NilClass>]
+    # @see Decoding::Decoders::Match
+    def nil = Decoders::Match.new(NilClass)
+
+    # Decode a `true` value.
+    #
+    # @example
+    #   decode(Decoding.true, true) # => Decoding::Ok(true)
+    # @return [Decoding::Decoder<TrueClass>]
+    # @see Decoding::Decoders::Match
+    def true = Decoders::Match.new(TrueClass)
+
+    # Decode a `false` value.
+    #
+    # @example
+    #   decode(Decoders.false, false) # => Decoding::Ok(false)
+    # @return [Decoding::Decoder<FalseClass>]
+    # @see Decoding::Decoders::Match
+    def false = Decoders::Match.new(FalseClass)
+
+    # Decode a boolean value (either `true` or `false`).
+    #
+    # @example
+    #   decode(boolean, true) # => Decoding::Ok(true)
+    #   decode(boolean, false) # => Decoding::Ok(false)
+    # @return [Decoding::Decoder<Boolean>]
+    def boolean = any(self.true, self.false)
+
+    # Decode a String value into a symbol.
+    #
+    # @example
+    #   decode(symbol, "foo") # => Decoding::Ok(:foo)
+    # @return [Decoding::Decoder<Symbol>]
+    def symbol = map(string, &:to_sym)
+
+    # @!group Utility decoders
+
+    # A decoder that always succeeds with the given value.
+    #
+    # @example
+    #   decode(succeed(5), "foo") # => Decoding::Ok(5)
+    # @return [Decoding::Decoder<String>]
+    def succeed(value) = ->(_) { Result.ok(value) }
+
+    # A decoder that always fails with the given value.
+    #
+    # @example
+    #   decode(fail("oh no"), "foo") # => Decoding::Err("oh no")
+    # @return [Decoding::Decoder<String>]
+    def fail(value) = ->(_) { Result.err(value) }
+
+    # @!group Compound decoders
+
+    # Decode a value with the given decoder and, if successful, apply a block to
+    # the decoded result.
+    #
+    # Given multiple decoders, apply them all to the same value and, if all
+    # succeeded, create a single output value from them.
+    #
+    # @example map over a single value
+    #   decode(map(string, &:upcase), "foo") # => Decoding::Ok("FOO")
+    # @example map over multiple values
+    #   decode(
+    #     map(
+    #       field("id", integer),
+    #       field("name", string)
+    #     ) { |id, name| [id, name] },
+    #     { "id" => 1, "name" => "john" }
+    #   )
+    #   # => [1, "john"]
+    # @overload map(decoder, *decoders)
+    #   @param decoder [Decoding::Decoder<a>]
+    #   @yieldparam value [a]
+    #   @yieldreturn [b]
+    #   @return [Decoding::Decoder<b>]
+    # @see Decoding::Decoders::Map
+    def map(...) = Decoders::Map.new(...)
+
+    # Decode a value by trying many different decoders in order, using the first
+    # matching result -- or a failure when none of the given decoders succeed.
+    #
+    # @example
+    #   decode(any(string, integer), 12) # => Decoding::Ok(12)
+    #   decode(any(string, integer), '12') # => Decoding::Ok('12')
+    # @overload any(decoder, *decoders)
+    #   @param decoder [Decoding::Decoder<a>]
+    #   @return [Decoding::Decoder<a>]
+    # @see Decoding::Decoders::Any
+    def any(...) = Decoders::Any.new(...)
+
+    # Decode a value that may or may not be `nil`.
+    #
+    # @example
+    #   decode(string, "foo") # => Decoding::Ok("foo")
+    #   decode(string, nil) # => Decoding::Ok(nil)
+    # @param decoder [Decoding::Decoder<a>]
+    # @return [Decoding::Decoder<a, nil>]
+    def optional(decoder) = any(decoder, self.nil)
+
+    # Decode a value from a given key in a hash.
+    #
+    # @example
+    #   decode(field('id', integer), { 'id' => 5 }) # => Decoding::Ok(5)
+    # @overload field(key, decoder)
+    #   @param key [Object]
+    #   @param decoder [Decoding::Decoder<a>]
+    #   @return [Decoding::Decoder<a>]
+    # @see Decoding::Decoders::Field
+    def field(...) = Decoders::Field.new(...)
+
+    # Decode an array of values using a given decoder.
+    #
+    # @example
+    #   decode(array(integer), [1, 2, 3]) # => Decoding::Ok([1, 2, 3])
+    # @overload array(decoder)
+    #   @param decoder [Decoding::Decoder<a>]
+    #   @return [Decoding::Decoder<Array<a>>]
+    # @see Decoding::Decoders::Array
+    def array(...) = Decoders::Array.new(...)
+
+    # Decode an array element by index using a given decoder.
+    #
+    # @example
+    #   decode(index(0, integer), [1, 2, 3]) # => Decoding::Ok(1)
+    # @overload index(integer, decoder)
+    #   @param index [Integer]
+    #   @param decoder [Decoding::Decoder<a>]
+    #   @return [Decoding::Decoder<a>]
+    # @see Decoding::Decoders::Index
+    def index(...) = Decoders::Index.new(...)
+
+    # Decode a Hash with arbitrary contents using two decoders for the keys and
+    # the pairs.
+    #
+    # @example
+    #   decode(hash(string, integer), { 'john' => 1 })
+    #   # => Decoding::Ok({ 'john' => 1 })
+    # @overload hash(key_decoder, value_decoder)
+    #   @param key_decoder [Decoding::Decoder<a>]
+    #   @param value_decoder [Decoding::Decoder<b>]
+    #   @return [Decoding::Decoder<Hash<a, b>>]
+    # @see Decoding::Decoders::Hash
+    def hash(...) = Decoders::Hash.new(...)
+
+    # Create a decoder that depends on a previously decoded value.
+    #
+    # @example
+    #   decoder = and_then(field("version", integer)) do |version|
+    #     if version == 1
+    #       field("name", string)
+    #     else
+    #       field("fullName", string)
+    #     end
+    #   end
+    #   decode(decoder, { "version" => 1, "name" => "john" })
+    #   # => Decoding::Ok("john")
+    #   decode(decoder, { "version" => 2, "fullName" => "john" })
+    #   # => Decoding::Ok("john")
+    # @overload and_then(deocder)
+    #   @param decoder [Decoding::Decoder<a>]
+    #   @yieldparam value [a]
+    #   @yieldreturn [Decoding::Decoder<b>]
+    #   @return [Decoding::Decoder<b>]
+    # @see Decoding::Decoders::AndThen
+    def and_then(...) = Decoders::AndThen.new(...)
+  end
+end

data/lib/decoding/result.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Decoding
+  # 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.
+  #
+  # The use of a result is the common interface provided to callers for
+  # transforming or chaining result values.
+  #
+  # @abstract
+  class Result
+    # Construct a new `Ok` value with the given `value`.
+    #
+    # @param value [a]
+    # @return [Decoding::Ok<a>]
+    def self.ok(value) = Ok.new(value)
+
+    # Construct a new `Err` value with the given `value`.
+    #
+    # @param value [a]
+    # @return [Decoding::Err<a>]
+    def self.err(value) = Err.new(value)
+
+    # Collapse array of result values into a single result, or return the
+    # first `Err` value.
+    #
+    # @example
+    #   all(Ok(1), Ok(2)) # => Ok([1, 2])
+    #   all(Ok(1), Err("error")) # => Err("error")
+    # @param results [Array<Result<a>>]
+    # @return [Result<a>]
+    def self.all(results)
+      results.reduce(ok([])) do |acc, el|
+        acc.and(el.to_result) { [*_1, _2] }
+      end
+    end
+
+    private_class_method :new
+
+    # @return [Object]
+    attr_reader :value
+
+    protected :value
+
+    # @private
+    attr_reader :hash
+
+    def initialize(value)
+      @value = value
+      @hash = [self.class, value].hash
+      freeze
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && value == other.value
+    end
+    alias == eql?
+
+    def inspect
+      "#<#{self.class} #{value.inspect}>"
+    end
+
+    # Whether this value is an `Ok` value.
+    #
+    # @return [Boolean]
+    def ok? = false
+
+    # Whether this value is an `Err` value.
+    #
+    # @return [Boolean]
+    def err? = false
+
+    # Extract the value out of a `Result` value. In case of an `Ok`, this
+    # returns the result's value. In case of an `Err`, the given `default_value`
+    # is returned.
+    #
+    # @param default_value [Object]
+    # @return [Object]
+    def unwrap(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.
+    #
+    # @example
+    #   Result.ok(123).map { |i| i * 2 } # => Ok(246)
+    #   Result.err("error").map { |i| i * 2 } # => Err("error")
+    # @yieldparam value [a]
+    # @yieldreturn [b]
+    # @return [Decoding::Result<b>]
+    def map = self
+
+    # Create a new `Result` value for the result of the block applied to this
+    # result's `value`. `Ok` values are returned as-is.
+    #
+    # @example
+    #   Result.ok(123).map { |s| s.upcase } # => Ok(123)
+    #   Result.err("error").map { |s| s.upcase } # => Err("ERROR")
+    # @yieldparam value [a]
+    # @yieldreturn [b]
+    # @return [Decoding::Result<b>]
+    def map_err = self
+
+    # Combine two `Result` values if they are both `Ok` using the given block, or
+    # return the first `Err` value.
+    #
+    # @overload and(other)
+    #   @param other [Decoding::Result<a>]
+    #   @yieldparam left [Object]
+    #   @yieldparam right [Object]
+    #   @yieldreturn [c]
+    #   @return [Decoding::Result<c>]
+    def and(_) = self
+
+    # Transform a result using a block that will also return a result.
+    #
+    # @yieldparam value [Object]
+    # @yieldreturn [Decoding::Result<a>]
+    # @return [Decoding::Result<a>]
+    def and_then = self
+
+    def to_result = self
+  end
+
+  # The `Ok` value represents the result of a successful computation.
+  #
+  # @see Decoding::Err
+  class Ok < Result
+    public_class_method :new
+
+    def ok? = true
+    def unwrap(_) = value
+    def map = self.class.new(yield value)
+
+    def and(other)
+      return other unless other.is_a?(self.class)
+
+      self.class.new(yield value, other.value)
+    end
+
+    def and_then = yield(value).to_result
+  end
+
+  # The `Err` value represents the result of an unsuccessful computation.
+  #
+  # @see Decoding::Err
+  class Err < Result
+    public_class_method :new
+
+    def err? = true
+    def map_err = self.class.new(yield value)
+  end
+end

data/lib/decoding/version.rb

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

data/lib/decoding.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require_relative "decoding/version"
+require_relative "decoding/decoders"
+
+# 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
+# value. After passing it through decoder, you will have a value with a known
+# shape -- or a sensible error message.
+#
+# For example, call an API to get some JSON value:
+#
+#     body = JSON.parse(Net::HTTP.get("https://api.placeholderjson.dev/shipments/7EBWXB5"))
+#
+# How do you safely work with `body`? If parsing the response body as JSON has
+# worked, you know you have some kind of Ruby value -- but you're not sure of
+# its structure. This can lead to cryptic error messages far removing of making
+# this HTTP call where values are of unexpected types, hashes turn out not to
+# have certain keys or the nesting of data is different from what you expected.
+#
+# Assume the response body, parsed as JSON, results in a value like this:
+#
+#     {
+#       "orderID" => "7EBWXB5",
+#       "orderDate" => "1595674680",
+#       "estimatedDeliveryDate" => "1596365935",
+#       "deliveryDate" => null,
+#       "delayed" => false,
+#       "status" => {
+#         "orderPlaced" => true,
+#         "orderShipped" => true,
+#         "outForDelivery" => true,
+#         "orderDelivered" => false
+#       }
+#     }
+#
+# We can use decoders to extract exactly those pieces from this payload that we need,
+# making assertions along the way of what the data looks like and generating helpful errors
+# when reality does not match our expectations.
+#
+# For example, we could parse the above payload like so:
+#
+#     Order = Data.define(:id, :date, :status)
+#     D = Decoding::Decoders
+#     order_decoder = D.map(
+#       D.field("orderID", D.string),
+#       D.map(D.field("orderDate", D.string)) { Time.at(_1.to_i) },
+#       D.hash(D.string, D.boolean)
+#     ) { Order.new(*args) }
+#     Decoding.decode(order_decoder, body)
+#     # => Decoding::Ok(#<data Order
+#       id: '7EBWXB5',
+#       date: 2020-07-25 12:58:00 +0200,
+#       status: {"orderPlaced"=>true,"orderShipped"=>true,"outForDelivery"=>true,"orderDelivered"=>false}>)
+#
+# Decoders take an input value and generate an output value from it. There are
+# decoders for basic Ruby types, compound types such as arrays and hashes,
+# decoders for trying out various decoders and, finally, there is the `map`
+# decoder for decoding one or more output values from a given input value and
+# applying a transformation to them with a block. All these decoders can be
+# composed together into new, more complex decoders.
+#
+# A decoder is, in essence, a function that returns a result based on an input value. Consider
+# how, roughly, the `string` decoder is implemented:
+#
+#     string_decoder = ->(input_value) do
+#       if input_value.is_a?(String)
+#         Decoding::Result.ok(input_value)
+#       else
+#         Decoding::Result.err("expected String, got #{input_value.class}")
+#       end
+#     end
+#
+# You can use the base decoders along with `map` to write more complex decoder. For example, you could
+# extract a `time_decoder` from the example above:
+#
+#     time_decoder = D.map(D.string) { Time.at(_1.to_i) }
+#
+# When the shape of the incoming data is unknown, you can try out various
+# decoders in a row to find the first that succeeds using `any`:
+#
+#     string_or_integer = D.any(D.string, D.integer)
+#     Decoding.decode(string_or_integer, 1) # => Decoding::Ok(1)
+#     Decoding.decode(string_or_integer, '1') # => Decoding::Ok('1')
+#
+# You can also base one decoder on a previously decoded value. For example, a
+# payload might contain a version number describing its format. Use `and_then`
+# to decode one value and then construct a new decoder to run against the same
+# input using that value:
+#
+#     multiple_version_decoder = D.and_then(D.field("version", D.string)) do |version|
+#       if version == "1"
+#         D.field("name", D.string)
+#       else
+#         D.field("fullName", D.string)
+#       end
+#     end
+#
+# Now, you have a decoder that can work inputs using format version 1 and 2:
+#
+#     Decoding.decode(multiple_version_decoder, "version" => "1", "name" => "John")
+#     # => "John"
+#     Decoding.decode(multiple_version_decoder, "version" => "2", "fullName" => "Paul")
+#     # => "Paul"
+#
+# The return values of decoding are `Decoding::Result` values, which come in
+# `Ok` and `Err` subclasses. These describe how the decoding either succeeded or
+# failed. The `Ok` values contain the decoded result, while the `Err` values
+# always contain a string error message. It is up to you, as a developer, to
+# decide how to deal with unsuccessful decoding.
+module Decoding
+  class Error < StandardError; end
+
+  module_function
+
+  # Run a given `decoder` on the given input `value`.
+  #
+  # @param decoder [Decoding::Decoder<a>]
+  # @param value [Object]
+  # @return [Decoding::Result<a>]
+  def decode(decoder, value) = decoder.call(value)
+end

data/sig/decoding.rbs

@@ -0,0 +1,4 @@
+module Decoding
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: decoding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- arjan@arjanvandergaag.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/decoding.rb
+- lib/decoding/decoder.rb
+- lib/decoding/decoders.rb
+- lib/decoding/decoders/and_then.rb
+- lib/decoding/decoders/any.rb
+- lib/decoding/decoders/array.rb
+- lib/decoding/decoders/field.rb
+- lib/decoding/decoders/hash.rb
+- lib/decoding/decoders/index.rb
+- lib/decoding/decoders/map.rb
+- lib/decoding/decoders/match.rb
+- lib/decoding/result.rb
+- lib/decoding/version.rb
+- sig/decoding.rbs
+homepage: https://github.com/avdgaag/decoding
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/avdgaag/decoding
+  source_code_uri: https://github.com/avdgaag/decoding
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Decode dynamic values into known Ruby data structures
+test_files: []