keka 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4644a49e6ff908024e1ec91cdeec0d7a6886c9d
-  data.tar.gz: 6a89ab5dab98c71ab7f77a1ddfed84419e956eed
+SHA256:
+  metadata.gz: 441fd2d2712b2ea5b6a15076088de3a1617945f0683251addd7e0be5f5077b9e
+  data.tar.gz: 3d7cf921207b9000a838197669af05d619aadc1252b420d48d74771266dfbccf
 SHA512:
-  metadata.gz: b2ba159cfc8a028f3f834cd2b48af5184da28f8b2d85a36ad62711b3771754f812b8f01c60e426f7f39c441eb30c4dc8b7b1eabda0632a970dc94767c13c41c7
-  data.tar.gz: 62b1c97c626ff58d1e51b033259b9d18bf0c0f71594a73549150f6b6b37aeff5d58944c5d591564fc78ac43975b1ef16bb50725cd3f67d354e2ddb3e17917c9e
+  metadata.gz: 447a280a18b005007788861863dce8b2dc647100add773615a1f5e2ae1a1151020f3955b0486da070a8995e32b7c9b168f5da5adf652b8fb8cb535e1e6b1b151
+  data.tar.gz: 7514d83dd424338c51254855275b4031d45ba34a4814104130a2549aad7e0676327e288edfb1422b08a899d0528ffc48a93f8822a574f17d6af346a749ab57a3

data/.circleci/config.yml

@@ -0,0 +1,17 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.3
+    working_directory: ~/repo
+    environment:
+      BUNDLER_VERSION: 1.17.3
+    steps:
+      - checkout
+      - run: gem install bundler:1.17.3
+      - run:
+          name: install dependencies
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run:
+          name: run specs
+          command: bundle exec rspec

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+## Unreleased
+
+## Version 0.2.0
+* Support `.rescue_with` to handle exceptions in `.run` block.
+* Add CI.
+
+## Version 0.1.0
+* Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keka (0.1.0)
+    keka (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,19 +13,19 @@ GEM
       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)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
 
 PLATFORMS
   ruby
@@ -38,4 +38,4 @@ DEPENDENCIES
   rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/README.md

@@ -4,44 +4,34 @@ Keka (Japanese for 'result') is a wrapper that represents the result of a partic
 
 ## 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
+  def refund(cancel_delivery = true)
     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')
+      Keka.err_unless!(payment.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?
+      # if cancel_delivery
+      # => returns an err keka with provided msg if !remove_delivery_assignment
+      Keka.err_unless!(remove_delivery_assignment, 'Refunded but failed to remove delivery.') if cancel_delivery
       # returns an ok keka if nothing 'return' from above
     end
   end
 
   private
 
-  def remove_delivery
+  def remove_delivery_assignment
     Keka.run do
       # returns an ok keka if already_removed?
       Keka.ok_if! already_removed?
@@ -64,9 +54,56 @@ class SomeController
 end
 ```
 
-Of course, you can also use `.err_unless!`, `err_if!`, and `ok_if!` outside
+Of course, you can also use `.err_unless!`, `.err_if!`, and `.ok_if!` outside
 of the `Keka.run` block.
 
+### Handle Exceptions
+
+Before version 0.2.0, handling exceptions in `.run` block is a bit tricky. You might do something like this
+
+```ruby
+def validate_purchase(item_ids)
+  Keka.run do
+    Item.find(item_ids)
+  rescue ActiveRecord::RecordNotFound
+    Keka.err_if! true, 'Some item is unavailable'
+  end
+end
+```
+
+After version 0.2.0, you can simply
+```ruby
+# * Returns ok result if no exception is raised.
+# * Returns err result if ActiveRecord::RecordNotFound is raised, with msg set
+#   to 'Some item is unavailable'.
+# * Raises if any other non-keka exception is thrown.
+def validate_purchase(item_ids)
+  Keka.rescue_with(ActiveRecord::RecordNotFound, 'Some item is unavailable')
+    .run { Item.find(item_ids) }
+end
+```
+
+You can also chain `.rescue_with`
+```ruby
+def validate_purchase(store_id, new_item_payload)
+  Keka.rescue_with(ActiveRecord::RecordNotFound, 'Some item is unavailable')
+    .rescue_with(ActiveRecord::RecordInvalid, 'Invalid payload')
+    .run do
+      store = Store.find(store_id)
+      store.items.create!(new_item_payload)
+    end
+end
+```
+
+Note, by design, `.rescue_with` only rescues from descendants of StandardError. This will **NOT** work.
+```ruby
+def invalid_example
+  # The .rescue_with does NOTHING here. This method will raise a NoMemoryError exception.
+  Keka.rescue_with(NoMemoryError, 'oops')
+    .run { raise NoMemoryError.new }
+end
+```
+
 ## 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.

data/lib/keka.rb

@@ -1,72 +1,44 @@
 require 'keka/version'
+require 'keka/exceptions'
+require 'keka/result'
+require 'keka/context'
 
 module Keka
+  class << self
+    include Context::Originable
 
-  class Halt < StandardError
-    attr_reader :keka
-    def initialize(keka)
-      @keka = keka
-      super
+    def err_if!(evaluator, msg = nil)
+      raise Halt.new(err(msg)) if (evaluator.respond_to?(:ok?) ? evaluator.ok? : evaluator)
     end
-  end
-
-  class Base
-    attr_accessor :msg
 
-    def initialize(is_success, msg)
-      @is_success = is_success
-      @msg = msg
+    def err_unless!(evaluator, msg = nil)
+      if evaluator.is_a? self::Result
+        return if evaluator.ok?
+        evaluator.msg = msg if msg
+        raise Halt.new(evaluator)
+      else
+        raise Halt.new(err(msg)) unless evaluator
+      end
     end
 
-    def ok?
-      is_success
+    def ok_if!(evaluator, msg = nil)
+      if evaluator.is_a? self::Result
+        return unless evaluator.ok?
+        evaluator.msg = msg if msg
+        raise Halt.new(evaluator)
+      else
+        raise Halt.new(ok(msg)) if evaluator
+      end
     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
+    # private (maybe)
+    def ok(msg = nil)
+      Result.new(true, msg)
     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
+    # private (maybe)
+    def err(msg = nil)
+      Result.new(false, msg)
     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/context.rb

@@ -0,0 +1,43 @@
+module Keka
+  class Context
+
+    module Originable
+      def rescue_with(err_class, err_msg = nil)
+        Context.new.rescue_with(err_class, err_msg)
+      end
+
+      def run(&block)
+        Context.new.run(&block)
+      end
+    end
+
+    def initialize
+      @opts = {
+        rescue_exceptions: []
+      }
+    end
+
+    def rescue_with(err_class, err_msg = nil)
+      opts[:rescue_exceptions] << {
+        klass: err_class,
+        msg:   err_msg
+      }
+      self
+    end
+
+    def run
+      raise 'Block required!' unless block_given?
+      yield
+      Keka.ok
+    rescue Keka::Halt => e
+      e.result
+    rescue StandardError => e
+      raise unless matched = opts[:rescue_exceptions].detect { |setting| e.is_a?(setting[:klass]) }
+      Keka.err(matched[:msg])
+    end
+
+    private
+    attr_reader :opts
+
+  end
+end

data/lib/keka/exceptions.rb

@@ -0,0 +1,9 @@
+module Keka
+  class Halt < StandardError
+    attr_reader :result
+    def initialize(result)
+      @result = result
+      super
+    end
+  end
+end

data/lib/keka/result.rb

@@ -0,0 +1,17 @@
+module Keka
+  class Result
+    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
+end

data/lib/keka/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keka
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - zino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2020-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,9 +74,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".rspec_status"
+- ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -86,6 +88,9 @@ files:
 - bin/setup
 - keka.gemspec
 - lib/keka.rb
+- lib/keka/context.rb
+- lib/keka/exceptions.rb
+- lib/keka/result.rb
 - lib/keka/version.rb
 homepage: https://github.com/zinosama/keka
 licenses:
@@ -107,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Better handle short-circuit logic, result state, and return message