drewolson-block-chainable 0.1.1

data/History.txt

@@ -0,0 +1,27 @@
+=== 0.1.1 / 2008-05-23
+
+* 1 minor enhancement
+  * Classes instantiated through blocks (using start) return the result of executing the block
+
+=== 0.1.0 / 2008-04-08
+
+* 1 major enhancement
+  * Methods with implicit blocks with be propagated correctly to parent scopes
+
+=== 0.0.3 / 2008-03-27
+
+* 1 minor enhancement
+  * Classes inheriting from a parent class that mixes in BlockChainable will gain all functionality
+
+=== 0.0.2 / 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
+  * Block instantiation of classes
+  * Method calls within block instantiated classes can jump "up-scope" to parent classes
+* 1 minor bug
+  * Stack trace on errors should be simplified

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+example/roster.rb
+example/roster_dsl.rb
+example/student.rb
+lib/block_chainable.rb
+spec/bar.rb
+spec/block_chainable_spec.rb
+spec/foo.rb
+test/bar.rb
+test/baz.rb
+test/foo.rb
+test/test_block_chainable.rb

data/Rakefile

@@ -0,0 +1,26 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'need'
+require 'spec/rake/spectask'
+need{'./lib/block_chainable.rb'}
+
+Hoe.new('block-chainable', '0.1.1') do |p|
+  p.rubyforge_name = 'block-chainable'
+  p.author = 'Drew Olson'
+  p.email = 'drew@drewolson.org'
+  p.summary = 'tool for building DSLs with blocks'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = "http://block-chainable.rubyforge.org"
+  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|
+  t.warning = true
+end
+
+# vim: syntax=Ruby

data/example/roster.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'need'
+need{"../lib/block_chainable"}
+
+class Roster
+  include BlockChainable
+  
+  def initialize(subject)
+    @subject = subject
+    @students = []
+  end
+  
+  def add_student_to_class student
+    @students << student
+  end
+  
+  def print_roster
+    puts "Roster for #{@subject}:"
+    @students.each{|s| puts "  #{s}"}
+  end
+end

data/example/roster_dsl.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'need'
+need{"roster"}
+need{"student"}
+
+Roster :Math do
+  Student do
+    first_name "Drew"
+    last_name "Olson"
+    age 25
+    
+    add_to_roster
+  end
+  
+  Student do
+    first_name "John"
+    last_name "Doe"
+    age 17
+    
+    add_to_roster
+  end    
+
+  Student do
+    first_name "Jane"
+    last_name "Doe"
+    age 19
+    
+    add_to_roster
+  end
+  
+  print_roster
+end

data/example/student.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'need'
+need{"../lib/block_chainable"}
+
+class Student
+  include BlockChainable
+  
+  def add_to_roster
+    add_student_to_class self
+  end
+  
+  def to_s
+    "#{@last_name}, #{@first_name} - age #{@age}"
+  end
+  
+  def first_name name
+    @first_name = name
+  end
+  
+  def last_name name
+    @last_name = name
+  end
+  
+  def age years
+    @age = years
+  end
+end

data/lib/block_chainable.rb

@@ -0,0 +1,42 @@
+module BlockChainable
+  module ClassMethods
+    def start(*args,&block)
+      klass_instance = self.new(*args)
+      
+      klass_instance.instance_variable_set("@__parent",eval("self",block))
+      
+      class << klass_instance
+        def method_missing(name,*args,&block)
+          if chain_respond_to?(name)
+            @__parent.send(name,*args,&block)
+          else
+            super
+          end
+        end
+      end
+      
+      klass_instance.instance_eval(&block)
+    end
+    
+    def inherited(klass)
+      klass.class_eval{include BlockChainable}
+    end
+  end
+  
+  def self.included(klass)
+    klass.extend(ClassMethods)
+    
+    Object.class_eval <<-EOS
+      def #{klass}(*args,&block)
+        #{klass}.start(*args,&block)
+      end
+    EOS
+  end
+  
+  def chain_respond_to?(name)
+    self.respond_to?(name) || 
+    (@__parent && 
+    (@__parent.respond_to?(name) || 
+    (@__parent.respond_to?(:chain_respond_to?) && @__parent.chain_respond_to?(name))))
+  end
+end

data/spec/bar.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'need'
+need{"../lib/block_chainable"}
+
+class Bar
+  include BlockChainable
+  
+  def is_bar?
+    true
+  end
+end

data/spec/block_chainable_spec.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'need'
+need{"foo"}
+need{"bar"}
+
+describe "test block chainable" do
+  it "should work on standard method calls" do
+    Foo do
+      is_foo?.should == true
+    end
+  end
+  
+  it "should work for standard method calls on nested blocks" do
+    Foo do
+      Bar do
+        is_bar?.should == true
+      end
+    end
+  end
+  
+  it "it should allow calls to outer block methods from inner blocks" do
+    Foo do
+      Bar do
+        is_foo?.should == true
+      end
+    end
+  end
+  
+  it "should not allow method calls to inner blocks from outer blocks" do
+    lambda do
+      Foo do
+        is_bar?
+        Bar do 
+        end
+      end
+    end.should raise_error(NoMethodError)
+  end
+end

data/spec/foo.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'need'
+need{"../lib/block_chainable"}
+
+class Foo
+  include BlockChainable
+  
+  def is_foo?
+    true
+  end
+end

data/test/bar.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'need'
+need{"../lib/block_chainable"}
+
+class Bar
+  include BlockChainable
+  
+  def is_bar?
+    true
+  end
+end

data/test/baz.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'need'
+need{'foo'}
+
+class Baz < Foo
+  def is_baz?
+    true
+  end
+end

data/test/foo.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'need'
+need{"../lib/block_chainable"}
+
+class Foo
+  include BlockChainable
+  
+  def is_foo?
+    true
+  end
+  
+  def call_block &block
+    block.call
+  end
+end

data/test/test_block_chainable.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'need'
+need{"foo"}
+need{"bar"}
+need{"baz"}
+
+require "test/unit"
+
+class TestBlockChainable < Test::Unit::TestCase
+  def test_standard_method_call
+    Foo do
+      assert is_foo?
+    end
+  end
+  
+  def test_standard_method_call_inner_block
+    Foo do
+      Bar do
+        assert is_bar?
+      end
+    end
+  end
+  
+  def test_outer_block_method_call_from_inner_block
+    Foo do
+      Bar do
+        assert is_foo?
+      end
+    end
+  end
+  
+  def test_inner_block_method_call_from_outer_block_fails
+    assert_raises NoMethodError do
+      Foo do
+        is_bar?
+        Bar do 
+        end
+      end
+    end
+  end
+  
+  def test_block_chainable_works_with_inheritance
+    Baz do
+      assert is_baz?
+    end
+  end
+  
+  def test_method_with_block_in_parent_scope
+    Foo do
+      Bar do
+        assert(call_block{true})
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: drewolson-block-chainable
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Drew Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: need
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: "== DESCRIPTION:  BlockChainable is a module to aid in the creation of Domain Specific Languages using block structure. By including BlockChainable into your classes, you will be able to instantiate that class using the class name itself, followed by any parameters to be passed to initialize, followed by a block to be executed within the instantiated class.  BlockChainable also allows methods to search up the chain of classes, meaning that although a block is executed in the scope of the instantiated class, any methods not found in the class but found in a class \"up-scope\" will be called successfully on the up-scope class. This chaining of method calls allows you to assert values within the blocks as well as calling any other methods from \"up-scope\" classes.  == FEATURES/PROBLEMS:"
+email: drew@drewolson.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- example/roster.rb
+- example/roster_dsl.rb
+- example/student.rb
+- lib/block_chainable.rb
+- spec/bar.rb
+- spec/block_chainable_spec.rb
+- spec/foo.rb
+- test/bar.rb
+- test/baz.rb
+- test/foo.rb
+- test/test_block_chainable.rb
+has_rdoc: true
+homepage: http://block-chainable.rubyforge.org
+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: block-chainable
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: tool for building DSLs with blocks
+test_files: 
+- test/test_block_chainable.rb