bracket_notation 1.0.4 → 1.0.5

data/CHANGELOG

@@ -1,5 +1,11 @@
 = Version History
 
+== 1.0.5 / 2011-03-09:
+
+* Removed an extraneous space from the #pretty_print output that has always
+  bugged me. *So* worth a new release
+* Added information and a usage example to the README
+
 == 1.0.4 / 2011-01-09:
 
 * Added a validation class method to the Parser class to help with error

data/README.rdoc

@@ -1,3 +1,5 @@
+= BracketNotation
+
 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
@@ -9,3 +11,41 @@ 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
+
+== Using BracketNotation
+
+To use BracketNotation, simply initialize a Parser instance with the string you
+want to parse, and call the #parse method. Parser performs some basic validation
+before attempting to evaluate the string. If validation fails, Parser raises a
+ValidationError. If the evaluator encounters a syntax error in the string, it
+raises an EvaluationError.
+
+  require 'bracket_notation'
+  include BracketNotation
+  
+  input = "[S [NP colorless green ideas] [VP [V sleep] [Adv furiously]]]"
+  
+  begin
+    parser = Parser.new(input)
+    tree = parser.parse
+    
+    puts tree.pretty_print # => S
+                           #    -- NP
+                           #    ---- colorless
+                           #    ---- green
+                           #    ---- ideas
+                           #    -- VP
+                           #    ---- V
+                           #    ------ sleep
+                           #    ---- Adv
+                           #    ------ furiously
+  rescue ValidationError
+    puts "Validation failed: #{$!}"
+  rescue EvaluationError
+    puts "Evaluation failed: #{$!}"
+  end
+
+== Bugs, Feature Requests, Et Cetera
+
+If you have any bugs, feature requests, or glowing praise, you can
+find this project on GitHub[http://github.com/zbrimhall/bracket_notation].

data/bracket_notation.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bracket_notation}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cody Brimhall"]
-  s.date = %q{2011-03-08}
+  s.date = %q{2011-03-09}
   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"]

data/lib/bracket_notation/expressions/expression.rb

@@ -43,7 +43,8 @@ module BracketNotation # :nodoc:
     def pretty_print
       out = ""
       @depth.times {out << "--"}
-      out << " #{@value}\n"
+      out << " " if @depth > 0
+      out << "#{@value}\n"
     end
   end
 end

data/lib/bracket_notation/version.rb

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

metadata

@@ -2,7 +2,7 @@
 name: bracket_notation
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Cody Brimhall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 -08:00
+date: 2011-03-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency