resonad 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '049ebe880a81a65ead9e8fc9521acccc2fcf2b8d'
+  data.tar.gz: 502f3566a2a5e70424528d1ec79ba0cd234cf3f0
+SHA512:
+  metadata.gz: 24fc92d3b8c14bf477ae416a96c228107e169c0a18f203a814007215d112641aad620919ef37e23b4e86724a7fee98dcbd40fd37d28fe3404f28ba65a2eef33f
+  data.tar.gz: fac2fdac51b782ba081ea3a7c2fcff0f71c44ee91f342d5dab098abd89c9585414543bbf6fabf8b6cd24bfc87a315a51dbdcddaf9677b9d41745bb34e2951914

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+cache: bundler
+deploy:
+  provider: rubygems
+  on:
+    tags: true
+    rvm: 2.4.1
+  api_key:
+    secure: JPfhiLx7tDs9u4nXvVpQX041NHgZpTMTCAWqG52Us6pJIpDXl+nNzKaI0U/grucEE+OZQ8wfq/N3MV5uHHel+NzwVIVeJlouz3JiPXJUI60+tPvucLHe63LR/I3jzCWzHRLcwCYRo8mhh6jrq01KztgFRUxHzRTRodDcqFMi+xE=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tom@tomdalling.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tom Dalling
+
+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,78 @@
+# Resonad
+
+Usage example (assume each method returns a `Resonad`):
+
+```ruby
+find_widget(widget_id)
+  .and_then { |widget| update_widget(widget) }
+  .on_success { |widget| logger.info("Updated #{widget}" }
+  .on_failure { |error| logger.warn("Widget update failed because #{error}") }
+```
+
+Success type:
+
+```ruby
+result = Resonad.Success(5)
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 5
+result.error #=> raises an exception
+```
+
+Failure type:
+
+```ruby
+result = Resonad.Failure(:buzz)
+result.success? #=> false
+result.failure? #=> true
+result.value #=> raises an exception
+result.error #=> :buzz
+```
+
+Mapping monads:
+
+```ruby
+result = Resonad.Success(5)
+  .map { |i| i + 1 }
+  .map { |i| i + 1 }
+  .map { |i| i + 1 }
+result.success? #=> true
+result.value #=> 8
+
+result = Resonad.Failure(:buzz)
+  .map { |i| i + 1 }
+  .map { |i| i + 1 }
+  .map { |i| i + 1 }
+result.success? #=> false
+result.error #=> :buzz
+```
+
+Flat mapping monads (a.k.a. `and_then`):
+
+```ruby
+result = Resonad.Success(5)
+  .and_then { |i| Resonad.Success(i + 1) }
+  .and_then { |i| Resonad.Failure("buzz #{i}") }
+  .and_then { |i| Resonad.Success(i + 1) }
+  .error #=> "buzz 6"
+
+# can also use the less-nice `flat_map` method
+result
+  .flat_map { |i| Resonad.Success(i + 1) }
+```
+
+Automatic exception rescuing:
+
+```ruby
+def try_divide(top, bottom)
+  Resonad.rescuing_from(ZeroDivisionError) { top / bottom }
+end
+
+yep = try_divide(6, 2)
+yep.success? #=> true
+yep.value #=> 3
+
+nope = try_divide(6, 0)
+nope.success? #=> false
+node.error #=> #<ZeroDivisionError: ZeroDivisionError>
+```

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 "resonad"
+
+# 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/resonad.rb

@@ -0,0 +1,131 @@
+module Resonad
+  class NonExistantError < StandardError; end
+  class NonExistantValue < StandardError; end
+
+  def self.Success(*args)
+    Success.new(*args)
+  end
+
+  def self.Failure(*args)
+    Failure.new(*args)
+  end
+
+  def self.rescuing_from(*exception_classes)
+    Success(yield)
+  rescue Exception => e
+    if exception_classes.empty?
+      Failure(e) # rescue from all exceptions
+    elsif exception_classes.any? { |klass| e.is_a?(klass) }
+      Failure(e) # rescue from specified exception type
+    else
+      raise # reraise unhandled exception
+    end
+  end
+
+  class Success
+    attr_accessor :value
+
+    def initialize(value)
+      @value = value
+      freeze
+    end
+
+    def success?
+      true
+    end
+
+    def failure?
+      false
+    end
+
+    def on_success
+      yield value
+      self
+    end
+
+    def on_failure
+      self
+    end
+
+    def error
+      raise NonExistantError, "Success resonads do not have errors"
+    end
+
+    def map
+      new_value = yield(value)
+      if new_value.__id__ == value.__id__
+        self
+      else
+        self.class.new(new_value)
+      end
+    end
+
+    def map_error
+      self
+    end
+
+    def flat_map
+      yield value
+    end
+    alias_method :and_then, :flat_map
+
+    def flat_map_error
+      self
+    end
+    alias_method :or_else, :flat_map_error
+  end
+
+  class Failure
+    attr_accessor :error
+
+    def initialize(error)
+      @error = error
+      freeze
+    end
+
+    def success?
+      false
+    end
+
+    def failure?
+      true
+    end
+
+    def on_success
+      self
+    end
+
+    def on_failure
+      yield error
+      self
+    end
+
+    def value
+      raise NonExistantValue, "Failure resonads do no have values"
+    end
+
+    def map
+      self
+    end
+
+    def map_error
+      new_error = yield(error)
+      if new_error.__id__ == error.__id__
+        self
+      else
+        self.class.new(new_error)
+      end
+    end
+
+    def flat_map
+      self
+    end
+    alias_method :and_then, :flat_map
+
+    def flat_map_error
+      yield error
+    end
+    alias_method :or_else, :flat_map_error
+  end
+
+end

data/lib/resonad/version.rb

@@ -0,0 +1,3 @@
+module Resonad
+  VERSION = '1.0'
+end

data/resonad.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'resonad/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resonad'
+  spec.version       = Resonad::VERSION
+  spec.authors       = ["Tom Dalling"]
+  spec.email         = ['tom' + '@' + 'tomdalling.com']
+
+  spec.summary       = "Objects that represent success or failure"
+  spec.homepage      = "https://github.com/tomdalling/resonad"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "gem-release", "~> 0.7"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: resonad
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 
+email:
+- tom@tomdalling.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/resonad.rb
+- lib/resonad/version.rb
+- resonad.gemspec
+homepage: https://github.com/tomdalling/resonad
+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.2
+signing_key: 
+specification_version: 4
+summary: Objects that represent success or failure
+test_files: []