block-chainable 0.0.1

data/History.txt

@@ -0,0 +1,7 @@
+=== 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,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/block_chainable.rb
+test/test_block_chainable.rb
+spec/block_chainable_spec.rb

data/README.txt

@@ -0,0 +1,141 @@
+= BlockChainable
+
+* http://block-chainable.rubyforge.org
+
+== 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:
+
+* 2 major features
+  * Block instantiation of classes
+  * Method calls will look "up-scope" for receives when called inside BlockChainable blocks
+* 1 minor problem
+  * Stack trace should be simplified on errors within BlockChainable blocks
+
+== SYNOPSIS:
+
+  # a simple dsl for creating classroom rosters and printing them out. code can be found in the
+  # example directory.
+  
+  # first, define our roster
+  class Roster
+    include BlockChainable
+    
+    def initialize(subject)
+	  @subject = subject
+      @students = []
+    end
+    
+    def add_student_to_roster student
+      @students << student
+    end
+    
+    def print_roster
+	  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
+  # Student instance as a parameter.
+  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
+
+  # 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
+      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
+
+== REQUIREMENTS:
+
+* need
+* rspec
+
+== INSTALL:
+
+* sudo gem install block-chainable
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Drew Olson
+
+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,25 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'need'
+require 'spec/rake/spectask'
+need{'./lib/block_chainable.rb'}
+
+Hoe.new('block-chainable', '0.0.1') do |p|
+  p.rubyforge_name = 'block-chainable'
+  p.author = 'Drew Olson'
+  p.email = 'olsonas@gmail.com'
+  # p.summary = 'FIX'
+  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']
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end
+
+# vim: syntax=Ruby

data/lib/block_chainable.rb

@@ -0,0 +1,40 @@
+module BlockChainable
+  module ClassMethods
+    def start(*args,&block)
+      klass_instance = self.new(*args)
+      
+      klass_instance.instance_eval do
+        @__parent = eval("self",block.binding)
+      end
+      
+      class << klass_instance
+        def method_missing(name,*args)
+          if chain_respond_to?(name)
+            @__parent.send(name,*args)
+          else
+            super(name,*args)
+          end
+        end
+      end
+      
+      klass_instance.instance_eval(&block)
+    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/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/test/test_block_chainable.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'need'
+need{"foo"}
+need{"bar"}
+
+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
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: block-chainable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Drew Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-29 00:00:00 -06: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.5.0
+    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: olsonas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/block_chainable.rb
+- test/test_block_chainable.rb
+- spec/block_chainable_spec.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.0.1
+signing_key: 
+specification_version: 2
+summary: BlockChainable is a module to aid in the creation of Domain Specific Languages using block structure
+test_files: 
+- test/test_block_chainable.rb