resultr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1651637e66e98a6a7001ee31ec00314f2a64c42ddb1520d20d4f407271b383ab
+  data.tar.gz: 4aca80aa9cc55ec641d255a3c05984ecea4f8cdc75a334179a20f813900c9f74
+SHA512:
+  metadata.gz: 1843722ea0e26a7a67c8b693c613e567f269a12fb62a765452bab23e7a54a414753a76886dc539a39d545688d824f06a85e8d1914364248a833aade06104276c
+  data.tar.gz: 31ec642597a4a10651b25234b321e1518e184fef7eb43e290f4e23a7462157a0940a9d10d3dd8de857536e2ecfa41da51aa8775d0ad298b4d3b2b07a20936440

data/.gitignore

@@ -0,0 +1,7 @@
+.ruby-version
+.ruby-gemset
+.bundle
+.DS_Store
+Gemfile.lock
+tags
+resultr-*.gem

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5.0
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude: test/**/*.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.5.0
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Leonardo Camelo
+
+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,169 @@
+# Resultr
+
+[![Build Status](https://travis-ci.org/leocamelo/resultr.svg?branch=master)](https://travis-ci.org/leocamelo/resultr)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d59916bca76b37153273/maintainability)](https://codeclimate.com/github/leocamelo/resultr/maintainability)
+
+Ruby beautiful results.
+
+Resultr provides a simple interface to work with computation results, highly
+inspired by [Rust results](https://doc.rust-lang.org/std/result) for handling
+errors on function returns.
+
+## Installation
+
+Add Resultr to your `Gemfile`:
+
+```ruby
+gem 'resultr'
+```
+
+and run `bundle install` from your shell.
+
+## Getting Started
+
+### Good and bad results
+
+Resultr works with two kinds of results, good results (`Resultr.ok`) and bad
+results (`Resultr.err`). You can store any kind of data on any kind of result.
+
+```ruby
+  good_result = Resultr.ok(42)
+  # => <Resultr::Result @kind=:ok @value=42>
+
+  good_result.ok?
+  # => true
+
+  good_result.value
+  # => 42
+
+  bad_result = Resultr.err('foo')
+  # => <Resultr::Result @kind=:err @value="foo">
+
+  bad_result.err?
+  # => true
+
+  bad_result.reason
+  # => "foo"
+```
+
+*`#reason` is an alias of `#value`, but is a common practice
+to use `#value` for good results and `#reason` for bad results.*
+
+### Chaining results
+
+You can chain results with `#and_then` and `#or_else` methods,
+both will receive a block using result's value / reason and returns
+the block return or itself, depending on result kind.
+
+```ruby
+  def shout(word)
+    if word == 'marco'
+      Resultr.ok('polo')
+    else
+      Resultr.err('unknown word')
+    end
+  end
+
+  # =========================================
+  # Using #and_then to chaining good results.
+  # =========================================
+
+  shout('marco').and_then { |value| "#{value}!" }
+  # => "polo!"
+
+  shout('foo').and_then { |value| "#{value}!" }
+  # => <Resultr::Result @kind=:err @value="unknown word">
+
+  # =======================================
+  # Using #or_else to chaining bad results.
+  # =======================================
+
+  shout('marco').or_else { |reason| "#{reason}, try 'marco'" }
+  # => <Resultr::Result @kind=:ok @value="polo">
+
+  shout('foo').or_else { |reason| "#{reason}, try 'marco'" }
+  # => "unknown word, try 'marco'"
+
+  # ================================================
+  # Using both to chaining the two kinds of results.
+  # ================================================
+
+  shout('marco').and_then { |v| "#{v}!" }.or_else { |r| "#{r}, try 'marco'" }
+  # => "polo!"
+
+  shout('foo').and_then { |v| "#{v}!" }.or_else { |r| "#{r}, try 'marco'" }
+  # => "unknown word, try 'marco'"
+```
+
+### Elegant result branching
+
+Resultr provides a sugar syntax for branching results by kind,
+its called `#thus` and works like a flavor of case statement.
+
+```ruby
+  def get_posts
+    response = get('/posts')
+
+    if response.status == 200
+      Resultr.ok(response.body)
+    else
+      Resultr.err(response.body)
+    end
+  end
+
+  # ==================================
+  # Using #thus for branching actions.
+  # ==================================
+
+  get_posts.thus do |result|
+    result.ok do |value|
+      render json: { posts: value }
+    end
+    result.err do |reason|
+      render json: { error: reason }
+    end
+  end
+  # => ["{\"posts\":[{\"title\":\"The Free Lunch Is Over\"}]}"]
+
+  # =====================================
+  # Using #thus for branching assignment.
+  # =====================================
+
+  posts = get_posts.thus do |result|
+    result.ok # if you omit the block, it returns value
+    result.err { |_reason| [{ title: 'The Placeholder Post' }] }
+  end
+  # => [{ title: "The Free Lunch Is Over" }]
+```
+
+### Raising exceptions for bad results
+
+If you don't want to handle possible result errors, you can use
+`#expect!`, that returns the result value when successful or raises
+an exception with the error reason, you can also provides a custom
+message for the exception.
+
+```ruby
+  def write_on(file, text)
+    if File.exist?(file)
+      File.open(file, 'w') { |f| f.write(text) }
+      Resultr.ok(text)
+    else
+      Resultr.err('File not found')
+    end
+  end
+
+  write_on('diary.txt', 'Dear diary').expect!
+  # => "Dear diary"
+
+  write_on('wrong.txt', 'Dear diary').expect!
+  # => Resultr::ExpectationError: File not found
+
+  write_on('wrong.txt', 'Dear diary').expect!('Failed to write text')
+  # => Resultr::ExpectationError: Failed to write text
+```
+
+## License
+
+Resultr is freely distributable under the
+[MIT license](https://github.com/leocamelo/resultr/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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/lib/resultr.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'resultr/version'
+require 'resultr/expectation_error'
+require 'resultr/result'
+require 'resultr/result_proxy'
+
+module Resultr
+  def self.ok(value)
+    ::Resultr::Result.new(:ok, value)
+  end
+
+  def self.err(reason)
+    ::Resultr::Result.new(:err, reason)
+  end
+end

data/lib/resultr/expectation_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Resultr
+  class ExpectationError < StandardError; end
+end

data/lib/resultr/result.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Resultr
+  class Result
+    attr_reader :value
+    alias reason value
+
+    def initialize(kind, value)
+      @kind = kind
+      @value = value
+    end
+
+    def ok?
+      @kind == :ok
+    end
+
+    def err?
+      @kind == :err
+    end
+
+    def and_then
+      if ok?
+        yield @value
+      else
+        self
+      end
+    end
+
+    def or_else
+      if err?
+        yield @value
+      else
+        self
+      end
+    end
+
+    def expect!(message = @value)
+      if ok?
+        @value
+      else
+        raise ::Resultr::ExpectationError, message
+      end
+    end
+
+    def thus
+      result_proxy = ::Resultr::ResultProxy.new(self)
+      yield result_proxy
+    end
+  end
+end

data/lib/resultr/result_proxy.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Resultr
+  class ResultProxy
+    def initialize(result)
+      @result = result
+      @resolved = false
+    end
+
+    def ok
+      resolve_result_if :ok? do |value|
+        if block_given?
+          yield value
+        else
+          value
+        end
+      end
+    end
+
+    def err
+      resolve_result_if :err? do |reason|
+        if block_given?
+          yield reason
+        else
+          reason
+        end
+      end
+    end
+
+    private
+
+    def resolve_result_if(condition)
+      if @resolved
+        @result.value
+      elsif @result.send(condition)
+        @resolved = true
+        yield @result.value
+      end
+    end
+  end
+end

data/lib/resultr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Resultr
+  VERSION = '0.1.0'
+end

data/resultr.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resultr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resultr'
+  spec.version       = Resultr::VERSION
+  spec.authors       = ['@leocamelo']
+  spec.email         = ['leonardocamelo.nave@gmail.com']
+  spec.summary       = 'Ruby beatiful results'
+  spec.homepage      = 'https://github.com/leocamelo/resultr'
+  spec.license       = 'MIT'
+  spec.require_paths = ['lib']
+
+  spec.description = <<~DESCRIPTION
+    Resultr provides a simple interface to work with
+    computation results, highly inspired by Rust results
+    for handling errors on function returns.
+  DESCRIPTION
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: resultr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "@leocamelo"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !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'
+description: |
+  Resultr provides a simple interface to work with
+  computation results, highly inspired by Rust results
+  for handling errors on function returns.
+email:
+- leonardocamelo.nave@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/resultr.rb
+- lib/resultr/expectation_error.rb
+- lib/resultr/result.rb
+- lib/resultr/result_proxy.rb
+- lib/resultr/version.rb
+- resultr.gemspec
+homepage: https://github.com/leocamelo/resultr
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Ruby beatiful results
+test_files: []