safety_dance 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b31621603fc39f116f89c25d490c732980bfa03c
+  data.tar.gz: 2ce97de88b2a16e1792237de97d56548bdfb334e
+SHA512:
+  metadata.gz: 2a10c5836ae66408dec42c293bf390b15a28ed9422b56acdc45dad186d85da3c20f2748bb67fdf9ae20890a4f955aaf34c927112e847f8e40d721914ea7fe597
+  data.tar.gz: fe3e24de58791fa2f35bad417f6480bda42256b6b3644f6a8018eaa43113050b89eca124a47e3d2e4777d76913ff082338289964c1f51d2d398e343e572bc3d2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

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 github@benjaminfleischer.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in safety_dance.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Benjamin Fleischer
+
+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,120 @@
+# SafetyDance
+
+A Response Object pattern for resilient Ruby code.
+
+Example:
+
+```ruby
+SafetyDance.new { dance! }.
+  then { |result| leave_friends_behind(!result) }.
+  rescue { |error| not_friends_of_mine(error) }.
+  value!
+```
+
+Strongly inspired by [John Nunemaker's 'Resilience in Ruby: Handling Failure'](https://johnnunemaker.com/resilience-in-ruby/)
+post, and the implementation of [Github::Result]( https://github.com/github/github-ds/blob/fbda5389711edfb4c10b6c6bad19311dfcb1bac1/lib/github/result.rb).
+
+Quoting the post:
+
+> By putting a response object in between the caller and the call to get the data:
+
+> - we always return the same object, avoiding `nil` and retaining duck typing.
+> - we now have a place to add more context about the failure if necessary, which we did not have with `nil`.
+> - we have a single place to update rescued exceptions if a new one pops up.
+> - we have a nice place for instrumentation and circuit breakers in the future.
+> - we avoid needing `begin` and `rescue` all over and instead can use conditionals or whatever makes sense.
+> - we give the caller the ability to handle different failures differently (Conn refused vs Timeout vs Rate limited, etc.).
+
+> The key to me including *a layer on top* that bakes in the resiliency,
+> making it easy for callers to do the right thing in the face of failure.
+> Using response objects can definitely help with that.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safety_dance'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safety_dance
+
+Or just copy the relevant code into your project somewhere, such as this minimal implementation:
+
+```ruby
+class Result
+  def initialize
+    @value = yield
+    @error = nil
+  rescue => e
+    @error = e
+  end
+
+  def ok?
+    @error.nil?
+  end
+
+  def value!
+    if ok?
+      @value
+    else
+      raise @error
+    end
+  end
+
+  def rescue
+    return self if ok?
+    Result.new { yield(@error) }
+  end
+end
+```
+
+## Usage
+
+Start with passing a block to `SafetyDance.new`, and continue with the available API.
+
+### Instance methods
+
+| method call |  returns  |
+|------------ | --------- |
+| ok?         | true if value when no error else false
+| value!      | value if no error else raises error
+| error       | the rescued error
+
+
+### Instance chain methods
+
+| method call | call conditions  | yields          | returns  |
+|------------ |----------------- |---------------- |--------- |
+| then        |  ok?             | return value    | instance |
+| rescue      |  error           | rescued error   | instance |
+
+## Development
+
+1. Check out the repo.
+2. Run `bin/setup` to install dependencies.
+3. Run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bf4/safety_dance.
+
+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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SafetyDance project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bf4/safety_dance/blob/master/CODE_OF_CONDUCT.md).

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

@@ -0,0 +1,102 @@
+require "safety_dance/version"
+
+# Generic 'Result' object for declarative result success/failure/cascade handling.
+#
+# Usage:
+#
+#   def some_action_that_succeeds(msg); msg; end
+#   def some_action_that_fails(msg); raise msg; end
+#
+#   SafetyDance.new { some_action_that_succeeds(:success) } #=> SafetyDance
+#
+#   SafetyDance.new { some_action_that_succeeds(:success) }
+#     .value {|error| "action failed with error #{error}" } #=> :success
+#
+#   SafetyDance.new { some_action_that_fails("fail")}
+#     .value {|error| "action failed with error #{error}" } #=> "action failed with error 'RuntimeError fail'"
+#
+#   SafetyDance.new { some_action_that_succeeds(:success) }
+#     .then { some_action_that_succeeds(:another_success }
+#     .value {|error| "I am handling #{error}" } # => :another_success
+#
+#   SafetyDance.new { some_action_that_fails("fail1") }
+#     .then { some_action_that_fails("fail2") }
+#     .then { some_action_that_succeeds(:another_success }
+#     .then { some_action_that_fails("fail3") }
+#     .value {|error| "I am handling #{error}" } # I am handling 'RuntimeError fail1'"
+#
+# Result object pattern is from https://johnnunemaker.com/resilience-in-ruby/
+# e.g. https://github.com/github/github-ds/blob/fbda5389711edfb4c10b6c6bad19311dfcb1bac1/lib/github/result.rb
+class SafetyDance
+	def initialize
+		@value = yield
+		@error = nil
+	rescue => e
+		@error = e
+	end
+
+  def ok?
+    @error.nil?
+  end
+
+  def to_s
+    if ok?
+      "#<SafetyDance:0x%x value: %s>" % [object_id, @value.inspect]
+    else
+      "#<SafetyDance:0x%x error: %s>" % [object_id, @error.inspect]
+    end
+  end
+
+  alias_method :inspect, :to_s
+
+  def error
+    @error
+  end
+
+  def value
+    unless block_given?
+      fail ArgumentError, "must provide a block to SafetyDance#value to be invoked in case of error"
+    end
+    if ok?
+      @value
+    else
+      yield @error
+    end
+  end
+
+  def value!
+    if ok?
+      @value
+    else
+      raise @error
+    end
+  end
+
+  def then
+    return self if !ok?
+    SafetyDance.new { yield(@value) }
+  end
+
+  def then_tap
+    self.then do |value|
+      yield value
+      value
+    end
+  end
+
+  def rescue
+    return self if ok?
+    result = SafetyDance.new { yield(@error) }
+    if result.ok? && result.value! == @error
+      self
+    else
+      result
+    end
+  end
+
+  def self.error(e)
+    result = allocate
+    result.instance_variable_set(:@error, e)
+    result
+  end
+end

data/lib/safety_dance/version.rb

@@ -0,0 +1,3 @@
+class SafetyDance
+  VERSION = "1.0.0"
+end

data/safety_dance.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "safety_dance/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "safety_dance"
+  spec.version       = SafetyDance::VERSION
+  spec.authors       = ["Benjamin Fleischer"]
+  spec.email         = ["github@benjaminfleischer.com"]
+
+  spec.summary       = %q{Response Objects pattern for resilient Ruby}
+  spec.description   = %q{SafetyDance.new { dance! }.then { |result| leave_friends_behind(!result) }.rescue { |error| not_friends_of_mine(error) }.value!}
+  spec.homepage      = "https://github.com/bf4/safety_dance"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: safety_dance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Fleischer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-08 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: 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: SafetyDance.new { dance! }.then { |result| leave_friends_behind(!result)
+  }.rescue { |error| not_friends_of_mine(error) }.value!
+email:
+- github@benjaminfleischer.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/safety_dance.rb
+- lib/safety_dance/version.rb
+- safety_dance.gemspec
+homepage: https://github.com/bf4/safety_dance
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Response Objects pattern for resilient Ruby
+test_files: []