chess 0.2.0 → 0.3.2

data/lib/chess/gnuchess.rb

@@ -1,7 +1,6 @@
 require 'mkmf'
 
 module Chess
-
   # Use Gnuchess to I.A. _(Only a draft)_.
   #
   # To use this module, extend a game object with {Chess::Gnuchess}.
@@ -12,7 +11,6 @@ module Chess
   #   g.gnuchess_move!
   #   puts g
   module Gnuchess
-
     # Returns the next move calculated by Gnuchess.
     # @return [String] Returns the short algebraic chess notation of the move.
     def gnuchess_move
@@ -24,8 +22,9 @@ module Chess
           pipe.puts(m)
         end
         pipe.puts('go')
-        while line = pipe.gets
+        while (line = pipe.gets)
           raise IllegalMoveError if line.include?('Invalid move')
+
           match = line.match(/My move is : ([a-h][1-8][a-h][1-8][rkbq]?)/)
           return match[1] if match
         end
@@ -44,16 +43,25 @@ module Chess
       self.move(next_move) if next_move
     end
 
-    private
+    class << self
+      private
 
-    def self.included(mod)
-      raise_if_gnuchess_is_not_installed
-    end
+      def included(_mod)
+        raise_if_gnuchess_is_not_installed
+      end
+
+      def extended(_mod)
+        raise_if_gnuchess_is_not_installed
+      end
 
-    def self.extended(mod)
-      raise_if_gnuchess_is_not_installed
+      # Raise an exception if Gnuchess is not installed
+      def raise_if_gnuchess_is_not_installed
+        raise 'You must install Gnuchess to use the module Chess::Gnuchess!' unless find_executable0('gnuchess')
+      end
     end
 
+    private
+
     def gen_pgn(file_to_save, moves = [])
       done = false
       pipe = IO.popen('gnuchess', 'r+')
@@ -64,20 +72,18 @@ module Chess
         moves.each do |move|
           pipe.write("#{move}\n")
         end
-        while(!done)
+        until done
           pipe.write("go\n")
-          while line = pipe.gets
-            if line =~ /My move is : /
-              break
-            elsif line =~ / : resign/
-              break
-            elsif line =~ / : 1-0 {White mates}/
+          while (line = pipe.gets)
+            break if /My move is : /.match?(line) || / : resign/.match?(line)
+
+            if / : 1-0 {White mates}/.match?(line)
               done = :white_won
               break
-            elsif line =~ / : 0-1 {Black mates}/
+            elsif / : 0-1 {Black mates}/.match?(line)
               done = :black_won
               break
-            elsif m = line.match(/1\/2-1\/2 {(.*?)}/)
+            elsif (m = line.match(/1\/2-1\/2 {(.*?)}/))
               case m[1]
               when 'Stalemate'
                 done = :stalemate
@@ -100,14 +106,5 @@ module Chess
         pipe.close
       end
     end
-
-    # Raise an exception if Gnuchess is not installed
-    def self.raise_if_gnuchess_is_not_installed
-      unless find_executable0('gnuchess')
-        raise 'You must install Gnuchess to use the module Chess::Gnuchess!'
-      end
-    end
-
   end
-
 end

data/lib/chess/pgn.rb

@@ -1,10 +1,8 @@
 module Chess
-
   # Rappresents a game in PGN (Portable Game Notation) format.
   class Pgn
-
     # Array that include PGN standard tags.
-    TAGS = %w(event site date round white black result)
+    TAGS = %w[event site date round white black result].freeze
 
     # The name of the tournament or match event.
     # @return [String]
@@ -16,7 +14,7 @@ module Chess
     attr_accessor :site
     # The starting date of the game, in YYYY.MM.DD form. ?? is used for unknown values.
     # @return [String]
-    attr_accessor :date
+    attr_reader :date
     # The playing round ordinal of the game within the event.
     # @return [String]
     attr_accessor :round
@@ -42,7 +40,6 @@ module Chess
     def initialize(filename = nil, check_moves: false)
       self.load(filename, check_moves: check_moves) if filename
       @date = '??'
-      @round = '1'
     end
 
     # Load a PGN from file.
@@ -52,21 +49,30 @@ module Chess
     # @raise [InvalidPgnFormatError]
     # @raise [IllegalMoveError]
     def load(filename, check_moves: false)
-      data = File.open(filename, 'r').read
-      data.gsub!(/\{.*?\}/, '') # remove comments
+      str = File.open(filename, 'r').read
+      load_from_string(str, check_moves: check_moves)
+    end
+
+    # Load a PGN from string.
+    # @param [String] str The PGN string to load.
+    # @param [Boolean] check_moves If true check if the moves are legal.
+    # @return [Pgn] Returns `self`.
+    # @raise [InvalidPgnFormatError]
+    # @raise [IllegalMoveError]
+    def load_from_string(str, check_moves: false)
+      str.gsub!(/\{.*?\}/, '') # remove comments
       TAGS.each do |t|
-        instance_variable_set("@#{t}", data.match(/^\[#{t.capitalize} ".*"\]\s?$/).to_s.strip[t.size+3..-3])
+        instance_variable_set("@#{t}", str.match(/^\[#{t.capitalize} ".*"\]\s?$/).to_s.strip[t.size + 3..-3])
       end
       @result = '1/2-1/2' if @result == '1/2'
-      game_index = data.index(/^1\./)
-      raise Chess::InvalidPgnFormatError.new(filename) if game_index.nil?
-      game = data[game_index..-1].strip
-      @moves = game.gsub("\n", ' ').split(/\d+\./).collect{|t| t.strip}[1..-1].collect{|t| t.split(' ')}.flatten
-      @moves.delete_at(@moves.size-1) if @moves.last =~ /(0-1)|(1-0)|(1\/2)|(1\/2-1\/2)|(\*)/
+      game_index = str.index(/^1\./)
+      raise Chess::InvalidPgnFormatError.new if game_index.nil?
+
+      game = str[game_index..-1].strip
+      @moves = game.tr("\n", ' ').split(/\d+\./).collect(&:strip)[1..-1].map(&:split).flatten
+      @moves.delete_at(@moves.size - 1) if @moves.last.match?(/(0-1)|(1-0)|(1\/2)|(1\/2-1\/2)|(\*)/)
       @moves.each do |m|
-        if m !~ MOVE_REGEXP && m !~ SHORT_CASTLING_REGEXP && m !~ LONG_CASTLING_REGEXP
-          raise Chess::InvalidPgnFormatError.new(filename)
-        end
+        raise Chess::InvalidPgnFormatError.new if m !~ MOVE_REGEXP && m !~ SHORT_CASTLING_REGEXP && m !~ LONG_CASTLING_REGEXP
       end
       Chess::Game.new(@moves) if check_moves
       return self
@@ -76,13 +82,13 @@ module Chess
     def to_s
       s = ''
       TAGS.each do |t|
-        tag = instance_variable_get("@#{t}")
+        tag = instance_variable_defined?("@#{t}") ? instance_variable_get("@#{t}") : ''
         s << "[#{t.capitalize} \"#{tag}\"]\n"
       end
       s << "\n"
       m = ''
       @moves.each_with_index do |move, i|
-        m << "#{i/2+1}. " if i % 2 == 0
+        m << "#{i / 2 + 1}. " if i.even?
         m << "#{move} "
       end
       m << @result unless @result.nil?
@@ -95,17 +101,17 @@ module Chess
       File.open(filename, 'w') { |f| f.write(self.to_s) }
     end
 
-    # @!visibility private
-    alias :old_date= :date=
+    # # @!visibility private
+    # alias old_date= date=
 
     # Set the date tag.
     def date=(value)
-      if value.is_a?(Time)
-        @date = value.strftime('%Y.%m.%d')
-      else
-        @data = value
-      end
+      @date =
+        if value.is_a?(Time)
+          value.strftime('%Y.%m.%d')
+        else
+          value
+        end
     end
-
   end
 end

data/lib/chess/utf8_notation.rb

@@ -1,4 +1,5 @@
 module Chess
+  # rubocop:disable Style/AsciiComments
 
   # With this module is possible call the method {#to_utf8} on a string. This
   # method convert the chess piece identifier character into UTF8 chess
@@ -12,7 +13,6 @@ module Chess
   # @note To use this utility explicit require is needed: <tt>require
   #   'chess/utf8_notation'</tt>
   module UTF8Notation
-
     # Map a piece identifier character with the corresponding UTF8 chess
     # character
     UTF8_MAP = {
@@ -28,15 +28,15 @@ module Chess
       'b' => '♝',
       'q' => '♛',
       'k' => '♚'
-    }
+    }.freeze
 
     # Replace the piece identifier characters with UTF8 chess characters.
     # @return [String]
     def to_utf8
       self.gsub(/[PRNBQKprnbqk]/, UTF8_MAP)
     end
-
   end
+  # rubocop:enable Style/AsciiComments
 end
 
 String.prepend(Chess::UTF8Notation)

data/lib/chess/version.rb

@@ -1,5 +1,5 @@
 # The Chess library module.
 module Chess
   # The library version.
-  VERSION = '0.2.0'
+  VERSION = '0.3.2'.freeze
 end

data/test/test_big_pgn_collection.rb

@@ -1,19 +1,18 @@
 require 'test_helper'
 
 class ChessTest < Minitest::Test
-
   if ENV['BIG_PGN_COLLECTION'] && File.exist?(TestHelper::BIG_PGN_COLLECTION)
     puts 'Loading tests for a big PGN collection...'
     300_000.times do |i|
-      filename = sprintf("%06d.pgn", i+1)
+      filename = format('%06d.pgn', i + 1)
       path = File.join(TestHelper::BIG_PGN_COLLECTION, filename)
       break unless File.exist?(path)
+
       define_method "test_big_pgn_#{filename}" do
         pgn = Chess::Pgn.new(path)
         game = Chess::Game.new(pgn.moves)
-        assert(game.checkmate?) if pgn.moves.last =~ /\#$/
+        assert(game.checkmate?) if pgn.moves.last.match?(/\#$/)
       end
     end
   end
-
 end

data/test/test_checkmate.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class ChessTest < Minitest::Test
-
   TestHelper.pgns('checkmate').each do |file|
     name = File.basename(file, '.pgn')
     win = file.include?('white') ? 'white' : 'black'
@@ -10,13 +9,12 @@ class ChessTest < Minitest::Test
       game = Chess::Game.new(pgn.moves)
       assert(game.board.checkmate?)
       if file.include?('white_won')
-        assert_equal(game.result, '1-0')
-        assert_equal(game.active_player, :black)
+        assert_equal('1-0', game.result)
+        assert_equal(:black, game.active_player)
       elsif file.include?('black_won')
-        assert_equal(game.result, '0-1')
-        assert_equal(game.active_player, :white)
+        assert_equal('0-1', game.result)
+        assert_equal(:white, game.active_player)
       end
     end
   end
-
 end

data/test/test_errors.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class ChessTest < Minitest::Test
+  def test_bad_notation_error
+    game = Chess::Game.new
+    assert_raises(Chess::BadNotationError) do
+      game << 'gg'
+    end
+  end
+
+  def test_invalid_pgn_format_error
+    assert_raises(Chess::InvalidPgnFormatError) do
+      Chess::Pgn.new('test/pgn_collection/invalid/0001.pgn')
+    end
+  end
+
+  def test_invalid_fen_format_error
+    assert_raises(Chess::InvalidFenFormatError) do
+      Chess::Game.load_fen('invalid')
+    end
+  end
+end

data/test/test_fifty_rule_move.rb

@@ -1,14 +1,12 @@
 require 'test_helper'
 
 class ChessTest < Minitest::Test
-
   TestHelper.pgns('fifty_move_rule').each do |file|
     name = File.basename(file, '.pgn')
-    define_method "test_fifty_rule_move_#{name}" do
+    define_method "test_fifty_move_rule_#{name}" do
       pgn = Chess::Pgn.new(file)
       game = Chess::Game.new(pgn.moves)
-      assert(game.board.fifty_rule_move?)
+      assert game.board.fifty_move_rule?
     end
   end
-
 end

data/test/test_game.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class ChessTest < Minitest::Test
+  def test_moves
+    game = Chess::Game.new
+    game.moves = %w[e4 e5]
+    assert_equal %w[e4 e5], game.moves
+  end
+
+  def test_active_player
+    game = Chess::Game.new
+    game << 'a3'
+    assert_equal :black, game.active_player
+  end
+
+  def test_inactive_player
+    game = Chess::Game.new
+    game.moves = %w[a3 f5]
+    assert_equal :black, game.inactive_player
+  end
+
+  def test_status_white_won_resign
+    game = Chess::Game.new
+    game.resign(:black)
+    assert_equal :white_won_resign, game.status
+    assert game.over?
+    assert '1-0', game.result
+  end
+
+  def test_status_black_won_resign
+    game = Chess::Game.new
+    game << 'e4'
+    game.resign(:white)
+    assert_equal :black_won_resign, game.status
+    assert game.over?
+    assert '0-1', game.result
+  end
+
+  def test_status_insufficient_material
+    pgn = TestHelper.pick_pgn('insufficient_material/0001.pgn')
+    game = Chess::Game.new(pgn.moves)
+    assert_equal :insufficient_material, game.status
+  end
+
+  def test_status_fifty_move_rule
+    pgn = TestHelper.pick_pgn('fifty_move_rule/0001.pgn')
+    game = Chess::Game.new(pgn.moves)
+    game.draw
+    assert_equal :fifty_move_rule, game.status
+  end
+
+  def test_status_threefold_repetition
+    pgn = TestHelper.pick_pgn('threefold_repetition/0001.pgn')
+    game = Chess::Game.new(pgn.moves)
+    game.draw
+    assert_equal :threefold_repetition, game.status
+  end
+
+  def test_pgn
+    pgn = TestHelper.pick_pgn('valid/0001.pgn')
+    game = Chess::Game.new(pgn.moves)
+    expected_pgn = <<~PGN
+      [Event ""]
+      [Site ""]
+      [Date "??"]
+      [Round ""]
+      [White ""]
+      [Black ""]
+      [Result "*"]
+
+      1. e4 c5 2. Nf3 d6 3. d4 cxd4 4. Qxd4 Nc6 5. Bb5 Bd7 6. Bxc6 Bxc6 7. Bg5 Nf6
+      8. Bxf6 gxf6 9. Nc3 e6 10. O-O-O Be7 11. Rhe1 Rg8 12. Qe3 Rxg2 13. Rg1 Rg6 14.
+      Nd4 Qb6 15. h4 O-O-O 16. h5 Rg5 17. Nd5 Bxd5 18. exd5 e5 19. Qh3+ Kb8 20. Nf5
+      Bf8 21. Rxg5 fxg5 22. Ne3 Qb4 23. c4 g4 24. Qxg4 Bh6 25. Kb1 Rc8 26. Rc1 Qd2
+      27. Qf5 Bf4 28. Qc2 Qxc2+ 29. Rxc2 Rg8 30. b4 Rg5 31. c5 e4 32. c6 Rxh5 33.
+      Rc4 f5 34. b5 Rg5 35. Rc3 Be5 36. Rc1 Bd4 37. Nc4 Bc5 38. Ne5 dxe5 39. Rxc5
+      Rg6 40. a4 Rd6 41. a5 b6 42. axb6 axb6 43. Rc2 Rxd5 44. Rb2 h5 45. Ka2 h4 46.
+      Ka3 h3 47. Ka4 Rd1 *
+    PGN
+    assert_equal expected_pgn, game.pgn.to_s
+  end
+end

data/test/test_helper.rb

@@ -1,13 +1,26 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'lib/chess/gnuchess.rb'
+end
+if ENV['CODECOV'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
 require 'chess'
 require 'minitest/autorun'
+require 'byebug'
 
 module TestHelper
-
-  PGN_COLLECTION = 'test/pgn_collection'
-  BIG_PGN_COLLECTION = '/Users/pioz/Code/prog/misc/pgn_collection/pgn'
+  PGN_COLLECTION = 'test/pgn_collection'.freeze
+  BIG_PGN_COLLECTION = '/Users/pioz/Code/prog/misc/pgn_collection/pgn'.freeze
 
   def self.pgns(path, prefix = PGN_COLLECTION)
     Dir[File.join(prefix, path, '**/*.pgn')]
   end
 
+  def self.pick_pgn(path, prefix = PGN_COLLECTION)
+    file = File.join(prefix, path)
+    return Chess::Pgn.new(file)
+  end
 end