mangrove 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f08bb435ea573ede01749ec506f16e5d81bc7c0fd9ee3ac3e92934937147a27
-  data.tar.gz: db95dc470d4978d96289dd98abfd6d42afde618f53d42e62a95e431bb71a8ec1
+  metadata.gz: 3ade560b0dc327319be4fee46607f4b03375d6672b19955bfc7e024a425868d3
+  data.tar.gz: 913c9ce80834cf53e653d1d7bbcfb0213e0cc21435eb4a3acd741ffcacc0ada6
 SHA512:
-  metadata.gz: 4a7687933e307aecffffa7bd5749074dfb957244faa7ab24aabe43ebaaf56eef7e2d186217bd9402bc2828ca0f03d0a4ceb71b8fd1696baf097fbd8575960147
-  data.tar.gz: c34f26429cefd1fd1640dd4efab1bc4160e581f43c0fe04a6c833de4d4fd19c406235bb6fcf52759ccecf83ff1ac16e00bf14144a007f204ab131b6cfaae8bce
+  metadata.gz: b39ce6a6a8dde42e1581d553e8f0019aa14273a608a62e612e95138e820cda90621a7ba754a5078a8774ebcf463b134d44be6c5253852fc3b7ef4a22310edeb1
+  data.tar.gz: 4a735957cb30d9419fb407d64d281d6bc8711c60079566b3b866528d9a2d582e57acaadd9da223954e4444f11527f3c4cac06fcf456cd77f079f1175ae67eb31

data/README.md

@@ -3,30 +3,30 @@ Mangrove provides type utility to use with Sorbet.
 
 You can do something like this with the gem.
 
+use `rubocop-mangrove`` to statically check rescuing ControlSignal is done
+
 ```ruby
-class MyClass
+class TransposeExample
   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
+    Mangrove::Result.from_results(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)
+      })
+  rescue ::Mangrove::ControlFlow::ControlSignal => e
+    Mangrove::Result::Err.new(e.inner_value)
   end
 end
+# rubocop:enable Lint/ConstantDefinitionInBlock
 
-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])
+expect(TransposeExample.new.divide_arguments_by_3([3, 4, 5])).to eq Mangrove::Result::Err.new(["number 4 is not divisible by 3", "number 5 is not divisible by 3"])
+expect(TransposeExample.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).
@@ -34,9 +34,9 @@ Other examples are available at [`spec/**/**_spec.rb`](https://github.com/kazzix
 ## Features
 Most features are not implemented.
 
-- [x] Option Type (Partially Implemented)
-- [x] Result Type (Partially Implemented)
-- [ ] Builder type (Not implemented)
+- [x] Option Type
+- [x] Result Type
+- [ ] Builder Type Factory
   - [ ] Auto Implementation
 - [ ] TODO
 

data/docs/Mangrove/ControlFlow/ControlSignal.html

@@ -213,7 +213,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 12 17:51:33 2023 by
+  Generated on Wed Oct 18 11:45:16 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>

data/docs/Mangrove/ControlFlow.html

@@ -69,11 +69,6 @@
 
   
   
-  <dl>
-      <dt>Extended by:</dt>
-      <dd>T::Sig</dd>
-  </dl>
-  
   
   
   
@@ -83,9 +78,7 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/mangrove/control_flow/rewriter.rb<span class="defines">,<br />
-  lib/mangrove/control_flow/control_signal.rb</span>
-</dd>
+    <dd>lib/mangrove/control_flow/control_signal.rb</dd>
   </dl>
   
 </div>
@@ -98,8 +91,6 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ControlFlow/Rewriter.html" title="Mangrove::ControlFlow::Rewriter (class)">Rewriter</a></span>
-    
   
 </p>
 
@@ -109,131 +100,12 @@
 
 
 
-  
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#impl!-class_method" title="impl! (class method)">.<strong>impl!</strong>(method_to_be_rewritten)  &#x21d2; String </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'></div></span>
-  
-</li>
-
-      
-    </ul>
-  
-
-
-  
-
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="impl!-class_method">
-  
-    .<strong>impl!</strong>(method_to_be_rewritten)  &#x21d2; <tt>String</tt> 
-  
-
-  
 
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-  
-    <li>
-      
-        <span class='name'>method_to_be_rewritten</span>
-      
-      
-        <span class='type'>(<tt>Method</tt>, <tt>UnboundMethod</tt>)</span>
-      
-      
-      
-    </li>
-  
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-  
-    <li>
-      
-      
-        <span class='type'>(<tt>String</tt>)</span>
-      
-      
-      
-    </li>
-  
-</ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-16
-17
-18
-19
-20
-21
-22
-23
-24</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/control_flow/rewriter.rb', line 16</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_impl!'>impl!</span><span class='lparen'>(</span><span class='id identifier rubyid_method_to_be_rewritten'>method_to_be_rewritten</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_line_number'>line_number</span> <span class='op'>=</span> <span class='id identifier rubyid_method_to_be_rewritten'>method_to_be_rewritten</span><span class='period'>.</span><span class='id identifier rubyid_source_location'>source_location</span>
-
-  <span class='id identifier rubyid_source'>source</span> <span class='op'>=</span> <span class='id identifier rubyid_method_to_be_rewritten'>method_to_be_rewritten</span><span class='period'>.</span><span class='id identifier rubyid_source'>source</span>
-  <span class='id identifier rubyid_ast'>ast</span> <span class='op'>=</span> <span class='const'>Parser</span><span class='op'>::</span><span class='const'>CurrentRuby</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_source_buffer'>source_buffer</span> <span class='op'>=</span> <span class='const'>Parser</span><span class='op'>::</span><span class='const'>Source</span><span class='op'>::</span><span class='const'>Buffer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_filename'>filename</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_line_number'>line_number</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>source:</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_rewriter'>rewriter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ControlFlow/Rewriter.html" title="Mangrove::ControlFlow::Rewriter (class)">Rewriter</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='id identifier rubyid_rewriter'>rewriter</span><span class='period'>.</span><span class='id identifier rubyid_rewrite'>rewrite</span><span class='lparen'>(</span><span class='id identifier rubyid_source_buffer'>source_buffer</span><span class='comma'>,</span> <span class='id identifier rubyid_ast'>ast</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
 
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 12 17:51:33 2023 by
+  Generated on Wed Oct 18 11:45:16 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>

data/docs/Mangrove/Option/ControlSignal.html

@@ -424,7 +424,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 12 17:51:34 2023 by
+  Generated on Wed Oct 18 11:45:16 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>

data/docs/Mangrove/Option/None.html

@@ -190,6 +190,28 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#expect_with!-instance_method" title="#expect_with! (instance method)">#<strong>expect_with!</strong>(&amp;block)  &#x21d2; InnerType </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -423,20 +445,20 @@
       <pre class="lines">
 
 
-107
-108
-109
-110
-111
 112
 113
 114
 115
 116
-117</pre>
+117
+118
+119
+120
+121
+122</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 107</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 112</span>
 
 <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id identifier rubyid_other'>other</span>
@@ -519,15 +541,95 @@
       <pre class="lines">
 
 
-130
-131
-132</pre>
+135
+136
+137</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 130</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 135</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_expect!'>expect!</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Option.html" title="Mangrove::Option (module)">Option</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Result/Err.html" title="Mangrove::Result::Err (class)">Err</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Result/Err.html#initialize-instance_method" title="Mangrove::Result::Err#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Option.html" title="Mangrove::Option (module)">Option</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="expect_with!-instance_method">
+  
+    #<strong>expect_with!</strong>(&amp;block)  &#x21d2; <tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::None::InnerType (constant)">InnerType</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>block</span>
+      
+      
+        <span class='type'>(<tt>T.proc.returns(T.untyped)</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="#InnerType-constant" title="Mangrove::Option::None::InnerType (constant)">InnerType</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">Option::ControlSignal</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+140
+141
+142</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 140</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_expect_with!'>expect_with!</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Option.html" title="Mangrove::Option (module)">Option</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -586,12 +688,12 @@
       <pre class="lines">
 
 
-146
-147
-148</pre>
+156
+157
+158</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 146</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 156</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_map_none'>map_none</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
@@ -653,12 +755,12 @@
       <pre class="lines">
 
 
-141
-142
-143</pre>
+151
+152
+153</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 141</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 151</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_map_some'>map_some</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid__block'>_block</span><span class='rparen'>)</span>
   <span class='kw'>self</span>
@@ -705,10 +807,10 @@
       <pre class="lines">
 
 
-138</pre>
+148</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 138</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 148</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_none?'>none?</span> <span class='op'>=</span> <span class='kw'>true</span></pre>
     </td>
@@ -753,10 +855,10 @@
       <pre class="lines">
 
 
-135</pre>
+145</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 135</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 145</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_some?'>some?</span> <span class='op'>=</span> <span class='kw'>false</span></pre>
     </td>
@@ -816,12 +918,12 @@
       <pre class="lines">
 
 
-151
-152
-153</pre>
+161
+162
+163</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 151</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 161</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_transpose'>transpose</span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='rparen'>)</span>
   <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Result/Err.html" title="Mangrove::Result::Err (class)">Err</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Result/Err.html#initialize-instance_method" title="Mangrove::Result::Err#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='rparen'>)</span>
@@ -881,15 +983,15 @@
       <pre class="lines">
 
 
-125
-126
-127</pre>
+130
+131
+132</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 125</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 130</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unwrap!'>unwrap!</span>
-  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Option.html" title="Mangrove::Option (module)">Option</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Result/Err.html" title="Mangrove::Result::Err (class)">Err</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Result/Err.html#initialize-instance_method" title="Mangrove::Result::Err#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>called `Option#unwrap!` on an `None` value: </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Option.html" title="Mangrove::Option (module)">Option</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Option::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>called `Option#unwrap!` on an `None` value: </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -948,12 +1050,12 @@
       <pre class="lines">
 
 
-120
-121
-122</pre>
+125
+126
+127</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 120</span>
+      <pre class="code"><span class="info file"># File 'lib/mangrove/option.rb', line 125</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_unwrap_or'>unwrap_or</span><span class='lparen'>(</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_default'>default</span>
@@ -968,7 +1070,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Sep 12 17:51:33 2023 by
+  Generated on Wed Oct 18 11:45:16 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>