contextr 0.0.1

data/spec/contextr/contextr_api_spec.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class ContextRApiFoo
+  def non_contextified_method
+    "non_contextified_method"
+  end
+  def foo
+    "foo"
+  end
+end
+
+context 'Each class' do
+  specify 'should provide a method to enable a single layer' do
+    lambda do
+      class ContextRApiFoo 
+        layer :bar
+      end
+    end.should_not raise_error
+  end
+
+  specify 'should provide a method to access these layers by name' do
+    begin
+      class ContextRApiFoo
+        bar
+      end
+    end.layer.should == ContextR::BarLayer
+  end
+end
+
+context 'Each layer in a class' do
+  specify 'should allow the definition of pre method wrappers ' +
+          'with `pre`' do
+    lambda do
+      class ContextRApiFoo
+        bar.pre :foo do
+          @pre_visited = true
+          @pre_count = ( @pre_count || 0 ) + 1
+        end
+      end
+    end.should_not raise_error
+  end
+  specify 'should allow the definition of post method wrappers ' +
+          'with `post`' do
+    lambda do
+      class ContextRApiFoo
+        bar.post :foo do
+          @post_visited = true
+          @post_count = ( @post_count || 0 ) + 1
+        end
+      end
+    end.should_not raise_error
+  end
+  specify 'should allow the definition of around method wrappers ' +
+          'with `around`' do
+    lambda do
+      class ContextRApiFoo
+        bar.around :foo do | method_nature |
+          @around_visited = true
+          @around_count = ( @around_count || 0 ) + 1
+          method_nature.call_next
+        end
+      end
+    end.should_not raise_error
+  end
+  specify 'should allow the definition of around method wrappers ' +
+          'with `wrap`' do
+    lambda do
+      class ContextRApiFoo
+        bar.wrap :foo do | method_nature |
+          @around_visited = true
+          @around_count = ( @around_count || 0 ) + 1
+          method_nature.call_next
+        end
+      end
+    end.should_not raise_error
+  end
+end
+
+context "An instance of a contextified class" do
+  setup do
+    @instance = ContextRApiFoo.new
+  end
+
+  specify "should run a simple method " + 
+          "*normally* when all layers are deactivated" do
+    @instance.non_contextified_method.should == "non_contextified_method"
+  end
+
+  specify "should run a simple method " +
+          "*normally* when any layer is activated" do
+    ContextR.with_layers( :bar ) do
+      @instance.non_contextified_method.should == "non_contextified_method"
+    end
+  end
+
+  specify "should run a contextified method " +
+          "*normally* when all layers are deactivated" do
+    @instance.foo.should == "foo"
+  end
+
+  specify "should run a contextified method " +
+          "*normally* when any layer is activated" do
+    ContextR.with_layers( :baz ) do
+      @instance.foo.should == "foo"
+    end
+  end
+
+  specify "should run a contextified method with " +
+          "additional behaviour when a specific layer is activated" do
+    ContextR.with_layers( :bar ) do
+      @instance.foo.should == "foo"
+    end
+    @instance.instance_variable_get( :@pre_visited ).should == true
+    @instance.instance_variable_get( :@post_visited ).should == true
+    @instance.instance_variable_get( :@around_visited ).should == true
+  end
+end

data/spec/core_ext/module_spec.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+context 'Each first level module' do
+  specify 'should have the same name and namespace_free_name' do
+    Math.namespace_free_name.should == Math.name
+    Kernel.namespace_free_name.should == Kernel.name
+  end
+
+  specify 'should have a namespace_free_name matching their constant' do
+    Kernel.namespace_free_name.should == Kernel.to_s
+    Kernel.namespace_free_name.should == "Kernel"
+  end
+end
+
+context 'Each sublevel module' do
+  setup do
+    module ModuleTestA
+      module B
+        module C
+        end
+      end
+    end
+  end
+
+  specify 'should have a namespace free namespace_free_name' do
+    ModuleTestA::B.namespace_free_name.should == "B"
+    ModuleTestA::B::C.namespace_free_name.should == "C"
+  end
+end
+
+context "Each module" do
+  specify "should have a attr_accessor_with_default_setter" do
+    lambda do
+      class ClassSpecA
+        attr_accessor_with_default_setter :miau do
+          {}
+        end
+      end
+    end.should_not raise_error
+  end
+end
+
+context "Each instance" do
+  setup do
+    @instance = ClassSpecA.new
+    @instance2 = ClassSpecA.new
+  end
+  specify "should provide a getter method" do
+    @instance.should_respond_to :miau
+  end
+  specify "should provide a setter method" do
+    @instance.should_respond_to :miau=
+  end
+
+end
+
+context "A getter method" do
+  setup do
+    @getter = ClassSpecA.instance_method( :miau )
+    @instance = ClassSpecA.new
+    @instance2 = ClassSpecA.new
+  end
+
+  specify "should not expect a parameter" do
+    @getter.arity.should == 0
+  end
+
+  specify "should provide the default value" do
+    @instance.miau.should == Hash.new 
+  end
+
+  specify "should provide the default value also multiple times" do
+    @instance.miau.object_id.should == @instance.miau.object_id
+  end
+
+  specify "should provide the different default values for different " +
+          "instances" do
+    @instance2.miau.object_id.should_not == @instance.miau.object_id
+  end
+end
+
+context "A setter method" do
+  setup do
+    @setter = ClassSpecA.instance_method( :miau= )
+    @instance = ClassSpecA.new
+    @instance2 = ClassSpecA.new
+  end
+
+  specify "should not expect a parameter" do
+    @setter.arity.should == 1
+  end
+
+  specify "should allow the setting of the corresonding instance variable" do
+    begin
+      @instance.miau = "blue"
+    end.should == "blue"
+    @instance.instance_variable_get( :@miau ).should == "blue"
+  end
+end

data/spec/core_ext/proc_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class ProcSpecFoo
+  def non_contextified_method
+    "non_contextified_method"
+  end
+  def foo
+    "foo"
+  end
+end
+
+context "A Proc" do
+  setup do
+    @a = lambda do @a = true; "a" end
+    @b = lambda do @b = true; "b" end
+    @foo = ProcSpecFoo.new
+  end
+
+  specify "should convert itself to an unbound method" do 
+    @b.to_unbound_method( ProcSpecFoo ).should_be_kind_of UnboundMethod
+  end
+
+  specify "which should be bindable to an instance of the specified class" do 
+    lambda do
+      @b.to_unbound_method( ProcSpecFoo ).bind( @foo )
+    end.should_not raise_error
+  end
+
+  specify "which should execute the proc in turn" do
+    @b.to_unbound_method( ProcSpecFoo ).bind( @foo ).call.should == "b"
+    @foo.instance_variable_get( :@b ).should == true
+  end
+
+  specify "should respond to `+`" do
+    @b.should_respond_to :+
+  end
+
+  specify "should build a joined block with `self.+( other_proc)`" do
+    (@a + @b).should_be_kind_of Proc
+  end
+end
+
+context "The result of `+` of two Procs" do
+  setup do
+    @a = lambda do | arg | 
+      arg || "a" 
+    end
+    @b = lambda do | arg | 
+      arg || "b" 
+    end
+  end
+
+  specify "should give the correct return value" do
+    (@a + @b).call( nil ).should == "b"
+    (@b + @a).call( nil ).should == "a"
+  end
+
+  specify "should pass through given parameters" do
+    (@a + @b).call( 1 ).should == 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/contextr'

data/tasks/annotations.rb

@@ -0,0 +1,107 @@
+# The following copyright applies to this File 
+# which we borrowed from rails.
+#
+# Copyright (c) 2004 David Heinemeier Hansson
+# 
+# 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.
+class SourceAnnotationExtractor
+  class Annotation < Struct.new(:line, :tag, :text)
+    def to_s(options={})
+      s = "[%3d] " % line
+      s << "[#{tag}] " if options[:tag]
+      s << text
+    end
+  end
+
+  def self.enumerate(tag, options={})
+    extractor = new(tag)
+    extractor.display(extractor.find, options)
+  end
+
+  attr_reader :tag
+
+  def initialize(tag)
+    @tag = tag
+  end
+
+  def find(dirs=%w(app lib test))
+    dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
+  end
+
+  def find_in(dir)
+    results = {}
+
+    Dir.glob("#{dir}/*") do |item|
+      next if File.basename(item)[0] == ?.
+
+      if File.directory?(item)
+        results.update(find_in(item))
+      elsif item =~ /\.r(?:b|xml|js)$/
+        results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
+      elsif item =~ /\.rhtml$/
+        results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/))
+      end
+    end
+
+    results
+  end
+
+  def extract_annotations_from(file, pattern)
+    lineno = 0
+    result = File.readlines(file).inject([]) do |list, line|
+      lineno += 1
+      next list unless line =~ pattern
+      list << Annotation.new(lineno, $1, $2)
+    end
+    result.empty? ? {} : { file => result }
+  end
+
+  def display(results, options={})
+    results.keys.sort.each do |file|
+      puts "#{file}:"
+      results[file].each do |note|
+        puts "  * #{note.to_s(options)}"
+      end
+      puts
+    end
+  end
+end
+
+desc "Enumerate all annotations"
+task :notes do
+  SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true
+end
+
+namespace :notes do
+  desc "Enumerate all OPTIMIZE annotations"
+  task :optimize do
+    SourceAnnotationExtractor.enumerate "OPTIMIZE"
+  end
+
+  desc "Enumerate all FIXME annotations"
+  task :fixme do
+    SourceAnnotationExtractor.enumerate "FIXME"
+  end
+
+  desc "Enumerate all TODO annotations"
+  task :todo do
+    SourceAnnotationExtractor.enumerate "TODO"
+  end
+end

data/test/contextr/test_contextr.rb

@@ -0,0 +1,165 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UnitContextRFoo
+  layer :pre, :post, :wrap
+  layer :stop_wrap, :stop_pre, :stop_post
+  layer :order_wrap, :order_pre, :order_post
+  layer :group_pre, :group_post
+  
+  def bar( sum )
+    sum + 0b00100
+  end
+
+  pre.pre :bar do | nature |
+    nature.arguments[ 0 ] += 0b00010
+  end
+
+  post.post :bar do | nature |
+    nature.return_value += 0b01000
+  end
+
+  wrap.wrap :bar do | nature |
+    nature.arguments[ 0 ] += 0b00001
+    nature.call_next
+    nature.return_value += 0b10000
+  end
+  
+  stop_pre.pre :bar do | nature |
+    nature.break! nature.arguments[0]
+  end
+  stop_wrap.wrap :bar do | nature |
+    nature.break! nature.arguments[0]
+  end
+  stop_post.post :bar do | nature |
+    nature.break! nature.return_value
+  end
+  
+  order_pre.pre :bar do | nature |
+    nature.break! :pre
+  end
+  
+  order_post.post :bar do | nature |
+    nature.break! :post
+  end
+  
+  order_wrap.wrap :bar do | nature |
+    nature.break! :wrap
+  end
+  
+  group_pre.pre :bar do | nature |
+    nature.return_value = :pre
+  end
+  
+  group_pre.pre :bar do | nature |
+    nature.break! nature.return_value
+  end
+
+  group_post.post :bar do | nature |
+    nature.return_value = :post
+  end
+  
+  group_post.post :bar do | nature |
+    nature.break! nature.return_value
+  end
+end
+
+
+class ContextRTest < Test::Unit::TestCase
+  def setup
+    @foo = UnitContextRFoo.new
+  end
+  
+  def test_01_layer_activiation
+    assert_equal 0b00100, @foo.bar( 0 )
+    
+    ContextR.with_layers :wrap do
+      assert_equal 0b10101, @foo.bar( 0 )
+      
+      ContextR.without_layers :wrap do
+        assert_equal 0b00100, @foo.bar( 0 )
+      end
+      
+      assert_equal 0b10101, @foo.bar( 0 )
+    end
+    
+    assert_equal 0b00100, @foo.bar( 0 )
+  end
+  
+  def test_02_cascading_layers
+    assert_equal 0b00100, @foo.bar( 0 )
+    
+    ContextR.with_layers :pre do
+      assert_equal 0b00110, @foo.bar( 0 )
+      
+      ContextR.with_layers :post do
+        assert_equal 0b01110, @foo.bar( 0 )
+        
+        ContextR.with_layers :wrap do
+          assert_equal 0b11111, @foo.bar( 0 )
+        end
+        
+        assert_equal 0b01110, @foo.bar( 0 )
+      end
+      
+      assert_equal 0b00110, @foo.bar( 0 )
+    end
+    
+    assert_equal 0b00100, @foo.bar( 0 )
+  end
+  
+  def test_03_breaking_behaviour
+    ContextR.with_layers :pre, :post, :stop_wrap do
+      assert_equal 0b00010, @foo.bar( 0 )
+    end
+  end
+  
+  def test_04_ordering_by_selectors
+    # pre before post
+    ContextR.with_layers :order_pre, :order_post do
+      assert_equal :pre, @foo.bar( 0 )
+    end
+    # pre before wrap
+    ContextR.with_layers :order_wrap, :order_pre do
+      assert_equal :pre, @foo.bar( 0 )
+    end
+    # wrap before body
+    ContextR.with_layers :order_wrap do
+      assert_equal :wrap, @foo.bar( 0 )
+    end
+    # wrap before post
+    ContextR.with_layers :order_wrap, :order_post do
+      assert_equal :wrap, @foo.bar( 0 )
+    end
+    # To be completed...
+  end
+  
+  def test_05_ordering_by_layers
+    ContextR.with_layers :wrap, :stop_wrap do
+      assert_equal 0b00000, @foo.bar( 0 )
+    end
+    ContextR.with_layers :stop_wrap, :wrap do
+      assert_equal 0b00001, @foo.bar( 0 )
+    end
+    ContextR.with_layers :pre, :stop_pre do
+      assert_equal 0b00000, @foo.bar( 0 )
+    end
+    ContextR.with_layers :stop_pre, :pre do
+      assert_equal 0b00010, @foo.bar( 0 )
+    end
+    ContextR.with_layers :post, :stop_post do
+      assert_equal 0b01100, @foo.bar( 0 )
+    end
+    ContextR.with_layers :stop_post, :post do
+      assert_equal 0b00100, @foo.bar( 0 )
+    end
+  end
+  
+  def test_06_ordering_within_groups
+    ContextR.with_layers :group_pre do
+      assert_equal nil, @foo.bar( 0 )
+    end
+    ContextR.with_layers :group_post do
+      assert_equal :post, @foo.bar( 0 )
+    end
+  end
+end