SgfParser 1.0.0 → 2.0.0

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+doc
+pkg
+.bundle
+
+## PROJECT::SPECIFIC
+
+## Rubymine
+.idea/*

data/.rvmrc

@@ -1 +1 @@
-rvm 1.9.2@jrun
+rvm 1.9.3@sgfparser

data/Gemfile

@@ -1,13 +1,3 @@
-# A sample Gemfile
 source "http://rubygems.org"
 
-
-group :development do
-  gem "jeweler"
-  gem "rcov"
-  gem "rdoc"
-end
-
-group :test do
-  gem "rspec"
-end
+gemspec

data/Gemfile.lock

@@ -1,29 +1,32 @@
+PATH
+  remote: .
+  specs:
+    SgfParser (1.0.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      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)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    diff-lcs (1.1.3)
+    json (1.6.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
+    rspec-mocks (2.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler
+  SgfParser!
+  rake
   rcov
   rdoc
   rspec

data/README.rdoc

@@ -1,44 +1,18 @@
 =INFORMATION
-Author: Aldric Giacomoni
+Author: Aldric Giacomoni || Email : trevoke@gmail.com
 
-Email : aldric@at@trevoke.net (feedback very welcome!)
+Build status {<img src="https://secure.travis-ci.org/Trevoke/SGFParser.png" />}[http://travis-ci.org/Trevoke/SGFParser]
 
-SGF: all formats (but untested with FF < 4)
+Are you using this gem? Is there functionality you wish it had? Is something hard to do?
 
-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.
+Let me know and I'll make it possible, or easier!
 
-Most games will just care about, say,
- tree.root.children[0] which is the first node of the first gametree.
+SGF: FF4 - may support earlier ones as well, but untested.
 
-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.
+Ruby: >=1.8.7 (may work with 1.8.6)
 
-___
+WARNING: An implementation requirement is to make sure any closing bracket ']' inside a comment is escaped: '\\]'. If this is not done, you will be one sad panda! This library will do this for you upon saving, but will most likely die horribly when parsing anything which does not follow this rule.
 
-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
+I'm honestly hoping that this is and remains the fastest SGF parser in Ruby. On my desktop, loading the SGF library and parsing Kogo's Joseki dictionary takes a little under six seconds.
 
+Documentation available at the Github wiki: https://github.com/Trevoke/SGFParser/wiki

data/Rakefile

@@ -1,44 +1,105 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "SgfParser"
-    gem.summary = %Q{A library for working with SGF files.}
-    gem.description = %Q{SGFParser is a library that parses and saves SGF (Smart Game Format) files.}
-    gem.email = "aldric@trevoke.net"
-    gem.homepage = "http://github.com/Trevoke/SGFParser"
-    gem.authors = ["Aldric Giacomoni"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rspec/core/rake_task'
-desc 'Default: run specs.'
-task :default => :spec
-
-desc "Run specs"
-RSpec::Core::RakeTask.new do |spec|
-  spec.pattern = "./spec/**/*_spec.rb"
-end
-
-RSpec::Core::RakeTask.new(:coverage) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-  spec.rcov_opts = ['--exclude', 'spec']
-end
-
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "SgfParser #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rubygems'
+require 'rake'
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:coverage) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'spec']
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "SgfParser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Handle gem version"
+namespace 'version' do
+  desc "Bump major version number"
+  task "bump:major" do
+    bump :major
+  end
+  desc "Bump minor version number"
+  task "bump:minor" do
+    bump :minor
+  end
+  desc "Bump patch version number"
+  task "bump:patch" do
+    bump :patch
+  end
+  desc "write out a specified version (rake version:write[\"x.y.z\"])"
+  task "write", :version do |task, args|
+    change_version_to(args.version)
+  end
+end
+
+VERSION_ASSIGNMENT_REGEXP = /\A\s*?VERSION\s*?=\s*?['"](.*?)['"]\s*?\z/mx
+
+def bump bit_to_increment
+  change_version_to incremented_version(bit_to_increment)
+end
+
+def change_version_to(new_version)
+  File.open(version_file, 'w') { |f| f << new_version_file( new_version ) }
+  puts "New version is now #{new_version}"
+end
+
+def incremented_version bit_to_increment
+  version = {}
+  version[:major], version[:minor], version[:patch] = current_version.split('.')
+  version[bit_to_increment] = version[bit_to_increment].to_i + 1
+  "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
+end
+
+def new_version_file new_version
+  lines_of_version_file.map do |line|
+    is_line_with_version_assignment?(line) ? %Q{  VERSION = "#{new_version}"\n} : line
+  end.join
+end
+
+def current_version
+  array_of_value_versions = lines_of_version_file.grep(VERSION_ASSIGNMENT_REGEXP) { $1 }
+  raise_too_many_lines_matched if array_of_value_versions.size > 1
+  raise_no_lines_matched if array_of_value_versions.empty?
+  array_of_value_versions.first
+end
+
+def lines_of_version_file
+  @content_of_version_file ||= File.readlines(version_file)
+end
+
+def version_file
+  file_array = Dir['*/**/version.rb']
+  raise_too_many_files_found if file_array.size > 1
+  file_array.first
+end
+
+def is_line_with_version_assignment? line
+  !!(line[VERSION_ASSIGNMENT_REGEXP])
+end
+
+def raise_too_many_files_found
+  raise ArgumentError, "There are two files called version.rb and I do not know which one to use. Override the version_file method in your Rakefile and provide the correct path."
+end
+
+def raise_too_many_lines_matched
+  raise ArgumentError, "There are more than one line in version.rb which assign a value to VERSION. This is almost certainly a mistake. At the very least, I have no idea what I'm supposed to do. You must either increment the version manually in the file, or change the file so it only assigns VERSION once."
+end
+
+def raise_no_lines_matched
+  raise ArgumentError, "I did not find anything in the version file matching a version assignment."
+end

data/SgfParser.gemspec

@@ -1,73 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sgf/version"
 
 Gem::Specification.new do |s|
   s.name = %q{SgfParser}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.version = SGF::VERSION
   s.authors = ["Aldric Giacomoni"]
+  s.email = %q{trevoke@gmail.com}
+  s.homepage = %q{http://github.com/Trevoke/SGFParser}
   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.summary = %q{A library that parses and saves SGF (Smart Game Format) files.}
+  s.description = %q{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 :)}
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
   ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".rvmrc",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "SgfParser.gemspec",
-    "VERSION",
-    "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_spec.rb"
-  ]
-  s.homepage = %q{http://github.com/Trevoke/SGFParser}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{A library for working with SGF files.}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
 
-    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
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
 end
 

data/bin/sgf_indent.rb

@@ -0,0 +1,13 @@
+#Thankfully, whitespace doesn't matter in SGF, unless you're inside a comment.
+#This makes it possible to indent an SGF file and let it be somewhat human-readable.
+
+require '../lib/sgf'
+
+if ARGV.size != 2
+  puts "Usage:\n sgf_indent source.sgf destination.sgf"
+  exit
+end
+
+parser = SGF::Parser.new
+tree = parser.parse ARGV[0]
+tree.save ARGV[1]

data/examples/simple_iteration_of_games_in_a_directory.rb

@@ -0,0 +1,11 @@
+#Assuming you have the gem installed, of course
+require 'sgf'
+parser = SGF::Parser.new
+
+Dir['*.sgf'].each do |file|
+  tree = parser.parse File.read(file)
+  tree.games.each do |game|
+    puts "White player: #{game.white_player} and Black player: #{game.black_player}"
+  end
+  tree.save file #Because may as well indent the files while I'm here, right?
+end

data/lib/sgf.rb

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

data/lib/sgf/error.rb

@@ -0,0 +1,13 @@
+module SGF
+  class MalformedDataError < StandardError
+    # error raised by parser
+  end
+  class FormatNotSpecifiedWarning < StandardError
+    # Warning if FF is not in first node
+  end
+
+  class NoIdentityError < StandardError
+    # Error if the user tries to read an identity that doesn't exist
+  end
+
+end

data/lib/sgf/game.rb

@@ -0,0 +1,64 @@
+module SGF
+  class Game
+
+    include Enumerable
+
+    SGF::Game::PROPERTIES.each do |human_readable_method, sgf_identity|
+      define_method(human_readable_method.to_sym) do
+        @root[sgf_identity] ? @root[sgf_identity] : raise(SGF::NoIdentityError)
+      end
+    end
+
+    attr_accessor :current_node, :root
+
+    #Takes a SGF::Node as an argument. It will be a problem if that node isn't
+    #really the first node of of a game (ie: no FF property)
+    def initialize node
+      raise ArgumentError, "Expected SGF::Node argument but received #{node.class}" unless node.instance_of? SGF::Node
+      @root = node
+      @current_node = node
+    end
+
+    #A simple way to go to the next node in the same branch of the tree
+    def next_node
+      @current_node = @current_node.children[0]
+    end
+
+    #Iterate through all the nodes in preorder fashion
+    def each &block
+      preorder @root, &block
+    end
+
+    def node_count
+      count = 0
+      each { |node| count += 1 }
+      count
+    end
+
+    def to_s
+      "<SGF::Game:#{object_id}>"
+    end
+
+    alias :inspect :to_s
+
+    def to_str
+      SGF::Writer.new.stringify_tree_from @root
+    end
+
+    private
+
+    def method_missing method_name, *args
+      human_readable_identity = method_name.to_s.downcase
+      identity = SGF::Game::PROPERTIES[human_readable_identity]
+      return @root[identity] if identity
+      super(method_name, args)
+    end
+
+    def preorder node=@root, &block
+      yield node
+      node.each_child do |child|
+        preorder child, &block
+      end
+    end
+  end
+end