ronad 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92c3fe5954c20636ef0adfda0823d73b1c3c91a9778bc6698d9be5538c22d402
-  data.tar.gz: de98fafde865cb62229efb3163c708349f15d2922e6cb860c75c6f69a005b9cd
+  metadata.gz: aae96a5293971c4033fb68485338315e17f1f0c307e11f50c57f2e2583e81067
+  data.tar.gz: 3eecd824510dc9fa3ee01742797bac4c7a0ab7ffe949498a4c1d2074d320793f
 SHA512:
-  metadata.gz: d7da852fd7409736474db7734b38fb2ea2caa558830a26c12499bc6ede51bb8c59c24c896f344c24c3070dc3483015cdce40789eb6b14ea655a89028479b395b
-  data.tar.gz: 99b5d6de76fb2f78e204284170e71eccf792a6108421cc3cccc705eb4d31f685e284d003f90d6c7cd12a6f8b322d175acd7c344321dd2e6ff372cd67cb235f36
+  metadata.gz: 5264e71387940e8728026b6fd524f0e237b81200c05e2abe4840d96a3ee7aa8e2d2e453af5e70dc117d2e9f4db0ed86c8052ee36bc49d632a670d17ffcd40927
+  data.tar.gz: 92b79c02a184d29a6a86ce2c01fdbc6efc201105d49debfcbd12bb68236ada59ac9f97683930ed8d7521bd1667e716e8fe502206b17a7dc6854883f2bfbaaaa3

data/lib/ronad/many.rb

@@ -0,0 +1,89 @@
+module Ronad
+  # Chain operations on lists that can possibly return other lists.
+  #
+  #     sentence = 'hello-there my-friend@good-bye my-pal'
+  #
+  #     words = sentence.split('@').flat_map do |partials|
+  #       partials.split('-').map do |word|
+  #          word + '!'
+  #       end
+  #     end
+  #
+  # Or using Many:
+  #
+  #     word = Many(sentence).split('@').split('-') + '!'
+  #     words = word.value
+  #
+  # A Many can be useful for tranversing 'has many' relationships in a
+  # database. For example given the following relations with each relationship
+  # having 0 or more:
+  #
+  # - store has many products
+  # - product has many variants
+  # - variant has many inventory_units
+  #
+  # To obtain all the inventory_units of a store:
+  #
+  #     store.products.flat_map(&:variants).flat_map(&:inventory_units)
+  #
+  # Or if a certain parameterized scope had to be used:
+  #
+  #     store.products.flat_map do |product|
+  #       prodcut.variants.where(some_state: true).flat_map do |variant|
+  #         variant.inventory_units.where(physical: true)
+  #       end
+  #     end
+  #
+  # With Many:
+  #
+  #     Many(store).products.variants.where(some_state: true).inventory_units.where(physical: true)
+  #       .value
+  #
+  # A Many will also remove nil values:
+  #
+  #     Many([1,2,nil,4,nil]).value #=> [1,2,4]
+  class Many < Monad
+    # Wraps a value in the Many monad.
+    #
+    # @param value - Does not need to be an enumerable as
+    #   it will be wrapped in an Array.
+    # @param return_lazy - specifies if #monad_value should return a lazy
+    #   enumerator. If left as nil, then #monad_value will return a lazy
+    #   enumerator if one was initially provided to the constructor.
+    def initialize(value, return_lazy: nil)
+      @return_lazy = if return_lazy.nil?
+        value.is_a? Enumerator::Lazy
+      else
+        return_lazy
+      end
+
+      if value.is_a? Enumerable
+        @value = value.lazy
+      else
+        @value = Array(value).lazy
+      end
+    end
+
+
+    def and_then &b
+      from_value @value.reject(&:nil?).flat_map(&b)
+    end
+
+    # Returns the underlying value of the many. Always an Enumerator, sometimes
+    # lazy.
+    # @see #initialize
+    def monad_value
+      if @return_lazy
+        super
+      else
+        super.to_a
+      end
+    end
+
+    protected
+
+    def from_value(value)
+      self.class.new(value, return_lazy: @return_lazy)
+    end
+  end
+end

data/lib/ronad/maybe.rb

@@ -37,28 +37,6 @@ module Ronad
       end
     end
 
-    # "Fails" a maybe given a certain condition. If the condition is `false`
-    # then Maybe(nil) will be returned. Useful for performing side-effects
-    # given a certain condition
-    #
-    #   Maybe([]).and_then do |value|
-    #     value.each(&:some_operation)
-    #     OtherModule.finalize! # Side Effect should only happen if there
-    #   end                     # are any values
-    #
-    # The following `and_then` only executes if `value` responds truthy to any?
-    #
-    #   Maybe([]).continue(&:any?).and_then do |value|
-    #     value.each(&:some_operation)
-    #     OtherModule.finalize!
-    #   end
-    # @return [Monad]
-    def continue
-      and_then do |value|
-        value if yield value
-      end
-    end
-
     # "Fails" a maybe given a certain condition. If the condition is `true`
     # then Maybe(nil) will be returned.
     #

data/lib/ronad/monad.rb

@@ -60,6 +60,29 @@ module Ronad
     end
 
 
+    # "Fails" a maybe given a certain condition. If the condition is `false`
+    # then Maybe(nil) will be returned. Useful for performing side-effects
+    # given a certain condition
+    #
+    #   Maybe([]).and_then do |value|
+    #     value.each(&:some_operation)
+    #     OtherModule.finalize! # Side Effect should only happen if there
+    #   end                     # are any values
+    #
+    # The following `and_then` only executes if `value` responds truthy to any?
+    #
+    #   Maybe([]).continue(&:any?).and_then do |value|
+    #     value.each(&:some_operation)
+    #     OtherModule.finalize!
+    #   end
+    # @return [Monad]
+    def continue
+      and_then do |value|
+        value if yield value
+      end
+    end
+
+
     private
 
     # Provides convinience for chaining methods together while maintaining a

data/lib/ronad/one.rb

@@ -0,0 +1,26 @@
+module Ronad
+  # A One is similar to a Many but does not flatten the results if #and_then
+  # produces another list.
+  #
+  #     urls = %w[
+  #       example.com?p1=a&p2=b
+  #       example.com?z1=5&y1=9
+  #     ]
+  #
+  #     one(urls)
+  #       .split('?')
+  #       .last # a Many would have flatten the #split and #last would be called on a String
+  #       .split('&')
+  #       .last
+  #       .split('=')
+  #       .first
+  #       .value #=> ['p2', 'y1']
+  #
+  # A One can be used for providing a familiar interface to a function that
+  # does not expect the flattening behavior of Many.
+  class One < Many
+    def and_then &b
+      from_value @value.reject(&:nil?).map(&b)
+    end
+  end
+end

data/lib/ronad/sugar.rb

@@ -1,10 +1,14 @@
 require 'ronad/maybe'
+require 'ronad/many'
+require 'ronad/one'
 require 'ronad/just'
 require 'ronad/just_one'
 require 'ronad/default'
 require 'ronad/eventually'
 
 def Maybe(*values) ; Ronad::Maybe.from_multiple_values(*values) end
+def Many(value, **kargs) ; Ronad::Many.new(value, **kargs) end
+def One(value, **kargs) ; Ronad::One.new(value, **kargs) end
 def Just(value); Ronad::Just.new(value) end
 def JustOne(*values); Ronad::JustOne.new(*values) end
 def Default(fallback, value) ; Ronad::Default.new(fallback, value) end

data/lib/ronad/version.rb

@@ -1,3 +1,3 @@
 module Ronad
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronad
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Uri Gorelik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,8 +101,10 @@ files:
 - lib/ronad/eventually.rb
 - lib/ronad/just.rb
 - lib/ronad/just_one.rb
+- lib/ronad/many.rb
 - lib/ronad/maybe.rb
 - lib/ronad/monad.rb
+- lib/ronad/one.rb
 - lib/ronad/sugar.rb
 - lib/ronad/version.rb
 - lib/sugar.rb