bracket_notation 1.0.3 → 1.0.4

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Version History
 
+== 1.0.4 / 2011-01-09:
+
+* Added a validation class method to the Parser class to help with error
+  checking in applications
+
 == 1.0.3 / 2011-01-08:
 
 * Trying to fix version detection when building gem

data/bracket_notation.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bracket_notation}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   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.date = %q{2011-03-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"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.6.1}
   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"]
 

data/init.rb

@@ -26,4 +26,4 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'lib/bracket_notation'
+require './lib/bracket_notation'

data/lib/bracket_notation/evaluator.rb

@@ -69,9 +69,12 @@ module BracketNotation # :nodoc:
       
       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
+          when Token::NAME
+            Terminal.new(token.value)
+          when Token::LBRACKET
+            evaluate_phrase
+          else
+            unexpected_token_error
         end
         
         identifier.add_child(expression)

data/lib/bracket_notation/parser.rb

@@ -38,62 +38,60 @@ module BracketNotation # :nodoc:
     # validation process.
     class ValidationError < RuntimeError; end
     
-    # Saves the input string, as well as a copy of the input string that has
-    # been normalized and validated.
-    def initialize(input)
-      validation_error "Parser input cannot be nil" if input.nil?
-      
-      @input = input
-      @data = scrub(input)
-      validate
-    end
-    
-    # Scans and evaluates the input string, returning an expression tree.
-    def parse
-      scanner = Scanner.new(@data)
-      evaluator = Evaluator.new(scanner.scan)
-      expression = evaluator.evaluate
-    end
-    
-    private
-    
-    # Normalizes the input string to make it easier to parse.
-    def scrub(str)
-      output = str.gsub(/\t/, "")
-      output.gsub!(/\s+/, " ")
-      output.gsub!(/\] \[/, "][")
-      output.gsub!(/ \[/, "[")
-      
-      return output
-    end
-    
-    # Checks to see if the input is valid, i.e. it has a length, no unnamed
-    # nodes, and the bracket-nesting is balanced.
-    def validate
-      validation_error("Input string can't be empty.") if @data.length < 1
-      validation_error("All opening brackets must have a label.") if /\[\s*\[/ =~ @data
+    # Performs basic validation of a string without executing the entire parse
+    # process. Returns true if validation is successful; raises an exception if
+    # not.
+    def self.validate(input)
+      validation_error("parser input cannot be nil") if input.nil?
+      validation_error("input string can't be empty") if input.length < 1
+      validation_error("all opening brackets must have a label") if /\[\s*\[/ =~ input
       
       # Count the opening and closing brackets to make sure they're balanced
-      chars = @data.gsub(/[^\[\]]/, "").split(//)
-      validation_error("Opening and closing brackets must be balanced.") if chars.length % 2 != 0
+      chars = input.gsub(/[^\[\]]/, "").split(//)
+      validation_error("opening and closing brackets must be balanced") if chars.length % 2 != 0
       
       open_count, close_count = 0, 0
       
       chars.each do |char|
         case char
-          when '[': open_count += 1
-          when ']': close_count += 1
+          when '['
+            open_count += 1
+          when ']'
+            close_count += 1
         end
         
         break if open_count < close_count
       end
       
-      validation_error("Opening and closing brackets must be properly nested.") if open_count != close_count
+      validation_error("opening and closing brackets must be properly nested") if open_count != close_count
+      
+      return true
     end
     
+    # Saves the input string, as well as a copy of the input string that has
+    # been normalized and validated.
+    def initialize(input)
+      @input = input
+      validate
+    end
+    
+    # Scans and evaluates the input string, returning an expression tree.
+    def parse
+      Evaluator.new(Scanner.new(@input).scan).evaluate
+    end
+    
+    private
+    
     # Raises a validation exception with the given message
-    def validation_error(message)
+    def self.validation_error(message)
       raise ValidationError, message
     end
+    
+    # Performs basic validation of the input string without executing the entire
+    # parse process. Returns true if validation is successful; raises an
+    # exception if not.
+    def validate
+      self.class.validate(@input)
+    end
   end
 end

data/lib/bracket_notation/scanner.rb

@@ -76,11 +76,16 @@ module BracketNotation # :nodoc:
       token = nil
       while(token.nil?)
         token = case read_char
-          when UNRESERVED_CHARACTER: name_token
-          when LBRACKET_CHARACTER: Token.LBRACKET
-          when RBRACKET_CHARACTER: Token.RBRACKET
-          when EOL_CHARACTER: Token.EOL
-          else nil
+          when UNRESERVED_CHARACTER
+            name_token
+          when LBRACKET_CHARACTER
+            Token.LBRACKET
+          when RBRACKET_CHARACTER
+            Token.RBRACKET
+          when EOL_CHARACTER
+            Token.EOL
+          else
+            nil
         end
       end
       

data/lib/bracket_notation/version.rb

@@ -30,7 +30,7 @@ module BracketNotation # :nodoc:
   module Version # :nodoc:
     MAJOR = 1
     MINOR = 0
-    MAINT = 3
+    MAINT = 4
     
     # Returns the current version string.
     def self.to_s;

data/test/functional/evaluator_test.rb

@@ -26,7 +26,7 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'test/test_helper'
+require 'test_helper'
 
 class EvaluatorTest < Test::Unit::TestCase
   include BracketNotation

data/test/functional/parser_test.rb

@@ -26,7 +26,7 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'test/test_helper'
+require 'test_helper'
 
 class ParserTest < Test::Unit::TestCase
   include BracketNotation

data/test/functional/scanner_test.rb

@@ -26,7 +26,7 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'test/test_helper'
+require 'test_helper'
 
 class ScannerTest < Test::Unit::TestCase
   include BracketNotation

data/test/integration/parsing_test.rb

@@ -26,7 +26,7 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'test/test_helper'
+require 'test_helper'
 
 class ParsingTest < Test::Unit::TestCase
   include BracketNotation

data/test/test_helper.rb

@@ -27,6 +27,5 @@
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
 require 'test/unit'
-require 'rubygems'
 require 'shoulda'
-require 'lib/bracket_notation'
+require 'bracket_notation'

data/test/unit/expression_test.rb

@@ -26,7 +26,7 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'test/test_helper'
+require 'test_helper'
 
 class ExpressionTest < Test::Unit::TestCase
   include BracketNotation

data/test/unit/token_test.rb

@@ -26,7 +26,7 @@
 # Copyright:: Copyright (c) 2010 Cody Brimhall
 # License:: Distributed under the terms of the GNU General Public License, v. 3
 
-require 'test/test_helper'
+require 'test_helper'
 
 class TokenTest < Test::Unit::TestCase
   include BracketNotation

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bracket_notation
 version: !ruby/object:Gem::Version 
-  hash: 17
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Cody Brimhall
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-08 00:00:00 -08:00
+date: 2011-03-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 37
-        segments: 
-        - 2
-        - 11
-        - 3
         version: 2.11.3
   type: :development
   version_requirements: *id001
@@ -98,24 +88,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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
+rubygems_version: 1.6.1
 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.