divergent 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ba0cd2b5c2f7fe954da0d3d7606369605b4d258
+  data.tar.gz: f8647ef8978718d7e1f6723adf57972e571361ad
+SHA512:
+  metadata.gz: d30e7e48cc2e25382f685b392c8bf06d018cdfffcaaa16289993bd61d72e24963824cd5eb1dbd3607aea77559a31d054bf2f57e9f6dbff8f4d91070796a25bfa
+  data.tar.gz: 480627d46e138a0715a4e7966b5e49f05059730a0911af63840f60ce296e725d708e240a30c08e823d9b0623473c4b862f1867eef855044a8b33d2b2cc5747a4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cao Jiafeng
+
+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,104 @@
+# Divergent
+
+A collection of monads for handling error in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'divergent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install divergent
+
+## Usage
+
+Using `Try`:
+
+``` ruby
+require 'divergent'
+
+include Divergent
+
+require 'uri'
+def parse_url(url)
+  Try {
+    URI.parse url
+  }
+end
+
+success_url = parse_url("http://www.google.com") # => Success<http://www.google.com>
+
+failed_url = parse_url(':google.com') #=> Failure<bad URI(is not URI?): :google.com>
+
+### get_or_else
+
+failed_url.get_or_else URI('http://duckduckgo.com') #=> #<URI::HTTP http://duckduckgo.com>
+
+### chainable operations
+
+# map
+success_url.map(&:scheme) #=> Success<http>
+
+failed_url.map(&:scheme) #=> Failure<bad URI(is not URI?): :google.com>
+
+# fmap
+parse_url("http://thisisnotagoodsite.com").fmap do |url|
+  Try { Net::HTTP.get(url) }
+end
+
+# each
+parse_url("http://google.com").each { |url| p url.to_s }
+# =>
+# "http://google.com"
+
+# filter
+parse_url("http://google.com").filter { |url| url.scheme == "http" }  #=> Success<http://google.com>
+parse_url("http://google.com").filter { |url| url.scheme == "https" } #=> Failure<Predicate does not hold for http://google.com>
+
+# recover from error
+failed_url.recover do |error|
+  case error
+  when NoMethodError
+    :no_method
+  when StandardError
+    :standard_error
+  else
+    :others
+  end
+end #=> Success<standard_error>
+```
+
+
+`Maybe` has similar interface to `Try`.
+`Maybe` uses `None` instead of `Failure`.
+
+``` ruby
+# provide default value
+user = Maybe.unit User.find('a_non_exist_id')
+user.get_or_else(default_user)
+user.or_else(Maybe.unit User.find_by_name("username"))
+
+# usage as a collection
+user.each { |u| p u}
+user.map(&:age)
+user.fmap { |u| Maybe(u.gender) }
+user.filter { |u| u.age > 20 }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lerencao/divergent.rb.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "divergent"
+
+# 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.
+
+require "pry"
+Pry.start

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/divergent.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'divergent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "divergent"
+  spec.version       = Divergent::VERSION
+  spec.authors       = ["Cao Jiafeng"]
+  spec.email         = ["funfriendcjf@gmail.com"]
+
+  spec.summary       = %q{a collection of monad implemented in ruby inspired by scala}
+  spec.description   = %q{the collection provides class handling errors in ruby}
+  spec.homepage      = "http://github.com/lerencao/devergent.rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/divergent.rb

@@ -0,0 +1,13 @@
+require 'divergent/version'
+require 'divergent/try'
+require 'divergent/maybe'
+
+
+##
+# Divergent is a collection of monad class to do error handling in Ruby.
+#
+# Currently, it only contains two class:
+# 1. Try: a container which can wraps possible errors.
+# 2. Maybe: a container which wraps nil case.
+module Divergent
+end

data/lib/divergent/errors.rb

@@ -0,0 +1,7 @@
+module Divergent
+  class UnSupportedOperationError < StandardError
+  end
+
+  class NoSuchElementError < StandardError
+  end
+end

data/lib/divergent/maybe.rb

@@ -0,0 +1,248 @@
+require 'singleton'
+
+require_relative 'errors'
+require_relative 'monad'
+
+module Divergent
+  ##
+  # Represents optional values. Instances of Maybe
+  #  are either an instance of Some or the object None.
+  #
+  #  The most idiomatic way to use an Maybe instance is to treat it
+  #  as a collection or monad and use `map`, `fmap`, `filter`, or
+  #  `each`.
+  class Maybe
+    include Monad
+
+    ##
+    # An Maybe factory which return None.
+    # This always return the same None object.
+    #
+    # Example:
+    #
+    # ```
+    # Maybe.empty == Maybe.empty
+    # ```
+    def self.empty
+      None
+    end
+
+    ##
+    # An factory which creates Some(v) if the argument is not nil,
+    # and None if it is nil.
+    #
+    # Examples:
+    #
+    # ```
+    # Maybe.unit(1)   # => Some(1)
+    # Maybe.unit(nil) # => None
+    # ```
+    def self.unit(v)
+      if v.nil?
+        None
+      else
+        Some.new(v)
+      end
+    end
+
+    ##
+    # Returns the result of applying block to this Maybe value,
+    # if this value is not empty.
+    # Return `None` if this value is empty.
+    #
+    # Slightly different from `map` in that block is expected to
+    # return an instance of `Maybe`.
+    #
+    # Examples
+    #
+    # ```
+    # Maybe.unit(1).fmap { |v| Maybe.unit(v + 1) } # => Some(2)
+    # some_hash = {}
+    # Maybe.unit(:a).fmap { |v| Maybe.unit(some_hash[v]) } # => None
+    # ```
+    def fmap() # :yields: v
+      if empty?
+        None
+      else
+        yield(get)
+      end
+    end
+
+    ##
+    # Return true if the maybe is None, false otherwise.
+    def empty?
+      raise NotImplementedError
+    end
+
+    ##
+    # Return the maybe's value.
+    #
+    # Notes:
+    # the maybe should not be empty.
+    #
+    # otherwise, raise Standarderror.
+    def get
+      raise NotImplementedError
+    end
+
+    ##
+    # Returns the maybe's value if the maybe is nonempty, otherwise
+    # return the `v`.
+    def get_or_else(v)
+      if empty?
+        v
+      else
+        get
+      end
+    end
+
+    ##
+    # Return this maybe id it is not empty,
+    # else return the `v`.
+    #
+    # Note:
+    # This is similar to Maybe#get_or_else,
+    # but the v should be an instance of Maybe.
+    def or_else(v)
+      if empty?
+        v
+      else
+        self
+      end
+    end
+
+    ##
+    # Return a Maybe containing the result of applying block to the maybe's value
+    # if not empty.
+    # Otherwise, return None.
+
+    # Notes:
+    # This is similar to +flat_map+ except here,
+    # block does not need to wrap its result in a maybe.
+    def map() # :yields: v
+      if empty?
+        None
+      else
+        Maybe.unit(yield get)
+      end
+    end
+
+
+    ##
+    # Return this maybe if it is not empty and the predicate block evals to true.
+    # Otherwise, return None.
+    def filter() # :yields: v
+      if !empty? && yield(get)
+        self
+      else
+        None
+      end
+    end
+
+    ##
+    # Test whether the maybe contains a given elem.
+    #
+    # Examples:
+    #
+    # ```
+    # Maybe.unit(1).include?(1) #=> true
+    # Maybe.unit(1).include?(2) #=> false
+    # Maybe.empty.include?(1) #=> false
+    # ```
+    def include?(elem)
+      !empty? && get == elem
+    end
+
+    ##
+    # Return true if it is not empty and the predicate block evals to true.
+    #
+    # Examples:
+    #
+    # ```
+    # Maybe.unit(1).any?{ |v| v == 1} #=> true
+    # Maybe.unit(1).any?{ |v| v == 2} #=> false
+    # Maybe.empty.any?{ |v| v == 1} #=> false
+    # ```
+    def any?() # :yields: v
+      !empty? && yield(get)
+    end
+
+    ##
+    # Return true if it is empty or the predicate block evals to true
+    # when applying to the maybe's value.
+    #
+    # Examples:
+    #
+    # ```
+    # Maybe.unit(1).all?{ |v| v == 1} #=> true
+    # Maybe.unit(1).all?{ |v| v == 2} #=> false
+    # Maybe.empty.all?{ |v| v == 1} #=> true
+    # ```
+    def all?() # :yields: v
+      empty? || yield(get)
+    end
+    ##
+    # Apply the given block to the maybe's value if not empty.
+    # Otherwise, do nothing.
+    def each() # :yields: v
+      yield(get) unless empty?
+    end
+
+    ## Returns a singleton list containing the maybe's value
+    #  if it is nonempty, or the empty list if empty.
+    def to_a
+      if empty?
+        []
+      else
+        [get]
+      end
+    end
+  end
+
+  class Some < Maybe # :nodoc: all
+    def initialize(v)
+      raise 'value cannot be nil' if v.nil?
+      @v = v
+    end
+
+    def empty?
+      false
+    end
+
+    def get
+      @v
+    end
+
+    def to_s
+      "Some(#{@v.inspect})"
+    end
+
+    alias inspect to_s
+  end
+
+  None = Class.new(Maybe) do # :nodoc: all
+    include Singleton
+
+    def empty?
+      true
+    end
+
+    def get
+      raise NoSuchElementError, 'no such element in None.get'
+    end
+
+    def to_s
+      "None"
+    end
+
+    alias inspect to_s
+  end.instance.freeze
+end
+
+module Divergent
+  def Maybe(v)
+    Maybe.unit(v)
+  end
+
+  module_function :Maybe
+end

data/lib/divergent/monad.rb

@@ -0,0 +1,20 @@
+module Divergent
+  ##
+  # The module defines the interfaces that other class should implement.
+  #
+  # Examples:
+  #
+  # ```
+  # Maybe.unit(1) # => Some(1)
+  # Maybe.unit(1).fmap { |v| v + 1 } => Some(2)
+  # ```
+  module Monad
+    def self.unit(v)
+      raise NotImplementedError
+    end
+
+    def fmap(&f)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/divergent/try.rb

@@ -0,0 +1,296 @@
+require_relative 'errors'
+require_relative 'monad'
+
+module Divergent
+  ##
+  # The `Try` type represents a computation that
+  # may either result in an exception, or return a
+  # successfully computed value.
+  # It's similar to, but semantically different from Either.
+  #
+  # Instances of Try, are either an instance of Success or Failure.
+  #
+  # For example, `Try` can be used to perform division on a user-defined input,
+  # without the need to do explicit exception-handling in
+  # all of the places that an exception might occur.
+  module Try
+    include Monad
+    def self.unit(v)
+      Success.new(v)
+    end
+
+    # Returns `true` if the `Try` is a `Failure`, `false` otherwise.
+    def failure?
+      raise NotImplementedError
+    end
+
+    # Returns `true` if the `Try` is a `Success`, `false` otherwise.
+    def success?
+      raise NotImplementedError
+    end
+
+    # Returns the value from this `Success`
+    # or the given `default` argument if this is a `Failure`.
+    def get_or_else(default)
+      if success?
+        get
+      else
+        default
+      end
+    end
+
+    # Returns this `Try` if it's a `Success`
+    # or the given `default` argument if this is a `Failure`.
+    #
+    # Notes: the `default` value should be an instance of Try.
+    def or_else(default)
+      if success?
+        self
+      else
+        default
+      end
+    end
+
+    # Returns the value from this `Success`
+    # or throws the exception if this is a `Failure`.
+    def get
+      raise NotImplementedError
+    end
+
+    ##
+    # Applies the given block if this is a `Success`,
+    # otherwise returns `Unit` if this is a `Failure`.
+    #
+    # Notes:
+    #
+    # If block throws, then this method may throw an exception.
+    def each(&block)
+      raise NotImplementedError
+    end
+
+    ##
+    # Maps the given function to the value from this `Success`
+    # or returns this if this is a `Failure`.
+    def map(&block)
+      raise NotImplementedError
+    end
+
+    # Converts this to a `Failure` if the predicate is not satisfied.
+    def filter(&block)
+      raise NotImplementedError
+    end
+
+    # Applies the given block if this is a `Failure`,
+    # otherwise returns this if this is a `Success`.
+    #
+    # Notes: block call should return an instance of Try.
+    # This is like `fmap` for the exception.
+    def recover_with(&block)
+      raise NotImplementedError
+    end
+
+    # Applies the given block if this is a `Failure`,
+    # otherwise returns this if this is a `Success`.
+    #
+    # This is like `fmap` for the exception.
+    def recover(&block)
+      raise NotImplementedError
+    end
+
+    # Transforms a nested `Try` into an un-nested `Try`.
+    def flatten
+      raise NotImplementedError
+    end
+
+    ##
+    # Inverts this `Try`. If this is a `Failure`, returns its exception wrapped in a `Success`.
+    # If this is a `Success`, returns a `Failure` containing an UnSupportedOperationError.
+    def failed
+      raise NotImplementedError
+    end
+
+    ##
+    # Completes this `Try` by applying the function `f` to this if this is of type `Failure`,
+    # or conversely, by applying `s` if this is a `Success`.
+    def transform(s, f)
+      raise NotImplementedError
+    end
+  end
+
+  class Success # :nodoc: true
+    include Try
+
+    def initialize(value)
+      @value = value
+    end
+
+    def fmap()
+      begin
+        yield @value
+      rescue => e
+        Failure.new(e)
+      end
+    end
+
+    def success?
+      true
+    end
+
+    def failure?
+      false
+    end
+
+    def get
+      @value
+    end
+
+    def each()
+      yield(@value)
+      nil
+    end
+
+    def map()
+      t = begin
+            yield(@value)
+          rescue => e
+            Failure.new(e)
+          end
+
+      Success.new(t)
+    end
+
+    def filter()
+      p = begin
+            yield(@value)
+          rescue => e
+            return Failure.new(e)
+          end
+      if p
+        self
+      else
+        Failure.new(NoSuchElementError.new("Predicate does not hold for #{@value}"))
+      end
+    end
+
+    def recover_with(&block)
+      self
+    end
+
+    def recover(&block)
+      self
+    end
+
+    def failed
+      Failure.new(UnSupportedOperationError.new('Success.failed'))
+    end
+
+    def transform(s, _f)
+      begin
+        s.call(@value)
+      rescue => e
+        Failure.new(e)
+      end
+    end
+
+    def flatten
+      if @value.is_a? Try
+        @value
+      else
+        self
+      end
+    end
+
+    def to_s
+      "Success<#{@value}>"
+    end
+
+    alias inspect to_s
+  end
+
+  class Failure # :nodoc: true
+    include Try
+    def initialize(error)
+      raise 'error should be an StandardError' unless error.is_a? StandardError
+      @error = error
+    end
+
+    def fmap()
+      self
+    end
+
+    def failure?
+      true
+    end
+
+    def success?
+      false
+    end
+
+    def get
+      raise @error
+    end
+
+    def each(&block)
+      nil
+    end
+
+    def map(&block)
+      self
+    end
+
+    def filter(&block)
+      self
+    end
+
+    def recover_with()
+      begin
+        yield(@error)
+      rescue => e
+        Failure.new(e)
+      end
+    end
+
+    def recover()
+      t = yield(@error)
+      Success.new(t)
+    rescue => e
+      return Failure.new(e)
+    end
+
+    def failed
+      Success.new(@error)
+    end
+
+    def transform(_s, f)
+      begin
+        f.call(@error)
+      rescue => e
+        Failure.new(e)
+      end
+    end
+
+    def flatten
+      self
+    end
+
+    def to_s
+      "Failure<#{@error}>"
+    end
+
+    alias inspect to_s
+  end
+end
+
+
+module Divergent
+  ##
+  # Constructs a `Try` by calling the passed block.  This
+  # method will ensure any StandardError is caught and a
+  # `Failure` object is returned.
+  def Try
+    Success.new(yield)
+  rescue => e
+    Failure.new(e)
+  end
+  module_function :Try
+end

data/lib/divergent/version.rb

@@ -0,0 +1,3 @@
+module Divergent
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: divergent
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Cao Jiafeng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: the collection provides class handling errors in ruby
+email:
+- funfriendcjf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- divergent.gemspec
+- lib/divergent.rb
+- lib/divergent/errors.rb
+- lib/divergent/maybe.rb
+- lib/divergent/monad.rb
+- lib/divergent/try.rb
+- lib/divergent/version.rb
+homepage: http://github.com/lerencao/devergent.rb
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: a collection of monad implemented in ruby inspired by scala
+test_files: []