sums_up 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2abe6b0d49df01a5e9c588600079c91e3927c81501eb7816a0e6615a0579e00
-  data.tar.gz: 9d18cf08079f9508c53a41e8fc97707346de0e36ab2d27c55089322e61b84bed
+  metadata.gz: b738f32804f828e44cb44a935122653f979279de6d7b69b1818bd29aace58775
+  data.tar.gz: 7549c23eeb68eed7e11f3ac00e4ccab39f7f5efebea5fabc7c5422871ba3141e
 SHA512:
-  metadata.gz: 3efb1c7fd3c3e0c92f17aa0f2d92fa344f802be872785836e401c5a9f88f1d090b135542c11cd9a23aa1b158c0072b789eee47bf56aae328198395358f08223b
-  data.tar.gz: 74c83c4a9f6efa3ba3a6466da3f02f9a064af367ee59b94ba6566cb270f1d4a7cdeea6b54c8d9af1d60038accf258cbf9426bf3d262e3a623b0758e8313ded27
+  metadata.gz: '0459d08b4c857ce4fd23ec3fb8983591284519dc67aa65a9ba262467cb8e8d5749e4a47e9f29e39f55b68b49534ec80bd1c91e6b5c873d94c225779ee7b0f1de'
+  data.tar.gz: 85cb701af891be51103a3be3cef418f6419e656288d2fc764ef244b7a559091cb7e640e1042c3ae30def6c30a79432d418cb120c339f5983d5e4e4882d44086d

data/.rubocop.yml

@@ -21,6 +21,9 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Enabled: false
 
+Style/ExplicitBlockArgument:
+  Enabled: false
+
 # Disabling for now to support Ruby 2.3.
 Style/HashTransformValues:
   Enabled: false

data/README.md

@@ -2,7 +2,7 @@
 
 Sum types for Ruby with zero runtime dependencies. Inspired by [hojberg/sums-up](https://github.com/hojberg/sums-up).
 
-[![Build Status](https://travis-ci.org/nahiluhmot/sums_up.svg?branch=main)](https://travis-ci.org/nahiluhmot/sums_up)
+[![Build Status](https://travis-ci.com/nahiluhmot/sums_up.svg?branch=main)](https://travis-ci.com/nahiluhmot/sums_up)
 [![Gem Version](https://badge.fury.io/rb/sums_up.svg)](https://badge.fury.io/rb/sums_up)
 
 * [What is a Sum Type?](#what-is-a-sum-type)
@@ -631,6 +631,23 @@ SumsUp::Maybe.of(false)
 # => #<variant SumsUp::Maybe::Just value=false>
 ```
 
+`SumsUp::Maybe#chain` (and its alias, `#flat_map`) can compose blocks which return `SumsUp::Maybe`s, halting at the first `SumsUp::Maybe.nothing`:
+
+```ruby
+def double_if_odd(n)
+  SumsUp::Maybe
+    .just(n)
+    .chain { |x| x.odd? ? SumsUp::Maybe.just(x) : SumsUp::Maybe.nothing }
+    .chain { |x| SumsUp::Maybe.just(x * 2) }
+end
+
+double_if_odd(3)
+# => #<variant SumsUp::Maybe::Just value=6>
+
+double_if_odd(42)
+# => #<variant SumsUp::Maybe::Nothing>
+```
+
 `SumsUp::Maybe#map` applies a function to the value if it's present:
 
 ```ruby
@@ -712,6 +729,50 @@ SumsUp::Result.from_block { raise 'unexpected error' }
 
 SumsUp::Result.from_block { 'good result' }
 # => #<variant SumsUp::Result::Success value="good result">
+
+SumsUp::Result.from_block(ArgumentError) { raise ArgumentError, 'bad argument' }
+# => #<variant SumsUp::Result::Failure error=#<ArgumentError: Bad argument>
+
+SumsUp::Result.from_block(ArgumentError) { raise KeyError, 'no such key' }
+# => KeyError: no such key
+```
+
+`SumsUp::Result#chain` (and its alias, `#flat_map`) can compose blocks which return `SumsUp::Result`s, halting at the first `SumsUp::Result.failure(...)`:
+
+```ruby
+User = Struct.new(:name, :email)
+
+def parse_user(hash)
+  fetch_key(hash, :name).chain do |name|
+    fetch_key(hash, :email).chain do |email|
+      if URI::MailTo::EMAIL_REGEXP.match?(email)
+        SumsUp::Result.success(User.new(name, email))
+      else
+        SumsUp::Result.failure("invalid email: #{email}")
+      end
+    end
+  end
+end
+
+def fetch_key(hash, key)
+  if hash.key?(key)
+    SumsUp::Result.success(hash[key])
+  else
+    SumsUp::Result.failure("key not found: #{key}")
+  end
+end
+
+parse_user(email: '1337h@ck.er')
+# => #<variant SumsUp::Result::Failure error="key not found: name">
+
+parse_user(name: 'Sam')
+# => #<variant SumsUp::Result::Failure error="key not found: email">
+
+parse_user(name: 'Sam', email: '1337h@ck.er')
+# => #<variant SumsUp::Result::Success value=#<struct User name="Sam", email="1337h@ck.er">>
+
+parse_user(name: 'Sam', email: '1337hacker')
+# => #<variant SumsUp::Result::Failure error="invalid email: 1337hacker">
 ```
 
 `SumsUp::Result#map` applies a function to the successful values:

data/lib/sums_up/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## vX.Y.Z
+
+## v1.2.0
+
+* Define `SumsUp::{Maybe,Result}#{chain,flat_map}`
+* `SumsUp::Result#from_block` now accepts an optional `Class` argument
+
 ## v1.1.0
 
 * Support rubies as low as 2.3

data/lib/sums_up/maybe.rb

@@ -17,6 +17,15 @@ module SumsUp
       end
     end
 
+    def chain
+      match do |m|
+        m.just { |value| yield(value) }
+        m.nothing self
+      end
+    end
+
+    alias_method(:flat_map, :chain)
+
     # Map a function across the Maybe. If present, the value is yielded and that
     # result is wrapped in a new Maybe.just. Returns Maybe.nothing otherwise.
     def map

data/lib/sums_up/result.rb

@@ -11,12 +11,21 @@ module SumsUp
   Result = SumsUp.define(failure: :error, success: :value) do
     # Yield, wrapping the result in Result.success, or wrap the raised error
     # in Result.failure.
-    def self.from_block
+    def self.from_block(error_class = StandardError)
       success(yield)
-    rescue StandardError => e
+    rescue error_class => e
       failure(e)
     end
 
+    def chain
+      match do |m|
+        m.success { |value| yield(value) }
+        m.failure self
+      end
+    end
+
+    alias_method(:flat_map, :chain)
+
     # Map a function across the successful value (if present).
     def map
       match do |m|

data/lib/sums_up/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SumsUp
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sums_up
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tom Hulihan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry