multidispatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cb0cc40fa1dbf67b7ac1719ff91f623e65e7fb7
+  data.tar.gz: b55d47ba43e2b8f1d6d98fd02e37f59ba4c5ab2e
+SHA512:
+  metadata.gz: 0fbe1ab138090370cfda4f1c4be6e4b376d2066e81527a0ff04f98d4821f8bb07f18e6130f2db19d2d9c683e3e753c94bd55ca8217be8189fb349f4f69046928
+  data.tar.gz: bf9452366c911bfc1a1973874e6164a52e3e073b687e4d19f7ac595cb426b816c1a48fe3999f5c5adbbef336bf33b8d8484328b8bd0bb93b16c3389fd27d0652

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-multidispatch.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Iaroslav
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yaroslav Sergeyev
+
+MIT License
+
+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,81 @@
+ruby-multidispatch
+==================
+
+Very basic multidispatch in Ruby using natural syntax.
+It solves only one problem: converts
+
+```ruby
+class BoilerplateClass
+  def foo(a = nil, b = nil)
+    unless a || b
+      # do action 1
+      # ...
+    end
+    if a && !b
+      # do action 2
+      # ...
+    end
+    if a && b
+      # do action 3
+      # ...
+    end
+  end
+end
+```
+
+to 
+
+```ruby
+class MultidispatchClass
+  include Multidispatch
+
+  def foo
+    # do action 1
+    # ...
+  end
+
+  def foo(a)
+    # do action 2
+    # ...
+  end
+
+  def foo(a,b)
+    # do action 3
+    # ...
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-multidispatch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-multidispatch
+
+## Usage
+
+See samples:
+
+* multidispatch.rb - the module itself
+* morning.rb, night.rb - sample classes using multidispatch module
+* main.rb - quick CLI test for **Morning** and **Night**
+
+Currently supports overloads by count of mandatory parameters.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+... and Happy Hacking!

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/multidispatch/version.rb

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

data/lib/multidispatch.rb

@@ -0,0 +1,65 @@
+require "multidispatch/version"
+
+module Multidispatch
+
+  class Store
+    attr_reader :store
+
+    def initialize
+      @store = {}
+      @locked = nil
+    end
+
+    def get(klass, method_name, arity)
+      class_methods = @store[klass.name] || {}
+      methods = class_methods[method_name] || {}
+      method_body = methods[-1] || methods[arity]
+      raise NoMethodError unless method_body
+      method_body
+    end
+
+    def set(klass, method_name)
+      return nil if locked?
+
+      class_methods = @store[klass.name] ||= {}
+      methods = class_methods[method_name] ||= {}
+      method = klass.instance_method(method_name)
+      methods[method.arity] = method
+    end
+
+    def locked?
+      @locked
+    end
+
+    def lock!
+      @locked = true
+      self
+    end
+
+    def release!
+      @locked = nil
+      self
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    puts "ClassMethods: #{self}"
+    @@store = Store.new
+
+    def method_added(name)
+      return if @@store.locked? # prevent recursion
+      @@store.set(self, name)
+
+      @@store.lock!
+      define_method(name) do |*args|
+        method = @@store.get(self.class, name, args.count)
+        method.bind(self).call(*args)
+      end
+      @@store.release!
+    end
+  end
+end

data/multidispatch.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multidispatch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multidispatch"
+  spec.version       = Multidispatch::VERSION
+  spec.authors       = ["Iaroslav Sergieiev"]
+  spec.email         = ["noomorph@gmail.com"]
+  spec.description   = %q{
+    Very basic multidispatch in Ruby using natural def syntax.
+  }
+  spec.summary       = %q{
+    Very basic multidispatch in Ruby using natural def syntax.
+    Currently supports only overloads by count of mandatory parameters.
+  }
+  spec.homepage      = "https://github.com/noomorph/ruby-multidispatch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/integration_spec.rb

@@ -0,0 +1,31 @@
+describe "integration test" do
+
+  it "should not overwrite methods of previous classes" do
+    class Intersect1
+      include Multidispatch
+      def foo() "foo"; end
+    end
+
+    class Intersect2
+      include Multidispatch
+      def foo() "bar"; end
+    end
+
+    Intersect1.new.foo.should == "foo"
+  end
+
+  it "should work" do
+    class Foo
+      include Multidispatch
+
+      def foo() "foo"; end
+      def foo(a) "foo #{a}"; end
+      def foo(n, a) "#{n} foo #{a}"; end
+    end
+
+    f = Foo.new
+    f.foo().should == "foo"
+    f.foo(5).should == "foo 5"
+    f.foo(0,1).should == "0 foo 1"
+  end
+end

data/spec/multidispatch_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Multidispatch do
+  it "should have self.included method" do
+    subject.method(:included).should_not be_nil
+  end
+end
+
+describe Multidispatch::Store do
+
+  context "when released" do
+    it "can be locked" do
+      expect { subject.lock! }.to change { subject.locked? }.from(nil).to(true)
+    end
+
+    it "has no effect to release" do
+      expect { subject.release! }.not_to change { subject.locked? }
+    end
+
+    context "when method added" do
+      before { @the_method = subject.set(Hash, :inspect) }
+
+      it { @the_method.should be_instance_of(UnboundMethod) }
+      its(:store) { should == {"Hash" => {inspect: {0 => @the_method}}} }
+
+      it "get() returns it" do
+        subject.get(Hash, :inspect, 0).should == @the_method
+      end
+    end
+    
+  end
+
+  context "when locked" do
+    before { subject.lock! }
+
+    it "can be released" do
+      expect { subject.release! }.to change { subject.locked? }.from(true).to(nil)
+    end
+    
+    context "when try to add method" do
+      before { @the_method = subject.set(Object, :some_method) }
+
+      it { @the_method.should be_nil }
+      its(:store) { should == {} }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'multidispatch'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: multidispatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Iaroslav Sergieiev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: "\n    Very basic multidispatch in Ruby using natural def syntax.\n  "
+email:
+- noomorph@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multidispatch.rb
+- lib/multidispatch/version.rb
+- multidispatch.gemspec
+- spec/integration_spec.rb
+- spec/multidispatch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/noomorph/ruby-multidispatch
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Very basic multidispatch in Ruby using natural def syntax. Currently supports
+  only overloads by count of mandatory parameters.
+test_files:
+- spec/integration_spec.rb
+- spec/multidispatch_spec.rb
+- spec/spec_helper.rb