bracket_notation 1.0.5 → 1.1.0

data/test/functional/evaluator_test.rb

@@ -23,7 +23,7 @@
 # and small portions of his code have been incorporated in the parser.
 #
 # Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
-# Copyright:: Copyright (c) 2010 Cody Brimhall
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test_helper'

data/test/functional/node_test.rb

@@ -0,0 +1,132 @@
+#--
+# This file is part of BracketNotation.
+# 
+# BracketNotation is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# BracketNotation is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with BracketNotation.  If not, see <http://www.gnu.org/licenses/>.
+#++
+# BracketNotation is a parser for generating syntax trees from sentences
+# annotated with the kind of bracket notation that is commonly used by
+# linguists. The result is a tree structure with nodes that describe the phrases
+# and constituents of the sentence.
+#
+# BracketNotation was inspired by Yoichiro Hasebe's RSyntaxTree[http://yohasebe.com/rsyntaxtree/],
+# and small portions of his code have been incorporated in the parser.
+#
+# Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test_helper'
+
+class NodeTest < Test::Unit::TestCase
+  context "any node" do
+    setup do
+      @tree = BracketNotation::View::Tree.new("[A [B [E] [F]] [C] [D]]")
+      @root = BracketNotation::View::Node.new(@tree, "A")
+      @child1 = BracketNotation::View::Node.new(@tree, "B")
+      @child2 = BracketNotation::View::Node.new(@tree, "C")
+      @child3 = BracketNotation::View::Node.new(@tree, "D")
+      @child4 = BracketNotation::View::Node.new(@tree, "E")
+      @child5 = BracketNotation::View::Node.new(@tree, "F")
+      
+      @child1.children += [@child4, @child5]
+      @child4.parent = @child1
+      @child5.parent = @child1
+      
+      @root.children += [@child1, @child2, @child3]
+      @child1.parent = @root
+      @child2.parent = @root
+      @child3.parent = @root
+      
+      @tree.root = @root
+      
+      @root.rect = BracketNotation::Geometry::Rect.new(BracketNotation::Geometry::Point.new(0,0), BracketNotation::Geometry::Size.new(42,42))
+    end
+    
+    should "know its parent" do
+      assert_same @child1.parent, @root
+    end
+    
+    should "know its children" do
+      assert_equal @root.children, [@child1, @child2, @child3]
+      assert_equal @child1.children, [@child4, @child5]
+      assert_equal @child4.children, []
+    end
+    
+    should "know its ancestors" do
+      assert_equal @root.ancestors, []
+      assert_equal @child1.ancestors, [@root]
+      assert_equal @child4.ancestors, [@child1, @root]
+    end
+    
+    should "know its left sibling" do
+      assert_same @child2.left_sibling, @child1
+      assert_nil @child1.left_sibling
+    end
+    
+    should "know its right sibling" do
+      assert_same @child2.right_sibling, @child3
+      assert_nil @child3.right_sibling
+    end
+    
+    should "know its tree" do
+      assert_same @root.tree, @tree
+      assert_same @child1.tree, @tree
+      assert_same @child4.tree, @tree
+    end
+    
+    should "know its corners" do
+      assert_equal @root.corner_top_left, BracketNotation::Geometry::Point.new(0,0)
+      assert_equal @root.corner_top_right, BracketNotation::Geometry::Point.new(42,0)
+      assert_equal @root.corner_bottom_right, BracketNotation::Geometry::Point.new(42,42)
+      assert_equal @root.corner_bottom_left, BracketNotation::Geometry::Point.new(0,42)
+    end
+    
+    should "know its side midpoints" do
+      assert_equal @root.side_middle_top, BracketNotation::Geometry::Point.new(21,0)
+      assert_equal @root.side_middle_right, BracketNotation::Geometry::Point.new(42, 21)
+      assert_equal @root.side_middle_bottom, BracketNotation::Geometry::Point.new(21,42)
+      assert_equal @root.side_middle_left, BracketNotation::Geometry::Point.new(0, 21)
+    end
+  end
+  
+  context "a branch node" do
+    setup do
+      @tree = BracketNotation::View::Tree.new("[A [B [E] [F]] [C] [D]]")
+      @root = BracketNotation::View::Branch.new(@tree, "A")
+      @child1 = BracketNotation::View::Branch.new(@tree, "B")
+      @child2 = BracketNotation::View::Leaf.new(@tree, "C")
+      @child3 = BracketNotation::View::Leaf.new(@tree, "D")
+      @child4 = BracketNotation::View::Leaf.new(@tree, "E")
+      @child5 = BracketNotation::View::Leaf.new(@tree, "F")
+      
+      @child1.children += [@child4, @child5]
+      @child4.parent = @child1
+      @child5.parent = @child1
+      
+      @root.children += [@child1, @child2, @child3]
+      @child1.parent = @root
+      @child2.parent = @root
+      @child3.parent = @root
+      
+      @tree.root = @root
+      
+      @root.rect = BracketNotation::Geometry::Rect.new(BracketNotation::Geometry::Point.new(0,0), BracketNotation::Geometry::Size.new(42,42))
+    end
+    
+    should "start out unrolled" do
+      assert !@root.roll_up
+      assert !@child1.roll_up
+    end
+  end
+end

data/test/functional/parser_test.rb

@@ -23,7 +23,7 @@
 # and small portions of his code have been incorporated in the parser.
 #
 # Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
-# Copyright:: Copyright (c) 2010 Cody Brimhall
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test_helper'

data/test/functional/scanner_test.rb

@@ -23,7 +23,7 @@
 # and small portions of his code have been incorporated in the parser.
 #
 # Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
-# Copyright:: Copyright (c) 2010 Cody Brimhall
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test_helper'

data/test/functional/tree_test.rb

@@ -0,0 +1,67 @@
+#--
+# This file is part of BracketNotation.
+# 
+# BracketNotation is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# BracketNotation is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with BracketNotation.  If not, see <http://www.gnu.org/licenses/>.
+#++
+# BracketNotation is a parser for generating syntax trees from sentences
+# annotated with the kind of bracket notation that is commonly used by
+# linguists. The result is a tree structure with nodes that describe the phrases
+# and constituents of the sentence.
+#
+# BracketNotation was inspired by Yoichiro Hasebe's RSyntaxTree[http://yohasebe.com/rsyntaxtree/],
+# and small portions of his code have been incorporated in the parser.
+#
+# Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test_helper'
+
+class TreeTest < Test::Unit::TestCase
+  include BracketNotation::View
+  
+  context "a tree" do
+    setup do
+      @tree = Tree.new("[A [B [E] [F]] [C] [D]]")
+      @root = Node.new(@tree, "A")
+      @child1 = Node.new(@tree, "B")
+      @child2 = Node.new(@tree, "C")
+      @child3 = Node.new(@tree, "D")
+      @child4 = Node.new(@tree, "E")
+      @child5 = Node.new(@tree, "F")
+      
+      @child1.children += [@child4, @child5]
+      @root.children += [@child1, @child2, @child3]
+      @tree.root = @root
+    end
+    
+    should "traverse preorder" do
+      buffer = ""
+      @tree.traverse(:order => :preorder) {|node, depth| buffer << node.content }
+      assert_equal buffer, "ABEFCD"
+    end
+    
+    should "traverse postorder" do
+      buffer = ""
+      @tree.traverse(:order => :postorder) {|node, depth| buffer << node.content }
+      assert_equal buffer, "EFBCDA"
+    end
+    
+    should "traverse breadthfirst" do
+      buffer = ""
+      @tree.traverse(:order => :breadthfirst) {|node, depth| buffer << node.content }
+      assert_equal buffer, "ABCDEF"
+    end
+  end
+end

data/test/integration/layout_test.rb

@@ -0,0 +1,151 @@
+#--
+# This file is part of BracketNotation.
+# 
+# BracketNotation is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# BracketNotation is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with BracketNotation.  If not, see <http://www.gnu.org/licenses/>.
+#++
+# BracketNotation is a parser for generating syntax trees from sentences
+# annotated with the kind of bracket notation that is commonly used by
+# linguists. The result is a tree structure with nodes that describe the phrases
+# and constituents of the sentence.
+#
+# BracketNotation was inspired by Yoichiro Hasebe's RSyntaxTree[http://yohasebe.com/rsyntaxtree/],
+# and small portions of his code have been incorporated in the parser.
+#
+# Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test_helper'
+
+class LayoutTest < Test::Unit::TestCase
+  include BracketNotation
+  include BracketNotation::View
+  include BracketNotation::Geometry
+  
+  SANS_FONT_NAME = "Helvetica"
+  SERIF_FONT_NAME = "Georgia"
+  DEFAULT_METRICS = {:large => {:font_point_size => 40,
+                                :tree_padding    => 20,
+                                :node_h_margin   => 50,
+                                :node_v_margin   => 30,
+                                :node_padding    => 10},
+                                
+                     :small => {:font_point_size => 12,
+                                :tree_padding    => 20,
+                                :node_h_margin   => 20,
+                                :node_v_margin   => 15,
+                                :node_padding    => 10}}
+  
+  context "a single-node tree" do
+    setup do
+      @input = "[S]"
+      @tree = Tree.new(@input)
+      @root = Branch.new(@tree, "S")
+      @tree.root = @root
+    end
+    
+    should "layout correctly at large point sizes" do
+      configure_tree(@tree, :size => :large)
+      @tree.compute_layout
+      
+      assert_equal Rect.new(20, 20, 24, 60), @root.rect
+    end
+    
+    should "layout correctly at small point sizes" do
+      configure_tree(@tree, :size => :small)
+      @tree.compute_layout
+      
+      assert_equal Rect.new(20, 20, 7, 32), @root.rect, "The root rect is wrong"
+    end
+  end
+  
+  context "a two-node tree" do
+    setup do
+      @input = "[S [NP]]"
+      @tree = Tree.new(@input)
+      @root = Branch.new(@tree, "S")
+      @child = Branch.new(@tree, "NP")
+      
+      @child.parent = @root
+      @root.children << @child
+      @tree.root = @root
+    end
+    
+    should "layout correctly at large point sizes" do
+      configure_tree(@tree, :size => :large)
+      @tree.compute_layout
+      
+      assert_equal Rect.new(34, 20, 24, 60), @root.rect, "The root rect is wrong"
+      assert_equal Rect.new(20, 110, 52, 60), @child.rect, "The child rect is wrong"
+    end
+    
+    should "layout correctly at small point sizes" do
+      configure_tree(@tree, :size => :small)
+      @tree.compute_layout
+      
+      assert_equal Rect.new(25, 20, 7, 32), @root.rect, "The root rect is wrong"
+      assert_equal Rect.new(20, 67, 16, 32), @child.rect, "The child rect is wrong"
+    end
+  end
+  
+  context "a three-node tree" do
+    setup do
+      @input = "[S [NP] [VP]]"
+      @tree = Tree.new(@input)
+      @root = Branch.new(@tree, "S")
+      @child1 = Branch.new(@tree, "NP")
+      @child2 = Branch.new(@tree, "VP")
+      
+      @child1.parent = @root
+      @child2.parent = @root
+      @root.children += [@child1, @child2]
+      @tree.root = @root
+    end
+    
+    should "layout correctly at large point sizes" do
+      configure_tree(@tree, :size => :large)
+      @tree.compute_layout
+      
+      assert_equal Rect.new(85, 20, 24, 60), @root.rect, "The root rect is wrong"
+      assert_equal Rect.new(20, 110, 52, 60), @child1.rect, "The first child's rect is wrong"
+      assert_equal Rect.new(122, 110, 52, 60), @child2.rect, "The second child's rect is wrong"
+    end
+    
+    should "layout correctly at small point sizes" do
+      configure_tree(@tree, :size => :small)
+      @tree.compute_layout
+      
+      assert_equal Rect.new(43, 20, 7, 32), @root.rect, "The root rect is wrong"
+      assert_equal Rect.new(20, 67, 16, 32), @child1.rect, "The first child's rect is wrong"
+      assert_equal Rect.new(56, 67, 16, 32), @child2.rect, "The second child's rect is wrong"
+    end
+  end
+  
+  private
+  
+  def configure_tree(tree, options)
+    font_name = options[:font_name] || SANS_FONT_NAME
+    size = options[:size] || :small
+    metrics = DEFAULT_METRICS[size]
+    
+    tree.font_name = font_name
+    tree.font_point_size = metrics[:font_point_size]
+    tree.tree_padding = metrics[:tree_padding]
+    tree.node_h_margin = metrics[:node_h_margin]
+    tree.node_v_margin = metrics[:node_v_margin]
+    tree.node_padding = metrics[:node_padding]
+    
+    return tree
+  end
+end

data/test/integration/parsing_test.rb

@@ -23,7 +23,7 @@
 # and small portions of his code have been incorporated in the parser.
 #
 # Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
-# Copyright:: Copyright (c) 2010 Cody Brimhall
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test_helper'

data/test/test_helper.rb

@@ -23,7 +23,7 @@
 # and small portions of his code have been incorporated in the parser.
 #
 # Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
-# Copyright:: Copyright (c) 2010 Cody Brimhall
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test/unit'

data/test/unit/expression_test.rb

@@ -23,7 +23,7 @@
 # and small portions of his code have been incorporated in the parser.
 #
 # Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
-# Copyright:: Copyright (c) 2010 Cody Brimhall
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test_helper'

data/test/unit/point_test.rb

@@ -0,0 +1,69 @@
+#--
+# This file is part of BracketNotation.
+# 
+# BracketNotation is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# BracketNotation is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with BracketNotation.  If not, see <http://www.gnu.org/licenses/>.
+#++
+# BracketNotation is a parser for generating syntax trees from sentences
+# annotated with the kind of bracket notation that is commonly used by
+# linguists. The result is a tree structure with nodes that describe the phrases
+# and constituents of the sentence.
+#
+# BracketNotation was inspired by Yoichiro Hasebe's RSyntaxTree[http://yohasebe.com/rsyntaxtree/],
+# and small portions of his code have been incorporated in the parser.
+#
+# Author:: Cody Brimhall (mailto:brimhall@somuchwit.com)
+# Copyright:: Copyright (c) 2010-2011 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test_helper'
+
+class PointTest < Test::Unit::TestCase
+  include BracketNotation::Geometry
+  
+  context "a point" do
+    setup do
+      @point1 = Point.new
+      @point2 = Point.new(42, 42)
+      @point3 = Point.new(42, 42)
+      @point4 = Point.new(42, 0)
+      @point5 = Point.new(0, 42)
+    end
+    
+    should "initiaize to {0,0}" do
+      assert @point1.x == 0 and @point1.y == 0
+    end
+    
+    should "be immutable" do
+      assert_raise(NoMethodError) { @point1.x = 0 }
+      assert_raise(NoMethodError) { @point1.y = 0 }
+    end
+    
+    should "base equality on coordinates" do
+      assert_not_equal @point1, @point2
+      assert_equal @point2, @point3
+    end
+    
+    should "create new point by adding to X" do
+      assert_equal @point1.point_by_adding_to_x(42), @point4
+    end
+    
+    should "create new point by adding to y" do
+      assert_equal @point1.point_by_adding_to_y(42), @point5
+    end
+    
+    should "create new point by adding to x and y" do
+      assert_equal @point1.point_by_adding_to_x_and_y(42, 42), @point2
+    end
+  end
+end