ksr-maybe 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9b624308416ed8b74db359022fe3cbc65c63e5b
-  data.tar.gz: d03ab54204740c3c608e4bc5faea88952cb373de
+  metadata.gz: 96a1150eee677ad2091303f4306c9d4ed498f5f5
+  data.tar.gz: 27f9c68387c3e40c14cd2f5702b38dee7a168188
 SHA512:
-  metadata.gz: 67d3f7414267af4083a86ad199fbabf76eefcd5414edb62345141b9c848c686bdc59f4e0bce496e13b6aacb8e4097c095fe895f26bf9e44bb3f7dfab73155651
-  data.tar.gz: dcb5d360e0475ffdcdbd7c222b1f25e23d2e5f1f3b73fa9a4747511cdb72a543752fc292cf721f37a2694f765776163a7d45cc7b1c9f4106ec76dfe290ac26c0
+  metadata.gz: f93b06a4f7a3eb276cb87817e86be45d3355c3e3f1af5452fd69926c7e7e0de6327185e396cc6b6e151f766697cbf176a8885267994ce4d43c57d32049a27383
+  data.tar.gz: 0a8a459bd7e25d29f499229fc18b7c05aa29b151139802e5e249e9a052e62101ab34c633ce776db3537256abe200216e225a6e4d7a575bfe9038a6cb4cb4a903

data/CHANGES.md

@@ -0,0 +1,9 @@
+# Changes
+
+## 0.1.1
+
+* [Add `lift` method to Maybe](https://github.com/kickstarter/ruby-maybe/pull/7)
+
+## 0.1.0
+
+* Initial implementation

data/README.md

@@ -3,6 +3,47 @@
 This gem provides a `Maybe` type. The `Maybe` type either contains a value
 (represented as `Just`) or it is empty (represented as `Nothing`).
 
+# Installation
+
+Install the `ksr-maybe` gem, or add it to your Gemfile with bundler:
+
+```ruby
+# In your Gemfile
+gem 'ksr-maybe'
+```
+
+# Usage
+
+Maybe is useful for handling potentially null values:
+
+```ruby
+User = Struct.new(:email, :name)
+
+users = [
+  User.new("jane@doe.com", "Jane Doe"),
+  User.new("john@doe.com", "John Doe")
+]
+
+# When value is not null
+
+user = users.find { |user| user.email == "jane@doe.com" }
+
+Maybe.from_nullable(user)
+  .map { |user| user.name }
+  .get_or_else { "User not found" }
+
+#=> "Jane Doe"
+
+# When value is null
+
+user = users.find { |user| user.email == "not@present.com" }
+
+Maybe.from_nullable(user)
+  .map { |user| user.name }
+  .get_or_else { "User not found" }
+
+#=> "User not found"
+```
 
 ## Contracts
 

data/ksr-maybe.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'ksr-maybe'
-  s.version = '0.1.0'
+  s.version = '0.1.1'
   s.summary = 'A library providing the optional type \'Maybe\''
   s.authors = ['Ryan Closner', 'Corey Farwell']
   s.email = 'eng@kickstarter.com'

data/lib/maybe.rb

@@ -129,12 +129,53 @@ module Maybe
   # @return [Just<Any>,Nothing] either a combined Just, or Nothing
   Contract C::Args[Maybe] => C::Or[Maybe]
   def self.zip(fst, snd, *rest)
-    [fst, snd, *rest].reduce(of([])) do |accum, maybe|
+    [fst, snd, *rest].reduce(Just([])) do |accum, maybe|
       accum.flat_map do |accum_|
         maybe.map {|maybe_| accum_ + [maybe_] }
       end
     end
   end
+
+  # Takes a function and a set of Maybes, and attempts to apply the function
+  # and return the result wrapped in a Maybe.
+  #
+  # @example with a single instance of Just
+  #   Maybe.lift(->(n){ n ** 2 }, Maybe.Just(3))
+  #   #=> Just(9)
+  #
+  # @example with a single instance of Nothing
+  #   Maybe.lift(->(n){ n ** 2 }, Maybe.Nothing)
+  #   #=> Nothing
+  #
+  # @example with multiple instances of Just
+  #   Maybe.lift(->(x,y){ x + y }, Maybe.Just(1), Maybe.Just(2))
+  #   #=> Just(3)
+  #
+  # @example with multiple instances of Nothing
+  #   Maybe.lift(->(x,y){ x + y }, Maybe.Nothing, Maybe.Nothing)
+  #   #=> Nothing
+  #
+  # @example a mixture of Just and Nothing instances
+  #   Maybe.lift(->(x,y,z) { x + y + z }, Maybe.Just(1), Maybe.Nothing, Maybe.Just(2))
+  #   #=> Nothing
+  #
+  # @example called with the wrong number of arguments
+  #   Maybe.lift(->(x,y) { x + y }, Maybe.Just(1))
+  #   #=> ArgumentError: wrong number of arguments (given 1, expected 2)
+  #
+  # @param f [Proc] a function
+  # @param m [Array<Just<Any>>, Array<Nothing>] a collection of Maybes
+  # @return [Just<Any>,Nothing] either the result wrapped in a Just, or Nothing
+  Contract Proc, C::Args[Maybe] => Maybe
+  def self.lift(f, fst, *rst)
+    [fst, *rst]
+      .reduce(Just([])) {|accum, maybe|
+        accum.flat_map {|accum_|
+          maybe.map {|maybe_| accum_ + [maybe_] }
+        }
+      }
+      .ap( Just(->(args){ f.call(*args) }) )
+  end
 end
 
 # Nothing is a member of the Maybe union type that represents a null value.

data/test/maybe_test.rb

@@ -61,6 +61,39 @@ class MaybeTest < Minitest::Test
     end
   end
 
+  context ".lift" do
+    setup do
+      @add = ->(x,y){ x + y }
+      @squared = ->(x){ x ** 2 }
+      @maybe_x = Maybe.Just(2)
+      @maybe_y = Maybe.Just(3)
+    end
+
+    context "with the wrong number of arguments" do
+      should "raise an error" do
+        assert_raises(ArgumentError) { Maybe.lift(@add, @maybe_x) }
+      end
+    end
+
+    context "with a single Just value" do
+      should "return an instance of Just" do
+        assert_equal Maybe.Just(9), Maybe.lift(@squared, @maybe_y)
+      end
+    end
+
+    context "with multiple Just values" do
+      should "return an instance of Just" do
+        assert_equal Maybe.Just(5), Maybe.lift(@add, @maybe_x, @maybe_y)
+      end
+    end
+
+    context "with a Nothing value" do
+      should "return an instance of Just" do
+        assert_equal Nothing.instance, Maybe.lift(@add, @maybe_x, Nothing.instance)
+      end
+    end
+  end
+
   context "Nothing" do
     subject do
       Nothing.instance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ksr-maybe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryan Closner
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
 description: 
@@ -73,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - NOTICE.md
@@ -93,17 +94,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: A library providing the optional type 'Maybe'