mangrove 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9289ae193acf40ac02f9fd2c1abfaa21e9a2eaa99367ba37f12508fe86b37b7a
-  data.tar.gz: 21c2c5271f29b8b93bb7f9658c03c6edfb213d12eb02a8b06b0e520e75ab825a
+  metadata.gz: d918f24a3f566f944a31d9eac30ab5f4924c69260ac95977cca466fb758f32fa
+  data.tar.gz: 6a2f8b8dc58cbb9a3b51d79834cd0a342671dbc5c4d870ae238bd756f6c2fe12
 SHA512:
-  metadata.gz: 7bfa222f9fa0e262315f6cd30fd0e1798222450abc14fbb5aa442d2027c58e19e906a37a88f4f2018359c979272d61f05741327beb7f36b216047176ade02ba3
-  data.tar.gz: 7be4b82b310e40005f171ee72f2513fa70e4e19038513814c7d0195c0c50aa51e720b5a82ec1dd15b8066197461c5f93b0e8fe16d87c572cb37b9c9b007ee545
+  metadata.gz: fc901c133dd8b64466ab1f5a900f2469e17564cb5a7e7b7db13e3714f094dd400877ed214383500229d3e98d51c457427044df78afbc28a96b48fba29e6e91cb
+  data.tar.gz: 890c8fbd972e5c2b87e6ffde50eda4b98c45105419fd43abac76644781bcb4f5dd8d2ee736877f2a4198c0a068a0b2732a89fb40c5607ced5fc5ac7897208ed6

data/.rubocop.yml

@@ -9,6 +9,9 @@ Layout/FirstArrayElementIndentation:
 Layout/LineLength:
   Enabled: false
 
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -27,6 +30,13 @@ Metrics/ModuleLength:
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 
+Style/BlockDelimiters:
+  EnforcedStyle: always_braces
+  AllowedMethods:
+  - describe
+  - context
+  - it
+
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -1,5 +1,35 @@
 # Mangrove
-Mangrove provides utility types to use with Sorbet
+Mangrove provides type utility to use with Sorbet.
+
+You can do something like this with the gem.
+
+```ruby
+class MyClass
+  extend T::Sig
+
+  include Mangrove::ControlFlow::Handler
+
+  sig { params(numbers: T::Enumerable[Integer]).returns(Mangrove::Result[T::Array[Integer], String]) }
+  def divide_arguments_by_3(numbers)
+    divided_nubmers = numbers
+      .map { |number|
+        if number % 3 == 0
+          Mangrove::Result::Ok.new(number / 3)
+        else
+          Mangrove::Result::Err.new("number #{number} is not divisible by 3")
+        end
+      }
+      .map(&:unwrap!)
+
+    Mangrove::Result::Ok.new(divided_nubmers)
+  end
+end
+
+expect(MyClass.new.divide_arguments_by_3([3, 4, 6])).to eq Mangrove::Result::Err.new("number 4 is not divisible by 3")
+expect(MyClass.new.divide_arguments_by_3([3, 6, 9])).to eq Mangrove::Result::Ok.new([1, 2, 3])
+```
+
+Other examples are available at [`spec/**/**_spec.rb`](https://github.com/kazzix14/mangrove/tree/main/spec).
 
 ## Features
 Most features are not implemented.
@@ -10,27 +40,40 @@ Most features are not implemented.
   - [x] Auto propagation like Rust's `?` (formerly `try!`)
 - [ ] Builder type (Not implemented)
   - [ ] Auto Implementation
-
-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/mangrove`. To experiment with that code, run `bin/console` for an interactive prompt.
+- [ ] TODO
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` 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 UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```
+bundle add mangrove
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Documentation is available [here](https://kazzix14.github.io/mangrove/).
+For more concrete examples, see [`spec/**/**_spec.rb`](https://github.com/kazzix14/mangrove/tree/main/spec).
+
+```ruby
+Mangrove::Result[OkType, ErrType]
+Mangrove::Result::Ok[OkType, ErrType]
+Mangrove::Result::Err[OkType, ErrType]
+Mangrove::Option[InnerType]
+Mangrove::Option::Some[InnerType]
+Mangrove::Option::None[InnerType]
+
+my_ok = Result::Ok.new("my value")
+my_err = Result::Err.new("my err")
+my_some = Option::Some.new(1234)
+my_none = Option::None.new
+
+# Including this Module into your class appends rescue clause into its methods. Results to `Option#unwrap!` and `Result#unwrap!` propagates to calling method like Ruet's `?` operator.
+# https://doc.rust-lang.org/reference/expressions/operator-expr.html#the-question-mark-operator
+include Mangrove::ControlFlow::Handler
+```
 
 ## Commands
 ```
+git config core.hooksPath hooks
 bundle exec tapioca init
 bundle exec tapioca gems
 bundle exec tapioca dsl
@@ -41,6 +84,7 @@ bundle exec rubocop -DESP
 bundle exec srb typecheck
 bundle exec ordinare --check
 bundle exec ruboclean
+bundle exec yardoc -o docs/ --plugin yard-sorbet
 rake build
 rake release
 ```
@@ -53,4 +97,4 @@ 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]/mangrove.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kazzix14/mangrove.

data/Rakefile

@@ -3,12 +3,25 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-task :check do
+task(:check) {
   system("bundle exec ordinare --check") &&
     system("bundle exec rubocop -DESP") &&
     system("bundle exec tapioca check-shims") &&
     system("bundle exec srb typecheck") &&
-    system("bundle exec rspec -f d")
-end
+    system("bundle exec rspec -f d") &&
+    # check doc version
+    system(
+      <<~SHELL
+        gem_version=`bundle info mangrove | grep -o '[0-9]\\+\\.[0-9]\\+\\.[0-9]\\+'`
+        doc_version=`grep 'VERSION =' docs/Mangrove.html -A 5 | grep -o '[0-9]\\+\\.[0-9]\\+\\.[0-9]\\+'`
+
+        if [ "$gem_version" = "$doc_version" ]; then
+          exit 0
+        else
+          exit 1
+        fi
+      SHELL
+    )
+}
 
 task default: :check

data/docs/Mangrove/ControlFlow/ControlSignal.html

@@ -0,0 +1,223 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Mangrove::ControlFlow::ControlSignal
+  
+    &mdash; Documentation by YARD 0.9.34
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Mangrove::ControlFlow::ControlSignal";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Mangrove.html" title="Mangrove (module)">Mangrove</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../ControlFlow.html" title="Mangrove::ControlFlow (module)">ControlFlow</a></span></span>
+     &raquo; 
+    <span class="title">ControlSignal</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: Mangrove::ControlFlow::ControlSignal
+  <span class="abstract note title">Abstract</span>
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  <dl>
+      <dt>Extended by:</dt>
+      <dd>T::Helpers, T::Sig</dd>
+  </dl>
+  
+  
+  
+  
+
+  
+  <dl>
+    <dt>Included in:</dt>
+    <dd><span class='object_link'><a href="../Option/ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">Option::ControlSignal</a></span>, <span class='object_link'><a href="../Result/ControlSignal.html" title="Mangrove::Result::ControlSignal (class)">Result::ControlSignal</a></span></dd>
+  </dl>
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/mangrove/control_flow/control_signal.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This module is abstract.</strong>
+  <div class='inline'>
+<p>Subclasses must implement the ‘abstract` methods below.</p>
+</div>
+</div>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#inner_value-instance_method" title="#inner_value (instance method)">#<strong>inner_value</strong>  &#x21d2; T.untyped </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  <span class="abstract note title">abstract</span>
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+  
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="inner_value-instance_method">
+  
+    #<strong>inner_value</strong>  &#x21d2; <tt>T.untyped</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'></div>
+</div>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>T.untyped</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/control_flow/control_signal.rb', line 13</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_inner_value'>inner_value</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Aug 31 15:04:25 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.2.2).
+</div>
+
+    </div>
+  </body>
+</html>