multidispatch_dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c188815e5ebea95a603b6756349b233ae3deba0
+  data.tar.gz: 4002fc2dfb32cc96e86cad69dafb88a727a09f88
+SHA512:
+  metadata.gz: de7e6fabc8c9cfd0de466917c036e1990a44684371b0710a7b37b603b75d869797cc0c3b92da9f1b05b9759c2bdb1c097d85158f540f6c19dcdb0d21d3a5124a
+  data.tar.gz: 0f51bc346dcc8120c7a7cf3db4812abf204f6cc9ec876b09a5592bbd6c3d108becbd453a3cd4adb4f27bde5b6aa8bd342a5ff9da5baa299614624bd85b6d23c9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Pchelincev
+
+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.rdoc

@@ -0,0 +1,110 @@
+= MultidispatchDSL
+
+If you worked with other languages you probably know multi dispatch feature - define variants of same method with
+different number of arguments of different types. In Ruby with it's duck typing you cannot do it from out of box. This
+gem will allow you to do it.
+
+{<img src="https://codeclimate.com/github/jalkoby/multidispatch_dsl.png" />}[https://codeclimate.com/github/jalkoby/multidispatch_dsl]
+{<img src="https://travis-ci.org/jalkoby/uni_sender_gem.png?branch=master" alt="Build Status" />}[https://travis-ci.org/jalkoby/uni_sender_gem]
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multidispatch_dsl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multidispatch_dsl
+
+== Usage
+
+Just include MultidispatchDSL into your class and your will get `mdef` class method. For example
+
+  class TestClass
+    include MultidispatchDSL
+
+    # hello method with one integer argument
+    mdef(:hello, Fixnum) do |i|
+      "Fixnum version with number #{ i }"
+    end
+
+    # hello method with one string argument
+    mdef(:hello, String) do |str|
+      "String version with string #{ str }"
+    end
+
+    # hello method with fixnum and string arguments
+    mdef(:hello, Fixnum, String) do |i, str|
+      "Fixnum String version with #{ i } & #{ str }"
+    end
+
+    # hello method with string and fixnum arguments
+    mdef(:hello, String, Fixnum) do |str, i|
+      "String Fixnum version with #{ str } & #{ i }"
+    end
+
+    # hello method without arguments
+    mdef(:hello) do
+      "Version without args"
+    end
+
+    # hello method with symbol argument
+    mdef(:hello, Symbol) do |symbol|
+      "Symbol version with :#{ symbol } & :#{ internal_method }"
+    end
+
+    # hello method with 2 string argument and nested block
+    mdef(:hello, String, String) do |str_one, str_two, &block|
+      instance_exec(str_one.upcase, str_two.downcase, &block)
+    end
+
+    def internal_method
+      :internal_method
+    end
+  end
+
+  test_instance = TestClass.new
+
+  test_instance.hello
+  #=> "Version without args"
+
+  test_instance.hello(1)
+  #=> "Fixnum version with number 1"
+
+  test_instance.hello(:foo)
+  #=> "Symbol version with :foo & :internal_method"
+
+  test_instance.hello(1, "string")
+  #=> "Fixnum String version with 1 & string"
+
+  test_instance.hello("string", 1)
+  #=> "String Fixnum version with string & 1"
+
+  test_instance.hello(:not, :defined)
+  #=> raise error MultidispatchDSL::MissingDeclarationError
+
+  test_instance.hello('One', 'Two') { |str_one, str_two| "#{str_one} #{ str_two } #{ internal_method }" }
+  #=> "ONE two internal_method"
+
+As you can see defining version of method with *yield* is little bit tricky. That because defining method from block add extra scope. More details about it here http://www.andylindeman.com/2011/01/08/defining-methods-using-blocks-in-ruby.html
+
+If you desire add this functionality to all classes just include MultidispatchDSL to Object class:
+
+  Object.send(:include, MultidispatchDSL)
+
+== Requirements
+
+  Ruby >= 1.9.2 and other ruby implementations with 1.9 mode
+
+== 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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run all specs"
+task :default => :spec

data/lib/multidispatch_dsl/dsl.rb

@@ -0,0 +1,28 @@
+require 'multidispatch_dsl/generator'
+require 'multidispatch_dsl/missing_declaration_error'
+
+module MultidispatchDSL::DSL
+  def self.included(klass)
+    klass.extend(::MultidispatchDSL::DSL::ClassMethods)
+  end
+
+  module ClassMethods
+    def mdef(method_name, *declaration, &block)
+      real_method_name = ::MultidispatchDSL::Generator.method_name_from_declaration(method_name, declaration)
+      define_method(real_method_name, &block)
+
+      unless method_defined?(method_name)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ method_name }(*args, &block)
+            real_method_name = ::MultidispatchDSL::Generator.method_name_from_args(__callee__, args)
+            if respond_to?(real_method_name)
+              send(real_method_name, *args, &block)
+            else
+              raise ::MultidispatchDSL::MissingDeclarationError.new(__callee__, args)
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/multidispatch_dsl/generator.rb

@@ -0,0 +1,32 @@
+module MultidispatchDSL::Generator
+  module_function
+
+  def method_name_from_declaration(base, declaration)
+    if declaration.empty?
+      "#{ base }_empty"
+    else
+      prefix = declaration.map { |klass| underscore(klass) }.join('_')
+      "#{ base }_#{ prefix }"
+    end
+  end
+
+  def method_name_from_args(base, args)
+    method_name_from_declaration(base, args.map(&:class))
+  end
+
+  def declaration_from_args(args)
+    list = args.join(', ') { |item| item.class.to_s }
+    "(#{ list })"
+  end
+
+  # source code was taken from activesupport library
+  def underscore(klass)
+    word = klass.to_s.dup
+    word.gsub!(/::/, '_')
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/lib/multidispatch_dsl/missing_declaration_error.rb

@@ -0,0 +1,6 @@
+class MultidispatchDSL::MissingDeclarationError < StandardError
+
+  def initialize(method_name, args)
+    super "#{ MultidispatchDSL::Generator.declaration_from_args(args) } for #{ method_name }"
+  end
+end

data/lib/multidispatch_dsl/version.rb

@@ -0,0 +1,3 @@
+module MultidispatchDSL
+  VERSION = '0.1.0'
+end

data/lib/multidispatch_dsl.rb

@@ -0,0 +1,7 @@
+module MultidispatchDSL
+  autoload :DSL, 'multidispatch_dsl/dsl'
+
+  def self.included(klass)
+    klass.send(:include, ::MultidispatchDSL::DSL)
+  end
+end

data/multidispatch_dsl.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multidispatch_dsl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multidispatch_dsl"
+  spec.version       = MultidispatchDSL::VERSION
+  spec.authors       = ["Sergey Pchelincev"]
+  spec.email         = ["jalkoby91@gmail.com"]
+  spec.description   = %q{Add mutlti dispatch functionality to Ruby}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  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 "rake"
+  spec.add_development_dependency "rspec", ">= 2.0.0"
+end

data/spec/lib/multidispatch_dsl_generator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe MultidispatchDSL::Generator do
+  context '.method_name_from_declaration' do
+    specify { should == "execute_empty" }
+    specify { subject(Fixnum).should == "execute_fixnum" }
+    specify { subject(Fixnum, String).should == "execute_fixnum_string" }
+    specify { subject(described_class).should == "execute_multidispatch_dsl_generator" }
+
+    def subject(*declaration)
+      described_class.method_name_from_declaration("execute", declaration)
+    end
+  end
+
+  context '.declaration_from_args' do
+    specify { should = "()" }
+    specify { subject(Fixnum, String).should == "(Fixnum, String)" }
+
+    def subject(*args)
+      described_class.declaration_from_args(args)
+    end
+  end
+end

data/spec/lib/multidispatch_dsl_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe MultidispatchDSL do
+  subject { TestClass.new }
+
+  specify { subject.hello.should == "Version without args" }
+  specify { subject.hello(1).should == "Fixnum version with number 1" }
+  specify { subject.hello(:foo).should == "Symbol version with :foo & :internal_method" }
+  specify { subject.hello(1, "string").should == "Fixnum String version with 1 & string" }
+  specify { subject.hello("string", 1).should == "String Fixnum version with string & 1" }
+  specify { expect { subject.fooo }.to raise_error(NameError) }
+  specify { expect { subject.hello(:not, :defined).to raise_error(MultidispatchDSL::MissingDeclarationError) } }
+
+  it 'allow yield in methods' do
+    subject.hello('One', 'Two') do |str_one, str_two|
+      "#{str_one} #{ str_two } #{ internal_method }"
+    end.should == "ONE two internal_method"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+Bundler.require(:default)
+Dir["#{ File.dirname(__FILE__) }/support/**/*.rb"].each { |f| require f }

data/spec/support/test_class.rb

@@ -0,0 +1,35 @@
+class TestClass
+  include MultidispatchDSL
+
+  mdef(:hello, Fixnum) do |i|
+    "Fixnum version with number #{ i }"
+  end
+
+  mdef(:hello, String) do |str|
+    "String version with string #{ str }"
+  end
+
+  mdef(:hello, Fixnum, String) do |i, str|
+    "Fixnum String version with #{ i } & #{ str }"
+  end
+
+  mdef(:hello, String, Fixnum) do |str, i|
+    "String Fixnum version with #{ str } & #{ i }"
+  end
+
+  mdef(:hello) do
+    "Version without args"
+  end
+
+  mdef(:hello, Symbol) do |symbol|
+    "Symbol version with :#{ symbol } & :#{ internal_method }"
+  end
+
+  mdef(:hello, String, String) do |str_one, str_two, &block|
+    instance_exec(str_one.upcase, str_two.downcase, &block)
+  end
+
+  def internal_method
+    :internal_method
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: multidispatch_dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Pchelincev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-28 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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Add mutlti dispatch functionality to Ruby
+email:
+- jalkoby91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/multidispatch_dsl.rb
+- lib/multidispatch_dsl/dsl.rb
+- lib/multidispatch_dsl/generator.rb
+- lib/multidispatch_dsl/missing_declaration_error.rb
+- lib/multidispatch_dsl/version.rb
+- multidispatch_dsl.gemspec
+- spec/lib/multidispatch_dsl_generator_spec.rb
+- spec/lib/multidispatch_dsl_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_class.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Add mutlti dispatch functionality to Ruby
+test_files:
+- spec/lib/multidispatch_dsl_generator_spec.rb
+- spec/lib/multidispatch_dsl_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_class.rb