dry-monads 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88cbc378229c970ceaee7b5836e049e9802fa673
+  data.tar.gz: 1bb1cb7d186fe287406f2be34a5f068a29d2edde
+SHA512:
+  metadata.gz: 15a531580dda1dd1ae4d2a18da1ef0bc9d15925001fecad504276aceedf27619635620646c8f003b24f7282d2825f4ec65619a6bc30c656fc508c7259ffbc501
+  data.tar.gz: 9f71fc354106893b2b95f1f082014435cc3a74443b13812b8141f7c44b8007034ea2f77c5f7aa5e6c41b8214804af105cffcf8c559da6e98917a5633edb37b28

data/.codeclimate.yml

@@ -0,0 +1,41 @@
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/Documentation:
+        enabled: false
+      Rubocop/Style/StringLiterals:
+        enabled: false
+      Rubocop/Style/MethodName:
+        enabled: false
+      Rubocop/Style/LambdaCall:
+        enabled: false
+      Rubocop/Style/StabbyLambdaParentheses:
+        enabled: false
+      Rubocop/Style/NestedParenthesizedCalls:
+        enabled: false
+      Rubocop/Style/MultilineBlockChain:
+        enabled: false
+      Rubocop/Style/GuardClause:
+        enabled: false
+      Rubocop/Metrics/LineLength:
+        enabled: true
+        max: 110
+      Rubocop/Style/FileName:
+        enabled: true
+        exclude:
+          - 'lib/dry-monads.rb'
+      Rubocop/Lint/Debugger:
+        enabled: true
+        exclude:
+          - 'bin/console'
+      Rubocop/Lint/HandleExceptions:
+        enabled: true
+        exclude:
+          - 'spec/spec_helper.rb'
+ratings:
+  paths:
+    - lib/**/*.rb
+  exclude_paths:
+    - spec/**/*
+    - examples/**/*

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,40 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/MethodName:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/StabbyLambdaParentheses:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 110
+
+Style/FileName:
+  Exclude:
+    - 'lib/dry-monads.rb'
+
+Lint/Debugger:
+  Exclude:
+    - 'bin/console'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/spec_helper.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-04-29 01:33:48 +0100 using RuboCop version 0.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,40 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without benchmarks tools
+script:
+  - bundle exec rake spec
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - rbx-2
+  - jruby-9000
+  - ruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+before_install:
+  - gem update bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  include:
+    - rvm: jruby-head
+      before_install: gem install bundler --no-ri --no-rdoc
+
+notifications:
+  email:
+    recipients:
+      - fg@flashgordon.ru
+    on_success: change
+    on_failure: always
+    on_start: false     # default: false
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/19098b4253a72c9796db
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'simplecov', require: false
+end
+
+group :tools do
+  gem 'rubocop'
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2014 Piotr Solnica
+
+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,232 @@
+[gitter]: https://gitter.im/dry-rb/chat
+[gem]: https://rubygems.org/gems/dry-monads
+[travis]: https://travis-ci.org/dry-rb/dry-monads
+[code_climate]: https://codeclimate.com/github/dry-rb/dry-monads
+[inch]: http://inch-ci.org/github/dry-rb/dry-monads
+
+# dry-monads [![Join the Gitter chat](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
+[![Gem Version](https://img.shields.io/gem/v/dry-monads.svg)][gem]
+[![Build Status](https://img.shields.io/travis/dry-rb/dry-monads.svg)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/dry-rb/dry-monads.svg)][code_climate]
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/dry-rb/dry-monads.svg)][code_climate]
+[![API Documentation Coverage](http://inch-ci.org/github/dry-rb/dry-monads.svg)][inch]
+
+Monads for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-monads'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install dry-monads
+```
+
+## Usage
+
+### Maybe monad
+
+The `Maybe` mondad is used when a series of computations that could return `nil`
+at any point.
+
+#### `bind`
+
+```ruby
+require 'dry-monads'
+
+M = Dry::Monads
+
+maybe_user = M.Maybe(user).bind do |u|
+  M.Maybe(user.address).bind do |a|
+    M.Maybe(a.street)
+  end
+end
+
+# If user with address exists
+# => Some("Street Address")
+# If user or address is nil
+# => None()
+
+# You also can pass a proc to #bind
+
+add_two = -> x { x + 2 }
+
+M.Maybe(5).bind(add_two).bind(add_two) # => Some(9)
+
+```
+
+#### `fmap`
+
+Similar to `bind` but lifts the result for you.
+
+```ruby
+require 'dry-monads'
+
+Dry::Monads::Maybe(user).fmap(&:address).fmap(&:street)
+
+# If user with address exists
+# => Some("Street Address")
+# If user or address is nil
+# => None()
+```
+
+### Either monad
+
+The `Either` mondad is useful to express a series of computations that might
+return an error object with additional information.
+
+The `Either` mixin has two type constructors: `Right` and `Left`. The `Right`
+can be thought of as "everything went right" and the `Left` is used when
+"something has gone wrong".
+
+#### `Either::Mixin`
+
+```ruby
+require 'dry-monads'
+
+class EitherCalculator
+  include Dry::Monads::Either::Mixin
+
+  attr_accessor :input
+
+  def calculate
+    i = Integer(input)
+
+    Right(i).bind do |value|
+      if value > 1
+        Right(value + 3)
+      else
+        Left("value was less than 1")
+      end
+    end.bind do |value|
+      if value % 2 == 0
+        Right(value * 2)
+      else
+        Left("value was not even")
+      end
+    end
+  end
+end
+
+# EitherCalculator instance
+c = EitherCalculator.new
+
+# If everything went right
+c.input = 3
+result = c.calculate
+result # => Right(12)
+result.value # => 12
+
+# If if failed in the first block
+c.input = 0
+result = c.calculate
+result # => Left("value was less than 1")
+result.value # => "value was less than 1"
+
+# if it failed in the second block
+c.input = 2
+result = c.calculate
+result # => Left("value was not even")
+result.value # => "value was not even"
+```
+
+#### `fmap`
+
+An example of using `fmap` with `Right` and `Left`.
+
+```ruby
+require 'dry-monads'
+
+M = Dry::Monads
+
+result = if foo > bar
+  M.Right(10)
+else
+  M.Left("wrong")
+end.fmap { |x| x * 2 }
+
+# If everything went right
+result # => Right(20)
+# If it did not
+result # => Left("wrong")
+
+# #fmap accepts proc as well as #bind
+
+upcase = :upcase.to_proc
+
+M.Right('hello').fmap(upcase) # => Right("HELLO")
+```
+
+#### `or`
+
+An example of using `or` with `Right` and `Left`.
+
+```ruby
+M = Dry::Monads
+
+M.Right(10).or(M.Right(99)) # => Right(10)
+M.Left("error").or(M.Left("new error")) # => Left("new error")
+M.Left("error").or { |err| M.Left("new #{err}") } # => Left("new error")
+```
+
+#### `to_maybe`
+
+Sometimes it's useful to turn an 'Either' into a 'Maybe'
+
+```ruby
+require 'dry-monads'
+
+result = if foo > bar
+  Dry::Monads.Right(10)
+else
+  Dry::Monads.Left("wrong")
+end.to_maybe
+
+# If everything went right
+result # => Some(10)
+# If it did not
+result # => None()
+```
+
+### Try monad
+
+Examples of using the `Try` monad.
+
+```ruby
+require 'dry-monads'
+
+extend Dry::Monads::Try::Mixin
+
+res = Try() { 10 / 2 }
+res.value if res.success?
+# => 5
+
+res = Try() { 10 / 0 }
+res.exception if res.failure?
+# => #<ZeroDivisionError: divided by 0>
+
+Try(NoMethodError, NotImplementedError) { 10 / 0 }
+# => raise ZeroDivisionError: divided by 0 exception
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/dry-rb/dry-monads]().

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 'dry-monads'
+
+M = Dry::Monads
+
+# 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'
+
+binding.pry

data/bin/setup

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

data/dry-monads.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/monads/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-monads'
+  spec.version       = Dry::Monads::VERSION.dup
+  spec.authors       = ['Nikita Shilnikov']
+  spec.email         = ['fg@flashgordon.ru']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Common monads for Ruby.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dry-rb/dry-monads'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/dry-monads.rb

@@ -0,0 +1 @@
+require 'dry/monads'

data/lib/dry/monads.rb

@@ -0,0 +1,29 @@
+require 'dry/monads/either'
+require 'dry/monads/maybe'
+require 'dry/monads/try'
+
+module Dry
+  module Monads
+    extend self
+
+    def Maybe(value)
+      Maybe.lift(value)
+    end
+
+    def Some(value)
+      Maybe::Some.new(value)
+    end
+
+    def None
+      Maybe::Some::None.instance
+    end
+
+    def Right(value)
+      Either::Right.new(value)
+    end
+
+    def Left(value)
+      Either::Left.new(value)
+    end
+  end
+end

data/lib/dry/monads/either.rb

@@ -0,0 +1,100 @@
+module Dry
+  module Monads
+    class Either
+      attr_reader :right, :left
+
+      def ==(other)
+        other.is_a?(Either) && right == other.right && left == other.left
+      end
+
+      def right?
+        is_a? Right
+      end
+      alias success? right?
+
+      def left?
+        is_a? Left
+      end
+      alias failure? left?
+
+      class Right < Either
+        alias value right
+
+        def initialize(right)
+          @right = right
+        end
+
+        def bind(proc = nil)
+          if proc
+            proc.call(value)
+          else
+            yield(value)
+          end
+        end
+
+        def fmap(proc = nil, &block)
+          Right.new(bind(&(proc || block)))
+        end
+
+        def or(_val = nil)
+          self
+        end
+
+        def to_s
+          "Right(#{value.inspect})"
+        end
+        alias inspect to_s
+
+        def to_maybe
+          Maybe::Some.new(value)
+        end
+      end
+
+      class Left < Either
+        alias value left
+
+        def initialize(left)
+          @left = left
+        end
+
+        def bind(_proc = nil)
+          self
+        end
+
+        def fmap(_proc = nil)
+          self
+        end
+
+        def or(val = nil)
+          if block_given?
+            yield(value)
+          else
+            val
+          end
+        end
+
+        def to_s
+          "Left(#{value.inspect})"
+        end
+        alias inspect to_s
+
+        def to_maybe
+          Maybe::None.instance
+        end
+      end
+
+      module Mixin
+        Right = Right
+        Left = Left
+
+        def Right(value)
+          Right.new(value)
+        end
+
+        def Left(value)
+          Left.new(value)
+        end
+      end
+    end
+  end
+end

data/lib/dry/monads/maybe.rb

@@ -0,0 +1,103 @@
+module Dry
+  module Monads
+    class Maybe
+      def self.lift(value)
+        if value.nil?
+          None.instance
+        else
+          Some.new(value)
+        end
+      end
+
+      def ==(other)
+        other.is_a?(Maybe) && value == other.value
+      end
+
+      def none?
+        is_a?(None)
+      end
+
+      def some?
+        is_a?(Some)
+      end
+
+      class Some < Maybe
+        attr_reader :value
+
+        def initialize(value)
+          raise ArgumentError, 'nil cannot be some' if value.nil?
+          @value = value
+        end
+
+        def bind(proc = nil)
+          if proc
+            proc.call(value)
+          else
+            yield(value)
+          end
+        end
+
+        def fmap(proc = nil, &block)
+          self.class.lift(bind(&(proc || block)))
+        end
+
+        def or(_val = nil)
+          self
+        end
+
+        def to_s
+          "Some(#{value.inspect})"
+        end
+        alias inspect to_s
+      end
+
+      class None < Maybe
+        @instance = new
+        singleton_class.send(:attr_reader, :instance)
+
+        def value
+          nil
+        end
+
+        def bind(_proc = nil)
+          self
+        end
+
+        def fmap(_proc = nil)
+          self
+        end
+
+        def or(val = nil)
+          if block_given?
+            yield(value)
+          else
+            val
+          end
+        end
+
+        def to_s
+          'None'
+        end
+        alias inspect to_s
+      end
+
+      module Mixin
+        Maybe = Maybe
+        Some = Some
+        None = None
+
+        def Maybe(value)
+          Maybe.lift(value)
+        end
+
+        def Some(value)
+          Some.new(value)
+        end
+
+        def None
+          None.instance
+        end
+      end
+    end
+  end
+end

data/lib/dry/monads/try.rb

@@ -0,0 +1,101 @@
+module Dry
+  module Monads
+    class Try
+      attr_reader :exception, :value
+
+      def self.lift(exceptions, f)
+        Success.new(exceptions, f.call)
+      rescue *exceptions => e
+        Failure.new(e)
+      end
+
+      def success?
+        is_a? Success
+      end
+
+      def failure?
+        is_a? Failure
+      end
+
+      class Success < Try
+        attr_reader :catchable
+
+        def initialize(exceptions, value)
+          @catchable = exceptions
+          @value = value
+        end
+
+        def bind(proc = nil)
+          if proc
+            proc.call(value)
+          else
+            yield(@value)
+          end
+        rescue *catchable => e
+          Failure.new(e)
+        end
+
+        def fmap(proc = nil, &block)
+          Try.lift(catchable, -> { (block || proc).call(@value) })
+        end
+
+        def ==(other)
+          other.is_a?(Success) && @value == other.value && @catchable == other.catchable
+        end
+
+        def to_maybe
+          Dry::Monads::Maybe(@value)
+        end
+
+        def to_either
+          Dry::Monads::Right(@value)
+        end
+
+        def to_s
+          "Try::Success(#{value.inspect})"
+        end
+        alias inspect to_s
+      end
+
+      class Failure < Try
+        def initialize(exception)
+          @exception = exception
+        end
+
+        def bind(_f = nil)
+          self
+        end
+
+        def fmap(_f = nil)
+          self
+        end
+
+        def to_maybe
+          Dry::Monads::None()
+        end
+
+        def to_either
+          Dry::Monads::Left(@exception)
+        end
+
+        def ==(other)
+          other.is_a?(Failure) && @exception == other.exception
+        end
+
+        def to_s
+          "Try::Failure(#{exception.class}: #{exception.message})"
+        end
+        alias inspect to_s
+      end
+
+      module Mixin
+        Try = Try
+
+        def Try(*exceptions, &f)
+          catchable = exceptions.any? ? exceptions.flatten : [StandardError]
+          Try.lift(catchable, f)
+        end
+      end
+    end
+  end
+end

data/lib/dry/monads/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Monads
+    VERSION = '0.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: dry-monads
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nikita Shilnikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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'
+description: Common monads for Ruby.
+email:
+- fg@flashgordon.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dry-monads.gemspec
+- lib/dry-monads.rb
+- lib/dry/monads.rb
+- lib/dry/monads/either.rb
+- lib/dry/monads/maybe.rb
+- lib/dry/monads/try.rb
+- lib/dry/monads/version.rb
+homepage: https://github.com/dry-rb/dry-monads
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Common monads for Ruby.
+test_files: []