pgn 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0a443bf7faed2df357231993215ff3573ec0aa5
-  data.tar.gz: 270e148b8e7058f6de567e5109e3dbf701327515
+  metadata.gz: 70f3a7855b4d29274f4393cdc84bac75792dad94
+  data.tar.gz: 191c65ca1e5f3d7067629d2c167bdcfd495d8885
 SHA512:
-  metadata.gz: 44a48cabb57cb8de5b753b5d6475fda1c9820ce82f3bb088a62cce1c90ff274b67373d7189d8b7f67855e3e7c25c8880a53eb669878d8e94fa350d9cfa57ddef
-  data.tar.gz: c3c1609f08f1d0da32a27799e02deb1a4c4e3e56437bc71b9a4e3249ea68a1d04198d36216f2d9fea30ea4815e7a5a17c5ed616b81b15390c09f76417ea1fef7
+  metadata.gz: 475172b8b7b9b84031b0de1fc4010b5b63250ae586d1bc018e2d5e5bd59ffbc530f369989bea9406169d3f94be93ff67d0be88d1dcb535a28398538cb4e0d96e
+  data.tar.gz: 78cc6d760518aaad4b0fa1a0d758199a037c29dd17877583eefaa6242f831c4f55c91d41750a8dfea2454cb73b5c264770edabb6c2775fe1a65a95523b534f28

data/README.md

@@ -20,21 +20,21 @@ or right arrow to move forward. `q` or `^C` quits play mode.
 
     ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
     ♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
+    _ _ _ _ _ _ _ _
+    _ _ _ _ _ _ _ _
+    _ _ _ _ _ _ _ _
+    _ _ _ _ _ _ _ _
     ♙ ♙ ♙ ♙ ♙ ♙ ♙ ♙
     ♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖
 
     ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
     ♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ♙ ＿ ＿ ＿
-    ＿ ＿ ＿ ＿ ＿ ＿ ＿ ＿
-    ♙ ♙ ♙ ♙ ＿ ♙ ♙ ♙
+    _ _ _ _ _ _ _ _
+    _ _ _ _ _ _ _ _
+    _ _ _ _ _ _ _ _
+    _ _ _ _ ♙ _ _ _
+    _ _ _ _ _ _ _ _
+    ♙ ♙ ♙ ♙ _ ♙ ♙ ♙
     ♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖
 
     ...
@@ -44,14 +44,14 @@ You can also access all of the information about a game.
 ```
 > game.positions.last
 =>
-♜ ＿ ♝ ♚ ＿ ＿ ＿ ♜
-♟ ＿ ＿ ♟ ♗ ♟ ♘ ♟
-♞ ＿ ＿ ＿ ＿ ♞ ＿ ＿
-＿ ♟ ＿ ♘ ♙ ＿ ＿ ♙
-＿ ＿ ＿ ＿ ＿ ＿ ♙ ＿
-＿ ＿ ＿ ♙ ＿ ＿ ＿ ＿
-♙ ＿ ♙ ＿ ♔ ＿ ＿ ＿
-♛ ＿ ＿ ＿ ＿ ＿ ♝ ＿
+♜ _ ♝ ♚ _ _ _ ♜
+♟ _ _ ♟ ♗ ♟ ♘ ♟
+♞ _ _ _ _ ♞ _ _
+_ ♟ _ ♘ ♙ _ _ ♙
+_ _ _ _ _ _ ♙ _
+_ _ _ ♙ _ _ _ _
+♙ _ ♙ _ ♔ _ _ _
+♛ _ _ _ _ _ ♝ _
 
 > game.positions.last.to_fen
 => r1bk3r/p2pBpNp/n4n2/1p1NP2P/6P1/3P4/P1P1K3/q5b1 b - - 1 22
@@ -86,14 +86,14 @@ position. It is easy to convert between FEN strings and chess positions.
 > fen = PGN::FEN.new("r1bk3r/p2pBpNp/n4n2/1p1NP2P/6P1/3P4/P1P1K3/q5b1 b - - 1 22")
 > position = fen.to_position
 =>
-♜ ＿ ♝ ♚ ＿ ＿ ＿ ♜
-♟ ＿ ＿ ♟ ♗ ♟ ♘ ♟
-♞ ＿ ＿ ＿ ＿ ♞ ＿ ＿
-＿ ♟ ＿ ♘ ♙ ＿ ＿ ♙
-＿ ＿ ＿ ＿ ＿ ＿ ♙ ＿
-＿ ＿ ＿ ♙ ＿ ＿ ＿ ＿
-♙ ＿ ♙ ＿ ♔ ＿ ＿ ＿
-♛ ＿ ＿ ＿ ＿ ＿ ♝ ＿
+♜ _ ♝ ♚ _ _ _ ♜
+♟ _ _ ♟ ♗ ♟ ♘ ♟
+♞ _ _ _ _ ♞ _ _
+_ ♟ _ ♘ ♙ _ _ ♙
+_ _ _ _ _ _ ♙ _
+_ _ _ ♙ _ _ _ _
+♙ _ ♙ _ ♔ _ _ _
+♛ _ _ _ _ _ ♝ _
 
 > position.to_fen
 => r1bk3r/p2pBpNp/n4n2/1p1NP2P/6P1/3P4/P1P1K3/q5b1 b - - 1 22

data/lib/pgn/game.rb

@@ -1,6 +1,32 @@
 require 'io/console'
 
 module PGN
+  class MoveText
+    attr_accessor :notation, :annotation, :comment, :variations
+    
+    def initialize(notation, annotation = nil, comment = nil, variations = nil)
+      @notation = notation
+      @annotation = annotation
+      @comment = comment
+      @variations = variations
+    end
+    
+    def ==(m)
+      self.to_s == m.to_s
+    end
+    
+    def eql?(m)
+      self == m
+    end
+    
+    def hash
+      @notation.hash
+    end
+    
+    def to_s
+      @notation
+    end
+  end
   # {PGN::Game} holds all of the information about a game. It is either
   # the result of parsing a PGN file, or created by hand.
   #
@@ -45,7 +71,13 @@ module PGN
     # Standardize castling moves to use O's instead of 0's
     #
     def moves=(moves)
-      @moves = moves.map {|m| m.gsub("0", "O") }
+      @moves = moves.map do |m|
+        if m.is_a? String
+          MoveText.new(m.gsub("0", "O"))
+        else
+          MoveText.new(m.notation.gsub("0", "O"), m.annotation, m.comment, m.variations)
+        end
+      end
     end
 
     # @return [Array<PGN::Position>] list of the {PGN::Position}s in the game
@@ -55,7 +87,7 @@ module PGN
         position = PGN::Position.start
         arr = [position]
         self.moves.each do |move|
-          new_pos = position.move(move)
+          new_pos = position.move(move.notation)
           arr << new_pos
           position = new_pos
         end

data/lib/pgn/move_calculator.rb

@@ -116,6 +116,11 @@ module PGN
 
       restrict = "KQ" if ['K', 'Q'].include? move.castle
       restrict = "kq" if ['k', 'q'].include? move.castle
+      
+      restrict += 'Q' if self.move.destination == 'a1' && !restrict.include?('Q')
+      restrict += 'q' if self.move.destination == 'a8' && !restrict.include?('q')
+      restrict += 'K' if self.move.destination == 'h1' && !restrict.include?('K')
+      restrict += 'k' if self.move.destination == 'h8' && !restrict.include?('k')
 
       restrict ||= ''
 

data/lib/pgn/parser.rb

@@ -49,9 +49,34 @@ module PGN
 
     rule(:element) do |r|
       r[:move_number_indication].as { nil }
-      r[:san_move]
-      #r[:numeric_annotation_glyph]
+      r[:san_move_annotated]
+      r[:san_move_annotated, :variation_list].as do |move, variations|
+        move.variations = variations
+        move
+      end
+      r[:comment].as { nil }
     end
+    
+    rule(:san_move_annotated) do |r|
+      r[:san_move].as { |move| MoveText.new(move) }
+      r[:san_move, :comment].as { |move, comment| MoveText.new(move, nil, comment) }
+      r[:san_move, :numeric_annotation_glyph].as { |move, annotation| MoveText.new(move, annotation) }
+      r[:san_move, :numeric_annotation_glyph, :comment].as { |move, annotation, comment| MoveText.new(move, annotation, comment) }
+    end
+
+    rule(:variation_list) do |r|
+        r[:variation, :variation_list].as { |variation, sequence| sequence << variation }
+        r[:variation].as { |v| [v] }
+    end
+    
+    rule(:variation) do |r|
+      r["(", :element_sequence, ")"].as { |_, sequence, _| sequence }
+    end
+
+#     rule(:variation_sequence) do |r|
+#       r[:element, :variation_sequence]
+#       r[].as { [] }
+#     end
 
     #rule(:recursive_variation) do |r|
       #r["(", :element_sequence, ")"]
@@ -69,6 +94,20 @@ module PGN
       }x
     )
 
+    rule(
+      :comment => %r{
+        \{                         # beginning of comment
+        (
+          [[:print:]&&[^\\\}]] |   # printing characters except closing brace and backslash
+          \n                   |
+          \\\\                 |   # escaped backslashes
+          \\\}|\\\}            |   # escaped braces
+          \n                       # newlines
+        )*                         # zero or more of the above
+        \}                         # end of comment
+      }x
+    )
+
     rule(
       :game_termination => %r{
         1-0       |    # white wins
@@ -112,7 +151,8 @@ module PGN
 
     rule(
       :numeric_annotation_glyph => %r{
-        \$\d+    # dollar sign followed by an integer from 0 to 255
+        \$\d+       | # dollar sign followed by an integer from 0 to 255
+        [\?!][\?!]?   # support the most used annotations directly
       }x
     )
   end

data/lib/pgn/position.rb

@@ -61,7 +61,7 @@ module PGN
     #     :white,
     #   )
     #
-    def initialize(board, player, castling = CASTLING, en_passant = nil, halfmove = 0, fullmove = 0)
+    def initialize(board, player, castling = CASTLING, en_passant = nil, halfmove = 0, fullmove = 1)
       self.board      = board
       self.player     = player
       self.castling   = castling

data/lib/pgn/version.rb

@@ -1,3 +1,3 @@
 module PGN
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/spec/game_spec.rb

@@ -9,5 +9,13 @@ describe PGN::Game do
       game = PGN::Game.new(moves, tags, result)
       lambda { game.positions }.should_not raise_error
     end
+
+    it "should have fullmove 2 after 1.e4 c5" do
+      moves = %w{e4 c5}
+      game = PGN::Game.new(moves)
+      last_pos = game.positions.last
+
+      last_pos.fullmove.should == 2
+    end
   end
 end

data/spec/parser_spec.rb

@@ -23,4 +23,62 @@ describe PGN do
       end
     end
   end
+
+  context "annotations" do
+    describe "parsing a file" do
+      it "should return a list of games" do
+        games = PGN.parse(File.read("./spec/pgn_files/annotations.pgn"))
+        games.each do |game|
+          game.tags["White"].should == "Fool"
+          game.result.should == "0-1"
+          game.moves.last.should == "Qh4#"
+        end
+      end
+    end
+
+    describe "parsing a file" do
+      it "should work with comments" do
+        games = PGN.parse(File.read("./spec/pgn_files/comments.pgn"))
+        game = games.first
+        game.tags["White"].should == "Scholar"
+        game.result.should == "1-0"
+        game.moves.last.should == "Qxf7#"
+      end
+
+      it "should work with multiline comments" do
+        games = PGN.parse(File.read("./spec/pgn_files/multiline_comments.pgn"))
+        game = games.first
+        game.tags["White"].should == "Scholar"
+        game.result.should == "1-0"
+        game.moves.last.should == "Qxf7#"
+      end
+    end
+
+    describe "parsing a file" do
+      it "should return a list of games" do
+        games = PGN.parse(File.read("./spec/pgn_files/variations.pgn"))
+        game = games.first
+        game.tags["Black"].should == "Petrov"
+        game.result.should == "*"
+        game.moves.last.should == "Nf6"
+      end
+    end
+    
+    describe "parsing a complex file" do
+      it "should return a list of games" do
+        games = PGN.parse(File.read("./spec/pgn_files/test.pgn"))
+        game = games.first
+        game.tags["Black"].should == "Gelfand, Boris"
+        game.result.should == "1-0"
+        game.moves[13].should == "Nfd7"
+        game.moves[34].should == "f3"
+        game.moves[35].annotation.should == "$6"
+        game.moves[35].comment.should == "{Gelfand\ndecide tomar medidas.}"
+        game.moves[35].variations.size.should == 1
+        variation = game.moves[35].variations[0]
+        variation.size.should == 2
+        variation[0].should == "Nxf3"
+      end
+    end
+  end
 end

data/spec/pgn_files/annotations.pgn

@@ -0,0 +1,9 @@
+[White "Fool"]
+[Black "Somebody else"]
+
+1. f3 e5 2. g4 $4 Qh4# 0-1
+
+[White "Fool"]
+[Black "Somebody else"]
+
+1. f3 e5 2. g4 ?? Qh4# 0-1

data/spec/pgn_files/comments.pgn

@@ -0,0 +1,8 @@
+[White "Scholar"]
+[Black "Somebody else"]
+
+{ This is a multi-line commment, 
+where a comment spans in multiple lines. }
+
+1. e4 e5 2. Qh5 Nc6 3. {White about to move} Bc4 {White 
+moves} Nf6 {I pity the fool!} 4. Qxf7# 1-0

data/spec/pgn_files/multiline_comments.pgn

@@ -0,0 +1,5 @@
+[White "Scholar"]
+[Black "Somebody else"]
+
+1. e4 e5 2. Qh5 Nc6 3. Bc4 Nf6 {I pity
+the fool!} 4. Qxf7# 1-0

data/spec/pgn_files/test.pgn

@@ -0,0 +1,55 @@
+[Event "Zurich Chess Challenge"]
+[Site "Zurich"]
+[Date "2014.01.30"]
+[Round "1"]
+[White "Carlsen, Magnus"]
+[Black "Gelfand, Boris"]
+[Result "1-0"]
+[ECO "D78"]
+[WhiteElo "2878"]
+[BlackElo "2777"]
+[Annotator "Iago Porto"]
+[PlyCount "73"]
+[EventDate "2014.01.30"]
+[EventCountry "SUI"]
+[SourceDate "2014.01.04"]
+
+{Esta es la primera partida de Carlsen como campeón del mundo. La voy a
+comentar para el blog porque me ha gustado una idea bastante inusual que
+ejecuta el jugador noruego. El análisis no pretende ser exhaustivo ni en ideas
+ni en variantes, sino tan sólo reflejar las ideas y posiciones que me han
+llamado la atención. He visto el análisis de Daniel King y estoy claramente
+influenciado por él. Sin embargo, cualquier error es mío.} 1. c4 g6 2. d4 Nf6
+3. Nf3 Bg7 4. g3 c6 5. Bg2 d5 6. Qa4 O-O 7. O-O Nfd7 {No me voy a meter en la
+apertura, no conozco nada de estas líneas, aunque es cierto que esta jugada
+choca.} 8. Qc2 Nf6 9. Bf4 Bf5 10. Qb3 Qb6 11. Nbd2 Ne4 12. e3 {Hasta este
+momento, la posición es bastante simétrica. El blanco tiene, en mi opinión,
+una ligerísima ventaja gracias a tener más presión central, aunque la posición
+no presenta ningún desbalance estratégico.} Qxb3 13. axb3 {Se ha creado un
+desbalance en la posición. El blanco obtiene la columna a para su torre a
+cambio de los peones doblados.} Na6 {Y ahora Carlsen debió de decir: "yo
+quiero que mi alfil de g2 juegue" y sus siguientes jugadas son implacables
+para lograr este objetivo.} 14. cxd5 cxd5 15. g4 $1 {Brillante sacrificio de
+peón.} Bxg4 16. Nxe4 dxe4 17. Nd2 f5 18. f3 {Finalmente se consigue el
+objetivo, el alfil de g2 juega y el blanco tiene una presión desagradable
+sobre el ala de dama negra. Me recuerda a un gambito Benko.} e5 $6 {Gelfand
+decide tomar medidas.} (18... exf3 19. Nxf3 {A pesar de tener un peón de menos,
+todas las piezas del blanco están muy activas y son mejores que las de su
+rival. El blanco debería estar mejor.}) 19. dxe5 exf3 20. Nxf3 {Con respecto a
+la variante anterior, aquí Gelfand devuelve el peón para lograr que las piezas
+blancas no están tan activas. Considero que el blanco está también mejor y no
+hay que olvidar que el peón de e5 está pasado.} Rae8 21. Ra5 Nb4 {Tratando de
+poner el caballo en juego vía c6, donde defenderá a7 y atacará e5.} 22. Nd4 {
+Evita la amenaza negra de Cc6.} b6 {Gelfand cede ante la presión.} 23. Rxa7
+Bxe5 {Se mantiene la igualdad de material, pero ahora el rey negro empieza a
+parecer débil.} 24. Bh6 Rf6 (24... Rf7 25. Ra4 {y cuando el caballo se vaya,
+Ad5 gana la torre de f7.}) 25. h3 Bh5 {Carlsen encierra un poco más el alfil
+blanco de negras.} 26. Nc2 $1 {Otra bonita combinación.} g5 (26... Nxc2 27.
+Bd5+ Kh8 28. Bg7# {En su análisis, Daniel King decía que la torre entra por la
+banda, pase de la muerte hacia atrás al alfil blanco, el portero la detiene
+pero queda muerta para que el alfil negro la empuje al jaque mate.}) 27. Bxg5
+Rg6 28. Rxf5 h6 29. Bxh6 Rxh6 30. Nxb4 $18 {Con material de más, a partir de
+ahora es cuestión de técnica.} Bxb2 31. Nd5 Kh8 32. Rb7 Bd1 33. b4 Rg8 34. Ne7
+Rd8 35. Be4 {El alfil se suma al ataque. El rey negro sigue débil.} Bf6 36.
+Rxb6 Kg7 37. Rf2 $1 {Preciso remate. El caballo de e7 no se puede comer porque}
+(37. Rf2 Bxe7 38. Rg2+ {y cae la torre de h6.}) 1-0 

data/spec/pgn_files/variations.pgn

@@ -0,0 +1,4 @@
+[White "Somebody"]
+[Black "Petrov"]
+
+1. e4 e5 2. Nf3 {comment} (2. Nc3 {other} d5 (2... f5) 3. exd5) (2. f4 exf4 {final variation}) 2... Nf6 *

data/spec/position_spec.rb

@@ -1,6 +1,16 @@
 require 'spec_helper'
 
 describe PGN::Position do
+
+  describe "start" do
+
+    it "should have fullmove 1" do
+      pos = PGN::Position.start
+      pos.fullmove.should == 1
+    end
+    
+  end
+  
   context "disambiguating moves" do
     describe "using SAN square disambiguation" do
       pos = PGN::FEN.new("r1bqkb1r/pp1p1ppp/2n1pn2/8/3NP3/2N5/PPP2PPP/R1BQKB1R w KQkq - 3 6").to_position

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: pgn
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Stacey Touset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: whittle
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: A PGN parser and FEN generator for Ruby
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -95,6 +95,11 @@ files:
 - spec/game_spec.rb
 - spec/parser_spec.rb
 - spec/pgn_files/alternate_castling.pgn
+- spec/pgn_files/annotations.pgn
+- spec/pgn_files/comments.pgn
+- spec/pgn_files/multiline_comments.pgn
+- spec/pgn_files/test.pgn
+- spec/pgn_files/variations.pgn
 - spec/position_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/capicue/pgn
@@ -107,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A PGN parser for Ruby
@@ -126,6 +131,10 @@ test_files:
 - spec/game_spec.rb
 - spec/parser_spec.rb
 - spec/pgn_files/alternate_castling.pgn
+- spec/pgn_files/annotations.pgn
+- spec/pgn_files/comments.pgn
+- spec/pgn_files/multiline_comments.pgn
+- spec/pgn_files/test.pgn
+- spec/pgn_files/variations.pgn
 - spec/position_spec.rb
 - spec/spec_helper.rb
-has_rdoc: