result-monad 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a46ce98ac67bb98c771e13aa150b09f2bbfd913f
+  data.tar.gz: 6de578017fbab8aa918ee5c5dff8aaac2c9bf0a5
+SHA512:
+  metadata.gz: 4efe4a7c1d80d5485dfb861df83f7a22132bd404ea579e050b73ed8bdd6f87268ef98ee8293a11b6a5a8b8fe53ce38e54fe8349f2c3a49167a46cce34da022d7
+  data.tar.gz: 125c81ad50838e45931509ddb653355bccc27baa253dffcb063a804628cf8a3629e5bf27403306f4222eaf6886bce8a10e61becd6e36750ef54f4b270fe15ef2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in result.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Zachary Daniel
+
+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,190 @@
+# Result
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'result'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install result
+
+## Usage
+
+Use of the Result Monad is a paradigm that is baked into Rust and can lead to very good error handling.  This is an
+initial design, and will need to be refined.  The `Capture()` constructor makes it quite easy to integrate Result into
+a preexisting code base.
+
+### Examples
+
+#### `Capture` success into an Ok result, and exceptions into an Error result via
+
+```ruby
+
+Capture { 100 / 10 } #=> Result<Ok(10)>
+
+Capture { 100 / 0 } #=> Result<Error(divided by 0)>
+
+```
+
+#### Construct Ok or Error yourself
+
+```ruby
+  def can_go_wrong
+    res = do_operation
+    if res.meets_expectations
+      Ok(res)
+    else
+      Error(res)
+    end
+  end
+
+```
+
+#### Basic Dichotomy
+
+```ruby
+
+def divide(x, y)
+  Capture { x / y }
+end
+
+x = divide 50, 10 #=> Result<Ok(5)>
+x.ok? #=> true
+x.error? #=> false
+
+y = divide 50, 0 #=> Result<Error(divided by 0)>
+y.error? #=> true
+y.ok? #=> false
+```
+
+#### Chaining computations with map
+
+```ruby
+x = Ok(100)
+
+x.map {|i| i / 10}
+ .map {|i| i / 5}
+ .map {|i| i / 1}
+#=> Result<Ok(2)>
+```
+
+#### Carrying errors through computations
+
+```ruby
+x = Ok(100)
+
+x.map {|i| i / 10}
+ .map {|i| i / 0}
+ .map {|i| i / 10}
+ 
+#=>Result<Error(divided by 0)>
+```
+
+#### Performing actions in sequence
+
+```ruby
+x = Ok(5)
+y = Error(99)
+z = Ok(25)
+
+# In this case, imagine x and z as successful actions, whereas y is an unsuccessful action.
+
+x & y & z #=> Result<Error(99)>
+
+```
+
+#### Real World Scenario
+
+Lets say we are using an external library to read data from a file over FTP,
+write it to a local file, and then delete the file on the FTP server.  Some things to note:
+
+* We use overloaded operator & to chain on Ok
+* Every call to any outside library, even standard library functions are either in a `map` block which
+  gets Captured or they are themselves Captured
+* No independent action (as in someone calling `copy_file` directly) will execute without its requirements being met.
+
+```ruby
+require 'net/ftp'
+
+class SensitiveFileFTP
+  def initialize(server_uri)
+    @server_uri = server_uri
+  end
+  
+  def transfer_and_delete(file_name)
+    login & # "&" chains on Ok
+    copy_file(file_name) & 
+    ensure_file(file_name) & 
+    delete_remote_file(file_name)
+  end
+  
+  def ftp
+    @ftp ||= Capture { Net::FTP.new(@server_uri) }
+  end
+  
+  def login
+    ftp.map(&:login)
+  end
+  
+  def copy_file(source)
+    ftp.map { |f| f.getbinaryfile(source) }
+  end
+  
+  def ensure_file(name)
+    Capture { raise "Can not verify local copy of file" unless File.exist?(name) }
+  end
+  
+  def delete_remote_file(name)
+    ftp.map {|f| f.delete(name) }
+  end
+  
+  def delete_local_file(name)
+    Capture { File.delete(name) }
+  end
+end
+
+ftp = SensitiveFileFTP.new('speedtest.tele2.net')
+ftp.transfer_and_delete("5MB.zip")
+```
+
+`transfer_and_delete` can return numerous errors but there is no way for this code to raise an exception.  Exceptions
+raised in `map` or `map!` are caught and expressed as `Error`.
+
+
+
+## What's next
+
+* More documentation and refined use cases for existing methods, like `map_err`, `map!`, and `|`
+
+* refine methods of conditionally executing blocks.  Should the return values be wrapped in results, or should we trust
+  the users to do it?
+
+* Right now, the only computational state kept is the last good result or the first error that occurred.
+This may not be ideal or appropriate.  We also don't join errors up the chain, so it is possible to end up with
+something like this: `Error(Error(Error(Error(Error(...)))))`.  We either need to find a way to join, and perhaps
+store the errors as some aggregate object, or we need to provide utilities for probing for information on the different
+nested errors.  I think it may be appropriate to kep a collection of errors, and ensure that we don't nest.
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/result. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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 "result"
+
+# 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

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/lib/result/error.rb

@@ -0,0 +1,27 @@
+class Error
+  def initialize(error)
+    @error = error
+  end
+
+  def map!(&block)
+    @error = Capture {block.call(@error)}
+    self
+  end
+
+  def map(&block)
+    capture_as_error { block.call(@error) }
+  end
+
+  def to_s
+    "Error(#{@error})"
+  end
+
+  private
+  def capture_as_error
+    begin
+      Error(yield)
+    rescue StandardError => e
+      Error(e)
+    end
+  end
+end

data/lib/result/ok.rb

@@ -0,0 +1,18 @@
+class Ok
+  def initialize(value)
+    @value = value
+  end
+
+  def map!(&block)
+    @value = Capture { block.call(@value) }
+    self
+  end
+
+  def map(&block)
+    Capture { block.call(@value) }
+  end
+
+  def to_s
+    "Ok(#{@value})"
+  end
+end

data/lib/result/version.rb

@@ -0,0 +1,3 @@
+class Result
+  VERSION = "0.1.0"
+end

data/lib/result.rb

@@ -0,0 +1,138 @@
+require "result/version"
+require 'byebug'
+
+def Error(error)
+  Result.error(error)
+end
+
+def Ok(value)
+  Result.ok(value)
+end
+
+def Capture
+  begin
+    Ok(yield)
+  rescue StandardError => e
+    Error(e)
+  end
+end
+
+class Result
+  require 'result/error'
+  require 'result/ok'
+
+  def initialize(m)
+    @m = m
+  end
+
+  def ok?
+    @m.is_a? Ok
+  end
+
+  def error?
+    @m.is_a? Error
+  end
+
+  def map!(&block)
+    if ok?
+      @m.map!(&block)
+      self.lift!(val)
+    else
+      self
+    end
+  end
+
+  def map_err!(&block)
+    if error?
+      @m.map!(&block)
+    else
+      self
+    end
+  end
+
+  def map(&block)
+    if ok?
+      @m.map(&block)
+    else
+      self
+    end
+  end
+
+  def map_err(&block)
+    if error?
+      @m.map(&block)
+    else
+      self
+    end
+  end
+
+  def join!
+    if ok? && val.is_a?(Result)
+      lift!(val)
+    end
+    self
+  end
+
+  def lift!(other)
+    @m = (self & other.join!).instance_variable_get(:"@m")
+    self
+  end
+
+  def unwrap
+    raise ResultError.new(self), "Attempted to unwrap an error" if @m.is_a? Error
+    val
+  end
+
+  def and(other)
+    error? ? self : other
+  end
+  alias_method :&, :and
+
+  def or(other)
+    error? ? other : self
+  end
+  alias_method :|, :or
+
+  def and_then(&block)
+    Capture {block.call} if ok?
+  end
+
+  def or_else(&block)
+    Capture {block.call} if error?
+  end
+
+  def unwrap_or(cons)
+    ok? ? unwrap : cons
+  end
+
+  # Constructors
+  def self.error(error)
+    new(Error.new(error))
+  end
+
+  def self.ok(result)
+    new(Ok.new(result))
+  end
+
+  def to_s
+    @m.to_s
+  end
+
+  def inspect
+    "Result<#{self}>"
+  end
+
+  private
+
+  def val
+    @m.instance_variable_get(:"@value")
+  end
+end
+
+class ResultError < StandardError
+  attr_reader :result
+
+  def initialize(result)
+    @result = result
+  end
+end

data/result.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'result/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "result-monad"
+  spec.version       = Result::VERSION
+  spec.authors       = ["Zachary Daniel"]
+  spec.email         = ["zachary.s.daniel@gmail.com"]
+
+  spec.summary       = "The Result Monad implemented in ruby."
+  spec.description   = "The Result Monad implemented in ruby. Designed to maximize usefulness, as sticking to the category theoretical Monad is not really feasible without an evolved static type system."
+  spec.homepage      = "http://gitlab.com/zachdaniel/result"
+  spec.license       = "MIT"
+
+  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.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: result-monad
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zachary Daniel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: The Result Monad implemented in ruby. Designed to maximize usefulness,
+  as sticking to the category theoretical Monad is not really feasible without an
+  evolved static type system.
+email:
+- zachary.s.daniel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/result.rb
+- lib/result/error.rb
+- lib/result/ok.rb
+- lib/result/version.rb
+- result.gemspec
+homepage: http://gitlab.com/zachdaniel/result
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: The Result Monad implemented in ruby.
+test_files: []
+has_rdoc: