keka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4644a49e6ff908024e1ec91cdeec0d7a6886c9d
+  data.tar.gz: 6a89ab5dab98c71ab7f77a1ddfed84419e956eed
+SHA512:
+  metadata.gz: b2ba159cfc8a028f3f834cd2b48af5184da28f8b2d85a36ad62711b3771754f812b8f01c60e426f7f39c441eb30c4dc8b7b1eabda0632a970dc94767c13c41c7
+  data.tar.gz: 62b1c97c626ff58d1e51b033259b9d18bf0c0f71594a73549150f6b6b37aeff5d58944c5d591564fc78ac43975b1ef16bb50725cd3f67d354e2ddb3e17917c9e

data/.gitignore

@@ -0,0 +1,11 @@
+/.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/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 keka.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    keka (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  keka!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zino
+
+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,82 @@
+# Keka
+
+Keka (Japanese for 'result') is a wrapper that represents the result of a particular execution, along with any message returned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keka'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keka
+
+## Usage
+
+Below is an example of how the various methods can come together.
+
+```ruby
+class Order
+  def refund
+    Keka.run do
+      # returns an err keka with provided msg if !refundable?
+      Keka.err_unless!(refundable?, 'Payment is no longer refundable.')
+      # returns an err keka with provided msg if !refund!
+      Keka.err_unless!(refund!, 'Refund failed. Please try again')
+      # execute statements if nothing 'return' from above
+      do_something_else
+      # if cancel_delivery?
+      # => returns an err keka with provided msg if !remove_delivery
+      Keka.err_unless!(remove_delivery, 'Refunded but failed to remove delivery.') if cancel_delivery?
+      # returns an ok keka if nothing 'return' from above
+    end
+  end
+
+  private
+
+  def remove_delivery
+    Keka.run do
+      # returns an ok keka if already_removed?
+      Keka.ok_if! already_removed?
+      # returns an err keka with no msg if !remove!
+      Keka.err_unless! remove!
+      # returns an ok keka if nothing 'return' from above
+    end
+  end
+end
+
+class SomeController
+  def some_action
+    keka = @order.refund
+    if keka.ok?
+      head :ok
+    else
+      render json: { error: keka.msg }, status: 422
+    end
+  end
+end
+```
+
+Of course, you can also use `.err_unless!`, `err_if!`, and `ok_if!` outside
+of the `Keka.run` block.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zinosama/keka.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "keka"
+
+# 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/keka.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "keka/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "keka"
+  spec.version       = Keka::VERSION
+  spec.authors       = ["zino"]
+  spec.email         = ["zinocodes@gmail.com"]
+
+  spec.summary       = %q{Better handle short-circuit logic, result state, and return message}
+  spec.description   = %q{No more ad hoc passage of boolean results and error messages.}
+  spec.homepage      = "https://github.com/zinosama/keka"
+  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
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.7"
+  spec.add_development_dependency 'pry'
+
+end

data/lib/keka.rb

@@ -0,0 +1,72 @@
+require 'keka/version'
+
+module Keka
+
+  class Halt < StandardError
+    attr_reader :keka
+    def initialize(keka)
+      @keka = keka
+      super
+    end
+  end
+
+  class Base
+    attr_accessor :msg
+
+    def initialize(is_success, msg)
+      @is_success = is_success
+      @msg = msg
+    end
+
+    def ok?
+      is_success
+    end
+
+    private
+    attr_reader :is_success
+  end
+
+  def self.err_if!(evaluator, msg = nil)
+    raise Halt.new(err(msg)) if (evaluator.respond_to?(:ok?) ? evaluator.ok? : evaluator)
+  end
+
+  def self.err_unless!(evaluator, msg = nil)
+    if evaluator.is_a? self::Base
+      return if evaluator.ok?
+      evaluator.msg = msg if msg
+      raise Halt.new(evaluator)
+    else
+      raise Halt.new(err(msg)) unless evaluator
+    end
+  end
+
+  def self.ok_if!(evaluator, msg = nil)
+    if evaluator.is_a? self::Base
+      return unless evaluator.ok?
+      evaluator.msg = msg if msg
+      raise Halt.new(evaluator)
+    else
+      raise Halt.new(ok(msg)) if evaluator
+    end
+  end
+
+  def self.run
+    raise 'Block required!' unless block_given?
+    yield
+    ok
+  rescue Halt => e
+    e.keka
+  end
+
+
+  # private (maybe)
+  def self.ok(msg = nil)
+    Base.new(true, msg)
+  end
+
+  # private (maybe)
+  def self.err(msg = nil)
+    Base.new(false, msg)
+  end
+
+end

data/lib/keka/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: keka
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-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.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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: No more ad hoc passage of boolean results and error messages.
+email:
+- zinocodes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keka.gemspec
+- lib/keka.rb
+- lib/keka/version.rb
+homepage: https://github.com/zinosama/keka
+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.14
+signing_key: 
+specification_version: 4
+summary: Better handle short-circuit logic, result state, and return message
+test_files: []