bracket_notation 1.0.3

data/Manifest

@@ -0,0 +1,23 @@
+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

data/README.rdoc

@@ -0,0 +1,11 @@
+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

data/Rakefile

@@ -0,0 +1,42 @@
+#--
+# 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
+
+($:.unshift File.expand_path(File.join( File.dirname(__FILE__), 'lib' ))).uniq!
+
+require 'echoe'
+require 'bracket_notation/version'
+
+Echoe.new('bracket_notation', BracketNotation::Version) do |p|
+  p.description = "Generates a representation of a syntax tree using a string of bracket notation."
+  p.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."
+  p.url = "http://github.com/zbrimhall/bracket_notation"
+  p.author = "Cody Brimhall"
+  p.email = "zbrimhall@gmail.com"
+  p.ignore_pattern = %w(tmp/* script/* *.bbprojectd/*)
+  p.development_dependencies = ['shoulda >=2.11.3']
+end

data/bracket_notation.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bracket_notation}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cody Brimhall"]
+  s.date = %q{2011-01-08}
+  s.description = %q{Generates a representation of a syntax tree using a string of bracket notation.}
+  s.email = %q{zbrimhall@gmail.com}
+  s.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"]
+  s.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"]
+  s.homepage = %q{http://github.com/zbrimhall/bracket_notation}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bracket_notation", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bracket_notation}
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{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.}
+  s.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"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 2.11.3"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 2.11.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 2.11.3"])
+  end
+end

data/init.rb

@@ -0,0 +1,29 @@
+#--
+# 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 'lib/bracket_notation'

data/lib/bracket_notation.rb

@@ -0,0 +1,34 @@
+#--
+# 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 'bracket_notation/evaluator'
+require 'bracket_notation/expressions'
+require 'bracket_notation/parser'
+require 'bracket_notation/scanner'
+require 'bracket_notation/token'
+require 'bracket_notation/version'

data/lib/bracket_notation/evaluator.rb

@@ -0,0 +1,99 @@
+#--
+# 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
+
+module BracketNotation # :nodoc:
+  # This class takes a list of Token instances and evaluates them. The result is
+  # an abstract tree representation of the syntax of the original string fed to
+  # the parser.
+  class Evaluator
+    attr_reader :input
+    
+    # This class is an Exception subclass that reports errors in the evaluation
+    # process.
+    class EvaluationError < SyntaxError; end
+    
+    # Saves the token list for evaluation.
+    def initialize(input)
+      @input = input
+      @token_index = -1
+      @root = nil
+    end
+    
+    # Evaluates a bracketed phrase and returns the Evaluation instance that
+    # represents the phrase.
+    def evaluate
+      return @root unless @root.nil?
+      
+      token = next_token
+      unexpected_token_error if token.type != Token::LBRACKET
+      @root = evaluate_phrase
+      
+      unexpected_token_error if next_token.type != Token::EOL
+      
+      return @root
+    end
+    
+    private
+    
+    # Evaluates a phrase expression.
+    def evaluate_phrase
+      token = next_token
+      unexpected_token_error if token.type != Token::NAME
+      
+      identifier = Identifier.new(token.value)
+      
+      while((token = next_token).type != Token::RBRACKET)
+        expression = case token.type
+          when Token::NAME: Terminal.new(token.value)
+          when Token::LBRACKET: evaluate_phrase
+          else unexpected_token_error
+        end
+        
+        identifier.add_child(expression)
+      end
+      
+      return identifier
+    end
+    
+    # Returns the token currently being evaluated.
+    def current_token
+      return @input[@token_index]
+    end
+    
+    # Advances the token index and returns the new current token.
+    def next_token
+      @token_index += 1
+      return current_token
+    end
+    
+    # Raises an unexpected token error.
+    def unexpected_token_error
+      raise EvaluationError, "Unexpected token: #{current_token.inspect}"
+    end
+  end
+end

data/lib/bracket_notation/expressions.rb

@@ -0,0 +1,31 @@
+#--
+# 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 'bracket_notation/expressions/expression'
+require 'bracket_notation/expressions/identifier'
+require 'bracket_notation/expressions/terminal'

data/lib/bracket_notation/expressions/expression.rb

@@ -0,0 +1,49 @@
+#--
+# 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
+
+module BracketNotation # :nodoc:
+  # This class represents the result of evaluating a token. It is an abstract
+  # class that should have a subclass for every possible kind of expression.
+  class Expression
+    attr_accessor :value, :depth, :parent
+    
+    # Saves the token value and optional tree depth.
+    def initialize(value, depth = 0)
+      @value = value
+      @depth = depth
+      @parent = nil
+    end
+    
+    # Prints a visual representation of the syntax tree.
+    def pretty_print
+      out = ""
+      @depth.times {out << "--"}
+      out << " #{@value}\n"
+    end
+  end
+end

data/lib/bracket_notation/expressions/identifier.rb

@@ -0,0 +1,62 @@
+#--
+# 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
+
+module BracketNotation # :nodoc:
+  # This class represents an identifier expression. Identifers are expressions
+  # that can have children -- branch nodes, in other words.
+  class Identifier < Expression
+    attr_accessor :children, :depth
+    
+    # Saves the identifier value and optional tree depth.
+    def initialize(value, depth = 0)
+      super
+      @children = []
+    end
+    
+    # Adds the given expression to the children array and updates the new
+    # child's parent and depth attributes.
+    def add_child(expression)
+      expression.parent = self
+      expression.depth = @depth + 1
+      @children << expression
+    end
+    
+    # Sets the new depth, and the new depth of all children.
+    def depth=(rvalue)
+      @depth = rvalue
+      children.each {|child| child.depth = rvalue + 1}
+    end
+    
+    # Prints a visual representation of the syntax tree.
+    def pretty_print
+      out = super
+      @children.each {|child| out << child.pretty_print}
+      out
+    end
+  end
+end

data/lib/bracket_notation/expressions/terminal.rb

@@ -0,0 +1,34 @@
+#--
+# 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
+
+module BracketNotation # :nodoc:
+  # This class represents a terminal expression. Terminals are expressions that
+  # do not have children -- leaf nodes, in other words.
+  class Terminal < Expression
+  end
+end