SgfParser 2.0.0 → 3.0.0

data/lib/sgf/parsing_tokens.rb

@@ -0,0 +1,40 @@
+class SGF::IdentityToken
+  def still_inside? char, token_so_far, sgf_stream
+    char != "["
+  end
+
+  def transform token
+    token.gsub "\n", ""
+  end
+end
+
+class SGF::CommentToken
+  def still_inside? char, token_so_far, sgf_stream
+    char != "]" || (char == "]" && token_so_far[-1..-1] == "\\")
+  end
+
+  def transform token
+    token.gsub "\\]", "]"
+  end
+end
+
+class SGF::MultiPropertyToken
+  def still_inside? char, token_so_far, sgf_stream
+    return true if char != "]"
+    sgf_stream.peek_skipping_whitespace == "["
+  end
+
+  def transform token
+    token.gsub("][", ",").split(",")
+  end
+end
+
+class SGF::GenericPropertyToken
+  def still_inside? char, token_so_far, sgf_stream
+    char != "]"
+  end
+
+  def transform token
+    token
+  end
+end

data/lib/sgf/properties.rb

@@ -1,90 +1,87 @@
 module SGF
-
-#  http://www.red-bean.com/sgf/proplist.html
-
-  class Game
-
-    PROPERTIES = {"annotator"=>"AN",
-                  "black_octisquares"=>"BO", #Octi
-                  "black_rank"=>"BR",
-                  "black_team"=>"BT",
-                  "copyright"=>"CP",
-                  "date"=>"DT",
-                  "event"=>"EV",
-                  "game_content"=>"GC",
-                  "handicap"=>"HA", #Go
-                  "initial_position"=>"IP", #Lines of Action
-                  "invert_y_axis"=>"IY", #Lines of Action
-                  "komi"=>"KM", #Go
-                  "match_information"=>"MI", #Backgammon
-                  "name"=>"GN",
-                  "prongs"=>"NP", #Octi
-                  "reserve"=>"NR", #Octi
-                  "superprongs"=>"NS", #Octi
-                  "opening"=>"ON",
-                  "overtime"=>"OT",
-                  "black_player"=>"PB",
-                  "place"=>"PC",
-                  "puzzle"=>"PZ",
-                  "white_player"=>"PW",
-                  "result"=>"RE",
-                  "round"=>"RO",
-                  "rules"=>"RU",
-                  "setup_type"=>"SU", #Lines of Action
-                  "source"=>"SO",
-                  "time"=>"TM",
-                  "data_entry"=>"US",
-                  "white_octisquares"=>"WO", #Octi
-                  "white_rank"=>"WR",
-                  "white_team"=>"WT"}
+  #  http://www.red-bean.com/sgf/proplist.html
+  class Gametree
+    PROPERTIES = {
+                  annotator:         "AN",
+                  black_octisquares: "BO", # Octi
+                  black_rank:        "BR",
+                  black_team:        "BT",
+                  copyright:         "CP",
+                  date:              "DT",
+                  event:             "EV",
+                  game_content:      "GC",
+                  handicap:          "HA", # Go
+                  initial_position:  "IP", # Lines of Action
+                  invert_y_axis:     "IY", # Lines of Action
+                  komi:              "KM", # Go
+                  match_information: "MI", # Backgammon
+                  name:              "GN",
+                  prongs:            "NP", # Octi
+                  reserve:           "NR", # Octi
+                  superprongs:       "NS", # Octi
+                  opening:           "ON",
+                  overtime:          "OT",
+                  black_player:      "PB",
+                  place:             "PC",
+                  puzzle:            "PZ",
+                  white_player:      "PW",
+                  result:            "RE",
+                  round:             "RO",
+                  rules:             "RU",
+                  setup_type:        "SU", # Lines of Action
+                  source:            "SO",
+                  time:              "TM",
+                  data_entry:        "US",
+                  white_octisquares: "WO", # Octi
+                  white_rank:        "WR",
+                  white_team:        "WT"
+                 }
   end
 
   class Node
     PROPERTIES = {
-        "black_move" => "B",
-        "black_time_left" => "BL",
-        "bad_move" => "BM",
-        "doubtful" => "DO",
-        "interesting" => "IT",
-        "ko" => "KO",
-        "set_move_number" => "MN",
-        "otstones_black" => "OB", # What?
-        "otstones_white" => "OW", # Again! What?
-        "tesuji" => "TE",
-        "white_move" => "W",
-        "white_time_left" => "WL",
-        "add_black" => "AB",
-        "add_empty" => "AE",
-        "add_white" => "AW",
-        "player" => "PL",
-        "arrow" => "AR",
-        "comment" => "C",
-        "circle" => "CR",
-        "dim_points" => "DD",
-        "even_position" => "DM", #Yep. No idea how that makes sense.
-        "figure" => "FG",
-        "good_for_black" => "GB",
-        "good_for_white" => "GW",
-        "hotspot" => "HO",
-        "label" => "LB",
-        "line" => "LN",
-        "mark" => "MA",
-        "node_name" => "N",
-        "print_move_node" => "PM", #Am I going to have to code this?
-        "selected" => "SL",
-        "square" => "SQ",
-        "triangle" => "TR",
-        "unclear_position" => "UC",
-        "value" => "V",
-        "view" => "VW",
-        "application" => "AP",
-        "charset" => "CA",
-        "file_format" => "FF",
-        "game" => "GM",
-        "style" => "ST",
-        "size" => "SZ"
-    }
+                  black_move:       "B",
+                  black_time_left:  "BL",
+                  bad_move:         "BM",
+                  doubtful:         "DO",
+                  interesting:      "IT",
+                  ko:               "KO",
+                  set_move_number:  "MN",
+                  otstones_black:   "OB",
+                  otstones_white:   "OW",
+                  tesuji:           "TE",
+                  white_move:       "W",
+                  white_time_left:  "WL",
+                  add_black:        "AB",
+                  add_empty:        "AE",
+                  add_white:        "AW",
+                  player:           "PL",
+                  arrow:            "AR",
+                  comment:          "C",
+                  circle:           "CR",
+                  dim_points:       "DD",
+                  even_position:    "DM", # Yep. No idea how that makes sense.
+                  figure:           "FG",
+                  good_for_black:   "GB",
+                  good_for_white:   "GW",
+                  hotspot:          "HO",
+                  label:            "LB",
+                  line:             "LN",
+                  mark:             "MA",
+                  node_name:        "N",
+                  print_move_node:  "PM", # Am I going to have to code this?
+                  selected:         "SL",
+                  square:           "SQ",
+                  triangle:         "TR",
+                  unclear_position: "UC",
+                  value:            "V",
+                  view:             "VW",
+                  application:      "AP",
+                  charset:          "CA",
+                  file_format:      "FF",
+                  game:             "GM",
+                  style:            "ST",
+                  size:             "SZ"
+                 }
   end
-
 end
-

data/lib/sgf/stream.rb

@@ -0,0 +1,50 @@
+require 'stringio'
+
+class SGF::Stream
+  attr_reader :stream
+
+  def initialize sgf, error_checker
+    sgf = sgf.read if sgf.instance_of?(File)
+    sgf = File.read(sgf) if File.exist?(sgf)
+    error_checker.check_for_errors_before_parsing sgf
+    @stream = StringIO.new clean(sgf), 'r'
+  end
+
+  def eof?
+    stream.eof?
+  end
+
+  def next_character
+    !stream.eof? && stream.sysread(1)
+  end
+
+  def read_token format
+    property = ""
+    while char = next_character and format.still_inside? char, property, self
+      property << char
+    end
+    format.transform property
+  end
+
+  def peek_skipping_whitespace
+    while char = next_character
+      next if char[/\s/]
+      break
+    end
+    rewind if char
+    char
+  end
+
+  private
+
+  def rewind
+    stream.pos -= 1
+  end
+
+  def clean sgf
+    sgf.gsub("\\\\n\\\\r", '')
+    .gsub("\\\\r\\\\n", '')
+    .gsub("\\\\r", '')
+    .gsub("\\\\n", '')
+  end
+end

data/lib/sgf/variation.rb

@@ -0,0 +1,16 @@
+class SGF::Variation
+  attr_reader :root
+  def initialize
+    @root = SGF::Node.new
+    @size = 1
+  end
+
+  def append node
+    @root.add_children node
+    @size += 1
+  end
+
+  def size
+    @size
+  end
+end

data/lib/sgf/version.rb

@@ -1,3 +1,3 @@
 module SGF
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/lib/sgf/writer.rb

@@ -1,54 +1,52 @@
-module SGF
-  class Writer
+class SGF::Writer
+  # Takes a node and a filename as arguments
+  def save(root_node, filename)
+    #TODO - accept any I/O object?
+    stringify_tree_from root_node
+    File.open(filename, 'w') { |f| f << @sgf }
+  end
 
   def stringify_tree_from root_node
     @indentation = 0
     @sgf = ""
     write_new_branch_from root_node
+    @sgf
   end
 
-    # Takes a node and a filename as arguments
-    def save(root_node, filename)
-      stringify_tree_from root_node
+  private
 
-      File.open(filename, 'w') { |f| f << @sgf }
+  def write_new_branch_from node
+    node.each_child do |child_node|
+      open_branch
+      write_tree_from child_node
+      close_branch
     end
+  end
 
-    private
-
-    def write_tree_from node
-      @sgf << "\n" << node.to_str(@indentation)
-      decide_what_comes_after node
-    end
+  def write_tree_from node
+    @sgf << "\n" << node.to_s(@indentation)
+    decide_what_comes_after node
+  end
 
-    def decide_what_comes_after node
-      if node.children.size == 1
+  def decide_what_comes_after node
+    if node.children.size == 1
       then write_tree_from node.children[0]
-      else write_new_branch_from node
-      end
-    end
-
-    def write_new_branch_from node
-      node.each_child do |child_node|
-        open_branch
-        write_tree_from child_node
-        close_branch
-      end
+    else write_new_branch_from node
     end
+  end
 
-    def open_branch
-      @sgf << "\n" << whitespace << "("
-      @indentation += 2
-    end
+  def open_branch
+    @sgf << "\n" << whitespace << "("
+    @indentation += 2
+  end
 
-    def close_branch
-      @indentation -= 2
-      @indentation = (@indentation < 0) ? 0 : @indentation
-      @sgf << "\n" << whitespace << ")"
-    end
+  def close_branch
+    @indentation -= 2
+    @indentation = (@indentation < 0) ? 0 : @indentation
+    @sgf << "\n" << whitespace << ")"
+  end
 
-    def whitespace
-      " " * @indentation
-    end
+  def whitespace
+    " " * @indentation
   end
-end
+end

data/spec/acceptance_spec.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+require_relative '../lib/sgf'
+
+RSpec.describe 'End To End' do
+  let(:new_file) { full_path_to_file('./simple_changed.sgf', starting_point: __FILE__) }
+
+  after do
+    File.delete(new_file) if File.exist?(new_file)
+  end
+
+  it 'should modify an object and save the changes' do
+    collection = SGF.parse(full_path_to_file('./data/simple.sgf', starting_point: __FILE__))
+    game = collection.gametrees.first
+    game.current_node[:PB] = 'kokolegorille'
+
+    expect(game.current_node[:PB]).to eq 'kokolegorille'
+    collection.save(new_file)
+    expect(game.current_node[:PB]).to eq 'kokolegorille'
+    expect(SGF.parse(new_file).gametrees.first.current_node[:PB]).to eq 'kokolegorille'
+  end
+
+  it 'throws an error if asked to open a non-existing file'do
+    expect do
+      SGF.parse('some_file.sgf')
+    end.to raise_error(SGF::FileDoesNotExistError)
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+RSpec.describe SGF::Collection do
+
+  let(:collection) { get_collection_from 'spec/data/ff4_ex.sgf' }
+  subject { collection }
+
+  it "has two games" do
+    expect(subject.gametrees.size).to eq 2
+  end
+
+  context 'on the gametree level' do
+    subject { collection.root }
+    it "should have two children" do
+      expect(subject.children.size).to eq 2
+    end
+
+    context 'in the first gametree' do
+      subject { collection.root.children[0] }
+      it "should have five children" do
+        expect(subject.children.size).to eq 5
+      end
+    end
+  end
+
+  context "inspect" do
+    subject { collection.inspect }
+    it { is_expected.to match(/SGF::Collection/) }
+    it { is_expected.to match(/#{collection.object_id}/) }
+    it { is_expected.to match(/2 Games/) }
+    it { is_expected.to match(/62 Nodes/) }
+  end
+
+  it "should use preorder traversal for each" do
+    collection = get_collection_from 'spec/data/example1.sgf'
+    array = []
+    collection.each { |node| array << node }
+    expect(array[0].c).to eq "root"
+    expect(array[1].c).to eq "a"
+    expect(array[2].c).to eq "b"
+  end
+
+  it "should properly compare two collections" do
+    new_collection = get_collection_from 'spec/data/ff4_ex.sgf'
+    expect(collection).to eq new_collection
+  end
+
+  context "gametrees" do
+    it "always returns the same objects for the same gametrees" do
+      expect(subject.gametrees).to eq subject.gametrees
+    end
+
+    it "knows if you've added a new gametree" do
+      expect do
+        subject << SGF::Gametree.new(SGF::Node.new)
+      end.to change { subject.gametrees.count }.by(1)
+    end
+  end
+
+  it "barfs if you try to add a non-gametree object" do
+    expect do
+      subject << Object.new
+    end.to raise_error(ArgumentError)
+  end
+end