multi_case 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Andrey Korzhuev <andrew@korzhuev.com>
+
+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,131 @@
+multi_case [![Build Status](https://travis-ci.org/andrusha/multi_case.png)](https://travis-ci.org/andrusha/multi_case) [![Dependency Status](https://gemnasium.com/andrusha/multi_case.png)](https://gemnasium.com/andrusha/multi_case) [![Code Climate](https://codeclimate.com/github/andrusha/multi_case.png)](https://codeclimate.com/github/andrusha/multi_case)
+==========
+
+An improved `case` operator for ruby which allows you to make a choice based on how variable changes (a state machine of ifs).
+
+Installation
+------------
+
+`gem install multi_case`
+
+Usage
+-----
+
+### Interfaces
+
+There are two interfaces available, one is an unobtrusive module, which can be
+included into your class like so:  
+
+```ruby
+require 'multi_case'
+
+class Cookie
+  include MultiCase::API
+
+  def eat_it!
+    mutli_case weight_was, weight do
+      multi(150 => 0..50) { puts "That was a good bite!" }
+      multi(150 => 150..(+1.0/0.0)) { puts "Are you puked?!" }
+    end
+  end
+end
+```
+
+Another one is to extend your `Kernel` making `multi_case` function global:  
+
+```ruby
+require 'multi_case/core_ext'
+
+mutli_case ENV['petals_was'], ENV['petal'] do
+  multi([] => (0..100).step(2)) { puts "Любит" }
+  multi([] => (1..100).step(2)) { puts "Не любит" }
+end
+```
+
+### Features
+
+Most common use-case is to make a decision based on how your variable changes,
+it also might be used as an unbotrusive state-machine implementation. For 
+example, if you have a post and its state went from `:draft` to `:published`
+you might want to notify all your subscribed users about that, which can be
+implemented like so:  
+
+```ruby
+class Post
+  def notify
+    multi_case status_was, status do
+      multi([] => :draft)         { Notification.needs_input(post).to_editors }
+      multi(:draft => :published) { Notification.new_post(post).to_subscribers }
+      multi([] => :destroyed)     { Notification.destoyed_post(post).to_admins }
+    end
+  end
+end
+```
+
+It also returns values so it can be used to replace nested `case` statements:  
+
+```ruby
+beer_status = multi_case bottles_was, bottles do
+  multi(0 => 1..10) { :party_time }
+  multi(1..10 => 0) { :needs_refil }
+end
+```
+
+Since it uses case-matching (`===`) internally you can use all its goodiness:  
+
+```ruby
+multi_case x, y do
+  multi(String => /a+/i) { 0 }
+  multi(1..100 => [:x, :y, :z]) { 0 }
+end
+```
+
+### Syntax
+
+`multi_case` expect two values and block which contains matchers, first value 
+is matched against key of one-elemnt hash which is provided to `multi`,
+second value is matched against value of said hash.  
+
+`multi` expect you to provide one-elemnt hash and block, if hash has array in it
+then all array elements are matched against value sequentially and empty array
+means "match-all". The block provided to multi is executed in case of correct 
+match and its result is what is returned by `multi_case`. 
+
+### Implementation
+
+The `mutli_case` statement is complete equivalent of nested `case` statements, 
+so these two snippets are intedent to work exactly the same:  
+
+```ruby
+result = multi_case old_value, new_value do
+  multi [:a, :b] => [:c, :d] { :e }
+  multi [:f, :g] => [:h, :i] { :j }
+  multi [] => [:k, :l] { :m }
+  multi [:n, :o] => [] { :p }
+  multi [:f, :g] => [:q, :r] { :s }
+end
+```  
+
+
+```ruby
+result = case old_value
+when :a, :b
+  case new_value
+  when :c, :d then :e
+  end
+when :f, :g
+  case new_value
+  when :h, :i then :j
+  when :q, :r then :s
+  end
+when :n, :o then :p
+else
+  case new_value
+  when :k, :l then :m
+  end
+end
+```
+
+Copyright
+=========
+Copytright © 2013 Andrey Korzhuev. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => ["rspec"]
+
+require "multi_case"
+
+PACKAGE = "#{MultiCase::PACKAGE}"
+VERSION = "#{MultiCase::VERSION}"
+
+task :package do
+  system "gem build #{PACKAGE}.gemspec"
+end
+
+task :install => :package do
+  Dir.chdir("pkg") do
+    system "gem install #{PACKAGE}-#{VERSION}"
+  end
+end
+
+task :release => :package do
+  Dir.chdir("pkg") do
+    system "gem push #{PACKAGE}-#{VERSION}"
+  end
+end
+
+task :default => :test

data/lib/multi_case.rb

@@ -0,0 +1,10 @@
+#
+# An improved case operator which allow you to compare two
+# variables at once, usually describing some kind of state change
+#
+module MultiCase
+  PACKAGE = 'multi_case'
+  VERSION = '0.0.1'
+end
+
+require 'multi_case/api'

data/lib/multi_case/api.rb

@@ -0,0 +1,20 @@
+require 'multi_case/dsl'
+
+module MultiCase::API
+  protected
+
+  #
+  # Matches two parameters agains specified causes returning the result
+  # of user specified functions
+  # @param  lhs [#===] Matched against left-hand side
+  # @param  rhs [#===] Matches against right-hand side
+  # @param  &block [Object] A function which contains number of `multi` clauses
+  #
+  # @return [Object] Value returned by first matching matching specified by user
+  def multi_case(lhs, rhs, &block)
+    dsl = MultiCase::DSL.new(lhs, rhs)
+    dsl.instance_eval(&block)
+
+    dsl.result
+  end
+end

data/lib/multi_case/core_ext.rb

@@ -0,0 +1,15 @@
+require 'multi_case'
+
+#
+# Makes multi_case a global method available at main:Object
+# as well as inside any other class. BEWARE, this might make
+# some modules behave unexpectedly because of name collision.
+#
+module Kernel
+  include MultiCase::API
+  alias_method :_multi_case, :multi_case
+
+  def multi_case(x, y, &block)
+    _multi_case(x, y, &block)
+  end
+end

data/lib/multi_case/dsl.rb

@@ -0,0 +1,45 @@
+class MultiCase::DSL
+  #
+  # @param  lhs [#===]
+  # @param  rhs [#===]
+  #
+  def initialize(lhs, rhs)
+    @lhs = lhs
+    @rhs = rhs
+
+    @result = nil
+  end
+
+  attr_reader :result
+
+  #
+  # A single case to which @lhs & @rhs are matched against
+  # @param  from_to [Hash] @lhs is matched against keys, @rhs against values,
+  #                        they both can be arrays
+  # @param  &block [Object] User-specified result if both of parameters match
+  #
+  # @return [Object] Return-value of user-specified function
+  def multi(from_to, &block)
+    from = from_to.keys.flatten(1)
+    from = [@lhs]  if from.empty?  # catch-all on empty array
+
+    to = from_to.values.flatten(1)
+    to = [@rhs]  if to.empty?
+
+    if from.product(to).map(&method(:param_equal)).any?
+      @result ||= block.call
+    end
+  end
+
+  private
+
+  #
+  # Case-compares tuple against @lhs and @rhs
+  # @param  arr [Array] Tuple to match against
+  #
+  # @return [Boolean]
+  def param_equal(arr)
+    f, t = arr
+    (f === @lhs) && (t === @rhs)
+  end
+end

data/multi_case.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "multi_case"
+
+Gem::Specification.new do |s|
+  s.name        = MultiCase::PACKAGE
+  s.version     = MultiCase::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrey Korzhuev"]
+  s.email       = ["andrew@korzhuev.com"]
+  s.homepage    = "https://github.com/andrusha/multi_case"
+  s.summary     = %q{Multi-parameter case statement}
+  s.description = %q{A state-machine inspired case/if statement}
+
+  s.rubyforge_project = "multi_case"
+
+  s.files         = `git ls-files -z`.split("\0")
+  s.test_files    = `git ls-files -z -- {fixtures,features,spec}/*`.split("\0")
+  s.extra_rdoc_files = ["LICENSE", "README.md"]
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+end

data/spec/multi_case/api_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe MultiCase::API do
+  include MultiCase::API
+
+  describe "simple matching" do
+    it "matches two argument against pre-defined cases returning specified value" do
+      result = multi_case :a, :c do
+        multi(:a => :b) { 1 }
+        multi(:a => :c) { 2 }
+      end
+
+      result.should == 2
+    end
+
+    it "return nil if no matches found" do
+      result = multi_case :x, :y do
+        multi(:a => :b) { 1 }
+        multi(:a => :c) { 2 }
+      end
+
+      result.should be_nil
+    end
+
+    it "returns first match if we have multiple matches" do
+      result = multi_case :x, :y do
+        multi(:a => :b) { 1 }
+        multi(:x => :y) { 2 }
+        multi(:x => [:y, :z]) { 3 }
+      end
+
+      result.should == 2
+    end
+
+    it "doesn't execute unmatched functions" do
+      expect do
+        result = multi_case :a, :c do
+          multi(:a => :b) { raise "oh shit" }
+          multi(:a => :c) { 2 }
+          multi(:a => :c) { raise "oh shittiest" }
+        end
+      end.not_to raise_error
+    end
+  end
+
+  describe "case matching" do
+    it "classes" do
+      result = multi_case 'aaa', :y do
+        multi(:a => :b) { 1 }
+        multi(String => :y) { 2 }
+      end
+
+      result.should == 2
+    end
+
+    it "regexps" do
+      result = multi_case 'aaa', :y do
+        multi(:a => :b) { 1 }
+        multi(/A+/i => :y) { 2 }
+      end
+
+      result.should == 2
+    end
+
+    it "ranges" do
+      result = multi_case 'aaa', 100 do
+        multi(:a => :b) { 1 }
+        multi('aaa' => :c) { 2 }
+        multi('aaa' => [:c, 99..120]) { 3 }
+      end
+
+      result.should == 3
+    end
+  end
+
+  describe "array matching" do
+    it "allow arbitrary input" do
+      result = multi_case :a, :c do
+        multi([:c, :a] => [:b, :d]) { 1 }
+        multi([:c, :d] => [:c, :e]) { 2 }
+        multi([:c, :a] => [:c, :e]) { 3 }
+      end
+
+      result.should == 3
+    end
+
+    it "treat empty arrays as catch-all" do
+      result = multi_case :a, :c do
+        multi([] => [:c]) { 1 }
+      end
+
+      result.should == 1
+    end
+
+    it "can match nested arrays" do
+      result = multi_case [:a, :b], :c do
+        multi([[:a, :b]] => [:c]) { 1 }
+      end
+
+      result.should == 1
+    end
+  end
+
+end

data/spec/multi_case/core_ext_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'multi_case/core_ext'
+
+def f
+  multi_case :a, :b do
+    multi(:a => :b) { 1 }
+  end
+end
+
+describe "core extensions" do
+  it "makes multi_case global function" do
+    value = multi_case :a, :b do
+      multi(:a => :b) { 1 }
+    end
+
+    value.should == 1
+  end
+
+  it "allow you to call it from inside arbitrary function" do
+    f.should == 1
+  end
+
+  it "is accessible from inside another class" do
+    Class.new do
+      def f
+        multi_case :a, :b do
+          multi(:a => :b) { 1 }
+        end
+      end
+    end.new.f.should == 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'multi_case'

data/travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: multi_case
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrey Korzhuev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A state-machine inspired case/if statement
+email:
+- andrew@korzhuev.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/multi_case.rb
+- lib/multi_case/api.rb
+- lib/multi_case/core_ext.rb
+- lib/multi_case/dsl.rb
+- multi_case.gemspec
+- spec/multi_case/api_spec.rb
+- spec/multi_case/core_ext_spec.rb
+- spec/spec_helper.rb
+- travis.yml
+homepage: https://github.com/andrusha/multi_case
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: multi_case
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Multi-parameter case statement
+test_files:
+- spec/multi_case/api_spec.rb
+- spec/multi_case/core_ext_spec.rb
+- spec/spec_helper.rb