SgfParser 1.0.0 → 2.0.0

data/spec/tree_spec.rb

@@ -1,29 +1,36 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "SgfParser::Tree" do
+describe "SGF::Tree" do
 
+  before :each do
+    @tree = get_tree_from 'spec/data/ff4_ex.sgf'
+  end
 
-  it "should load a file properly" do
-    tree = SGF::Parser.new('spec/data/ff4_ex.sgf').parse
-    tree.class.should == SGF::Tree
-    tree.root.children.size.should == 2
-    tree.root.children[0].children.size.should == 5
+  it "should have two gametrees" do
+    @tree.games.size.should == 2
   end
 
-  it "should save a simple tree properly" do
-    tree = SGF::Parser.new('spec/data/simple.sgf').parse
-    new_file = 'spec/data/simple_saved.sgf'
-    tree.save :filename => new_file
-    tree2 = SGF::Parser.new(new_file).parse
-    tree.should == tree2
+  it "should have a decent inspect" do
+    inspect = @tree.inspect
+    inspect.should match /SGF::Tree/
+    inspect.should match /#{@tree.object_id}/
+    inspect.should match /2 Games/
+    inspect.should match /62 Nodes/
   end
 
-  it "should save the sample SGF properly" do
-    tree = SGF::Parser.new('spec/data/ff4_ex.sgf').parse
-    new_file = 'spec/data/ff4_ex_saved.sgf'
-    tree.save :filename => new_file
-    tree2 = SGF::Parser.new(new_file).parse
-    tree2.should == tree
+  it "should use preorder traversal for each" do
+    @tree = get_tree_from 'spec/data/example1.sgf'
+    array = []
+    @tree.each {|node| array << node}
+    array[0].c.should == "root"
+    array[1].c.should == "a"
+    array[2].c.should == "b"
+  end
+
+  it "should load a file properly" do
+    @tree.class.should == SGF::Tree
+    @tree.root.children.size.should == 2
+    @tree.root.children[0].children.size.should == 5
   end
 
 end

data/spec/writer_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SGF::Writer" do
+
+  TEMP_FILE = 'spec/data/temp.sgf'
+
+  after :each do
+    FileUtils.rm_f TEMP_FILE
+  end
+
+  it "should save a simple tree properly" do
+    sgf = File.read('spec/data/simple.sgf')
+    parse_save_load_and_compare_to_saved sgf
+  end
+
+  it "should save an SGF with two gametrees properly" do
+    parse_save_load_and_compare_to_saved "(;FF[4])(;FF[4])"
+  end
+
+  it "should save the one-line simplified sample" do
+    parse_save_load_and_compare_to_saved ONE_LINE_SIMPLE_SAMPLE_SGF
+  end
+
+  it "should save the simplified SGF properly" do
+    parse_save_load_and_compare_to_saved SIMPLIFIED_SAMPLE_SGF
+  end
+
+  it "should save the sample SGF properly" do
+    sgf = File.read('spec/data/ff4_ex.sgf')
+    parse_save_load_and_compare_to_saved sgf
+  end
+
+  it "should indent a simple SGF nicely" do
+    sgf = save_to_temp_file_and_read '(;FF[4])'
+    sgf.should == "\n(\n  ;FF[4]\n)"
+  end
+
+  it "should indent a one-node SGF with two properties" do
+    sgf = save_to_temp_file_and_read '(;FF[4]PW[Cho Chikun])'
+    sgf.should == "\n(\n  ;FF[4]\n  PW[Cho Chikun]\n)"
+  end
+
+  it "should indent two nodes on same column" do
+    sgf = save_to_temp_file_and_read '(;FF[4];PB[qq])'
+    sgf.should == "\n(\n  ;FF[4]\n  ;PB[qq]\n)"
+  end
+
+  it "should indent branches further" do
+    string = '(;FF[4](;PB[qq])(;PB[qa]))'
+    sgf = save_to_temp_file_and_read string
+    expected = %Q{
+(
+  ;FF[4]
+  (
+    ;PB[qq]
+  )
+  (
+    ;PB[qa]
+  )
+)}
+    sgf.should == expected
+  end
+
+  it "should indent two gametrees" do
+    string = '(;FF[4];PB[qq])(;FF[4];PB[dd])'
+    sgf = save_to_temp_file_and_read string
+    expected = %Q{
+(
+  ;FF[4]
+  ;PB[qq]
+)
+(
+  ;FF[4]
+  ;PB[dd]
+)}
+    sgf.should == expected
+  end
+
+  private
+
+  def parse_save_load_and_compare_to_saved string
+    parser =SGF::Parser.new
+    tree = parser.parse string
+    tree.save TEMP_FILE
+    tree2 = get_tree_from TEMP_FILE
+    tree2.should == tree
+  end
+
+
+  def save_to_temp_file_and_read sgf_string
+    tree = SGF::Parser.new.parse sgf_string
+    tree.save TEMP_FILE
+    sgf = File.read TEMP_FILE
+    sgf
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SgfParser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-01 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &76820790 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &84169490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76820790
+  version_requirements: *84169490
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &76820540 !ruby/object:Gem::Requirement
+  requirement: &84169230 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76820540
+  version_requirements: *84169230
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &76820300 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &84168780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,28 +43,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76820300
+  version_requirements: *84168780
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &76820030 !ruby/object:Gem::Requirement
+  name: rdoc
+  requirement: &84168450 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76820030
-description: SGFParser is a library that parses and saves SGF (Smart Game Format)
-  files.
-email: aldric@trevoke.net
-executables: []
+  version_requirements: *84168450
+description: SGF::Parser does standard stream parsing of the SGF file, instead of
+  using an AG or some other auto-generated newfangled parser stuff. It is therefore
+  faster to use, and hopefully will also be easier to use. Feedback helps :)
+email: trevoke@gmail.com
+executables:
+- sgf_indent.rb
 extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
 - .document
+- .gitignore
 - .rspec
 - .rvmrc
 - Gemfile
@@ -74,24 +76,27 @@ files:
 - README.rdoc
 - Rakefile
 - SgfParser.gemspec
-- VERSION
+- bin/sgf_indent.rb
+- examples/simple_iteration_of_games_in_a_directory.rb
 - lib/sgf.rb
-- lib/sgf/indenter.rb
+- lib/sgf/error.rb
+- lib/sgf/game.rb
 - lib/sgf/node.rb
 - lib/sgf/parser.rb
 - lib/sgf/properties.rb
 - lib/sgf/tree.rb
-- sample_usage/parsing_files.rb
+- lib/sgf/version.rb
+- lib/sgf/writer.rb
+- spec/data/example1.sgf
 - 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/game_spec.rb
 - spec/node_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
 - spec/tree_spec.rb
-has_rdoc: true
+- spec/writer_spec.rb
 homepage: http://github.com/Trevoke/SGFParser
 licenses: []
 post_install_message: 
@@ -112,8 +117,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A library for working with SGF files.
-test_files: []
+summary: A library that parses and saves SGF (Smart Game Format) files.
+test_files:
+- spec/data/example1.sgf
+- spec/data/ff4_ex.sgf
+- spec/data/redrose-tartrate.sgf
+- spec/data/simple.sgf
+- spec/game_spec.rb
+- spec/node_spec.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+- spec/tree_spec.rb
+- spec/writer_spec.rb

data/VERSION

@@ -1 +0,0 @@
-1.0.0

data/lib/sgf/indenter.rb

@@ -1,108 +0,0 @@
-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/sample_usage/parsing_files.rb

@@ -1,19 +0,0 @@
-# With this code, we will display info on all files within a directory:
-# "Black_player-White_player.sgf"
-
-require '../lib/sgf_parser'
-
-
-Dir.glob('../data/*').each do |file|
-  next if File.directory? file # Let's not touch directories.
-  next if File.extname(file) != ".sgf" # If it's not an SGF file, let's not touch it.
-  sgf = SgfParser::Tree.new :filename => file
-  # The "root" is an empty node, always, so we can support SGF collections painlessly:
-  # Whole trees simply become branches from the root.
-
-  black = sgf.root.children[0].PB rescue "Black" # Alright, so this isn't particularly elegant.
-  white = sgf.root.children[0].PW rescue "White" # It's a work in progress !
-
-  puts "#{black}-#{white}.sgf"
-
-end

data/spec/data/ff4_ex_saved.sgf

@@ -1,45 +0,0 @@
-(;FF[4]AP[Primiview:3.1]GM[1]SZ[19]GN[Gametree 1: properties]US[Arno Hollosi](;B[pd]N[Moves, comments, annotations]C[Nodename set to: "Moves, comments, annotations"];W[dp]GW[1]C[Marked as "Good for White"];B[pp]GB[2]C[Marked as "Very good for Black"];W[dc]GW[2]C[Marked as "Very good for White"];B[pj]DM[1]C[Marked as "Even position"];W[ci]UC[1]C[Marked as "Unclear position"];B[jd]TE[1]C[Marked as "Tesuji" or "Good move"];W[jp]BM[2]C[Marked as "Very bad move"];B[gd]DO[]C[Marked as "Doubtful move"];W[de]IT[]C[Marked as "Interesting move"];B[jj];C[White "Pass" move]W[];)(;AB[dd][de][df][dg][do:gq]  AW[jd][je][jf][jg][kn:lq][pn:pq]N[Setup]C[Black & white stones at the top are added as single stones.
-
-Black & white stones at the bottom are added using compressed point lists.];AE[ep][fp][kn][lo][lq][pn:pq]C[AddEmpty
-
-Black stones & stones of left white group are erased in FF[3\] way.
-
-White stones at bottom right were erased using compressed point list.];AB[pd]AW[pp]PL[B]C[Added two stones.
-
-Node marked with "Black to play".];)(;AB[dd][de][df][dg][dh][di][dj][nj][ni][nh][nf][ne][nd][ij][ii][ih][hq][gq][fq][eq][dr][ds][dq][dp][cp][bp][ap][iq][ir][is][bo][bn][an][ms][mr]AW[pd][pe][pf][pg][ph][pi][pj][fd][fe][ff][fh][fi][fj][kh][ki][kj][os][or][oq][op][pp][qp][rp][sp][ro][rn][sn][nq][mq][lq][kq][kr][ks][fs][gs][gr][er]N[Markup]C[Position set up without compressed point lists.];TR[dd][de][df][ed][ee][ef][fd:ff] MA[dh][di][dj][ej][ei][eh][fh:fj] CR[nd][ne][nf][od][oe][of][pd:pf] SQ[nh][ni][nj][oh][oi][oj][ph:pj] SL[ih][ii][ij][jj][ji][jh][kh:kj] TW[pq:ss][so][lr:ns] TB[aq:cs][er:hs][ao]C[Markup at top partially using compressed point lists (for markup on white stones); listed clockwise, starting at upper left:
-- TR (triangle)
-- CR (circle)
-- SQ (square)
-- SL (selected points)
-- MA ('X')
-
-Markup at bottom: black & white territory (using compressed point lists)];LB[dc:1][fc:2][nc:3][pc:4][dj:a][fj:b][nj:c][pj:d][gs:ABCDEFGH][gr:ABCDEFG][gq:ABCDEF][gp:ABCDE][go:ABCD][gn:ABC][gm:AB][mm:12][mn:123][mo:1234][mp:12345][mq:123456][mr:1234567][ms:12345678]C[Label (LB property)
-
-Top: 8 single char labels (1-4, a-d)
-
-Bottom: Labels up to 8 char length.];)(;B[qd]N[Style & text type]C[There are hard linebreaks & soft linebreaks.
-Soft linebreaks are linebreaks preceeded by '\\' like this one >o\
-k<. Hard line breaks are all other linebreaks.
-Soft linebreaks are converted to >nothing<, i.e. removed.
-
-Note that linebreaks are coded differently on different systems.
-
-Examples (>ok< shouldn't be split):
-
-linebreak 1 "": >o\
-k<
-linebreak 2 "": >o\
-
-linebreak 3 "": >o\
-k<
-linebreak 4 "": >o\
-Black stones left (in this byo-yomi period): 10];W[qq]WL[200]OW[2]C[White time left: 200 sec
-White stones left: 2];B[sr]BL[87.00]OB[9]C[Black time left: 87 sec
-Black stones left: 9];W[qs]WL[13.20]OW[1]C[White time left: 13.2 sec
-White stones left: 1];B[rs]C[One white stone at s2 captured];W[ps];B[pr];W[or]MN[2]C[Set move number to 2];B[os]C[Two white stones captured
-(at q1 & r1)];MN[112]W[pq]C[Set move number to 112];B[sq];W[rp];B[ps];W[ns];B[ss];W[nr];B[rr];W[sp];);FF[4]AP[Primiview:3.1]GM[1]SZ[19]C[Gametree 2: game-info
-
-Game-info properties are usually stored in the root node.
-If games are merged into a single game-tree, they are stored in the node\
- where the game first becomes distinguishable from all other games in\
- the tree.];B[pd](;)(;)(;W[ep];B[pp](;)(;))