feen 1.0.0 → 2.0.0

data/lib/feen/dumper.rb

@@ -1,56 +1,45 @@
 # frozen_string_literal: true
 
-require_relative 'dumper/board'
-require_relative 'dumper/pieces_in_hand'
-require_relative 'dumper/turn'
+require_relative "dumper/board"
+require_relative "dumper/pieces_in_hand"
+require_relative "dumper/turn"
 
 module FEEN
   # The dumper module.
   module Dumper
     # Dump position params into a FEEN string.
     #
-    # @param active_side [Integer] The identifier of the player who must play.
+    # @param active_side_id [Integer] The identifier of the player who must play.
+    # @param board [Hash] The indexes of each piece on the board.
     # @param indexes [Array] The shape of the board.
-    # @param pieces_in_hand_by_players [Array] The list of pieces in hand
+    # @param pieces_in_hand_grouped_by_sides [Array] The list of pieces in hand
     #   grouped by players.
-    # @param squares [Array] The list of squares on the board.
     #
-    # @example Dump Four-player chess's starting position
+    # @example Dump a classic Tsume Shogi problem
     #   call(
-    #     active_side: 0,
-    #     indexes: [14, 14],
-    #     pieces_in_hand_by_players: [
-    #       [],
-    #       [],
-    #       [],
-    #       []
-    #     ],
-    #     squares: [
-    #       nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
-    #       nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
-    #       nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-    #       "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-    #       "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-    #       "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-    #       "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
-    #       "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
-    #       "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-    #       "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-    #       "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-    #       nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-    #       nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
-    #       nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil
+    #     "active_side_id": 0,
+    #     "board": {
+    #       "3": "s",
+    #       "4": "k" ,
+    #       "5": "s",
+    #       "22": "+P",
+    #       "43": "+B"
+    #     },
+    #     "indexes": [9, 9],
+    #     "pieces_in_hand_grouped_by_sides": [
+    #       %w[S],
+    #       %w[r r b g g g g s n n n n p p p p p p p p p p p p p p p p p]
     #     ]
     #   )
-    #   # => "3,yR,yN,yB,yK,yQ,yB,yN,yR,3/3,yP,yP,yP,yP,yP,yP,yP,yP,3/14/bR,bP,10,gP,gR/bN,bP,10,gP,gN/bB,bP,10,gP,gB/bK,bP,10,gP,gQ/bQ,bP,10,gP,gK/bB,bP,10,gP,gB/bN,bP,10,gP,gN/bR,bP,10,gP,gR/14/3,rP,rP,rP,rP,rP,rP,rP,rP,3/3,rR,rN,rB,rQ,rK,rB,rN,rR,3 0 ///"
+    #   # => "3,s,k,s,3/9/4,+P,4/9/7,+B,1/9/9/9/9 0 S/b,g,g,g,g,n,n,n,n,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,r,r,s"
     #
     # @return [String] The FEEN string representing the position.
-    def self.call(active_side:, indexes:, pieces_in_hand_by_players:, squares:)
+    def self.call(active_side_id:, board:, indexes:, pieces_in_hand_grouped_by_sides:)
       [
-        Board.new(*indexes).to_s(*squares),
-        Turn.dump(active_side, pieces_in_hand_by_players.length),
-        PiecesInHand.dump(*pieces_in_hand_by_players)
-      ].join(' ')
+        Board.new(*indexes, **board).to_s,
+        Turn.dump(active_side_id, pieces_in_hand_grouped_by_sides.length),
+        PiecesInHand.dump(*pieces_in_hand_grouped_by_sides)
+      ].join(" ")
     end
   end
 end

data/lib/feen/dumper/board.rb

@@ -1,27 +1,65 @@
 # frozen_string_literal: true
 
-require_relative 'inconsistent_size_error'
-
 module FEEN
   module Dumper
     # The board class.
+    #
+    # @example Dump an empty board of Xiangqi
+    #   Board.new(10, 9).to_s # => "9/9/9/9/9/9/9/9/9/9"
+    #
+    # @example Dump the Xiangqi starting position board
+    #   Board.new(10, 9,
+    #     "0": "車",
+    #     "1": "馬",
+    #     "2": "象",
+    #     "3": "士",
+    #     "4": "將",
+    #     "5": "士",
+    #     "6": "象",
+    #     "7": "馬",
+    #     "8": "車",
+    #     "19": "砲",
+    #     "25": "砲",
+    #     "27": "卒",
+    #     "29": "卒",
+    #     "31": "卒",
+    #     "33": "卒",
+    #     "35": "卒",
+    #     "54": "兵",
+    #     "56": "兵",
+    #     "58": "兵",
+    #     "60": "兵",
+    #     "62": "兵",
+    #     "64": "炮",
+    #     "70": "炮",
+    #     "81": "俥",
+    #     "82": "傌",
+    #     "83": "相",
+    #     "84": "仕",
+    #     "85": "帥",
+    #     "86": "仕",
+    #     "87": "相",
+    #     "88": "傌",
+    #     "89": "俥").to_s # => "車,馬,象,士,將,士,象,馬,車/9/1,砲,5,砲,1/卒,1,卒,1,卒,1,卒,1,卒/9/9/兵,1,兵,1,兵,1,兵,1,兵/1,炮,5,炮,1/9/俥,傌,相,仕,帥,仕,相,傌,俥"
     class Board
       # @param indexes [Array] The shape of the board.
-      def initialize(*indexes)
+      # @param board [Hash] The indexes of each piece on the board.
+      def initialize(*indexes, **board)
         @indexes = indexes
+        @squares = Array.new(length) { |i| board.fetch(i.to_s.to_sym, nil) }
       end
 
-      # @param squares [Array] The list of squares on the board.
-      #
       # @return [String] The string representing the board.
-      def to_s(*squares)
-        raise InconsistentSizeError unless squares.length == @indexes.inject(:*)
-
-        unflatten(squares, *@indexes)
+      def to_s
+        unflatten(@squares, *@indexes)
       end
 
       private
 
+      def length
+        @indexes.inject(:*)
+      end
+
       def unflatten(squares, *remaining_indexes)
         return row(*squares) if remaining_indexes.length == 1
 
@@ -29,14 +67,14 @@ module FEEN
           .each_slice(squares.length / remaining_indexes.fetch(0))
           .to_a
           .map { |sub_squares| unflatten(sub_squares, *remaining_indexes[1..]) }
-          .join('/' * remaining_indexes.length.pred)
+          .join("/" * remaining_indexes.length.pred)
       end
 
       def row(*squares)
         squares
           .map { |square| square.nil? ? 1 : square }
-          .join(',')
-          .gsub(/1,[1,]*1/) { |str| str.split(',').length }
+          .join(",")
+          .gsub(/1,[1,]*1/) { |str| str.split(",").length }
       end
     end
   end

data/lib/feen/dumper/pieces_in_hand.rb

@@ -3,16 +3,23 @@
 module FEEN
   module Dumper
     # The pieces in hand class.
+    #
+    # @example Serialize a list of pieces in hand grouped by sides
+    #   PiecesInHand.dump(
+    #     %w[S],
+    #     %w[r r b g g g g s n n n n p p p p p p p p p p p p p p p p p]
+    #   )
+    #   # => "S/b,g,g,g,g,n,n,n,n,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,r,r,s"
     class PiecesInHand
       # Serialize pieces in hand lists into a string.
       #
-      # @param pieces_in_hand_by_players [Array] The list of pieces in hand
+      # @param pieces_in_hand_grouped_by_sides [Array] The list of pieces in hand
       #   grouped by players.
       #
       # @return [String] A string representing the pieces in hand of both
       #   players.
-      def self.dump(*pieces_in_hand_by_players)
-        pieces_in_hand_by_players.map { |pieces| new(*pieces).to_s }.join('/')
+      def self.dump(*pieces_in_hand_grouped_by_sides)
+        pieces_in_hand_grouped_by_sides.map { |pieces| new(*pieces).to_s }.join("/")
       end
 
       # @param pieces [Array] A list of pieces in hand.
@@ -22,7 +29,7 @@ module FEEN
 
       # @return [String] A string representing the pieces in hand.
       def to_s
-        @pieces.join(',')
+        @pieces.join(",")
       end
     end
   end

data/lib/feen/dumper/turn.rb

@@ -2,14 +2,17 @@
 
 module FEEN
   module Dumper
-    # The turn class.
+    # The turn module.
     module Turn
-      # @param active_side [Integer] The identifier of the active player.
+      # @param active_side_id [Integer] The identifier of the active player.
       # @param sides_count [Integer] The number of players.
       #
+      # @example Dump the number that identify the player who have to play
+      #   dump(0, 2) # => "0"
+      #
       # @return [String] The number that identify the player who have to play.
-      def self.dump(active_side, sides_count)
-        String(Integer(active_side) % Integer(sides_count))
+      def self.dump(active_side_id, sides_count)
+        String(Integer(active_side_id) % Integer(sides_count))
       end
     end
   end

data/lib/feen/parser.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'parser/board'
-require_relative 'parser/pieces_in_hand'
-require_relative 'parser/shape'
-require_relative 'parser/turn'
+require_relative "parser/board"
+require_relative "parser/pieces_in_hand"
+require_relative "parser/shape"
+require_relative "parser/turn"
 
 module FEEN
   # The parser module.
@@ -12,53 +12,42 @@ module FEEN
     #
     # @param feen [String] The FEEN string representing a position.
     #
-    # @example Parse Four-player chess's starting position
-    #   call("3,yR,yN,yB,yK,yQ,yB,yN,yR,3/3,yP,yP,yP,yP,yP,yP,yP,yP,3/14/bR,bP,10,gP,gR/bN,bP,10,gP,gN/bB,bP,10,gP,gB/bK,bP,10,gP,gQ/bQ,bP,10,gP,gK/bB,bP,10,gP,gB/bN,bP,10,gP,gN/bR,bP,10,gP,gR/14/3,rP,rP,rP,rP,rP,rP,rP,rP,3/3,rR,rN,rB,rQ,rK,rB,rN,rR,3 0 ///")
+    # @example Parse a classic Tsume Shogi problem
+    #   call("3,s,k,s,3/9/4,+P,4/9/7,+B,1/9/9/9/9 0 S/b,g,g,g,g,n,n,n,n,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,r,r,s")
     #   # => {
-    #   #      active_side: 0,
-    #   #      indexes: [14, 14],
-    #   #      pieces_in_hand_by_players: [
-    #   #        [],
-    #   #        [],
-    #   #        [],
-    #   #        []
-    #   #      ],
-    #   #      squares: [
-    #   #        nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
-    #   #        nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
-    #   #        nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-    #   #        "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-    #   #        "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-    #   #        "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-    #   #        "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
-    #   #        "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
-    #   #        "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-    #   #        "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-    #   #        "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-    #   #        nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-    #   #        nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
-    #   #        nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil
+    #   #      "active_side_id": 0,
+    #   #      "board": {
+    #   #        "3": "s",
+    #   #        "4": "k" ,
+    #   #        "5": "s",
+    #   #        "22": "+P",
+    #   #        "43": "+B"
+    #   #      },
+    #   #      "indexes": [9, 9],
+    #   #      "pieces_in_hand_grouped_by_sides": [
+    #   #        %w[S],
+    #   #        %w[r r b g g g g s n n n n p p p p p p p p p p p p p p p p p]
     #   #      ]
     #   #    }
     #
     # @return [Hash] The position params representing the position.
     def self.call(feen)
-      params(*feen.split(' '))
+      params(*feen.split(" "))
     end
 
     # Parse the FEEN string's three fields and return the position params.
     #
     # @param board [String] The flatten board.
-    # @param active_side [String] The active side identifier.
+    # @param active_side_id [String] The active side identifier.
     # @param in_hand [String] The captured actors.
     #
     # @return [Hash] The position params representing the position.
-    private_class_method def self.params(board, active_side, in_hand)
+    private_class_method def self.params(board, active_side_id, in_hand)
       {
-        active_side: Turn.parse(active_side),
+        active_side_id: Turn.parse(active_side_id),
+        board: Board.new(board).to_h,
         indexes: Shape.new(board).to_a,
-        pieces_in_hand_by_players: PiecesInHand.parse(in_hand),
-        squares: Board.new(board).to_a
+        pieces_in_hand_grouped_by_sides: PiecesInHand.parse(in_hand)
       }
     end
   end

data/lib/feen/parser/board.rb

@@ -4,7 +4,7 @@ module FEEN
   module Parser
     # The board class.
     #
-    # @example Parse a Shogi problem board
+    # @example Parse a Shogi problem board and return an array
     #   Board.new("3,s,k,s,3/9/4,+P,4/9/7,+B,1/9/9/9/9").to_a
     #   # => [
     #   #      nil, nil, nil, "s", "k", "s", nil, nil, nil,
@@ -17,6 +17,16 @@ module FEEN
     #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil,
     #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil
     #   #    ]
+    #
+    # @example Parse a Shogi problem board and return a hash
+    #   Board.new("3,s,k,s,3/9/4,+P,4/9/7,+B,1/9/9/9/9").to_h
+    #   # => {
+    #   #      "3": "s",
+    #   #      "4": "k" ,
+    #   #      "5": "s",
+    #   #      "22": "+P",
+    #   #      "43": "+B"
+    #   #    }
     class Board
       # @param board [String] The flatten board.
       def initialize(board)
@@ -30,6 +40,17 @@ module FEEN
           .flat_map { |str| row(str) }
       end
 
+      # @return [Hash] The indexes of each piece on the board.
+      def to_h
+        to_a
+          .each_with_index
+          .inject({}) do |h, (v, i)|
+            next h if v.nil?
+
+            h.merge(i.to_s.to_sym => v)
+          end
+      end
+
       private
 
       def row(string)

data/lib/feen/parser/pieces_in_hand.rb

@@ -2,11 +2,11 @@
 
 module FEEN
   module Parser
-    # The pieces in hand class.
+    # The pieces in hand module.
     module PiecesInHand
       # The list of pieces in hand grouped by players.
       #
-      # @param pieces_in_hand_by_players_str [String] The serialized list of
+      # @param pieces_in_hand_grouped_by_sides_str [String] The serialized list of
       #   pieces in hand grouped by players.
       #
       # @example Parse a list of serialized pieces in hand
@@ -17,10 +17,10 @@ module FEEN
       #   #    ]
       #
       # @return [Array] The list of pieces in hand grouped by players.
-      def self.parse(pieces_in_hand_by_players_str)
-        pieces_in_hand_by_players_str
-          .split('/', -1)
-          .map { |pieces_in_hand_str| pieces_in_hand_str.split(',') }
+      def self.parse(pieces_in_hand_grouped_by_sides_str)
+        pieces_in_hand_grouped_by_sides_str
+          .split("/", -1)
+          .map { |pieces_in_hand_str| pieces_in_hand_str.split(",") }
       end
     end
   end

data/lib/feen/parser/shape.rb

@@ -21,7 +21,7 @@ module FEEN
 
       def indexes(string, separator)
         if separator.empty?
-          last_index = string.split(',').inject(0) do |counter, sub_string|
+          last_index = string.split(",").inject(0) do |counter, sub_string|
             number = sub_string.match?(/[0-9]+/) ? Integer(sub_string) : 1
             counter + number
           end

data/lib/feen/parser/turn.rb

@@ -2,7 +2,7 @@
 
 module FEEN
   module Parser
-    # The turn class.
+    # The turn module.
     module Turn
       # @param active_side_id [String] The identifier of bottom-side and
       #   top-side.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: feen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: brutal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +133,6 @@ files:
 - lib/feen.rb
 - lib/feen/dumper.rb
 - lib/feen/dumper/board.rb
-- lib/feen/dumper/inconsistent_size_error.rb
 - lib/feen/dumper/pieces_in_hand.rb
 - lib/feen/dumper/turn.rb
 - lib/feen/parser.rb