SgfParser 2.0.0 → 3.0.0

data/spec/spec_helper.rb

@@ -1,9 +1,86 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-require 'sgf'
+require_relative '../lib/sgf'
 require 'fileutils'
-require 'rspec'
-require 'rspec/autorun'
+require 'pry' if ENV['PRY']
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = ".spec-examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
 
 ONE_LINE_SIMPLE_SAMPLE_SGF= "(;FF[4]AP[Primiview:3.1]GM[1]SZ[19](;DD[kq:os][dq:hs]AR[aa:sc][sa:ac][aa:sa][aa:ac][cd:cj][gd:md][fh:ij][kj:nh]LN[pj:pd][nf:ff][ih:fj][kh:nj]C[Arrows, lines and dimmed points.])(;B[qd]N[Style & text type]))(;FF[4]AP[Primiview:3.1]GM[1]SZ[19])"
 
@@ -20,11 +97,15 @@ SIMPLIFIED_SAMPLE_SGF= <<EOF
 EOF
 
 def get_first_game_from file
-  tree = get_tree_from file
-  tree.games.first
+  collection = get_collection_from file
+  collection.gametrees.first
 end
 
-def get_tree_from file
+def get_collection_from file
   parser = SGF::Parser.new
   parser.parse File.read(file)
-end
+end
+
+def full_path_to_file(relative_file_path, starting_point:)
+  File.expand_path(File.join(File.dirname(starting_point), relative_file_path))
+end

data/spec/variation_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module SGF
+  RSpec.describe Variation do
+    subject { Variation.new }
+    it 'begins with a Node' do
+      expect(subject.root).to be_an_instance_of Node
+    end
+
+    it "accepts more nodes" do
+      subject.append Node.new
+      expect(subject.size).to eq 2
+    end
+  end
+end

data/spec/writer_spec.rb

@@ -1,12 +1,12 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "SGF::Writer" do
+RSpec.describe SGF::Writer do
+
+  let(:parser) { SGF::Parser.new }
 
   TEMP_FILE = 'spec/data/temp.sgf'
 
-  after :each do
-    FileUtils.rm_f TEMP_FILE
-  end
+  after { FileUtils.rm_f TEMP_FILE }
 
   it "should save a simple tree properly" do
     sgf = File.read('spec/data/simple.sgf')
@@ -32,17 +32,17 @@ describe "SGF::Writer" do
 
   it "should indent a simple SGF nicely" do
     sgf = save_to_temp_file_and_read '(;FF[4])'
-    sgf.should == "\n(\n  ;FF[4]\n)"
+    expect(sgf).to eq "\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)"
+    expect(sgf).to eq "\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)"
+    expect(sgf).to eq "\n(\n  ;FF[4]\n  ;PB[qq]\n)"
   end
 
   it "should indent branches further" do
@@ -58,7 +58,7 @@ describe "SGF::Writer" do
     ;PB[qa]
   )
 )}
-    sgf.should == expected
+    expect(sgf).to eq expected
   end
 
   it "should indent two gametrees" do
@@ -73,25 +73,26 @@ describe "SGF::Writer" do
   ;FF[4]
   ;PB[dd]
 )}
-    sgf.should == expected
+    expect(sgf).to eq 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
+    collection = parse_and_save string
+    collection2 = get_collection_from TEMP_FILE
+    expect(collection2).to eq collection
   end
 
+  def save_to_temp_file_and_read string
+    parse_and_save string
+    File.read TEMP_FILE
+  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
+  def parse_and_save string
+    collection = parser.parse string
+    collection.save TEMP_FILE
+    collection
   end
 
-end
+end

data/wercker.yml

@@ -0,0 +1,21 @@
+box: wercker/ruby
+# Build definition
+build:
+  # The steps that will be executed on build
+  steps:
+    # A step that executes `bundle install` command
+    - bundle-install 
+    
+    # A custom script step, name value is used in the UI
+    # and the code value contains the command that get executed
+    - script:
+        name: echo ruby information
+        code: |
+          echo "ruby version $(ruby --version) running"
+          echo "from location $(which ruby)"
+          echo -p "gem list: $(gem list)"
+    
+    # Add more steps here:
+    - script:
+        name: rspec
+        code: bundle exec rake spec

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SgfParser
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors:
 - Aldric Giacomoni
@@ -13,122 +12,161 @@ date: 2011-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &84169490 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *84169490
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &84169230 !ruby/object:Gem::Requirement
-    none: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *84169230
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &84168780 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *84168780
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &84168450 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *84168450
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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 :)
+  using an AG or some other auto-generated parser. It is therefore faster to use.
+  It also intends to be very object-oriented and hopefully will also be easier to
+  use.
 email: trevoke@gmail.com
 executables:
 - sgf_indent.rb
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.md
 files:
-- .document
-- .gitignore
-- .rspec
-- .rvmrc
+- ".autotest"
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - SgfParser.gemspec
 - bin/sgf_indent.rb
 - examples/simple_iteration_of_games_in_a_directory.rb
 - lib/sgf.rb
+- lib/sgf/collection.rb
+- lib/sgf/collection_assembler.rb
 - lib/sgf/error.rb
-- lib/sgf/game.rb
+- lib/sgf/error_checkers.rb
+- lib/sgf/gametree.rb
 - lib/sgf/node.rb
 - lib/sgf/parser.rb
+- lib/sgf/parsing_tokens.rb
 - lib/sgf/properties.rb
-- lib/sgf/tree.rb
+- lib/sgf/stream.rb
+- lib/sgf/variation.rb
 - lib/sgf/version.rb
 - lib/sgf/writer.rb
+- spec/acceptance_spec.rb
+- spec/collection_spec.rb
 - spec/data/example1.sgf
 - spec/data/ff4_ex.sgf
 - spec/data/redrose-tartrate.sgf
 - spec/data/simple.sgf
-- spec/game_spec.rb
+- spec/gametree_spec.rb
 - spec/node_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-- spec/tree_spec.rb
+- spec/variation_spec.rb
 - spec/writer_spec.rb
+- wercker.yml
 homepage: http://github.com/Trevoke/SGFParser
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A library that parses and saves SGF (Smart Game Format) files.
 test_files:
+- spec/acceptance_spec.rb
+- spec/collection_spec.rb
 - spec/data/example1.sgf
 - spec/data/ff4_ex.sgf
 - spec/data/redrose-tartrate.sgf
 - spec/data/simple.sgf
-- spec/game_spec.rb
+- spec/gametree_spec.rb
 - spec/node_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-- spec/tree_spec.rb
+- spec/variation_spec.rb
 - spec/writer_spec.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.3@sgfparser

data/README.rdoc

@@ -1,18 +0,0 @@
-=INFORMATION
-Author: Aldric Giacomoni || Email : trevoke@gmail.com
-
-Build status {<img src="https://secure.travis-ci.org/Trevoke/SGFParser.png" />}[http://travis-ci.org/Trevoke/SGFParser]
-
-Are you using this gem? Is there functionality you wish it had? Is something hard to do?
-
-Let me know and I'll make it possible, or easier!
-
-SGF: FF4 - may support earlier ones as well, but untested.
-
-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.
-
-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