module_chain_method 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kurt Stephens
+
+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,73 @@
+= module_chain_method
+
+Module::ChainMethod mixin to simplify method chain aliasing.
+
+== Example
+
+  require 'module/chain_method' # Module::ChainMethod
+
+  module MyMixin
+    def self.included target
+      super
+      $stderr.puts "MyMixin.included #{target}
+    end		 
+    include ::Module::ChainMethod
+
+    def foo
+      puts "MyMixin#foo"
+      foo_without_MyMixin
+    end
+
+    def bar
+      puts "MyMixin#bar"
+    end
+
+    # Prepares method #foo for chaining.
+    chain_method :foo
+  end
+      
+  class Foo
+    def foo
+      puts "Foo#foo"
+    end
+        
+    def bar
+      puts "Foo#bar"
+      super rescue nil
+    end
+  end
+
+  f = Foo.new
+  f.foo
+  f.bar
+  puts
+
+  Foo.send(:include, MyMixin)
+  f.foo
+  f.bar
+
+Generates the following output:
+
+   > ruby -I lib example/ex01.rb
+  Foo#foo
+  Foo#bar
+  
+  MyMixin.included Foo
+  MyMixin#foo
+  Foo#foo
+  Foo#bar
+  MyMixin#bar
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kurt Stephens. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "module_chain_method"
+    gem.summary = %Q{Module::ChainMethod mixin to simplify method chain aliasing.}
+    gem.description = %Q{Module::ChainMethod mixin to simplify method chain aliasing.}
+    gem.email = "ks.github@kurtstephens.com"
+    gem.homepage = "http://github.com/kstephens/module_chain_method"
+    gem.authors = ["Kurt Stephens"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "module_chain_method #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/example/ex01.rb

@@ -0,0 +1,40 @@
+  require 'module/chain_method' # Module::ChainMethod
+
+  module MyMixin
+    def self.included target
+      super
+      $stderr.puts "MyMixin.included #{target}"
+    end		 
+    include ::Module::ChainMethod
+
+    def foo
+      puts "MyMixin#foo"
+      foo_without_MyMixin
+    end
+    # Prepares method #foo for chaining.
+    chain_method :foo
+
+    def bar
+      puts "MyMixin#bar"
+    end
+  end
+      
+  class Foo
+    def foo
+      puts "Foo#foo"
+    end
+        
+    def bar
+      puts "Foo#bar"
+      super rescue nil
+    end
+  end
+
+  f = Foo.new
+  f.foo
+  f.bar
+  puts 
+
+  Foo.send(:include, MyMixin)
+  f.foo
+  f.bar

data/lib/module/chain_method.rb

@@ -0,0 +1,96 @@
+
+class Module
+  module ChainMethod
+    def self.included target
+      # $stderr.puts "ChainMethod #{self.inspect}.included #{target}"
+      super
+      target.extend(ClassMethods)  if Class  === target 
+      target.extend(ModuleMethods) if Module === target
+      if target.method_defined?(:included)
+        target.send(:alias_method, :included_without_ChainMethod, :included)
+      end
+    end
+
+    module ModuleMethods 
+      def included target
+        # $stderr.puts "ChainMethod::ModuleMethods #{self.inspect}.included #{target}"
+        super
+        self.included_without_ChainMethod(target) if self.respond_to?(:included_without_ChainMethod)
+        # $stderr.puts "#{target.inspect}.ancestors = #{target.ancestors.inspect}"
+        target.extend(self.ClassMethods)  if Class  === target && defined?(self.ClassMethod)
+        target.extend(self.ModuleMethods) if Module === target && defined?(self.ModuleMethods)
+        chain_methods! target
+      end
+
+      def chain_methods suffix = nil
+        # $stderr.puts "ChainMethod::ModuleMethods #{self.inspect}.chain_methods #{suffix.inspect}"
+        @chain_methods_suffix = suffix if suffix 
+        @chain_methods ||= [ ]
+      end
+
+      def _chain_methods_suffix
+        @chain_methods_suffix ||= self.name.sub(/.*::/, '').freeze
+        @_chain_methods_suffix ||= @chain_methods_suffix.to_s.sub(/[^a-z0-9_]/i, '_').freeze
+      end
+
+      def chain_method *selectors
+        # $stderr.puts "ChainMethod::ModuleMethods #{self.inspect}.chain_method #{selectors.inspect}"
+        chain_methods.push(*selectors.map{|m| m.to_sym}).uniq!
+        # $stderr.puts "chain_selectors = #{chain_methods.inspect}"
+        self
+      end
+
+      # NOT THREAD-SAFE!
+      def prepare_methods!
+        @chain_methods_prepared ||= [ ] 
+        # $stderr.puts "ChainMethod::ModuleMethods #{self.inspect}.prepare_methods!"
+
+        suffix = _chain_methods_suffix
+
+        target = self
+
+        # $stderr.puts "  BEFORE: #{(target.instance_methods.sort - Object.methods).inspect}"
+
+        chain_methods.each do | selector |
+          next if @chain_methods_prepared.include?(selector)
+          @chain_methods_prepared << selector
+
+          without_selector = _map_selector(selector, "_without_#{suffix}")
+          with_selector    = _map_selector(selector, "_with_#{suffix}")
+          # $stderr.puts "  #{target.inspect}.alias #{without_selector.inspect} #{selector.inspect}"
+          unless target.method_defined?(with_selector)
+            target.send(:alias_method, with_selector, selector)
+          end
+        end
+        # $stderr.puts "  AFTER:  #{(target.instance_methods.sort - Object.methods).inspect}"
+
+        self
+      end
+
+      def chain_methods! target
+        # $stderr.puts "ChainMethod::ModuleMethods #{self.inspect}.chain_methods! #{target.inspect}"
+        prepare_methods!
+        suffix = _chain_methods_suffix
+
+        # $stderr.puts "  BEFORE: #{(target.instance_methods.sort - Object.methods).inspect}"
+        chain_methods.each do | selector |
+          without_selector = _map_selector(selector, "_without_#{suffix}")
+          with_selector    = _map_selector(selector, "_with_#{suffix}")
+          # $stderr.puts "  #{target.inspect}.alias #{without_selector.inspect} #{selector.inspect}"
+          unless target.method_defined?(without_selector)
+            target.send(:alias_method, without_selector, selector)
+          end
+          target.send(:alias_method, selector, with_selector)
+        end
+        # $stderr.puts "  AFTER:  #{(target.instance_methods.sort - Object.methods).inspect}"
+      end
+      
+      def _map_selector selector, suffix
+        selector.to_s.
+          sub(/\A([a-z0-9_]+)([^a-z0-9_]?)\Z/i) { | m | $1 + suffix + $2 }.
+          to_sym
+      end
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'module/chain_method'
+
+class Test::Unit::TestCase
+end

data/test/test_module_chain_method.rb

@@ -0,0 +1,72 @@
+require 'helper'
+
+require 'module/chain_method'
+
+class TestModuleChainMethod < Test::Unit::TestCase
+  should "handle Foo#foo and Foo#bar as expected" do
+    f = Module::ChainMethod::Test::Foo.new
+    f.foo
+    f.bar
+    assert_equal(f.instance_variable_get("@calls"), [ "Foo#foo", "Foo#bar" ])
+  end
+
+  should "handle Foo#foo and Foo#bar with aliases for *_without_MyMixin" do
+    Module::ChainMethod::Test::Foo.class_eval do
+      include Module::ChainMethod::Test::MyMixin
+    end
+    assert_equal( 
+                 [ "MyMixin.included Module::ChainMethod::Test::Foo" ],
+                 Module::ChainMethod::Test::MyMixin.instance_variable_get("@calls")
+                 )
+
+    f = Module::ChainMethod::Test::Foo.new
+    f.foo
+    f.bar
+    assert_equal(
+                 [ "MyMixin#foo", "Foo#foo", "Foo#bar" ],
+                 f.instance_variable_get("@calls")
+                 )
+                 
+  end
+end
+
+
+######################################################################
+
+
+class Module
+  module ChainMethod
+    module Test
+      module MyMixin
+        def self.included target
+          super
+          (@calls ||= [ ]) << "MyMixin.included #{target.inspect}"
+        end
+        include ::Module::ChainMethod
+        
+        def foo
+          (@calls ||= [ ]) << "MyMixin#foo"
+          foo_without_MyMixin
+        end
+        
+        def bar
+          (@calls ||= [ ]) << "MyMixin#bar"
+        end
+        
+        chain_method :foo
+      end
+      
+      class Foo
+        def foo
+          (@calls ||= [ ]) << "Foo#foo"
+        end
+        
+        def bar
+          (@calls ||= [ ]) << "Foo#bar"
+        end
+      end
+      
+    end
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: module_chain_method
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kurt Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Module::ChainMethod mixin to simplify method chain aliasing.
+email: ks.github@kurtstephens.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- example/ex01.rb
+- lib/module/chain_method.rb
+- test/helper.rb
+- test/test_module_chain_method.rb
+has_rdoc: true
+homepage: http://github.com/kstephens/module_chain_method
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Module::ChainMethod mixin to simplify method chain aliasing.
+test_files: 
+- test/helper.rb
+- test/test_module_chain_method.rb