ruby_result 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3847c6fa9fcba436ddfaaabd630efeae2f650f91
+  data.tar.gz: b82ef36162c5bcf63f505521b9a604a4a3a6d355
+SHA512:
+  metadata.gz: 5b3221cae0f045bb1b8dddb950ca40a6ef320f99ca63ad0e4e8f04b728887c5ff20b5f172dbb9cb07a3168f2893f003bbfc15f595f7f4ff67f64cbfacb1485c1
+  data.tar.gz: 1f6619553ccaabb034415ea4d373d0095ddedd2188567e50a51f985f96526bd0e0dc556a9b69ea4a56b17f868b68d84a196d0e52e8e65e7e1a9bb4039205e281

data/.gitignore

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

data/.rbenv-gemsets

@@ -0,0 +1 @@
+.gems

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format d
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at benjreinhart@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Ben Reinhart
+
+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,153 @@
+# RubyResult
+
+Provides a very simple set of objects for dealing with return values in a more structured and consistent way.
+
+```ruby
+include RubyResult
+
+case result = Something.perform(*args)
+when Success then do_something
+when Failure then do_something_else
+end
+```
+
+## Installation
+
+```ruby
+gem 'ruby_result'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_result
+
+## Usage
+
+This gem provides two objects, `RubyResult::Success` and `RubyResult::Failure`. Each are initialized with one object, the `value`. The value can be anything, though for consistency I usually return a `Hash`. The gem is intended to help structure the handling of return values.
+
+As an example, consider an ordering system where many things could fail when attempting to place an order. We'd want to wrap creating an order in a method or module but return an object that can represent success or failure and in each case provide some value.
+
+
+```ruby
+module Orders
+  include RubyResult
+
+  def create_order(product, order_options:, customer_options:, shipping_address_options:, charge_options:)
+    result = nil
+
+    product.with_lock do
+      result = Failure(errors: ["Sold out"]) and raise ActiveRecord::Rollback if product.sold_out?
+
+      customer = Customer.find_or_create_by(customer_options)
+      result = Failure(errors: customer.errors.full_messages) and raise ActiveRecord::Rollback unless customer.valid?
+
+      address = Address.find_or_create_by(shipping_address_options.merge(product: purchaser))
+      result = Failure(errors: address.errors.full_messages) and raise ActiveRecord::Rollback unless address.valid?
+
+      order = Orders::Order.create(order_options)
+      result = Failure(errors: order.errors.full_messages) and raise ActiveRecord::Rollback unless order.valid?
+
+      charge = Orders::Charge.create(charge_options.merge(order: order))
+      result = Failure(errors: charge.errors.full_messages) and raise ActiveRecord::Rollback unless charge.valid?
+
+      result = Success(product: product, order: order, customer: customer, address: address, charge: charge)
+    end
+
+    result
+  end
+end
+```
+
+Then we could call the above and handle the result in an Orders controller.
+
+```ruby
+class OrdersController < ApplicationController
+  include RubyResult
+
+  def create
+    product = load_product(params[:product_id])
+
+    case result = Orders.create_order(product, order_options: order_options, customer_options: customer_options, shipping_address_options: shipping_address_options, charge_options: charge_options)
+    when Success
+      redirect_to customer_order_path(result.value[:customer], result.value[:order]), notice: "Successfully completed order"
+    when Failure
+      redirect_to product_path(product), alert: result.value[:errors].join(". ")
+    end
+  end
+end
+```
+
+## API
+
+#### RubyResult#Success(value)
+
+Convenience method for constructing a `RubyResult::Success` object.
+
+```ruby
+Success("hooray")
+```
+
+#### RubyResult#Failure(value)
+
+Convenience method for constructing a `RubyResult::Failure` object.
+
+```ruby
+Failure("error message")
+```
+
+#### RubyResult::[Success,Failure].new(value)
+
+Create a new `Success` or `Failure` object with some arbitrary `value`.
+
+#### RubyResult::[Success,Failure].===(other)
+
+Compare `other` with `self`. If `other` is an instance of `self`, then it is true. Usefull in case statements.
+
+```ruby
+case result = Something.perform(*args)
+when Success then do_something
+when Failure then do_something_else
+end
+```
+
+#### RubyResult::[Success,Failure]#success?
+
+Returns true if `self` is an instance of `RubyResult::Success`.
+
+```ruby
+result = Something.perform(*args)
+do_something if result.success?
+```
+
+#### RubyResult::[Success,Failure]#failure?
+
+Returns true if `self` is an instance of `RubyResult::Failure`.
+
+```ruby
+result = Something.perform(*args)
+do_something if result.failure?
+```
+
+#### RubyResult::[Success,Failure]#value
+
+Returns the value provided when constructing an `Success` or `Failure` object.
+
+```ruby
+result = Success(order: order)
+result.value # { order: <#Order...> }
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/benjreinhart/ruby_result. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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 "ruby_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,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/ruby_result.rb

@@ -0,0 +1,43 @@
+require "ruby_result/version"
+
+module RubyResult
+  class AbstractResult
+    def self.===(other)
+      other.instance_of?(self)
+    end
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+  end
+
+  class Failure < AbstractResult
+    def failure?
+      true
+    end
+
+    def success?
+      false
+    end
+  end
+
+  class Success < AbstractResult
+    def failure?
+      false
+    end
+
+    def success?
+      true
+    end
+  end
+
+  def Success(v)
+    Success.new(v)
+  end
+
+  def Failure(v)
+    Failure.new(v)
+  end
+end

data/lib/ruby_result/version.rb

@@ -0,0 +1,3 @@
+module RubyResult
+  VERSION = "0.1.0"
+end

data/ruby_result.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_result/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_result"
+  spec.version       = RubyResult::VERSION
+  spec.authors       = ["Ben Reinhart"]
+  spec.email         = ["benjreinhart@gmail.com"]
+
+  spec.summary       = %q{Objects for representing success and error states.}
+  spec.description   = %q{Objects for representing success and error states. Similar to OCaml's Result type.}
+  spec.homepage      = "https://github.com/benjreinhart/ruby_result"
+  spec.license       = "MIT"
+
+  # 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", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ruby_result
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Reinhart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-13 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+description: Objects for representing success and error states. Similar to OCaml's
+  Result type.
+email:
+- benjreinhart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_result.rb
+- lib/ruby_result/version.rb
+- ruby_result.gemspec
+homepage: https://github.com/benjreinhart/ruby_result
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Objects for representing success and error states.
+test_files: []