SgfParser 0.9.1 → 1.0.0

data/Gemfile

@@ -5,6 +5,7 @@ source "http://rubygems.org"
 group :development do
   gem "jeweler"
   gem "rcov"
+  gem "rdoc"
 end
 
 group :test do

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       rake
     rake (0.9.2)
     rcov (0.9.9)
+    rdoc (3.9)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -24,4 +25,5 @@ PLATFORMS
 DEPENDENCIES
   jeweler
   rcov
+  rdoc
   rspec

data/README.rdoc

@@ -1,38 +1,44 @@
-=INFORMATION
-Author: Aldric Giacomoni
-
-Email : aldric~at~trevoke.net (feedback very welcome!)
-
-SGF: all formats (but untested with FF < 4)
-
-Ruby: >=1.8.7 (may work with 1.8.6)
-
-=QUICK HOWTO
-Example:
- require 'sgf_parser'
- tree = SgfParser::Tree.new :filename => File
- tree = SgfParser::Tree.new :string => String
-
-All trees begin with an empty node ( @root) which allows a simple support of multiple gametrees.
-
-Most games will just care about, say,
- tree.root.children[0] which is the first node of the first gametree.
-
-For any node, one can summon the properties as such:
- node.properties # => returns a hash of the properties.
-A single property can be called, like the comments, for instance, like so:
- node.C # => returns the comments for this node.
-
-The library currently uses method_missing to painlessly return the data. I must admit that this is both clever coding and laziness on my part.
-
-There is also a SGF Indenter. Its purpose is to make SGF files more readable to humans at a glance.
- require 'sgf_parser/sgfindent' # Done automatically if you require 'sgf_parser'
- sgf = SgfParser::Indenter.new 'some_ugly_file.sgf' # Will output to the console
- sgf = SgfParser::Indenter.new 'some_ugly_file.sgf' 'pretty.sgf' # Sends the result to a new file.
-
-___
-
-TODO
-? Create a "Game" class, and if a whole set of () exists, then I have a game?
-That way maybe I can easily go to multiple games stored in a single SGF file?
-Mostly syntactic sugar, but may be worth implementing.
+=INFORMATION
+Author: Aldric Giacomoni
+
+Email : aldric@at@trevoke.net (feedback very welcome!)
+
+SGF: all formats (but untested with FF < 4)
+
+Ruby: >=1.8.7 (may work with 1.8.6)
+
+=QUICK HOWTO
+Example:
+ require 'sgf'
+ tree = SGF::Parser.new file_or_string
+
+
+All trees begin with an empty node ( @root) which allows a simple support of multiple gametrees.
+
+Most games will just care about, say,
+ tree.root.children[0] which is the first node of the first gametree.
+
+For any node, one can summon the properties as such:
+ node.properties # => returns a hash of the properties.
+A single property can be called, like the comments, for instance, like so:
+ node.C # => returns the comments for this node.
+ node.comments # => syntactic sugar
+
+The library currently uses method_missing to painlessly return the data. I must admit that this is both clever coding and laziness on my part.
+
+There is also a SGF Indenter. Its purpose is to make SGF files more readable to humans at a glance.
+ require 'sgf/sgfindent' # Done automatically if you require 'sgf_parser'
+ sgf = SGF::Indenter.new 'some_ugly_file.sgf' # Will output to the console
+ sgf = SGF::Indenter.new 'some_ugly_file.sgf' 'pretty.sgf' # Sends the result to a new file.
+
+___
+
+TODO
+- Create a "Game" class that wraps a complete set of () for ease of use
+- implement node.next to go to node.children[0] because who wants to type that anyway?
+- implement a 'current' node in Tree so we don't have to jump from node to node. This means..
+    - implement tree.next instead of node.next for tree.current_node.children[0]
+- examine/fix the smell that when you use add_children, it also sets the parent on the passed-in nodes.
+- fix the multiple properties bug in the SGF indenter as well
+- see how much of the parser code the indenter can use, since it's basically the same logic
+

data/SgfParser.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{SgfParser}
-  s.version = "0.9.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aldric Giacomoni"]
-  s.date = %q{2011-07-29}
+  s.date = %q{2011-08-01}
   s.description = %q{SGFParser is a library that parses and saves SGF (Smart Game Format) files.}
   s.email = %q{aldric@trevoke.net}
   s.extra_rdoc_files = [
@@ -27,22 +27,21 @@ Gem::Specification.new do |s|
     "Rakefile",
     "SgfParser.gemspec",
     "VERSION",
-    "lib/sgf/parser/node.rb",
-    "lib/sgf/parser/properties.rb",
-    "lib/sgf/parser/tree.rb",
-    "lib/sgf/parser/tree_parse.rb",
-    "lib/sgf/sgf_indent.rb",
-    "lib/sgf/sgfindent.rb",
-    "lib/sgf_parser.rb",
-    "sample_sgf/ff4_ex.sgf",
-    "sample_sgf/ff4_ex_saved.sgf",
-    "sample_sgf/redrose-tartrate.sgf",
-    "sample_sgf/simple.sgf",
-    "sample_sgf/simple_saved.sgf",
+    "lib/sgf.rb",
+    "lib/sgf/indenter.rb",
+    "lib/sgf/node.rb",
+    "lib/sgf/parser.rb",
+    "lib/sgf/properties.rb",
+    "lib/sgf/tree.rb",
     "sample_usage/parsing_files.rb",
+    "spec/data/ff4_ex.sgf",
+    "spec/data/ff4_ex_saved.sgf",
+    "spec/data/redrose-tartrate.sgf",
+    "spec/data/simple.sgf",
+    "spec/data/simple_saved.sgf",
     "spec/node_spec.rb",
+    "spec/parser_spec.rb",
     "spec/spec_helper.rb",
-    "spec/tree_parser_spec.rb",
     "spec/tree_spec.rb"
   ]
   s.homepage = %q{http://github.com/Trevoke/SGFParser}
@@ -56,15 +55,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end
 end

data/VERSION

@@ -1 +1 @@
-0.9.1
+1.0.0

data/lib/sgf.rb

@@ -0,0 +1,8 @@
+$: << File.dirname(__FILE__)
+
+require 'yaml'
+require 'sgf/properties'
+require 'sgf/node'
+require 'sgf/tree'
+require 'sgf/parser'
+require 'sgf/indenter'

data/lib/sgf/{sgf_indent.rb → indenter.rb}

@@ -1,108 +1,108 @@
-require 'stringio'
-
-module SgfParser
-
-  # This indents an SGF file to make it more readable. It outputs to the screen
-  # by default, but can be given a file as output.
-  # Usage: SgfParser::Indenter.new infile, outfile
-  class Indenter
-
-    def initialize file, out=$stdout
-      @stream = load_file_to_stream(file)
-      @new_string = ""
-      @indentation = 0
-      @out = (out == $stdout) ? $stdout : File.open(out, 'w')
-      parse
-    end
-
-    def next_character
-      !@stream.eof? && @stream.sysread(1)
-    end
-
-    def parse
-      while char = next_character
-        case char
-          when '(' then open_branch
-          when ')' then close_branch
-          when ';' then new_node
-          when '[' then add_property
-          else add_identity(char)
-        end
-      end
-
-      @out << @new_string
-      @out.close unless @out == $stdout
-      #if out == $stdout
-      #  $stdout << @new_string
-      #else
-      #  File.open(out, 'w') { |file| file << @new_string }
-      #end      
-    end
-
-    def open_branch
-      next_line
-      @indentation += 2
-      @new_string << " " * @indentation
-      @new_string << "("
-    end
-
-    def close_branch
-      @new_string << ")"
-      next_line
-      @indentation -= 2
-      @indentation = 0 if @indentation < 0
-      @new_string << " " * @indentation
-    end
-
-    def new_node
-      next_line
-      @new_string << " " * @indentation
-      @new_string << ";"
-    end
-
-    def next_line
-      @new_string << "\n"
-    end
-
-    #TODO Fix it more. Add _ONE_ set of indentation if there are newlines,
-    #TODO Not one set for every newline.
-    def add_property
-      buffer = "["
-      while true
-        next_bit = @stream.sysread(1)
-        next_bit << @stream.sysread(1) if next_bit == "\\"
-        buffer << next_bit
-        buffer << " " * @indentation if next_bit == "\n"
-        break if next_bit == "]"
-      end
-      buffer << "\n"
-      buffer << " " * @indentation
-      @new_string << buffer
-    end
-
-    def add_identity(char)
-      @new_string << char unless char == "\n"
-    end
-
-    private
-
-    def load_file_to_stream(file)
-      sgf = ""
-      File.open(file) { |f| sgf = f.read }
-      clean_string(sgf)
-      return StringIO.new(sgf, 'r')
-    end
-
-    def clean_string(sgf)
-      sgf.gsub! "\\\\n\\\\r", ""
-      sgf.gsub! "\\\\r\\\\n", ""
-      sgf.gsub! "\\\\r", ""
-      sgf.gsub! "\\\\n", ""
-    end    
-
-  end
-end
-
-
-
-
+require 'stringio'
+
+module SGF
+
+  # This indents an SGF file to make it more readable. It outputs to the screen
+  # by default, but can be given a file as output.
+  # Usage: SgfParser::Indenter.new infile, outfile
+  class Indenter
+
+    def initialize file, out=$stdout
+      @stream = load_file_to_stream(file)
+      @new_string = ""
+      @indentation = 0
+      @out = (out == $stdout) ? $stdout : File.open(out, 'w')
+      parse
+    end
+
+    def next_character
+      !@stream.eof? && @stream.sysread(1)
+    end
+
+    def parse
+      while char = next_character
+        case char
+          when '(' then open_branch
+          when ')' then close_branch
+          when ';' then new_node
+          when '[' then add_property
+          else add_identity(char)
+        end
+      end
+
+      @out << @new_string
+      @out.close unless @out == $stdout
+      #if out == $stdout
+      #  $stdout << @new_string
+      #else
+      #  File.open(out, 'w') { |file| file << @new_string }
+      #end      
+    end
+
+    def open_branch
+      next_line
+      @indentation += 2
+      @new_string << " " * @indentation
+      @new_string << "("
+    end
+
+    def close_branch
+      @new_string << ")"
+      next_line
+      @indentation -= 2
+      @indentation = 0 if @indentation < 0
+      @new_string << " " * @indentation
+    end
+
+    def new_node
+      next_line
+      @new_string << " " * @indentation
+      @new_string << ";"
+    end
+
+    def next_line
+      @new_string << "\n"
+    end
+
+    #TODO Fix it more. Add _ONE_ set of indentation if there are newlines,
+    #TODO Not one set for every newline.
+    def add_property
+      buffer = "["
+      while true
+        next_bit = @stream.sysread(1)
+        next_bit << @stream.sysread(1) if next_bit == "\\"
+        buffer << next_bit
+        buffer << " " * @indentation if next_bit == "\n"
+        break if next_bit == "]"
+      end
+      buffer << "\n"
+      buffer << " " * @indentation
+      @new_string << buffer
+    end
+
+    def add_identity(char)
+      @new_string << char unless char == "\n"
+    end
+
+    private
+
+    def load_file_to_stream(file)
+      sgf = ""
+      File.open(file) { |f| sgf = f.read }
+      clean_string(sgf)
+      return StringIO.new(sgf, 'r')
+    end
+
+    def clean_string(sgf)
+      sgf.gsub! "\\\\n\\\\r", ""
+      sgf.gsub! "\\\\r\\\\n", ""
+      sgf.gsub! "\\\\r", ""
+      sgf.gsub! "\\\\n", ""
+    end    
+
+  end
+end
+
+
+
+

data/lib/sgf/{parser/node.rb → node.rb}

@@ -1,58 +1,62 @@
-module SgfParser
-
-  class Node
-
-    attr_accessor :parent, :children, :properties
-
-    # Creates a new node. Options which can be passed in are:
-    # :parent => parent_node (nil by default)
-    # : children => [list, of, children] (empty array by default)
-    # :properties => {hash_of => properties} (empty hash by default)
-    def initialize args={}
-      @parent = args[:parent]
-      @children = []
-      add_children args[:children] if !args[:children].nil?
-      @properties = Hash.new
-      @properties.merge! args[:properties] if !args[:properties].nil?
-    end
-
-    def add_children *nodes
-      nodes.flatten!
-      raise "Non-node child given!" if nodes.find { |node| node.class != Node }
-      # This node becomes the proud parent of one or more node!
-      nodes.each { |node| node.parent = self }
-      @children.concat nodes
-    end
-
-    def add_properties hash
-      hash.each do |key, value|
-        @properties[key] ||= ""
-        @properties[key].concat value
-      end
-    end
-
-    def each_child
-      @children.each { |child| yield child }
-    end
-
-    def == other_node
-      @properties == other_node.properties
-    end
-
-    def comments
-      @properties["C"]
-    end
-
-    alias :comment :comments
-
-    private
-
-    def method_missing method_name, *args
-      output = @properties[method_name.to_s.upcase]
-      super(method_name, args) if output.nil?
-      output
-    end
-
-  end
-
+module SGF
+
+  class Node
+
+    attr_accessor :parent, :children, :properties
+
+    # Creates a new node. Arguments which can be passed in are:
+    # :parent => parent_node (nil by default)
+    # :children => [list, of, children] (empty array by default)
+    # :properties => {hash_of => properties} (empty hash by default)
+    def initialize args={}
+      @parent = args[:parent]
+      @children = []
+      add_children args[:children] if args[:children]
+      @properties = Hash.new
+      @properties.merge! args[:properties] if args[:properties]
+    end
+
+    def add_children *nodes
+      nodes.flatten!
+      raise "Non-node child given!" if nodes.any? { |node| node.class != Node }
+      nodes.each { |node| node.parent = self }
+      @children.concat nodes
+    end
+
+    def add_properties hash
+      hash.each do |key, value|
+        @properties[key] ||= ""
+        @properties[key].concat value
+      end
+    end
+
+    def each_child
+      @children.each { |child| yield child }
+    end
+
+    def == other_node
+      @properties == other_node.properties
+    end
+
+    def comments
+      @properties["C"]
+    end
+
+    alias :comment :comments
+
+    private
+
+    def method_missing method_name, *args
+      property = method_name.to_s.upcase
+      if property[/(.*?)=$/]
+        @properties[$1] = args[0]
+      else
+        output = @properties[property]
+        super(method_name, args) if output.nil?
+        output
+      end
+    end
+
+  end
+
 end