SgfParser 0.9.1 → 1.0.0

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

@@ -1,111 +1,120 @@
-require 'stringio'
-
-module SgfParser
-  class Tree
-
-    #private
-
-    def parse
-      while char = next_character
-        case char
-          when '(' then store_branch
-          when ')' then fetch_branch
-          when ';' then store_node_and_create_new_node
-          when '[' then get_and_store_property
-          else store_character(char)
-        end
-      end
-    end
-
-    def next_character
-      character_available? && @stream.sysread(1)
-    end
-
-    def character_available?
-      @stream ||= StringIO.new clean_string, 'r'
-      !@stream.eof?
-    end
-
-    def clean_string
-      @sgf.gsub! "\\\\n\\\\r", ""
-      @sgf.gsub! "\\\\r\\\\n", ""
-      @sgf.gsub! "\\\\r", ""
-      @sgf.gsub! "\\\\n", ""
-      @sgf
-    end    
-
-    def store_branch
-      @branches ||= []
-      @branches.unshift @current_node
-    end
-
-    def current_node
-      @current_node ||= @root
-    end    
-
-    def fetch_branch
-      @current_node = @branches.shift
-      clear_temporary_data
-    end
-
-    def store_node_and_create_new_node
-      parent = current_node
-      @current_node = Node.new :parent => parent
-      parent.add_properties content
-      parent.add_children @current_node
-      clear_temporary_data
-    end
-
-    def get_and_store_property
-      @content[@identity] ||= ""
-      @content[@identity] << get_property
-      @identity = ""
-    end
-
-    def get_property
-      buffer = ""
-      while char = next_character
-        case char
-          when "]" then break unless multiple_properties?
-          when "\\" then
-            char << next_character
-            char = "]" if char == "\\]"
-        end
-
-        buffer << char
-      end
-      "[#{buffer}]"
-    end
-
-    def multiple_properties?
-      multiple_properties = false
-      if char = next_character
-        char = next_character if char == "\n"
-        if char == "["
-          multiple_properties = true
-        end
-        @stream.pos -= 1
-        multiple_properties
-      end
-    end
-
-    def store_character(char)
-      @identity << char unless char == "\n"
-    end
-
-    def clear_temporary_data
-      @content.clear
-      @identity = ""
-    end
-
-    def content
-      @content ||= {}
-    end
-
-    def identity
-      @identity ||= ""      
-    end
-
-  end
-end
-
+require 'stringio'
+
+module SGF
+  class Parser
+
+    def initialize sgf
+      @sgf = stringified(sgf)
+      @tree = Tree.new sgf
+      @root = @tree.root
+    end
+
+    def stringified sgf
+      File.exist?(sgf) ? File.read(sgf) : sgf
+    end
+
+    def parse
+      while char = next_character
+        case char
+          when '(' then store_branch
+          when ')' then fetch_branch
+          when ';' then store_node_and_create_new_node
+          when '[' then get_and_store_property
+          else store_character(char)
+        end
+      end
+      @tree
+    end
+
+    def next_character
+      character_available? && @stream.sysread(1)
+    end
+
+    def character_available?
+      @stream ||= StringIO.new clean_string, 'r'
+      !@stream.eof?
+    end
+
+    def clean_string
+      @sgf.gsub! "\\\\n\\\\r", ""
+      @sgf.gsub! "\\\\r\\\\n", ""
+      @sgf.gsub! "\\\\r", ""
+      @sgf.gsub! "\\\\n", ""
+      @sgf
+    end    
+
+    def store_branch
+      @branches ||= []
+      @branches.unshift @current_node
+    end
+
+    def current_node
+      @current_node ||= @root
+    end    
+
+    def fetch_branch
+      @current_node = @branches.shift
+      clear_temporary_data
+    end
+
+    def store_node_and_create_new_node
+      parent = current_node
+      @current_node = Node.new :parent => parent
+      parent.add_properties content
+      parent.add_children @current_node
+      clear_temporary_data
+    end
+
+    def get_and_store_property
+      @content[@identity] ||= ""
+      @content[@identity] << get_property
+      @identity = ""
+    end
+
+    def get_property
+      buffer = ""
+      while char = next_character
+        case char
+          when "]" then break unless multiple_properties?
+          when "\\" then
+            char << next_character
+            char = "]" if char == "\\]"
+        end
+
+        buffer << char
+      end
+      "[#{buffer}]"
+    end
+
+    def multiple_properties?
+      multiple_properties = false
+      if char = next_character
+        char = next_character if char == "\n"
+        if char == "["
+          multiple_properties = true
+        end
+        @stream.pos -= 1
+        multiple_properties
+      end
+    end
+
+    def store_character(char)
+      @identity << char unless char == "\n"
+    end
+
+    def clear_temporary_data
+      @content.clear
+      @identity = ""
+    end
+
+    def content
+      @content ||= {}
+    end
+
+    def identity
+      @identity ||= ""      
+    end
+
+  end
+end
+

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

@@ -1,97 +1,97 @@
-# A parser for SGF Files. Main usage: SGF::Tree.new :filename => file_name
-module SgfParser
-
-#  http://www.red-bean.com/sgf/proplist.html
-
-# Here we define SGF::Properties, so we can figure out what each property
-# is and does.
-
-  property_string = %Q{AB   Add Black       setup            list of stone
-AE   Add Empty       setup            list of point
-AN   Annotation      game-info        simpletext
-AP  Application     root	      composed simpletext ':' simpletext
-AR  Arrow           -                list of composed point ':' point
-AS  Who adds stones - (LOA)          simpletext
-AW   Add White       setup            list of stone
-B    Black           move             move
-BL   Black time left move             real
-BM   Bad move        move             double
-BR   Black rank      game-info        simpletext
-BT   Black team      game-info        simpletext
-C    Comment         -                text
-CA  Charset         root	      simpletext
-CP   Copyright       game-info        simpletext
-CR   Circle          -                list of point
-DD  Dim points      - (inherit)      elist of point
-DM   Even position   -                double
-DO   Doubtful        move             none
-DT  Date            game-info        simpletext
-EV   Event           game-info        simpletext
-FF   Fileformat      root	      number (range: 1-4)
-FG  Figure          -                none | composed number ":" simpletext
-GB   Good for Black  -                double
-GC   Game comment    game-info        text
-GM   Game            root	      number (range: 1-5,7-16)
-GN   Game name       game-info        simpletext
-GW   Good for White  -                double
-HA   Handicap        game-info (Go)   number
-HO   Hotspot         -                double
-IP  Initial pos.    game-info (LOA)  simpletext
-IT   Interesting     move             none
-IY  Invert Y-axis   game-info (LOA)  simpletext
-KM   Komi            game-info (Go)   real
-KO   Ko              move             none
-LB  Label           -                list of composed point ':' simpletext
-LN  Line            -                list of composed point ':' point
-MA   Mark            -                list of point
-MN   set move number move             number
-N    Nodename        -                simpletext
-OB   OtStones Black  move             number
-ON   Opening         game-info        simpletext
-OT  Overtime        game-info        simpletext
-OW   OtStones White  move             number
-PB   Player Black    game-info        simpletext
-PC   Place           game-info        simpletext
-PL   Player to play  setup            color
-PM  Print move mode - (inherit)      number
-PW   Player White    game-info        simpletext
-RE  Result          game-info        simpletext
-RO   Round           game-info        simpletext
-RU  Rules           game-info        simpletext
-SE  Markup          - (LOA)          point
-SL   Selected        -                list of point
-SO   Source          game-info        simpletext
-SQ  Square          -                list of point
-ST  Style           root	      number (range: 0-3)
-SU  Setup type      game-info (LOA)  simpletext
-SZ  Size            root	      (number | composed number ':' number)
-TB   Territory Black - (Go)           elist of point
-TE   Tesuji          move             double
-TM   Timelimit       game-info        real
-TR   Triangle        -                list of point
-TW   Territory White - (Go)           elist of point
-UC   Unclear pos     -                double
-US   User            game-info        simpletext
-V    Value           -                real
-VW  View            - (inherit)      elist of point
-W    White           move             move
-WL   White time left move             real
-WR   White rank      game-info        simpletext
-WT   White team      game-info        simpletext }
-
-  property_array = property_string.split("\n")
-  hash = {}
-  property_array.each do |set|
-    temp = set.gsub("\t", "        ")
-    id = temp[0..3].strip
-    desc = temp[4..19].strip
-    property_type = temp[20..35].strip
-    property_value = temp[37..-1].strip
-    hash[id] = [desc, property_type, property_value]
-  end
-
-  # All this work for this minuscule line!
-  PROPERTIES = hash
-
-end
-
+# A parser for SGF Files. Main usage: SGF::Tree.new :filename => file_name
+module SgfParser
+
+#  http://www.red-bean.com/sgf/proplist.html
+
+# Here we define SGF::Properties, so we can figure out what each property
+# is and does.
+
+  property_string = %Q{AB   Add Black       setup            list of stone
+AE   Add Empty       setup            list of point
+AN   Annotation      game-info        simpletext
+AP  Application     root	      composed simpletext ':' simpletext
+AR  Arrow           -                list of composed point ':' point
+AS  Who adds stones - (LOA)          simpletext
+AW   Add White       setup            list of stone
+B    Black           move             move
+BL   Black time left move             real
+BM   Bad move        move             double
+BR   Black rank      game-info        simpletext
+BT   Black team      game-info        simpletext
+C    Comment         -                text
+CA  Charset         root	      simpletext
+CP   Copyright       game-info        simpletext
+CR   Circle          -                list of point
+DD  Dim points      - (inherit)      elist of point
+DM   Even position   -                double
+DO   Doubtful        move             none
+DT  Date            game-info        simpletext
+EV   Event           game-info        simpletext
+FF   Fileformat      root	      number (range: 1-4)
+FG  Figure          -                none | composed number ":" simpletext
+GB   Good for Black  -                double
+GC   Game comment    game-info        text
+GM   Game            root	      number (range: 1-5,7-16)
+GN   Game name       game-info        simpletext
+GW   Good for White  -                double
+HA   Handicap        game-info (Go)   number
+HO   Hotspot         -                double
+IP  Initial pos.    game-info (LOA)  simpletext
+IT   Interesting     move             none
+IY  Invert Y-axis   game-info (LOA)  simpletext
+KM   Komi            game-info (Go)   real
+KO   Ko              move             none
+LB  Label           -                list of composed point ':' simpletext
+LN  Line            -                list of composed point ':' point
+MA   Mark            -                list of point
+MN   set move number move             number
+N    Nodename        -                simpletext
+OB   OtStones Black  move             number
+ON   Opening         game-info        simpletext
+OT  Overtime        game-info        simpletext
+OW   OtStones White  move             number
+PB   Player Black    game-info        simpletext
+PC   Place           game-info        simpletext
+PL   Player to play  setup            color
+PM  Print move mode - (inherit)      number
+PW   Player White    game-info        simpletext
+RE  Result          game-info        simpletext
+RO   Round           game-info        simpletext
+RU  Rules           game-info        simpletext
+SE  Markup          - (LOA)          point
+SL   Selected        -                list of point
+SO   Source          game-info        simpletext
+SQ  Square          -                list of point
+ST  Style           root	      number (range: 0-3)
+SU  Setup type      game-info (LOA)  simpletext
+SZ  Size            root	      (number | composed number ':' number)
+TB   Territory Black - (Go)           elist of point
+TE   Tesuji          move             double
+TM   Timelimit       game-info        real
+TR   Triangle        -                list of point
+TW   Territory White - (Go)           elist of point
+UC   Unclear pos     -                double
+US   User            game-info        simpletext
+V    Value           -                real
+VW  View            - (inherit)      elist of point
+W    White           move             move
+WL   White time left move             real
+WR   White rank      game-info        simpletext
+WT   White team      game-info        simpletext }
+
+  property_array = property_string.split("\n")
+  hash = {}
+  property_array.each do |set|
+    temp = set.gsub("\t", "        ")
+    id = temp[0..3].strip
+    desc = temp[4..19].strip
+    property_type = temp[20..35].strip
+    property_value = temp[37..-1].strip
+    hash[id] = [desc, property_type, property_value]
+  end
+
+  # All this work for this minuscule line!
+  PROPERTIES = hash
+
+end
+

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

@@ -1,107 +1,91 @@
-module SgfParser
-
-  class Tree
-    include Enumerable
-
-    attr_accessor :root
-
-    def initialize args={}
-      @root = Node.new
-      @sgf = ""
-      raise ArgumentError, "Both file and string provided" if args[:filename] && args[:string]
-      if args[:filename]
-        load_file args[:filename]
-      elsif args[:string]
-        load_string args[:string]
-      end
-
-      parse unless @sgf.empty?
-    end
-
-    def each order=:preorder, &block
-      # I know, I know. SGF is only preorder. Well, it's implemented, ain't it?
-      # Stop complaining.
-      case order
-        when :preorder
-          preorder @root, &block
-      end
-    end
-
-    # Compares a tree to another tree, node by node.
-    # Nodes must be the same (same properties, parents and children).
-    def == other_tree
-      one = []
-      two = []
-      each { |node| one << node }
-      other_tree.each { |node| two << node }
-      one == two
-    end
-
-    # Saves the tree as an SGF file. raises an error if a filename is not given.
-    # tree.save :filename => file_name
-    def save args={}
-      raise ArgumentError, "No file name provided" if args[:filename].nil?
-      @savable_sgf = "("
-      @root.children.each { |child| write_node child }
-      @savable_sgf << ")"
-
-      File.open(args[:filename], 'w') { |f| f << @savable_sgf }
-    end
-
-    private
-
-    # Adds a stringified node to the variable @savable_sgf.
-    def write_node node=@root
-      @savable_sgf << ";"
-      unless node.properties.empty?
-        properties = ""
-        node.properties.each do |identity, property|
-          new_property = property[1...-1]
-          new_property.gsub!("]", "\\]") if identity == "C"
-          properties += "#{identity.to_s}[#{new_property}]"
-        end
-        @savable_sgf << properties
-      end
-
-      case node.children.size
-        when 0
-          @savable_sgf << ")"
-        when 1
-          write_node node.children[0]
-        else
-          node.each_child do |child|
-            @savable_sgf << "("
-            write_node child
-          end
-      end
-    end
-
-    def load_string string
-      @sgf = string
-    end
-
-    def load_file filename
-      File.open(filename, 'r') { |f| @sgf = f.read }
-    end 
-
-    # Traverse the tree in preorder fashion, starting with the @root node if
-    # no node is given, and activating the passed block on each.
-    def preorder node=@root, &block
-      # stop processing if the block returns false
-      if yield node then
-        node.each_child do |child|
-          preorder(child, &block)
-        end
-      end
-    end
-
-    def method_missing method_name, *args
-      output = @root.children[0].properties[method_name]
-      super(method_name, args) if output.nil?
-      output
-    end
-
-  end
-
-end
-
+module SGF
+
+  class Tree
+    include Enumerable
+
+    attr_accessor :root
+
+    def initialize sgf
+      @root = Node.new
+      @sgf = sgf
+    end
+
+    def each order=:preorder, &block
+      # I know, I know. SGF is only preorder. Well, it's implemented, ain't it?
+      # Stop complaining.
+      case order
+        when :preorder
+          preorder @root, &block
+      end
+    end
+
+    # Compares a tree to another tree, node by node.
+    # Nodes must be the same (same properties, parents and children).
+    def == other_tree
+      one = []
+      two = []
+      each { |node| one << node }
+      other_tree.each { |node| two << node }
+      one == two
+    end
+
+    # Saves the tree as an SGF file. raises an error if a filename is not given.
+    # tree.save :filename => file_name
+    def save args={}
+      raise ArgumentError, "No file name provided" if args[:filename].nil?
+      @savable_sgf = "("
+      @root.children.each { |child| write_node child }
+      @savable_sgf << ")"
+
+      File.open(args[:filename], 'w') { |f| f << @savable_sgf }
+    end
+
+    private
+
+    # Adds a stringified node to the variable @savable_sgf.
+    def write_node node=@root
+      @savable_sgf << ";"
+      unless node.properties.empty?
+        properties = ""
+        node.properties.each do |identity, property|
+          new_property = property[1...-1]
+          new_property.gsub!("]", "\\]") if identity == "C"
+          properties += "#{identity.to_s}[#{new_property}]"
+        end
+        @savable_sgf << properties
+      end
+
+      case node.children.size
+        when 0
+          @savable_sgf << ")"
+        when 1
+          write_node node.children[0]
+        else
+          node.each_child do |child|
+            @savable_sgf << "("
+            write_node child
+          end
+      end
+    end
+
+    # Traverse the tree in preorder fashion, starting with the @root node if
+    # no node is given, and activating the passed block on each.
+    def preorder node=@root, &block
+      # stop processing if the block returns false
+      if yield node then
+        node.each_child do |child|
+          preorder(child, &block)
+        end
+      end
+    end
+
+    def method_missing method_name, *args
+      output = @root.children[0].properties[method_name]
+      super(method_name, args) if output.nil?
+      output
+    end
+
+  end
+
+end
+