mangrove 0.9.2 → 0.11.0

data/docs/method_list.html

@@ -237,6 +237,14 @@
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Mangrove/Option.html#from_nilable-class_method" title="Mangrove::Option.from_nilable (method)">from_nilable</a></span>
+      <small>Mangrove::Option</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result.html#from_results-class_method" title="Mangrove::Result.from_results (method)">from_results</a></span>
       <small>Mangrove::Result</small>
@@ -244,7 +252,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/Some.html#initialize-instance_method" title="Mangrove::Option::Some#initialize (method)">#initialize</a></span>
       <small>Mangrove::Option::Some</small>
@@ -252,7 +260,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/Ok.html#initialize-instance_method" title="Mangrove::Result::Ok#initialize (method)">#initialize</a></span>
       <small>Mangrove::Result::Ok</small>
@@ -260,7 +268,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/Err.html#initialize-instance_method" title="Mangrove::Result::Err#initialize (method)">#initialize</a></span>
       <small>Mangrove::Result::Err</small>
@@ -268,7 +276,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/ControlSignal.html#initialize-instance_method" title="Mangrove::Option::ControlSignal#initialize (method)">#initialize</a></span>
       <small>Mangrove::Option::ControlSignal</small>
@@ -276,7 +284,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/ControlSignal.html#initialize-instance_method" title="Mangrove::Result::ControlSignal#initialize (method)">#initialize</a></span>
       <small>Mangrove::Result::ControlSignal</small>
@@ -284,7 +292,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/ControlSignal.html#inner_value-instance_method" title="Mangrove::Option::ControlSignal#inner_value (method)">#inner_value</a></span>
       <small>Mangrove::Option::ControlSignal</small>
@@ -292,7 +300,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/ControlSignal.html#inner_value-instance_method" title="Mangrove::Result::ControlSignal#inner_value (method)">#inner_value</a></span>
       <small>Mangrove::Result::ControlSignal</small>
@@ -300,7 +308,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/ControlFlow/ControlSignal.html#inner_value-instance_method" title="Mangrove::ControlFlow::ControlSignal#inner_value (method)">#inner_value</a></span>
       <small>Mangrove::ControlFlow::ControlSignal</small>
@@ -308,33 +316,9 @@
   </li>
   
 
-  <li class="even ">
-    <div class="item">
-      <span class='object_link'><a href="Mangrove/Result.html#map_err-instance_method" title="Mangrove::Result#map_err (method)">#map_err</a></span>
-      <small>Mangrove::Result</small>
-    </div>
-  </li>
-  
-
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Result/Ok.html#map_err-instance_method" title="Mangrove::Result::Ok#map_err (method)">#map_err</a></span>
-      <small>Mangrove::Result::Ok</small>
-    </div>
-  </li>
-  
-
-  <li class="even ">
-    <div class="item">
-      <span class='object_link'><a href="Mangrove/Result/Err.html#map_err-instance_method" title="Mangrove::Result::Err#map_err (method)">#map_err</a></span>
-      <small>Mangrove::Result::Err</small>
-    </div>
-  </li>
-  
-
-  <li class="odd ">
-    <div class="item">
-      <span class='object_link'><a href="Mangrove/Option/Some.html#map_none-instance_method" title="Mangrove::Option::Some#map_none (method)">#map_none</a></span>
+      <span class='object_link'><a href="Mangrove/Option/Some.html#map-instance_method" title="Mangrove::Option::Some#map (method)">#map</a></span>
       <small>Mangrove::Option::Some</small>
     </div>
   </li>
@@ -342,7 +326,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option/None.html#map_none-instance_method" title="Mangrove::Option::None#map_none (method)">#map_none</a></span>
+      <span class='object_link'><a href="Mangrove/Option/None.html#map-instance_method" title="Mangrove::Option::None#map (method)">#map</a></span>
       <small>Mangrove::Option::None</small>
     </div>
   </li>
@@ -350,7 +334,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option.html#map_none-instance_method" title="Mangrove::Option#map_none (method)">#map_none</a></span>
+      <span class='object_link'><a href="Mangrove/Option.html#map-instance_method" title="Mangrove::Option#map (method)">#map</a></span>
       <small>Mangrove::Option</small>
     </div>
   </li>
@@ -358,7 +342,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Result.html#map_ok-instance_method" title="Mangrove::Result#map_ok (method)">#map_ok</a></span>
+      <span class='object_link'><a href="Mangrove/Result.html#map_err-instance_method" title="Mangrove::Result#map_err (method)">#map_err</a></span>
       <small>Mangrove::Result</small>
     </div>
   </li>
@@ -366,7 +350,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Result/Ok.html#map_ok-instance_method" title="Mangrove::Result::Ok#map_ok (method)">#map_ok</a></span>
+      <span class='object_link'><a href="Mangrove/Result/Ok.html#map_err-instance_method" title="Mangrove::Result::Ok#map_err (method)">#map_err</a></span>
       <small>Mangrove::Result::Ok</small>
     </div>
   </li>
@@ -374,7 +358,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Result/Err.html#map_ok-instance_method" title="Mangrove::Result::Err#map_ok (method)">#map_ok</a></span>
+      <span class='object_link'><a href="Mangrove/Result/Err.html#map_err-instance_method" title="Mangrove::Result::Err#map_err (method)">#map_err</a></span>
       <small>Mangrove::Result::Err</small>
     </div>
   </li>
@@ -382,24 +366,24 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option/Some.html#map_some-instance_method" title="Mangrove::Option::Some#map_some (method)">#map_some</a></span>
-      <small>Mangrove::Option::Some</small>
+      <span class='object_link'><a href="Mangrove/Result.html#map_ok-instance_method" title="Mangrove::Result#map_ok (method)">#map_ok</a></span>
+      <small>Mangrove::Result</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option/None.html#map_some-instance_method" title="Mangrove::Option::None#map_some (method)">#map_some</a></span>
-      <small>Mangrove::Option::None</small>
+      <span class='object_link'><a href="Mangrove/Result/Ok.html#map_ok-instance_method" title="Mangrove::Result::Ok#map_ok (method)">#map_ok</a></span>
+      <small>Mangrove::Result::Ok</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option.html#map_some-instance_method" title="Mangrove::Option#map_some (method)">#map_some</a></span>
-      <small>Mangrove::Option</small>
+      <span class='object_link'><a href="Mangrove/Result/Err.html#map_ok-instance_method" title="Mangrove::Result::Err#map_ok (method)">#map_ok</a></span>
+      <small>Mangrove::Result::Err</small>
     </div>
   </li>
   
@@ -462,7 +446,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option/Some.html#some%3F-instance_method" title="Mangrove::Option::Some#some? (method)">#some?</a></span>
+      <span class='object_link'><a href="Mangrove/Option/Some.html#or-instance_method" title="Mangrove::Option::Some#or (method)">#or</a></span>
       <small>Mangrove::Option::Some</small>
     </div>
   </li>
@@ -470,7 +454,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option/None.html#some%3F-instance_method" title="Mangrove::Option::None#some? (method)">#some?</a></span>
+      <span class='object_link'><a href="Mangrove/Option/None.html#or-instance_method" title="Mangrove::Option::None#or (method)">#or</a></span>
       <small>Mangrove::Option::None</small>
     </div>
   </li>
@@ -478,13 +462,37 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Mangrove/Option.html#some%3F-instance_method" title="Mangrove::Option#some? (method)">#some?</a></span>
+      <span class='object_link'><a href="Mangrove/Option.html#or-instance_method" title="Mangrove::Option#or (method)">#or</a></span>
       <small>Mangrove::Option</small>
     </div>
   </li>
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Mangrove/Option/Some.html#some%3F-instance_method" title="Mangrove::Option::Some#some? (method)">#some?</a></span>
+      <small>Mangrove::Option::Some</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Mangrove/Option/None.html#some%3F-instance_method" title="Mangrove::Option::None#some? (method)">#some?</a></span>
+      <small>Mangrove::Option::None</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Mangrove/Option.html#some%3F-instance_method" title="Mangrove::Option#some? (method)">#some?</a></span>
+      <small>Mangrove::Option</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/Ok.html#to_s-instance_method" title="Mangrove::Result::Ok#to_s (method)">#to_s</a></span>
       <small>Mangrove::Result::Ok</small>
@@ -492,7 +500,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/Err.html#to_s-instance_method" title="Mangrove::Result::Err#to_s (method)">#to_s</a></span>
       <small>Mangrove::Result::Err</small>
@@ -500,7 +508,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/Some.html#transpose-instance_method" title="Mangrove::Option::Some#transpose (method)">#transpose</a></span>
       <small>Mangrove::Option::Some</small>
@@ -508,7 +516,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/None.html#transpose-instance_method" title="Mangrove::Option::None#transpose (method)">#transpose</a></span>
       <small>Mangrove::Option::None</small>
@@ -516,7 +524,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option.html#transpose-instance_method" title="Mangrove::Option#transpose (method)">#transpose</a></span>
       <small>Mangrove::Option</small>
@@ -524,7 +532,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/Some.html#unwrap-instance_method" title="Mangrove::Option::Some#unwrap (method)">#unwrap</a></span>
       <small>Mangrove::Option::Some</small>
@@ -532,7 +540,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/Some.html#unwrap!-instance_method" title="Mangrove::Option::Some#unwrap! (method)">#unwrap!</a></span>
       <small>Mangrove::Option::Some</small>
@@ -540,7 +548,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/None.html#unwrap!-instance_method" title="Mangrove::Option::None#unwrap! (method)">#unwrap!</a></span>
       <small>Mangrove::Option::None</small>
@@ -548,7 +556,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option.html#unwrap!-instance_method" title="Mangrove::Option#unwrap! (method)">#unwrap!</a></span>
       <small>Mangrove::Option</small>
@@ -556,7 +564,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result.html#unwrap!-instance_method" title="Mangrove::Result#unwrap! (method)">#unwrap!</a></span>
       <small>Mangrove::Result</small>
@@ -564,7 +572,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/Ok.html#unwrap!-instance_method" title="Mangrove::Result::Ok#unwrap! (method)">#unwrap!</a></span>
       <small>Mangrove::Result::Ok</small>
@@ -572,7 +580,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Result/Err.html#unwrap!-instance_method" title="Mangrove::Result::Err#unwrap! (method)">#unwrap!</a></span>
       <small>Mangrove::Result::Err</small>
@@ -580,7 +588,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/Some.html#unwrap_or-instance_method" title="Mangrove::Option::Some#unwrap_or (method)">#unwrap_or</a></span>
       <small>Mangrove::Option::Some</small>
@@ -588,7 +596,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option/None.html#unwrap_or-instance_method" title="Mangrove::Option::None#unwrap_or (method)">#unwrap_or</a></span>
       <small>Mangrove::Option::None</small>
@@ -596,7 +604,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Mangrove/Option.html#unwrap_or-instance_method" title="Mangrove::Option#unwrap_or (method)">#unwrap_or</a></span>
       <small>Mangrove::Option</small>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Oct 24 12:49:57 2023 by
+  Generated on Tue Oct 24 20:35:17 2023 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.34 (ruby-3.1.2).
 </div>

data/lib/mangrove/option.rb

@@ -18,6 +18,20 @@ module Mangrove
 
     InnerType = type_member
 
+    class << self
+      extend ::T::Sig
+
+      sig { type_parameters(:InnerType).params(nilable: T.nilable(T.type_parameter(:InnerType))).returns(Mangrove::Option[T.type_parameter(:InnerType)]) }
+      def from_nilable(nilable)
+        case nilable
+        when NilClass
+          Mangrove::Option::None.new
+        else
+          Mangrove::Option::Some.new(nilable)
+        end
+      end
+    end
+
     # Option::Some
     class Some
       extend T::Sig
@@ -77,13 +91,13 @@ module Mangrove
       sig { override.returns(T::Boolean) }
       def none? = false
 
-      sig { override.params(block: T.proc.params(inner: InnerType).returns(Option[InnerType])).returns(Option[InnerType]) }
-      def map_some(&block)
+      sig { override.type_parameters(:NewInnerType).params(block: T.proc.params(inner: InnerType).returns(Option[T.type_parameter(:NewInnerType)])).returns(::Mangrove::Option[T.type_parameter(:NewInnerType)]) }
+      def map(&block)
         block.call(@inner)
       end
 
-      sig { override.params(_block: T.proc.returns(Option[InnerType])).returns(Option::Some[InnerType]) }
-      def map_none(&_block)
+      sig { override.params(_default: Option[InnerType]).returns(Option[InnerType]) }
+      def or(_default)
         self
       end
 
@@ -147,14 +161,14 @@ module Mangrove
       sig { override.returns(T::Boolean) }
       def none? = true
 
-      sig { override.params(_block: T.proc.params(inner: InnerType).returns(Option[InnerType])).returns(Option::None[InnerType]) }
-      def map_some(&_block)
-        self
+      sig { override.type_parameters(:NewInnerType).params(_block: T.proc.params(inner: InnerType).returns(Option[T.type_parameter(:NewInnerType)])).returns(Option[T.type_parameter(:NewInnerType)]) }
+      def map(&_block)
+        T.cast(self, Option[T.type_parameter(:NewInnerType)])
       end
 
-      sig { override.params(block: T.proc.returns(Option[InnerType])).returns(Option[InnerType]) }
-      def map_none(&block)
-        block.call
+      sig { override.params(default: Option[InnerType]).returns(Option[InnerType]) }
+      def or(default)
+        default
       end
 
       sig { override.type_parameters(:ErrType).params(err: T.type_parameter(:ErrType)).returns(Mangrove::Result[InnerType, T.type_parameter(:ErrType)]) }
@@ -184,11 +198,11 @@ module Mangrove
     sig { abstract.returns(T::Boolean) }
     def none?; end
 
-    sig { abstract.params(block: T.proc.params(inner: InnerType).returns(Option[InnerType])).returns(Option[InnerType]) }
-    def map_some(&block); end
+    sig { abstract.type_parameters(:NewInnerType).params(block: T.proc.params(inner: InnerType).returns(Option[T.type_parameter(:NewInnerType)])).returns(::Mangrove::Option[T.type_parameter(:NewInnerType)]) }
+    def map(&block); end
 
-    sig { abstract.params(block: T.proc.returns(Option[InnerType])).returns(Option[InnerType]) }
-    def map_none(&block); end
+    sig { abstract.params(default: Option[InnerType]).returns(Option[InnerType]) }
+    def or(default); end
 
     sig { abstract.type_parameters(:ErrType).params(err: T.type_parameter(:ErrType)).returns(Mangrove::Result[InnerType, T.type_parameter(:ErrType)]) }
     def transpose(err); end

data/lib/mangrove/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Mangrove
-  VERSION = "0.9.2"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangrove
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Kazuma Murata