block-chainable 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.0.1 / 2008-03-07
+
+* 1 minor enhancement
+  * Classes instantiated through blocks (using start) return the instance of the class for chaining
+
 === 0.0.1 / 2008-02-24
 
 * 2 major enhancements

data/README.txt

@@ -23,16 +23,65 @@ you to assert values within the blocks as well as calling any other methods from
   * Stack trace should be simplified on errors within BlockChainable blocks
 
 == SYNOPSIS:
+  # a simple nonsense example showing the ability to call methods in outer block scopes
+ 
+  # create some simple classes that include BlockChainable
+  require 'block_chainable'
 
+  class Foo
+    include BlockChainable
+  
+    def hi_from_foo
+      puts "hello from foo"
+    end
+  end
+  
+  class Bar
+    include BlockChainable
+  
+    def hi_from_bar
+      puts "hello from bar"
+    end
+  end
+  
+  class Boo
+    include BlockChainable
+  
+    def hi_from_boo
+      puts "hello from boo"
+    end
+  end
+  
+
+  # we can now use the classes in a DSL manner. notice that calls can happen from with blocks to
+  # "outer-block" methods.
+  Foo do
+    hi_from_foo
+  
+    Bar do
+      hi_from_bar
+      hi_from_foo
+  
+      Boo do
+        hi_from_boo
+        hi_from_bar
+        hi_from_foo
+      end
+    end
+  end
+
+  # A slighty more complicated example.
   # a simple dsl for creating classroom rosters and printing them out. code can be found in the
   # example directory.
+
+  require 'block_chainable'
   
   # first, define our roster
   class Roster
     include BlockChainable
     
     def initialize(subject)
-	  @subject = subject
+      @subject = subject
       @students = []
     end
     
@@ -41,20 +90,20 @@ you to assert values within the blocks as well as calling any other methods from
     end
     
     def print_roster
-	  puts "Roster for #{@subject}:"
+      puts "Roster for #{@subject}:"
       @students.each{|s| puts "  #{s}"}
     end
   end
 
   # next, define our student. the only tricky part here is add_to_roster, which calls
-  # the method add_student_to_class, which is actually defined on the Classroom class.
-  # BlockChainable will automatically send this method to the Classroom class with the
+  # the method add_student_to_roster, which is actually defined on the Roster class.
+  # BlockChainable will automatically send this method to the Roster class with the
   # Student instance as a parameter.
   class Student
     include BlockChainable
   
     def add_to_roster
-      add_student_to_class self
+      add_student_to_roster self
     end
   
     def to_s
@@ -76,7 +125,6 @@ you to assert values within the blocks as well as calling any other methods from
 
   # we now have all the pieces we need for creating a simple dsl for building
   # and printing a class roster
-  require 'block_chainable'
 
   Roster :Math do
     Student do

data/Rakefile

@@ -6,7 +6,7 @@ require 'need'
 require 'spec/rake/spectask'
 need{'./lib/block_chainable.rb'}
 
-Hoe.new('block-chainable', '0.0.1') do |p|
+Hoe.new('block-chainable', '0.0.2') do |p|
   p.rubyforge_name = 'block-chainable'
   p.author = 'Drew Olson'
   p.email = 'olsonas@gmail.com'
@@ -16,6 +16,7 @@ Hoe.new('block-chainable', '0.0.1') do |p|
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.extra_deps << ['need', '>= 1.0.1']
   p.extra_deps << ['rspec', '>= 1.1.3']
+  p.remote_rdoc_dir = ''
 end
 
 Spec::Rake::SpecTask.new do |t|

data/lib/block_chainable.rb

@@ -18,6 +18,8 @@ module BlockChainable
       end
       
       klass_instance.instance_eval(&block)
+      
+      klass_instance
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: block-chainable
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Drew Olson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-29 00:00:00 -06:00
+date: 2008-03-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency