ronad 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31ce7e2542c92dad39d02ede97796cae42721049
+  data.tar.gz: ad50b90276b62b10dc440d42a8b89dee3bd80a56
+SHA512:
+  metadata.gz: 650f5c6fcecb65d671769135daa99e1f8932bcc8ed2f27a1ee9ccba5aaba1aaff68380193f37b577ef1c5feb959ab0a27dfa572043f9963a4f97c9e7cd46a0b7
+  data.tar.gz: a09380df556ab58b6aa3cfa63c0d162a2877d0dc472e6caf52587546151b6a2e1354e7631ebbffa69172dab5fb2e525054c46b5070909adb6b1d8fda862e9cc5

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+.byebug_history
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ronad.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Uri Gorelik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# Ronad
+
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/D3MNetworks/ronad)
+
+Monads implemented in Ruby with sugar. Inspired by [@tomstuart](https://twitter.com/tomstuart)'s
+talk https://codon.com/refactoring-ruby-with-monads
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ronad', require: 'sugar'
+```
+
+Alernatively without sugar
+
+```ruby
+gem 'ronad'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ronad
+
+## Sugar
+
+If required, you can use the monads as methods:
+
+```ruby
+Maybe('hello')
+Just('world')
+Default('hello', 'world')
+```
+
+Without the sugar you must use the fully qualified name and invoke the constructor:
+
+```ruby
+Ronad::Maybe.new('hello')
+Ronad::Just.new('world')
+Ronad::Default.new('hello', 'world')
+```
+
+All examples will be using the "sugar" syntax but they are interchangeable.
+
+
+## Usage
+
+Generally every `Ronad::Monad` will respond to `and_then`.
+
+`method_missing` is also used to for convenience as a proxy for `and_then`.
+
+```ruby
+maybe_name = Maybe({person: {name: 'Bob'}})
+maybe_name
+  .and_then{ |v| v[:person] }
+  .and_then{ |v| v[:name] }
+  .value
+
+# Equivalent:
+
+maybe_name = Maybe({person: {name: 'Bob'}})
+~maybe_name[:person][:name]
+```
+
+
+Generally the `and_then` block will only run based on a condition from the specific monad.
+
+For example, `Maybe` will only invoke the block from `and_then` if the underlying value is not
+
+`nil`.
+
+```ruby
+Maybe(nil).and_then do |_|
+  raise "Boom"
+end #=> No error
+```
+
+
+### `value`, `monad_value`, `~`
+
+To get the underlying value of a monad you need to call `#value`. If the underlying value also
+responds to `#value`, you can use `#monad_value`. `#~` is a unary operator overload which is an
+alias for `monad_value`.
+
+```ruby
+m = Maybe(5)
+
+m.value == m.monad_value #=> true
+m.value == ~m #=> true
+m.monad_value == ~m #=> true
+```
+
+## Maybe
+
+`Maybe` is useful as a safe navigation operator:
+
+```ruby
+response = request(params) #=> {}
+name  = ~Maybe(response[:person])[:name] #=> nil
+```
+
+It's also useful as an annotation. If you look at the previous example, you'll notice that you could
+wrap `response` in a maybe instead:
+
+```ruby
+name = ~Maybe(response)[:person][:name] #=> nil
+```
+
+This functionally the same but has different semantics. With the former example, it has correctly
+annotated that `response[:person]` can be `nil`, whereas the latter example is an over eager usage.
+
+
+
+Here's a less trivial example
+
+```ruby
+Document.each do |doc|
+  maybe_json = Maybe(doc.data) # data is nil or a json string
+    .and_then{|str| JSON.parse str}
+
+  maybe_json['nodes'] # method_missing in action
+    .map do |n|
+      n['new_field'] = 'new'
+      n
+    end
+    .continue(&:any?) # see documentation
+    .and_then do |new_nodes|
+      doc.data['nodes'] = new_nodes
+      doc.save!
+    end
+end
+```
+
+In this example `value` was no invoked as `Maybe` was use more so for flow control.
+
+## Just
+
+Useful for catching a nil immediately
+
+```ruby
+Just(nil) #=> Ronad::Just::CannotBeNil
+never_nil = Just(5).and_then { nil }  #=> Ronad::Just::CannotBeNil
+good = ~Just(5) #=> 5
+```
+
+## Default
+
+Similar to a null object pattern. Setting up defaults so `#value` will never return nil. Can be
+combined with a `Maybe`.
+
+```ruby
+d = ~Default('hello', nil) #=> 'hello'
+d = ~Default('hello', Maybe(10)) #=> 10
+```
+
+Notice that default will recursively expand other Monads. As a general rule, you should never
+receive a monad after invoking `#value`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ronad"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ronad.rb

@@ -0,0 +1,4 @@
+require "ronad/version"
+
+# @nodoc
+module Ronad; end

data/lib/ronad/default.rb

@@ -0,0 +1,49 @@
+require 'ronad/monad'
+
+module Ronad
+  # A default "monad". Not technically a monad as it take two values.
+  class Default < Monad
+    # @param fallback [Object] The value on which to fallback if the doesn't
+    #   satisfy Just(value)
+    # @param value [Object]
+    def initialize(fallback, value)
+      @fallback = Just.new(fallback).value
+      super(value)
+    end
+
+    # @override
+    def monad_value
+      super || @fallback
+    end
+
+    # Allows chaining on nil values with a fallback
+    #
+    # @note The fallback does not get the transformations
+    #
+    # @example
+    #   d = Default('Missing name', nil)
+    #   d = d.upcase.split.join #=> Ronad::Default
+    #   name = ~d # 'Missing name'
+    #
+    #   d = Default('Missing name', 'Uri')
+    #   d = d.upcase #=> Ronad::Default
+    #   name = ~d # 'URI'
+    #
+    # Default can be combined with a maybe. Extracting the value is recursive
+    # and will never return another monad.
+    #
+    # @example Combining with a Maybe
+    #   m = Maybe(nil)
+    #   d = Default('No name', m) #=> Ronad::Default
+    #   name = ~d #=>  'No name'
+    #
+    # @see Ronad::Monad#method_missing
+    def and_then &block
+      if @value == nil
+        Default.new @fallback, nil
+      else
+        Default.new @fallback, block.call(@value)
+      end
+    end
+  end
+end

data/lib/ronad/just.rb

@@ -0,0 +1,48 @@
+require 'ronad/monad'
+
+module Ronad
+  # Useful for immediately failing when a nil pops up.
+  #   name = get_name(person) #=> nil
+  #   # ... later somewhere
+  #   name.upcase # Error!
+  #
+  # Using a Just catches the problem at the source
+  #
+  #   name = Just(get_name(person)) # Error!
+  class Just < Monad
+    # Raised if the underlying value of Just becomes nil
+    class CannotBeNil < StandardError; end
+
+    # @raise [Ronad::Just::CannotBeNil] if value is provided as nil
+    def initialize(value)
+      raise CannotBeNil if !(Monad === value) && value == nil
+      super
+    end
+
+    # @raise [Ronad::Just::CannotBeNil]
+    def monad_value
+      val = super
+      raise CannotBeNil if val == nil
+      val
+    end
+
+    # Similar to Maybe#and_then but raises an error if the value ever becomes
+    # nil.
+    #
+    # @example
+    #   j = Just('hello') #=> Just
+    #   text = ~j #=> 'hello'
+    #
+    # @example Failing when becomes nil
+    #   j = Just({}) #=> Just
+    #   j[:name] #=> Ronad::Monad::CannotBeNil
+    #
+    #
+    # @see Maybe#and_then
+    # @see Monad#method_missing
+    # @return [Just]
+    def and_then(&block)
+      Just.new block.call(@value)
+    end
+  end
+end

data/lib/ronad/maybe.rb

@@ -0,0 +1,57 @@
+require 'ronad/monad'
+
+module Ronad
+  class Maybe < Monad
+    # Allows for safe navigation on nil.
+    #
+    #   nil&.m1&.m2&.m3 #=> nil
+    #
+    #   ~Maybe(nil).m1.m2.m3 #=> nil
+    #
+    # Using a Maybe really shines when accessing a hash
+    #
+    #   ~Maybe({})[:person][:name].downcase.split(' ').join('-') #=> nil
+    #
+    #   {}.dig(:person, :name)&.downcase.&split(' ')&.join('-') #=> nil
+    #
+    # Using #and_then without the Monad#method_missing sugar is also useful if
+    # you need to pass your value to another method
+    #
+    #   Maybe(nil).and_then{ |value| JSON.parse(value) } #=> Maybe
+    #
+    # The block only gets executed if value is not `nil`
+    #
+    # @return [Maybe]
+    # @see Monad#method_missing
+    def and_then
+      if @value
+        Maybe.new yield(@value)
+      else
+        Maybe.new(nil)
+      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
+
+  end
+end

data/lib/ronad/monad.rb

@@ -0,0 +1,99 @@
+module Ronad
+  # This class provides a common interface.
+  #
+  # @abstract
+  class Monad
+    def initialize(value)
+      if Monad === value
+        @value = value.value
+      else
+        @value = value
+      end
+    end
+
+    # Extract the value from the monad. If the underlying value responds to
+    # #value then this will be bypassed instead.
+    #
+    # @see #monad_value
+    # @return [Object] The unwrapped value
+    def value
+      if !(Monad === @value) && @value.respond_to?(:value)
+        and_then{ |v| v.value }
+      else
+        monad_value
+      end
+    end
+
+
+    # Extract the value from the monad. Can also be extracted via `~` unary
+    # operator.
+    #
+    # @example
+    #   ~Maybe("hello") #=> "HELLO"
+    #   ~Maybe(nil)     #=> nil
+    #
+    # @note Useful when you want to extract the underlying value and it also
+    #   responds to #value
+    # @return [Object] The unwrapped value
+    def monad_value
+      if Monad === @value
+        @value.value
+      else
+        @value
+      end
+    end
+
+    # Alias for #monad_value
+    #
+    # @see #monad_value
+    def ~@
+      monad_value
+    end
+
+
+    # Proxy all Object methods to underlying value
+    #
+    # @private
+    Object.new.methods.each do |object_method|
+      define_method object_method do |*args|
+        and_then { |v| v.public_send(object_method, *args) }
+      end
+    end
+
+    private
+
+    # Provides convinience for chaining methods together while maintaining a
+    # monad.
+    #
+    # @example Chaining fetches on a hash that does not have the keys
+    #   m = Maybe({})
+    #   m_name = m[:person][:full_name] #=> Ronad::Maybe
+    #   name = ~m_name #=> nil
+    #
+    # @example Safe navigation
+    #   m = Maybe(nil)
+    #   m_name = m.does.not.have.methods.upcase #=> Ronad::Maybe
+    #   name = ~m_name #=> nil
+    #
+    # @return [Ronad::Monad]
+    def method_missing(method, *args, &block)
+      unwrapped_args = args.map do |arg|
+        case arg
+        when Monad then arg.value || arg
+        else arg
+        end
+      end
+      and_then { |value| value.public_send(method, *unwrapped_args, &block) }
+    rescue TypeError
+      self.class.new(nil)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      if @value
+        @value.respond_to?(method_name) || super
+      else
+        true
+      end
+    end
+  end
+end

data/lib/ronad/version.rb

@@ -0,0 +1,3 @@
+module Ronad
+  VERSION = "0.3.0"
+end

data/lib/sugar.rb

@@ -0,0 +1,8 @@
+require 'ronad/maybe'
+require 'ronad/just'
+require 'ronad/default'
+
+def Maybe(value) ; Ronad::Maybe.new(value) end
+def Just(value); Ronad::Just.new(value) end
+def Default(fallback, value) ; Ronad::Default.new(fallback, value) end
+

data/ronad.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ronad/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ronad"
+  spec.version       = Ronad::VERSION
+  spec.authors       = ["Uri Gorelik"]
+  spec.email         = ["ugorelik@teldio.com"]
+
+  spec.summary       = %q{Monads implemented the Ruby way}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/D3MNetworks/ronad"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "yard", "~> 0.9.12"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: ronad
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Uri Gorelik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: 
+email:
+- ugorelik@teldio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ronad.rb
+- lib/ronad/default.rb
+- lib/ronad/just.rb
+- lib/ronad/maybe.rb
+- lib/ronad/monad.rb
+- lib/ronad/version.rb
+- lib/sugar.rb
+- ronad.gemspec
+homepage: https://github.com/D3MNetworks/ronad
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Monads implemented the Ruby way
+test_files: []