quincunx 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle
+/log/*.log
+/tmp
+/tags
+/coverage
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'json', '~> 1.7.7'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    quincunx (0.0.1)
+      optional
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    json (1.7.7)
+    multi_json (1.7.3)
+    optional (0.0.5)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json (~> 1.7.7)
+  quincunx!
+  rspec
+  simplecov

data/lib/quincunx.rb

@@ -0,0 +1,14 @@
+require 'delegate'
+require 'optional'
+require_relative 'quincunx/all'
+
+module Quincunx
+  Anything = Object
+  def self.included(base)
+    base.extend(PatternMatcher)
+  end
+
+  class NoMatchForPatternError < StandardError
+  end
+
+end

data/lib/quincunx/all.rb

@@ -0,0 +1,7 @@
+require_relative 'dictionary'
+require_relative 'case_list'
+require_relative 'environment'
+require_relative 'method'
+require_relative 'extractor'
+require_relative 'builder'
+require_relative 'pattern_matcher'

data/lib/quincunx/builder.rb

@@ -0,0 +1,25 @@
+module Quincunx
+
+  class Builder
+
+    def initialize(args, matchers)
+      @args = args
+      @matchers = matchers
+    end
+
+    def params
+      args.zip(extractors).reduce({}) do |acc, (v, extractor)|
+        acc.merge(Extractor.new(extractor, v).extract)
+      end
+    end
+
+    private
+
+    def extractors
+      matchers.map { |m| m[1] || {} }
+    end
+
+    attr_reader :args, :matchers
+
+  end
+end

data/lib/quincunx/case_list.rb

@@ -0,0 +1,20 @@
+module Quincunx
+  class CaseList
+
+    def << method
+      cases << method ; self
+    end
+
+    def match(obj, args)
+      Option[cases.map { |method| method.application(obj, args) }.find(&:matches?)]
+    end
+
+    private
+
+    def cases
+      @cases ||= []
+    end
+
+  end
+
+end

data/lib/quincunx/dictionary.rb

@@ -0,0 +1,14 @@
+module Quincunx
+  class Dictionary
+
+    def [](name)
+      methods[name] ||= CaseList.new
+      methods[name]
+    end
+
+    def methods
+      @methods ||= {}
+    end
+
+  end
+end

data/lib/quincunx/environment.rb

@@ -0,0 +1,22 @@
+module Quincunx
+  class Environment < SimpleDelegator
+
+    def initialize(obj, params)
+      super(obj)
+      @params = params
+    end
+
+    def method_missing(name, *args, &block)
+      params.fetch(name.to_sym) { super }
+    end
+
+    private
+
+    attr_reader :params
+
+    def self.factory(obj, args, matchers)
+      new obj, Builder.new(args, matchers).params
+    end
+
+  end
+end

data/lib/quincunx/extractor.rb

@@ -0,0 +1,38 @@
+module Quincunx
+
+  class Extractor
+
+    def initialize(matcher, value)
+      @matcher = matcher
+      @value = value
+    end
+
+    def extract
+      as ? values.merge(as.to_sym => value) : values
+    end
+
+    def values
+      case
+        keys
+      when Array
+        keys.reduce({}) { |acc, k| acc.merge(k => value.send(k)) }
+      when Hash
+        keys.reduce({}) { |acc, (k, v)| acc.merge(v.to_sym => value.send(k)) }
+      end
+    end
+
+    private
+
+    def keys
+      matcher.fetch(:keys, [])
+    end
+
+    def as
+      matcher.fetch(:as, false)
+    end
+
+    attr_reader :matcher, :value
+
+  end
+end
+

data/lib/quincunx/method.rb

@@ -0,0 +1,69 @@
+module Quincunx
+  class Method
+
+    def initialize(params, body)
+      @params = params
+      @body   = body
+    end
+
+    attr_reader :params, :body
+
+    def application(obj, args)
+      Application.new(obj, args, params, body)
+    end
+
+    private
+
+    Application = Struct.new(:obj, :args, :params, :body) do
+
+      def call
+        env.instance_exec(&body)
+      end
+
+      def matches?
+        correct_arg_count? && args_match? && contains_right_keys? && passes_guard?
+      end
+
+      def env
+        @env ||= Environment.factory(obj, args, matchers)
+      end
+
+      def correct_arg_count?
+        matchers.count == args.count
+      end
+
+      def args_match?
+        pairs.all? { |(a,b)| a.first === b }
+      end
+
+      def contains_right_keys?
+        pairs.all? do |(a,b)|
+          (a[1] || {}).fetch(:keys, []).all? { |k| b.respond_to? k }
+        end
+      end
+
+      def passes_guard?
+        env.instance_exec(&guard)
+      end
+
+      def pairs
+        matchers.zip(args)
+      end
+
+      def guard
+        params.last.is_a?(Hash) ? params.last.fetch(:when) : ->{ true }
+      end
+
+      def is_guard?(param)
+        param.is_a?(Hash) && param.keys == [:when]
+      end
+
+      def matchers
+        @matchers ||= (is_guard?(params.last) ? params[0..-2] : params).map do |p|
+          p.is_a?(Array) ? p : [p]
+        end
+      end
+
+    end
+  end
+end

data/lib/quincunx/pattern_matcher.rb

@@ -0,0 +1,22 @@
+module Quincunx
+
+  module PatternMatcher
+
+    def define name, *args, &body
+      cases = dictionary[name] << Method.new(args, body)
+      define_method name do |*args, &block|
+        cases.match(self, args).match do |m|
+          m.some { |body| body.call }
+          m.none { raise NoMatchForPatternError }
+        end
+      end
+    end
+
+    private
+
+    def dictionary
+      @dictionary ||= Dictionary.new
+    end
+
+  end
+end

data/quincunx.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name          = 'quincunx'
+  s.version       = '0.0.1'
+  s.date          = '2013-04-22'
+  s.summary       = "Pattern matching for method dispatch - in Ruby?!"
+  s.description   = "This probably shouldn't work..."
+  s.authors       = ["Russell Dunphy"]
+  s.email         = ['russell@russelldunphy.com']
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.homepage      = 'http://github.com/rsslldnphy/quincunx'
+
+  s.add_dependency "optional"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+
+end
+

data/spec/lib/guard_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+class Drink
+end
+
+class SoftDrink < Drink
+end
+
+class Alcopop < Drink
+end
+
+class Bar
+  include Quincunx
+
+  define :serve_irresponsibly, Person, Anything do
+    "here you go!"
+  end
+
+  define :serve, [Person, keys: [:name]], SoftDrink do
+    "A soft drink? No problem, #{name}"
+  end
+
+  define :serve, [Person, keys: [:name, :age]], Alcopop, when: ->{ age < 18 } do
+    "No chance, #{name}, you're only #{age}!"
+  end
+
+  define :serve,
+    [Person, keys: [:name, :age]],
+    [Alcopop, as: :drink],
+    when: -> { age >= 18 } do
+
+    "Here you go, #{name}, here's your #{drink.class}"
+  end
+end
+
+describe Bar do
+
+  let (:bar)    { Bar.new }
+  let (:child)  { Person.new("Russell", 17) }
+  let (:adult)  { Person.new("Jeremy Irons", 44) }
+  let (:hooch)  { Alcopop.new }
+  let (:ribena) { SoftDrink.new }
+
+  describe "#serve_irresponsibly" do
+    it 'serves anyone anything' do
+      bar.serve_irresponsibly(child, hooch).should eq "here you go!"
+    end
+  end
+
+  describe "#serve" do
+    it 'will serve anyone a soft drink' do
+      bar.serve(child, ribena).should eq "A soft drink? No problem, Russell"
+    end
+
+    it 'will not serve children alcopops' do
+      bar.serve(child, hooch).should eq "No chance, Russell, you're only 17!"
+    end
+
+    it 'will serve adults alcopops' do
+      bar.serve(adult, hooch).should eq "Here you go, Jeremy Irons, here's your Alcopop"
+    end
+  end
+end

data/spec/lib/quincunx/builder_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Quincunx
+  describe Builder do
+
+    let (:russell)  { Cat.new("Russell", :tabby) }
+    let (:griselda) { Cat.new("Griselda", :persian) }
+    let (:args)     { [russell, griselda] }
+
+    let (:matchers) {[
+      [Cat, keys: [:type], as: :cat],
+      [Cat, keys: [:name]]
+    ]}
+
+    let (:builder) { Builder.new(args, matchers) }
+
+    it 'builds a hash of the passed params and extracted keys' do
+      builder.params.should eq ({
+        cat: russell,
+        name: "Griselda",
+        type: :tabby
+      })
+    end
+  end
+end

data/spec/lib/quincunx/case_list_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Quincunx
+  describe CaseList do
+
+    let (:obj)       { stub }
+    let (:case_list) { CaseList.new }
+
+    it 'allows methods to be shovelled in and retrieved' do
+      method = Method.new([[:foo]], ->{ :bar })
+      case_list << method
+      case_list.match(obj, [:foo]).map(&:call).should eq Some[:bar]
+    end
+
+    it 'returns a none when asked for a match if there is no match' do
+      method = Method.new([[:foo]], ->{ :bar })
+      case_list << method
+      case_list.match(obj, [:bar]).map(&:call).should be_none
+    end
+
+    it 'returns the correct method if there are multiple ones' do
+      first = Method.new([[:foo]], ->{ :bar })
+      second = Method.new([[:baz]], ->{ :quux })
+      case_list << first << second
+      case_list.match(obj, [:foo]).map(&:call).should eq Some[:bar]
+      case_list.match(obj, [:baz]).map(&:call).should eq Some[:quux]
+    end
+  end
+end

data/spec/lib/quincunx/dictionary_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Quincunx
+  describe Dictionary do
+
+    let (:dictionary) { Dictionary.new }
+
+    it 'adds methods to the dictionary' do
+      dictionary[:foo] << Method.new(:bar, :baz)
+      dictionary[:foo].should be_a CaseList
+    end
+
+    it 'defaults case lists to empty' do
+      dictionary[:quux].should be_a CaseList
+    end
+  end
+end

data/spec/lib/quincunx/environment_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Quincunx
+  describe Environment do
+
+    Cat = Struct.new(:name, :type)
+
+    let (:cat)       { Cat.new("Russell", "Tabby") }
+    let (:params)      {{ name: "Felix", paws: 3 }}
+
+    let (:delegator) { Environment.new(cat, params) }
+
+    it 'should delegate methods to the original object' do
+      delegator.type.should eq "Tabby"
+    end
+
+    it 'should prefer values in the params hash' do
+      delegator.name.should eq "Felix"
+    end
+
+    it 'should return values from the params' do
+      delegator.paws.should eq 3
+    end
+
+  end
+end

data/spec/lib/quincunx/extractor_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Quincunx
+  describe Extractor do
+
+    let (:cat) { Cat.new("Russell", "Tabby") }
+
+    let (:extractor) { Extractor.new(matcher, cat) }
+
+    subject { extractor.extract }
+
+    context "given an array of keys" do
+      let (:matcher) {{ keys: [:name, :type] }}
+
+      it "extracts the keys specified in the matcher" do
+        subject.should eq name: "Russell", type: "Tabby"
+      end
+    end
+
+    context "given a hash of keys to names" do
+      let (:matcher) {{ keys: { name: 'cat' } }}
+
+      it "extracts the keys and adds them to hash using the specified name" do
+        subject.should eq cat: "Russell"
+      end
+    end
+  end
+end

data/spec/lib/quincunx/method_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Quincunx
+  describe Method do
+
+    let (:method) { Method.new([[:cat], [:dog]], ->{ :bar }) }
+    let (:env)    { stub }
+
+    it 'can be compared to an array of args' do
+      method.application(env, [:cat, :dog]).matches?
+    end
+
+    it 'should not match a different array' do
+      method.application(env, [:cat, :cat])
+    end
+  end
+end

data/spec/lib/quincunx_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Quincunx do
+
+  let (:test_class) {
+    Class.new do
+      include Quincunx
+
+      define :speak, [:cat] do
+        :miaow
+      end
+
+      define :speak, [:dog] do
+        :woof
+      end
+
+      define :speak, [Person] do
+        :hello
+      end
+
+      define :introduce, [Person, as: :person] do
+        "hi, i'm #{person.name}"
+      end
+
+    end
+  }
+
+  subject { test_class.new }
+
+  describe "#define" do
+    it { should respond_to :speak }
+
+    it "should return the thing from the dictionary" do
+      subject.speak(:cat).should eq :miaow
+      subject.speak(:dog).should eq :woof
+    end
+
+    it "can match on class" do
+      russell = Person.new("russell", 29)
+      subject.speak(russell).should eq :hello
+    end
+
+    it "doesn't match if the number of args is wrong" do
+      expect { subject.speak(:cat, :dog) }.to raise_error Quincunx::NoMatchForPatternError
+    end
+
+    it "binds the arg to a variable if the 'as' keyword is used" do
+      russell = Person.new("russell", 29)
+      subject.introduce(russell).should eq "hi, i'm russell"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'rspec'
+require 'quincunx'
+
+RSpec.configure do |config|
+  config.order = :rand
+  config.color_enabled = true
+end
+
+class Cat
+  def initialize(name, type)
+    @name = name
+    @type = type
+  end
+
+  attr_reader :name, :type
+end
+
+class Person
+  def initialize(name, age)
+    @name = name
+    @age = age
+  end
+
+  attr_reader :name, :age
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: quincunx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Russell Dunphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optional
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: This probably shouldn't work...
+email:
+- russell@russelldunphy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- lib/quincunx.rb
+- lib/quincunx/all.rb
+- lib/quincunx/builder.rb
+- lib/quincunx/case_list.rb
+- lib/quincunx/dictionary.rb
+- lib/quincunx/environment.rb
+- lib/quincunx/extractor.rb
+- lib/quincunx/method.rb
+- lib/quincunx/pattern_matcher.rb
+- quincunx.gemspec
+- spec/lib/guard_spec.rb
+- spec/lib/quincunx/builder_spec.rb
+- spec/lib/quincunx/case_list_spec.rb
+- spec/lib/quincunx/dictionary_spec.rb
+- spec/lib/quincunx/environment_spec.rb
+- spec/lib/quincunx/extractor_spec.rb
+- spec/lib/quincunx/method_spec.rb
+- spec/lib/quincunx_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rsslldnphy/quincunx
+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: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Pattern matching for method dispatch - in Ruby?!
+test_files:
+- spec/lib/guard_spec.rb
+- spec/lib/quincunx/builder_spec.rb
+- spec/lib/quincunx/case_list_spec.rb
+- spec/lib/quincunx/dictionary_spec.rb
+- spec/lib/quincunx/environment_spec.rb
+- spec/lib/quincunx/extractor_spec.rb
+- spec/lib/quincunx/method_spec.rb
+- spec/lib/quincunx_spec.rb
+- spec/spec_helper.rb
+has_rdoc: