forwardablex 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Keita Yamaguchi
+
+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,68 @@
+# forwardablex
+
+forwardablex is a ruby library to extend forwardable.rb.
+
+## Installation
+
+    gem install forwardablex
+
+## Usage
+
+### Forward to Instance Variable
+
+```ruby
+Receiver = Struct(:m)
+class Forwarder
+  forward :@receiver, :m
+  def initialize
+    @recevier = Receiver.new("forwarded")
+  end
+end
+Forwarder.new.m #=> "forwarded"
+```
+
+### Forward to Proc Receiver
+
+```ruby
+class Forwarder
+  forward lambda{Struct(:m).new("forwarded")}, :m
+end
+Forwarder.new.m #=> "forwarded"
+```
+
+### Forward to Instance
+
+```ruby
+Receiver = Struct(:m)
+class Forwarder
+  forward Receiver.new("forwarded"), :m
+end
+Forwarder.new.m #=> "forwarded"
+```
+
+### Class Method Accessor
+
+```ruby
+Receiver = Struct(:name)
+class Forwarder
+  class << self
+    def m
+      "forwarded"
+    end
+    end
+  forward self, :m
+end
+Forwarder.new.m #=> "forwarded"
+```
+
+## Licence
+
+forwardablex is free software distributed under MIT licence.
+
+## 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,16 @@
+require "bundler/gem_tasks"
+
+desc 'Test specs'
+task 'test' do
+  sh "bundle exec bacon -a"
+end
+
+desc 'Generate API document'
+task 'html' do
+  sh "bundle exec yard doc -o html --hide-void-return --no-api"
+end
+
+desc 'Show undocumented function list'
+task 'html:undoc' do
+  sh "bundle exec yard stats --list-undoc --no-api --compact"
+end

data/forwardablex.gemspec

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forwardablex/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "forwardablex"
+  gem.version       = ForwardableX::VERSION
+  gem.authors       = ["Keita Yamaguchi"]
+  gem.email         = ["keita.yamaguchi@gmail.com"]
+  gem.description   = "This is a library to extend Forwardable functions"
+  gem.summary       = "Forwardable extension"
+  gem.homepage      = "https://github.com/keita/forwardablex"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency "bacon"
+  gem.add_development_dependency "yard", "~> 0.8.5"
+  gem.add_development_dependency "redcarpet"
+end

data/lib/forwardablex.rb

@@ -0,0 +1,110 @@
+# Copyright (C) 2013 Keita Yamaguchi <keita.yamaguchi@gmail.com>
+
+require "forwardablex/version"
+
+# ForwardableX is a module for providing extra Forwardable functions. Benefits
+# to use this library are the following:
+#
+# - you can use easy keyword "forward", instead of "def_instance_delegator" or "def_delegator"
+# - you can specify message receiver as instance variable name, Proc object or plain object
+# - no need to declare "extend Forwardable"
+# - forwardable.rb compatible API
+#
+# @example Forward to Instance Variable
+#   Receiver = Struct(:m)
+#   class Forwarder
+#     forward :@receiver, :m
+#     def initialize
+#       @recevier = Receiver.new("forwarded")
+#     end
+#   end
+#   Forwarder.new.m #=> "forwarded"
+# @example Forward to Proc Receiver
+#   class Forwarder
+#     forward lambda{Struct(:m).new("forwarded")}, :m
+#   end
+#   Forwarder.new.m #=> "forwarded"
+# @example Forward to Instance
+#   Receiver = Struct(:m)
+#   class Forwarder
+#     forward Receiver.new("forwarded"), :m
+#   end
+#   Forwarder.new.m #=> "forwarded"
+# @example Class Method Accessor
+#   Receiver = Struct(:name)
+#   class Forwarder
+#     class << self
+#       def m
+#         "forwarded"
+#       end
+#     end
+#     forward self, :m
+#   end
+#   Forwarder.new.m #=> "forwarded"
+module ForwardableX
+  # Define a method that forwards the message to the receiver. You can specify
+  # receiver as instance variable name, Proc object, and plain object.
+  #
+  # @param receiver [Symbol, String, Proc, or Object]
+  #   message receiver
+  # @param method [Symbol]
+  #   method name that we forward to
+  # @param name [Symbol]
+  #   method name that we forward from
+  # @return [void]
+  def forward(receiver, method, name=method)
+    context = self.kind_of?(Module) ? self : self.singleton_class
+    context.instance_eval do
+      case receiver
+      when Symbol, String
+        define_method(name) do |*args, &b|
+          instance_variable_get(receiver).__send__(method, *args, &b)
+        end
+      when Proc
+        define_method(name) do |*args, &b|
+          receiver.call.__send__(method, *args, &b)
+        end
+      else
+        define_method(name) do |*args, &b|
+          receiver.__send__(method, *args, &b)
+        end
+      end
+    end
+  end
+  alias :def_instance_delegator :forward
+  alias :def_singleton_delegator :forward
+  alias :def_delegator :forward
+
+  # Define each method that calls the receiver's method.
+  #
+  # @param receiver [Symbol, String, Proc, or Object]
+  #   message receiver
+  # @param methods [Array<Symbol>]
+  #   method names that we forward to
+  # @return [void]
+  def forward!(receiver, *methods)
+    methods.delete("__send__")
+    methods.delete("__id__")
+    methods.each {|method| forward(receiver, method)}
+  end
+  alias :def_instance_delegators :forward!
+  alias :def_singleton_delegators :forward!
+  alias :def_delegators :forward!
+
+  # Same as Forwardable#delegate, but you can specify receivers as instance
+  # variable name, Proc object, and plain object.
+  #
+  # @param hash [Hash]
+  #   the hash table contains keys as methods and values as recevier
+  # @return [void]
+  def delegate(hash)
+    hash.each do |methods, receiver|
+      forward!(receiver, *methods)
+    end
+  end
+end
+
+# @api private
+class Object
+  extend ForwardableX
+end

data/lib/forwardablex/version.rb

@@ -0,0 +1,4 @@
+module ForwardableX
+  # version of ForwardableX
+  VERSION = "0.1.0"
+end

data/test/spec_forwardablex.rb

@@ -0,0 +1,118 @@
+require 'forwardable'
+require 'forwardablex'
+
+class Receiver
+  def method_missing(name, *args)
+    name
+  end
+end
+
+class Forwarder
+  attr_reader :name
+
+  def initialize(name=self.class)
+    @rec = Receiver.new
+    @name = name
+  end
+end
+
+class XForwarder < Forwarder
+  forward :@rec, :m1
+  forward :@rec, :m1, :mm1
+  forward! :@rec, :m2, :m3
+  forward Proc.new{Receiver.new}, :m4
+  forward Proc.new{Receiver.new}, :m4, :mm4
+  forward! Proc.new{Receiver.new}, :m5, :m6
+  forward Receiver.new, :m7
+  forward Receiver.new, :m7, :mm7
+  forward! Receiver.new, :m8, :m9
+end
+
+class DefDelegatorForwarder < Forwarder
+  def_delegator :@rec, :m1
+  def_delegator :@rec, :m1, :mm1
+  def_delegators :@rec, :m2, :m3
+  def_delegator Proc.new{Receiver.new}, :m4
+  def_delegator Proc.new{Receiver.new}, :m4, :mm4
+  def_delegators Proc.new{Receiver.new}, :m5, :m6
+  def_delegator Receiver.new, :m7
+  def_delegator Receiver.new, :m7, :mm7
+  def_delegators Receiver.new, :m8, :m9
+end
+
+class DefInstanceDelegatorForwarder < Forwarder
+  def_instance_delegator :@rec, :m1
+  def_instance_delegator :@rec, :m1, :mm1
+  def_instance_delegators :@rec, :m2, :m3
+  def_instance_delegator Proc.new{Receiver.new}, :m4
+  def_instance_delegator Proc.new{Receiver.new}, :m4, :mm4
+  def_instance_delegators Proc.new{Receiver.new}, :m5, :m6
+  def_instance_delegator Receiver.new, :m7
+  def_instance_delegator Receiver.new, :m7, :mm7
+  def_instance_delegators Receiver.new, :m8, :m9
+end
+
+class DelegateForwarder < Forwarder
+  delegate :m1 => :@rec
+  delegate [:m2, :m3] => :@rec
+  delegate :m4 => Proc.new{Receiver.new}
+  delegate [:m5, :m6] => Proc.new{Receiver.new}
+  delegate :m7 => Receiver.new
+  delegate [:m8, :m9] => Receiver.new
+end
+
+xforwarder = Forwarder.new("xforwarder").tap do |obj|
+  obj.extend ForwardableX
+  obj.forward :@rec, :m1
+  obj.forward :@rec, :m1, :mm1
+  obj.forward! :@rec, :m2, :m3
+  obj.forward Proc.new{Receiver.new}, :m4
+  obj.forward Proc.new{Receiver.new}, :m4, :mm4
+  obj.forward! Proc.new{Receiver.new}, :m5, :m6
+  obj.forward Receiver.new, :m7
+  obj.forward Receiver.new, :m7, :mm7
+  obj.forward! Receiver.new, :m8, :m9
+end
+
+singletonforwarder = Forwarder.new("singletonforwarder").tap do |obj|
+  obj.extend ForwardableX
+  obj.def_singleton_delegator :@rec, :m1
+  obj.def_singleton_delegator :@rec, :m1, :mm1
+  obj.def_singleton_delegators :@rec, :m2, :m3
+  obj.def_singleton_delegator Proc.new{Receiver.new}, :m4
+  obj.def_singleton_delegator Proc.new{Receiver.new}, :m4, :mm4
+  obj.def_singleton_delegators Proc.new{Receiver.new}, :m5, :m6
+  obj.def_singleton_delegator Receiver.new, :m7
+  obj.def_singleton_delegator Receiver.new, :m7, :mm7
+  obj.def_singleton_delegators Receiver.new, :m8, :m9
+end
+
+describe 'ForwardableX' do
+  [ XForwarder.new,
+    DefDelegatorForwarder.new,
+    DefInstanceDelegatorForwarder.new,
+    DelegateForwarder.new,
+    xforwarder,
+    singletonforwarder
+  ].each do |obj|
+    describe obj.name do
+      it 'should forward' do
+        obj.m1.should == :m1
+        obj.m2.should == :m2
+        obj.m3.should == :m3
+        obj.m4.should == :m4
+        obj.m5.should == :m5
+        obj.m6.should == :m6
+        obj.m7.should == :m7
+        obj.m8.should == :m8
+        obj.m9.should == :m9
+      end
+
+      unless obj.kind_of? DelegateForwarder
+        it 'should forward by alias' do
+          obj.mm1.should == :m1
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: forwardablex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Keita Yamaguchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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 is a library to extend Forwardable functions
+email:
+- keita.yamaguchi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- forwardablex.gemspec
+- lib/forwardablex.rb
+- lib/forwardablex/version.rb
+- test/spec_forwardablex.rb
+homepage: https://github.com/keita/forwardablex
+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.24
+signing_key: 
+specification_version: 3
+summary: Forwardable extension
+test_files:
+- test/spec_forwardablex.rb
+has_rdoc: