mona-result 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 170acae8e3dab4e7c9dec3b88b17cb8668a678290aafa5eb363da54261a5eab9
-  data.tar.gz: 0b327151acf8487019f87f5b859b1f940d766e67c84479c29ef1a70a4d26aeb1
+  metadata.gz: 32cb8667c98ff681514f079fed657c8daa835b7c480f2e28c0524892408c81e7
+  data.tar.gz: 741a2b69c33f10b9ec8fad3c25aeb49d6b7dd6f9178824819d933f34b2b5db38
 SHA512:
-  metadata.gz: 45ca05476a2621a4d6e76a190b37852880b9c69d43470ec77ed5dc9dabf7ec9f6cbe9771777adc369f69ce421e8297f2e5c5ee66df8bf43b12c62d1e0ce3c53d
-  data.tar.gz: 59684cbea28ce2392a1755edb70c9756786b1bf730900e5aaf0829a3a4a068a0742c6db907e3720d4533ff17ff57a2c7b5a72e7dd5d1364c4acfd4f6a4bafd80
+  metadata.gz: 96e77b201ec66ee70f9aa84ff8b7aba988233c210e5cebb1157832c53f3c116f7ecf12f069dc29c4ae3514ed9f9007a0458e1824c2d3b45263ec7487f9bd0057
+  data.tar.gz: c359b0d6b6782297c3ebebea9e0d241d7646ccb3c44873c8d087567681ed3fb6ff58d827f6d0af9a97516d57e74410d754b47222c6b895440f9b15133b139faa

data/.rubocop.yml

@@ -1,3 +1,7 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
 AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.1.1]
+
+- Adds basic documentation
 
 ## [0.1.0] - 2022-08-04
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mona-result (0.1.0)
+    mona-result (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -33,14 +33,14 @@ GEM
     rbs (2.6.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.33.0)
+    rubocop (1.34.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.19.1, < 2.0)
+      rubocop-ast (>= 1.20.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)

data/README.md

@@ -1,8 +1,8 @@
 # Mona::Result
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mona/result`. To experiment with that code, run `bin/console` for an interactive prompt.
+Provides a result monad, with OK holding a value, and Err holding a failure, with optional reason, and metadata.
 
-TODO: Delete this and the text above, and describe your gem
+Also provides a dict result monad, a hash-like result, which provides `#sequence` whose semantics mirror _do notation_
 
 ## Installation
 
@@ -16,7 +16,67 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Result = Mona::Result
+
+# basic OK
+success = Result.ok(1) # => #<OK 1>
+success.ok? # => true
+success.err? # => false
+success.value # => 1
+success.and_tap { puts "it is #{_1}" }.and_then { _1 * 5 }.value_or { :nope }
+# OUT: it is 1
+# => 5
+
+# basic Err
+failure = Result.err(4, :not_prime) # => #<Err 4 reason: :not_prime>
+failure.ok? # => false
+failure.err? # => true
+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
+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}>
+
+# Action - a callable sequence
+divide = Result.action do |x, y|
+  set :numerator, x
+  set :divisor, y.zero? ? Result.err(y, :is_zero) : y
+  puts "ready to calculate answer"
+  set :answer, numerator / divisor
+  puts "answer was: #{answer}"
+end
+
+divide.call(12, 4)
+# OUT: ready to calculate answer
+# OUT: answer was: 3
+# => #<OK {:numerator=>12, :divisor=>4, :answer=>3}>
+
+result = divide.call(12, 0) # => #<Err {:numerator=>12, :divisor=>0} reason: :is_zero, key: :divisor>
+result.err? # => true
+result.failure # => {:numerator=>12, :divisor=>0}
+result.reason # => :is_zero
+result.meta # => {:key=>:divisor}
+```
+
+Pattern matching is supported in the following way:
+
+```ruby
+case result
+in :ok, value
+in :err, failure, reason, { **meta }
+end
+
+case result
+in ok:
+in err:, reason:, **meta
+end
+```
 
 ## Development
 
@@ -26,7 +86,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mona-result.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mona-rb/mona-result.
 
 ## License
 

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+desc "Run steep check"
 task :steep do
   system "steep check" or raise "Steep type checking failed"
 end

data/lib/mona/result/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mona-result
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ian White
@@ -10,7 +10,7 @@ bindir: exe
 cert_chain: []
 date: 2022-08-09 00:00:00.000000000 Z
 dependencies: []
-description: Mona::Result provides a result monad, and dict_result monad
+description: Mona::Result provides a result monad, and dict result monad with do-notation
 email:
 - ian.w.white@gmail.com
 executables: []
@@ -61,5 +61,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Mona::Result is a result Monad for ruby
+summary: Mona::Result is a result monad for ruby
 test_files: []