safe_operation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e94fff35d4584131e4618984db17237d7e0eb20
+  data.tar.gz: 5990172463731f5ea965977ab30ebca21a7c5fe5
+SHA512:
+  metadata.gz: b386772b2152fd9699f92fd7050b6da0086e503abc8082d309739302fd611eb0f9312169920cf4bae598a1c9f26385a1ff94f3439fe151ebc8aae5821ee2aaee
+  data.tar.gz: aa6ddc9cb1ed18e8621476d42c2806d87775621bd46fe91e3ca9564e92e10e7a2634fd82b8b1678e6779643459545db3c17bbf6ac072b8375fdb2e98a2fd9c1e

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 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## Unreleased
+
+## 1.0.0
+
+First implementation ([#1][pr1]) - 2017.07.09
+
+[pr1]: https://github.com/juanitofatas/safe_operation/pull/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 juanito-fatas@cookpad.jp. 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,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in safe_operation.gemspec
+gemspec
+
+gem "rake"
+gem "bundler"
+gem "pry"
+gem "rspec", "~> 3.6.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Juanito Fatas
+
+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,92 @@
+# SafeOperation
+
+Write safer code with SafeOperation.
+
+```ruby
+any_operation_may_fail = ->{ User.find(1) }
+
+operation = SafeOperation.either(any_operation_may_fail) do
+  # MUST handle the failure here
+end
+
+# know if operation succeeded
+operation.success?
+
+# get the result of the performed operation
+operation.result
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "safe_operation"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_operation
+
+## Usage
+
+```ruby
+class User
+  ActiveRecordRecordNotFound = Class.new(StandardError)
+
+  def self.find(id)
+    (id == 1) ? new : raise(ActiveRecordRecordNotFound)
+  end
+
+  def self.find_by(*); end
+end
+
+class Guest
+end
+
+SafeOperation.either(->{ User.find(1) })
+# => raises an SafeOperation::NoFailureHandler error
+
+SafeOperation.either(->{ User.find(1) }) do
+  Guest.new
+end
+# => returns a SafeOperation::Success object with User
+# => #<SafeOperation::Success:0x007fbc8d8c5ae0 @success=#<User:0x007fbc8d8c5b08>>
+
+SafeOperation.either(->{ User.find(2) }) do
+  Guest.new
+end
+# => rescue ActiveRecordRecordNotFound, returns a SafeOperation::Failure object with Guest
+# #<SafeOperation::Failure:0x007fbc8dbb71e0 @failure=#<Guest:0x007fbc8dbb7208>>
+
+SafeOperation.either(->{ User.find_by(id: 42) }) do
+  Guest.new
+end
+# => returns a SafeOperation::Failure object with Guest
+# #<SafeOperation::Failure:0x007fbc8dbb71e0 @failure=#<Guest:0x007fbc8dbb7208>>
+```
+
+## Contributing
+
+This project follows the [Moya Contributors Guidelines][moya].
+TLDR: means we give out push access easily and often.
+
+[moya]: https://github.com/Moya/contributors
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JuanitoFatas/safe_operation.
+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).
+
+## Code of Conduct
+
+Everyone interacting in the SafeOperation project’s codebases, issue trackers is expected to follow
+the [code of conduct](https://github.com/JuanitoFatas/safe_operation/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/hack

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_operation"
+
+# 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/safe_operation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "safe_operation/version"
+require_relative "safe_operation/success"
+require_relative "safe_operation/failure"
+
+module SafeOperation
+  NoFailureHandler = Class.new NotImplementedError
+
+  def self.either(maybe_block)
+    raise NoFailureHandler if !block_given?
+
+    if maybe = maybe_block.call
+      Success.new maybe
+    else
+      Failure.new yield
+    end
+  rescue StandardError
+    Failure.new yield
+  end
+
+  NO_FAILURE_HANDLER_MESSAGE = "Please pass in a block to handle the failure 😅"
+  private_constant :NO_FAILURE_HANDLER_MESSAGE
+end

data/lib/safe_operation/failure.rb

@@ -0,0 +1,18 @@
+module SafeOperation
+  class Failure
+    def initialize(failure)
+      @failure = failure
+    end
+
+    def result
+      failure
+    end
+
+    def success?
+      false
+    end
+
+    private
+    attr_reader :failure
+  end
+end

data/lib/safe_operation/success.rb

@@ -0,0 +1,18 @@
+module SafeOperation
+  class Success
+    def initialize(success)
+      @success = success
+    end
+
+    def result
+      success
+    end
+
+    def success?
+      true
+    end
+
+    private
+    attr_reader :success
+  end
+end

data/lib/safe_operation/version.rb

@@ -0,0 +1,3 @@
+module SafeOperation
+  VERSION = "1.0.0"
+end

data/safe_operation.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "safe_operation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_operation"
+  spec.version       = SafeOperation::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["katehuang0320@gmail.com"]
+
+  spec.summary       = %(Write safer code with SafeOperation.)
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/juanitofatas/safe_operation"
+  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"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: safe_operation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-09 00:00:00.000000000 Z
+dependencies: []
+description: Write safer code with SafeOperation.
+email:
+- katehuang0320@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hack
+- bin/setup
+- lib/safe_operation.rb
+- lib/safe_operation/failure.rb
+- lib/safe_operation/success.rb
+- lib/safe_operation/version.rb
+- safe_operation.gemspec
+homepage: https://github.com/juanitofatas/safe_operation
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Write safer code with SafeOperation.
+test_files: []