bracket_notation 1.0.3

data/test/functional/scanner_test.rb

@@ -0,0 +1,48 @@
+#--
+# 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 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test/test_helper'
+
+class ScannerTest < Test::Unit::TestCase
+  include BracketNotation
+  
+  context "the scanner" do
+    setup do
+      @input = "[S[DP[D the][NP[N boy]]][VP[V ate][DP[D the][NP[N bread]]]]]"
+      @scanner = Scanner.new(@input)
+    end
+    
+    should "always generate at least one token" do
+      assert @scanner.scan.length > 0
+    end
+    
+    should "always produce an EOL token as its last token" do
+      assert @scanner.scan.last == Token.EOL
+    end
+  end
+end

data/test/integration/parsing_test.rb

@@ -0,0 +1,50 @@
+#--
+# 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 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test/test_helper'
+
+class ParsingTest < Test::Unit::TestCase
+  include BracketNotation
+  
+  context "the parsing process" do
+    setup do
+      @input = "[S [DP [D the] [NP [N boy]]] [VP [V ate] [DP [D the] [NP [N bread]]]]]"
+      @parser = Parser.new(@input)
+    end
+    
+    should "not raise exceptions" do
+      assert_nothing_raised do
+        @parser.parse
+      end
+    end
+    
+    should "produce an expression" do
+      assert_kind_of Expression, @parser.parse
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+#--
+# 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 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'lib/bracket_notation'

data/test/unit/expression_test.rb

@@ -0,0 +1,72 @@
+#--
+# 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 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test/test_helper'
+
+class ExpressionTest < Test::Unit::TestCase
+  include BracketNotation
+  
+  context "an identifier expression" do
+    setup do
+      @identifier1 = Identifier.new("NP", 1)
+      @identifier2 = Identifier.new("VP")
+    end
+    
+    should "have a value" do
+      assert_not_nil @identifier1.value
+    end
+    
+    should "have a depth" do
+      assert_not_nil @identifier1.depth
+    end
+    
+    should "make itself the parent of a new child" do
+      @identifier1.add_child(@identifier2)
+      assert_same @identifier1, @identifier2.parent
+    end
+    
+    should "update the depth of a new child" do
+      @identifier1.add_child(@identifier2)
+      assert @identifier2.depth == @identifier1.depth + 1
+    end
+  end
+  
+  context "a terminal expression" do
+    setup do
+      @expression = Terminal.new("NP")
+    end
+    
+    should "have a value" do
+      assert_not_nil @expression.value
+    end
+    
+    should "have a depth" do
+      assert_not_nil @expression.depth
+    end
+  end
+end

data/test/unit/token_test.rb

@@ -0,0 +1,117 @@
+#--
+# 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 Cody Brimhall
+# License:: Distributed under the terms of the GNU General Public License, v. 3
+
+require 'test/test_helper'
+
+class TokenTest < Test::Unit::TestCase
+  include BracketNotation
+  
+  context "a left bracket token" do
+    setup do
+      @lbracket = Token.LBRACKET
+    end
+    
+    should "be of type #{Token::LBRACKET}" do
+      assert_equal Token::LBRACKET, @lbracket.type
+    end
+    
+    should "not have a value" do
+      assert_nil @lbracket.value
+    end
+  end
+  
+  context "a right bracket token" do
+    setup do
+      @rbracket = Token.RBRACKET
+    end
+    
+    should "be of type #{Token::RBRACKET}" do
+      assert_equal Token::RBRACKET, @rbracket.type
+    end
+    
+    should "not have a value" do
+      assert_nil @rbracket.value
+    end
+  end
+  
+  context "a name token" do
+    setup do
+      @value = "string"
+      @name = Token.NAME(@value)
+    end
+    
+    should "be of type #{Token::NAME}" do
+      assert_equal Token::NAME, @name.type
+    end
+    
+    should "have a value" do
+      assert_not_nil @name.value
+    end
+    
+    should "have a value equal to that which was given when initializing" do
+      assert_equal @value, @name.value
+    end
+  end
+  
+  context "an end-of-line token" do
+    setup do
+      @eol = Token.EOL
+    end
+    
+    should "be of type #{Token::EOL}" do
+      assert_equal Token::EOL, @eol.type
+    end
+    
+    should "not have a value" do
+      assert_nil @eol.value
+    end
+  end
+  
+  context "two tokens" do
+    setup do
+      @name1 = Token.NAME("name")
+      @name2 = Token.NAME("name")
+      @name3 = Token.NAME("other")
+      @bracket = Token.LBRACKET
+      @eol = Token.EOL
+    end
+    
+    should "be equal if they have the same type and value" do
+      assert_equal @name1, @name2
+      assert_equal @bracket1, @bracket2
+    end
+    
+    should "be unequal if they have different types" do
+      assert_not_equal @bracket, @eol
+    end
+    
+    should "be unequal if they have different values" do
+      assert_not_equal @name1, @name3
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: bracket_notation
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
+platform: ruby
+authors: 
+- Cody Brimhall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id001
+description: Generates a representation of a syntax tree using a string of bracket notation.
+email: zbrimhall@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- COPYING
+- README.rdoc
+- lib/bracket_notation.rb
+- lib/bracket_notation/evaluator.rb
+- lib/bracket_notation/expressions.rb
+- lib/bracket_notation/expressions/expression.rb
+- lib/bracket_notation/expressions/identifier.rb
+- lib/bracket_notation/expressions/terminal.rb
+- lib/bracket_notation/parser.rb
+- lib/bracket_notation/scanner.rb
+- lib/bracket_notation/token.rb
+- lib/bracket_notation/version.rb
+files: 
+- CHANGELOG
+- COPYING
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/bracket_notation.rb
+- lib/bracket_notation/evaluator.rb
+- lib/bracket_notation/expressions.rb
+- lib/bracket_notation/expressions/expression.rb
+- lib/bracket_notation/expressions/identifier.rb
+- lib/bracket_notation/expressions/terminal.rb
+- lib/bracket_notation/parser.rb
+- lib/bracket_notation/scanner.rb
+- lib/bracket_notation/token.rb
+- lib/bracket_notation/version.rb
+- test/functional/evaluator_test.rb
+- test/functional/parser_test.rb
+- test/functional/scanner_test.rb
+- test/integration/parsing_test.rb
+- test/test_helper.rb
+- test/unit/expression_test.rb
+- test/unit/token_test.rb
+- Manifest
+- bracket_notation.gemspec
+has_rdoc: true
+homepage: http://github.com/zbrimhall/bracket_notation
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Bracket_notation
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: bracket_notation
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Provides a parser for strings that have been marked up with the bracket notation commonly used by syntacticians. The parser generates an abstract tree representation of the syntax of the string.
+test_files: 
+- test/functional/evaluator_test.rb
+- test/functional/parser_test.rb
+- test/functional/scanner_test.rb
+- test/integration/parsing_test.rb
+- test/test_helper.rb
+- test/unit/expression_test.rb
+- test/unit/token_test.rb