chainable 0.1.0 → 0.1.1

data/README.rdoc

@@ -3,13 +3,13 @@
 This is heavy ruby abuse. It even got the Evil of the Day Award™ from zenspider.
 
 == Thou shalt not use alias_method_chain!
-- http://yehudakatz.com/2009/03/06/alias_method_chain-in-models/
-- http://yehudakatz.com/2009/01/18/other-ways-to-wrap-a-method/
+- http://yehudakatz.com/2009/03/06/alias_method_chain-in-models
+- http://yehudakatz.com/2009/01/18/other-ways-to-wrap-a-method
 - http://www.codefluency.com/articles/2009/01/03/wrapping-a-method-in-ruby
 
 == What it does
 Chainable is an alternative to alias_method_chain, that uses inheritance, rather
-than aliasing. Instead it does the following when "chaining" a method:
+than aliasing. It does the following when "chaining" a method:
 
 - copy the original method to a new model
 - include the model
@@ -17,8 +17,8 @@ than aliasing. Instead it does the following when "chaining" a method:
 
 Thus you can use super and keep your method list clean, too!
 It even supports a (rather dangerous) auto chaining mode, so you do not have
-to explicitly chain a method, but chain a method when ever it would be
-overwritten.
+to explicitly chain a method, but chain a method whenever it would be
+overwritten instead.
 
 
 Example:
@@ -64,4 +64,11 @@ Of course you can do this with any class (or module):
       return super if block_given? or RUBY_VERSION >= "1.8.7"
       MyStuff::Enumerator.new self, :each
     end
-  end
+  end
+
+== Installation
+Add github gems, if you haven't already:
+  gem sources -a http://gems.github.com
+
+Install gem:
+  gem install rkh-chainable

data/lib/chainable.rb

@@ -9,6 +9,11 @@ module Chainable
     @auto_chain = false
   end
 
+  # This will "chain" a method (read: push it to a module and include it).
+  # If a block is given, it will do a define_method(name, &block).
+  # Maybe that is not what you want, as methods defined by def tend to be
+  # faster. If that is the case, simply don't pass the block and call def
+  # after chain_method instead.
   def chain_method(name, &block)
     name = name.to_s
     if instance_methods(false).include? name
@@ -24,7 +29,11 @@ module Chainable
     define_method(name, &block)
   end
 
-  def auto_chain &block
+  # If you define a method inside a block passed to auto_chain, chain_method
+  # will be called on that method right after it has been defined. This will
+  # only affect methods defined for the class (or module) auto_chain has been
+  # send to. See README.rdoc or spec/chainable/auto_chain_spec.rb for examples.
+  def auto_chain
     class << self
       chain_method :method_added do |name|
         Chainable.skip_chain { chain_method name }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chainable
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Konstantin Haase