hosh-kase 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5eb5a1416bdde14aa18de27b673fce5cc8a74cdd
+  data.tar.gz: d8426c0fbae96a5d0d3fc68c7afb3ec151f467e9
+SHA512:
+  metadata.gz: 2689573acabb581501156e4aa2c2882c9003886e160353c1f75c96b2623ba0a41dee538fc40ca093abcea23ef3f3dbe5ee1811c3d658448484f129610f786181
+  data.tar.gz: 12f324cef935e82fd8210f79278361cf5eb3bea96857d6b0bdc9702f0409b8917abedddafc595c831cab1dc9e521561ecefc5213ebb7e45813b41c575c195e33

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rspec

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 lasse@lasseebert.dk. 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 kase.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lasse Skindstad Ebert
+
+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,289 @@
+# Kase
+
+Kase gracefully handles `[status, result]`-like return values from methods.
+
+It is a tool to avoid using exceptions as flow control and to write safer and
+more readable code.
+
+[![Gem Version](https://badge.fury.io/rb/kase.svg)](https://badge.fury.io/rb/kase)
+[![Build Status](https://travis-ci.org/lasseebert/kase.svg?branch=master)](https://travis-ci.org/lasseebert/kase)
+
+## Introduction
+
+The idea is inspired by Elixir in which many functions returns something like
+`{:ok, result}` or `{:error, :not_found, "More specific error message"}`.
+
+In Ruby we would usually handle those kind of return values like this:
+
+```ruby
+class Orders
+  def process(cart)
+    status, result, message = complete_order(cart)
+
+    case status
+    when :ok
+      order = result
+      process_order(order)
+    when :error
+      error_kind = result
+      case error_kind
+      when :not_found
+        [404, {}, "Not found"]
+      when :invalid_state
+        [400, {}, "Invalid request: #{message}"]
+      else
+        raise "Unhandled error kind: #{error_kind}"
+      end
+    else
+      raise "Unhandles status: #{status}"
+    end
+  end
+end
+```
+
+This is hard to read.
+
+Furthermore, the two lines that raises exception on unhandled status and
+error_kind are probably getting zero code coverage (otherwise we would have
+handled that specific status or error_kind).
+
+With Kase we can do this instead, which is equivalent to the above:
+
+```ruby
+require "kase"
+
+class Orders
+  include Kase
+
+  def process(cart)
+    kase complete_order(cart) do
+      on :ok do |order|
+        process_order(order)
+      end
+
+      on :error, :not_found do
+        [404, {}, "Not found"]
+      end
+
+      on :error, :invalid_state do |message|
+        [400, {}, "Invalid request: #{message}"]
+      end
+    end
+  end
+end
+```
+
+This is much more easy to read and reason about.
+
+See below for more a full list of what Kase does.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "kase", "~> 0.1"
+```
+
+## Usage
+
+
+### kase
+
+`kase` is the method used to match an array of values (typically a
+`[status, result]`-like array) against a number of "patterns" using the
+`on`-method. A pattern in this sense is just some values matching the array from
+the beginning using `==`.
+
+E.g. the pattern `:a, :b` matches `[:a, :b]` and `[:a, :b, :c]`, but not
+`[:c, :a, :b]`.
+
+The block in the first pattern that matches will be executed, and the return
+value from that block is the return value of `kase`.
+
+If no patterns match, a `Kase::NoMatchError` is raised.
+
+An empty pattern will match everything, so that can be used as a catch-all.
+
+The values yielded to the block are all the values that is not part of the
+pattern. E.g. if `[:ok, "THE RESULT"]` is matched with `on(:ok, &block)`,
+`"THE RESULT"` is yielded to block.
+
+#### Simple examples:
+
+```ruby
+kase process_order do
+  on :ok do
+    puts "Great success!"
+  end
+
+  on :error do
+    puts "BOOM"
+  end
+end
+```
+
+This will output "Great success" if process_order returns `:ok`,
+`[:ok]` or `[:ok, some, more, values, here]`.
+
+It will output "BOOM" if process_order returns `:error`, `[:error]` or
+`[:error, some, more, values]`
+
+If process_order returns something that is not matched, e.g. `:not_found`, this
+will raise a `Kase::NoMatchError`.
+
+#### Using the values
+
+In the above example we don't use the values returned by process_order, if more
+than one value is returned.
+
+All values that are not part of the pattern will be yielded to the given block:
+
+```ruby
+kase process_order do
+  on :ok do |order|
+    puts "Great success: #{order.inspect}"
+  end
+
+  on :error do |reason, message|
+    puts "BOOM! #{reason}: #{message}"
+  end
+end
+```
+
+Notice that we don't have to return the same number of values for each case to
+be able to catch and use the values.
+
+#### Matching on multiple values
+
+We can match on multiple values, but only from the left:
+
+```ruby
+kase process_order do
+  on :ok do |order|
+    puts "Great success: #{order.inspect}"
+  end
+
+  on :error, :not_found do
+    puts "Not found!"
+  end
+
+  on :error, :invalid_record do |message|
+    puts "Invalid record: #{message}"
+  end
+end
+```
+
+This `kase` will handle `[:ok, order]`, `[:error, :not_found]` and
+`[:error, :invalid_record, "Message"]`, but will raise a `Kase::NoMatchError` on
+e.g. `[:error, :not_authorized]`
+
+### ok!
+
+Sometimes we only expect the `:ok` status to appear. In that case we can use
+`ok!` as a shorthand.
+
+It can rewrite this:
+
+```ruby
+kase something do
+  on :ok do |result|
+    handle_result(result)
+  end
+end
+```
+
+To this:
+
+```ruby
+ok! something do |result|
+  handle_result(result)
+end
+```
+
+### Include or module_function
+
+Kase is a module with helper methods. You can either include it in your own
+class or use the methods as module functions. So both of these will work:
+
+```ruby
+require "kase"
+
+class MyFirstClass
+  include Kase
+
+  def call
+    kase some_result do
+      ...
+    end
+  end
+end
+
+class MySecondClass
+  def call
+    Kase.kase some_result do
+      ...
+    end
+  end
+end
+```
+
+All the logic resides in the Kase::Switcher class which you can use directly if
+you need to:
+
+```ruby
+switcher = Kase::Switcher.new(:ok, "RESULT")
+switcher.on(:ok) { |result| puts result }
+switcher.on(:error) { |message| warn message }
+switcher.validate!
+result = switcher.result
+```
+
+The above is equivalent to:
+
+```ruby
+result = Kase.kase :ok, "RESULT" do
+  on(:ok) { |result| puts result }
+  on(:error) { |message| warn message }
+end
+```
+
+Note that `#kase` is aliased to `#call` so you can use the shorthand
+`Kase.(values)`.
+
+## Development
+
+* Install dependencies with `bundle`
+* Run specs with `bundle exec rspec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/lasseebert/kase.
+
+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.
+
+### Pull requests
+
+To make a pull request:
+
+1. Fork the project
+2. Make at least one failing test that proves the bug or describes the feature.
+3. Implement bugfix or feature
+4. Make pull request
+
+## Contact
+
+Find me on twitter: [@lasseebert](https://twitter.com/lasseebert)
+
+## Alternatives
+
+* [Noadi](https://github.com/katafrakt/noaidi) mimics the functional pattern
+matching of Elixir and might be used as an alternative of Kase.
+
+## 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 @@
+require "bundler/gem_tasks"

data/kase.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hosh-kase"
+  spec.version       = Kase::VERSION
+  spec.authors       = ["Lasse Skindstad Ebert"]
+  spec.email         = ["lasse@lasseebert.dk"]
+
+  spec.summary       = %q{A tool to parse [:ok, result]-like return values}
+  spec.homepage      = "https://github.com/lasseebert/kase"
+  spec.license       = "MIT"
+
+  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"
+  spec.add_development_dependency "pry-byebug", "~> 3.3"
+end

data/lib/kase.rb

@@ -0,0 +1,30 @@
+require "kase/switcher"
+require "kase/version"
+
+module Kase
+  module_function
+
+  def kase(*values, &block)
+    Switcher.new(*values).switch(&block)
+  end
+  alias_method :call, :kase
+
+  def ok!(*values, &block)
+    Switcher.new(*values).switch do
+      on(:ok) do |*result|
+        if block_given?
+          yield(*result) if block_given?
+        else
+          case result.size
+          when 0
+            nil
+          when 1
+            result.first
+          else
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kase/errors.rb

@@ -0,0 +1,4 @@
+module Kase
+  class KaseError < StandardError; end
+  class NoMatchError < KaseError; end
+end

data/lib/kase/switcher.rb

@@ -0,0 +1,60 @@
+require "kase/errors"
+
+module Kase
+  class Switcher
+    def initialize(*values)
+      if values.size == 1 && values.first.is_a?(Array)
+        values = values.first
+      end
+      @values = values
+      @matched = false
+    end
+
+    attr_reader :values
+    attr_reader :result
+
+    def matched?
+      !!@matched
+    end
+
+    def match?(*pattern)
+      values[0...pattern.size] == pattern
+    end
+
+    def on(*pattern)
+      return if matched?
+      return unless match?(*pattern)
+      @matched = true
+      @result = yield(*values[pattern.size..-1])
+    end
+
+    def validate!
+      raise NoMatchError.new(@values) unless matched?
+      true
+    end
+
+    def switch(&block)
+      context = eval("self", block.binding)
+      dsl = DSL.new(self, context)
+
+      dsl.instance_eval(&block)
+      validate!
+      result
+    end
+
+    class DSL
+      def initialize(switcher, context)
+        @switcher = switcher
+        @context = context
+      end
+
+      def on(*args, &block)
+        @switcher.on(*args, &block)
+      end
+
+      def method_missing(method, *args, &block)
+        @context.send(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/kase/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: hosh-kase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lasse Skindstad Ebert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-31 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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- lasse@lasseebert.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kase.gemspec
+- lib/kase.rb
+- lib/kase/errors.rb
+- lib/kase/switcher.rb
+- lib/kase/version.rb
+homepage: https://github.com/lasseebert/kase
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A tool to parse [:ok, result]-like return values
+test_files: []