mona-result 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32cb8667c98ff681514f079fed657c8daa835b7c480f2e28c0524892408c81e7
-  data.tar.gz: 741a2b69c33f10b9ec8fad3c25aeb49d6b7dd6f9178824819d933f34b2b5db38
+  metadata.gz: 74a4d1f256317d8a2675c58dc8c5b52822987f3d7f05473042ce617828c9a78d
+  data.tar.gz: 278922b075a71ab08d07756e8b46c8cdafa2b11c390e489c9875d482039664d9
 SHA512:
-  metadata.gz: 96e77b201ec66ee70f9aa84ff8b7aba988233c210e5cebb1157832c53f3c116f7ecf12f069dc29c4ae3514ed9f9007a0458e1824c2d3b45263ec7487f9bd0057
-  data.tar.gz: c359b0d6b6782297c3ebebea9e0d241d7646ccb3c44873c8d087567681ed3fb6ff58d827f6d0af9a97516d57e74410d754b47222c6b895440f9b15133b139faa
+  metadata.gz: 8319264ee1391c3244626af638c33b575156b17db884984214d140069cf3ae1f5f28bcbf20b5e222537d24b895a36b75b65e656d74645999d01a6b16153e52d2
+  data.tar.gz: 8457dbf1772ac1b536b1026cb1cb241456a2fdb27fbbf22e178937d01816921289e825cb1a0f4172629c305ce23ec4f1c89dcbb16f0d9e71fcaf39d0d85588af

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## [0.1.1]
+## [0.1.2] - 2022-08-09
+
+- Fix gemspec links
+- Improve documentation
+
+## [0.1.1] - 2022-08-09
 
 - Adds basic documentation
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mona-result (0.1.1)
+    mona-result (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -36,12 +36,17 @@ failure.failure # => 4
 failure.reason # => :not_prime
 failure.and_tap { puts "it is #{_1}" }.and_then { _1 * 5 }.value_or { :nope } # => :nope
 
-# Dict with sequence
+# Dict with sequence, example using a fictional repository.
+# #set can take a [Symbol, Symbol] key argument where left is OK key, right is Err key
 result = Result.dict do |d|
-  d.set :numerator, 10
-  d.set :divisor, 2
-  d.set :answer, d[:numerator] / d[:divisor]
-end # => #<OK {:numerator=>10, :divisor=>2, :answer=>5}>
+  d.set :user, UserRepo.find user_id
+  d.set :input, PostInput.valid(attributes)
+  d.set [:post, :input], PostRepo.create user_id: user_id, **d[:input]
+end
+# if find user fails:  # => #<Err {:user=>NotFoundError} reason: :not_found, key: :user>
+# if validation fails: # => #<Err {:user=>User, :input=>PostInput(invalid)} reason: :invalid, key: :input>
+# if create fails:     # => #<Err {:user=>User, :input=>PostInput(db err)} reason: :db_err, key: :input>
+# if all ok:           # => #<OK: {:user=>User, :post=>Post}>
 
 # Action - a callable sequence
 divide = Result.action do |x, y|
@@ -78,6 +83,20 @@ in err:, reason:, **meta
 end
 ```
 
+You can also match a result, using similar semantics, the difference from using case/pattern-match is that a
+`Mona::Result::NoMatchError` is raised, which keeps a reference to the result (which is useful for differentially
+handling errors in an enclosing scope - not currently possible with ruby's `NoMatchingPatternError` which does not
+contain any information about the failed match)
+
+```ruby
+Mona::Result.match(result) do |on|
+  on.ok            { |value| puts "ok" }
+  on.err(key: :x)  { |failure, reason, **meta| puts "error with meta :key => :x" }
+  on.err(:invalid) { |failure, reason, **meta| puts "error with reason :invalid" }
+  on.err           { |failure, reason, **meta| puts "error" }
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/mona/result/version.rb

@@ -2,6 +2,6 @@
 
 module Mona
   module Result
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mona-result
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ian White
@@ -35,14 +35,14 @@ files:
 - lib/mona/result/sequence.rb
 - lib/mona/result/version.rb
 - sig/mona/result.rbs
-homepage: https://github.com/mona/mona-result
+homepage: https://github.com/mona-rb/mona-result
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  homepage_uri: https://github.com/mona/mona-result
-  source_code_uri: https://github.com/mona/mona-result
-  changelog_uri: https://github.com/mona/mona-result/CHANGELOG.md
+  homepage_uri: https://github.com/mona-rb/mona-result
+  source_code_uri: https://github.com/mona-rb/mona-result
+  changelog_uri: https://github.com/mona-rb/mona-result/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: