multiplexing_delegator 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 / 2008-01-25
+
+* Birth to the MultiplexingDelegator!

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/multiplexing_delegator
+lib/multiplexing_delegator.rb
+test/test_multiplexing_delegator.rb

data/README.txt

@@ -0,0 +1,77 @@
+MultiplexingDelegator
+    by Justin Knowlden
+    http://glomp.rubyforge.org/multiplexing_delegator
+
+== DESCRIPTION:
+  
+MultiplexingDelegator is used to define a delegator method that
+multiplexes calls from one method across many methods for an instance of an
+object. The class method is usable for any type of Object, but was intended for
+use within an ActiveRecord object.
+
+The delegator works by calling the same method across multiple methods or
+accessors for a given object instance and aggregating the results.
+
+== FEATURES/PROBLEMS:
+
+* Adds a multiplex class method to all Objects
+
+== SYNOPSIS:
+
+Example
+ class Foo
+   attr_accessor :baz, :bum
+   multiplex :bar, :on => [:baz, :bum]
+ end
+
+ foo = Foo.new
+ foo.baz = 1
+ foo.bum = ['boo']
+ foo.bar.map => [1, 'boo']
+
+You can also proxy method calls to each of the delegated items and results
+will be aggregated.
+
+Example
+ class Goo
+   attr_accessor :car
+   def initialize(car) @car = car; end
+ end
+
+ foo = Foo.new
+ foo.baz = Goo.new('hello')
+ foo.bum = Goo.new('world')
+ foo.bar.car => ['hello, 'world']
+
+== REQUIREMENTS:
+
+Ruby 1.8.6 and above
+
+== INSTALL:
+
+sudo gem install multiplexing_delegator
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Justin Knowlden
+
+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/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/multiplexing_delegator.rb'
+
+Hoe.new('MultiplexingDelegator', Glomp::MultiplexingDelegator::VERSION) do |p|
+  p.name = 'multiplexing_delegator'
+  p.rubyforge_name = 'glomp'
+  p.author = 'Justin Knowlden'
+  p.email = 'justin@goglomp.net'
+  p.summary = 'Define a single delegator method that multiplexes calls across multiple methods within an Object'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = 'multiplexing_delegator'
+end
+
+# vim: syntax=Ruby

data/lib/multiplexing_delegator.rb

@@ -0,0 +1,82 @@
+# class MultiplexingDelegator
+#   VERSION = '0.1.0'
+# end
+module Glomp #:nodoc:
+  module MultiplexingDelegator #:nodoc:
+    VERSION = '0.1.0'
+
+    # The multiplex class method is used to define a delegator method that
+    # multiplexes calls to a method across many methods for an instance of an
+    # object. The class method is usable for any type of Object, not just
+    # ActiveRecord objects.
+    #
+    # The delegator works by calling the same method across multiple methods or
+    # accessors for a given object instance and aggregating the results.
+    #
+    # Example
+    #  class Foo
+    #    attr_accessor :baz, :bum
+    #    multiplex :bar, :on => [:baz, :bum]
+    #  end
+    #
+    #  foo = Foo.new
+    #  foo.baz = 1
+    #  foo.bum = ['boo']
+    #  foo.bar.map => [1, 'boo']
+    #  foo.bar.each {|item| puts "Yo yo #{item}"}
+    #  => Yo yo 1
+    #  => Yo yo boo
+    #
+    # You can also proxy method calls to each of the delegated items and results
+    # will be aggregated.
+    #
+    # Example
+    #  class Goo
+    #    attr_accessor :car
+    #    def initialize(car) @car = car; end
+    #  end
+    #
+    #  foo = Foo.new
+    #  foo.baz = Goo.new('hello')
+    #  foo.bum = Goo.new('world')
+    #  foo.bar.car => ['hello, 'world']
+    #
+    def multiplex(method, opts={})
+      define_method(method) do
+        @multiplexer ||= Multiplexer.new(method, self, opts[:on])
+      end
+    end
+
+    class BlankSlate
+      instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+    end
+
+    class Multiplexer < BlankSlate
+      def initialize(name, target, on=[])
+        @target = target
+        @multiplexed = (array?(on) ? on : [on]).compact
+        if @multiplexed == []
+          raise ::ArgumentError.new(
+            "Must specify delegation methods for #{name.inspect} multiplexer")
+        end
+      end
+
+      def method_missing(sym, *args, &block)
+        @multiplexed.inject([]) do |acc, proxy_to|
+          proxy_target = @target.send(proxy_to)
+          if proxy_target
+            val = proxy_target.send(sym, *args, &block)
+            acc = acc.send((array?(val) ? :+ : :<<), val)
+          end
+          acc
+        end
+      end
+      
+    private
+      def array?(obj) obj.kind_of?(Array); end
+    end
+
+  end # MultiplexingDelegator
+end # Glomp
+
+Object.send(:extend, Glomp::MultiplexingDelegator)

data/test/test_multiplexing_delegator.rb

@@ -0,0 +1,113 @@
+require 'multiplexing_delegator'
+require 'test/unit'
+
+class Foo
+  attr_accessor :bar
+  def initialize(bar) @bar = bar; end
+  
+  def baz(&block)
+    "#{@bar} #{yield}"
+  end
+end
+
+class Family
+  attr_accessor :adults, :children, :pets
+  multiplex :members, :on => [:adults, :children, :pets]
+end
+
+class TestMultiplexingDelegator < Test::Unit::TestCase
+
+  def test_multiplex_returns_empty_array_when_nothing_to_aggregate
+    family = Family.new
+    assert_equal [], family.members.map
+  end
+
+  def test_multiplex_returns_flat_array_when_aggregating
+    family = Family.new
+    family.adults = ['mom', 'dad']
+    family.children = ['thing 1', 'thing 2']
+    family.pets = ['dog', 'cat']
+    assert_equal family.adults + family.children + family.pets,
+      family.members.map
+  end
+
+  def test_should_only_create_one_multiplex_instance_per_object_instance
+    family = Family.new
+    assert_same family.members.__id__, family.members.__id__
+    assert_not_equal Family.new.members.__id__, family.members.__id__
+  end
+
+  def test_should_include_single_element_returns
+    family = Family.new
+    family.adults = 'mom'
+    family.children = ['thing 1', 'thing 2']
+    family.pets = 'dog'
+    assert_equal ['mom'] + family.children + ['dog'], family.members.map
+  end
+
+  def test_should_ignore_nil_values
+    family = Family.new
+    family.adults = nil
+    family.children = ['superfudge']
+    family.pets = 'dog'
+    assert_equal ['superfudge', 'dog'], family.members.map
+  end
+
+  def test_should_accept_nil_array_values
+    family = Family.new
+    family.adults = [nil]
+    family.children = [nil]
+    family.pets = nil
+    assert_equal [nil, nil], family.members.map
+  end
+
+  def test_should_throw_no_method_found_when_calling_unknown_method_on_assoc
+    family = Family.new
+    assert_raise(NoMethodError) { family.methods.foo }
+  end
+
+  def test_should_only_flatten_array_for_first_level_elements
+    family = Family.new
+    family.adults = [[1], [2]]
+    family.children = [['a'], 'b']
+    family.pets = 'dog'
+    assert_equal [[1], [2], ['a'], 'b', 'dog'], family.members.map
+  end
+
+  def test_should_proxy_any_method
+    family = Family.new
+    family.adults = Foo.new(1)
+    family.children = Foo.new(2)
+    family.pets = Foo.new(3)
+    assert_equal [1, 2, 3], family.members.bar
+  end
+
+  def test_should_accept_non_array_values_for_on
+    family = Family.new
+    class << family
+      multiplex :foo, :on => :children
+    end
+    family.children = Foo.new('howdy')
+    assert_equal ['howdy'], family.foo.bar
+  end
+
+  def test_should_bail_with_a_nil_on
+    family = Family.new
+    class << family
+      multiplex :foo, :on => nil
+    end
+    assert_raise(::ArgumentError) do
+      family.foo.map
+    end
+  end
+
+  def test_should_proxy_blocks
+    family = Family.new
+    family.adults = Foo.new(1)
+    family.children = Foo.new(2)
+    family.pets = Foo.new(3)
+    aggregate_baz = family.members.baz {'foo'}
+    assert_equal ['1 foo', '2 foo', '3 foo'], aggregate_baz
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: multiplexing_delegator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Knowlden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-26 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "The delegator works by calling the same method across multiple methods or accessors for a given object instance and aggregating the results.  == FEATURES/PROBLEMS:  * Adds a multiplex class method to all Objects  == SYNOPSIS:"
+email: justin@goglomp.net
+executables: 
+- multiplexing_delegator
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/multiplexing_delegator
+- lib/multiplexing_delegator.rb
+- test/test_multiplexing_delegator.rb
+has_rdoc: true
+homepage: "    by Justin Knowlden"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: glomp
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Define a single delegator method that multiplexes calls across multiple methods within an Object
+test_files: 
+- test/test_multiplexing_delegator.rb