feen 1.0.0

data/lib/feen/dumper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+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 indexes [Array] The shape of the board.
+    # @param pieces_in_hand_by_players [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
+    #   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
+    #     ]
+    #   )
+    #   # => "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 ///"
+    #
+    # @return [String] The FEEN string representing the position.
+    def self.call(active_side:, indexes:, pieces_in_hand_by_players:, squares:)
+      [
+        Board.new(*indexes).to_s(*squares),
+        Turn.dump(active_side, pieces_in_hand_by_players.length),
+        PiecesInHand.dump(*pieces_in_hand_by_players)
+      ].join(' ')
+    end
+  end
+end

data/lib/feen/dumper/board.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'inconsistent_size_error'
+
+module FEEN
+  module Dumper
+    # The board class.
+    class Board
+      # @param indexes [Array] The shape of the board.
+      def initialize(*indexes)
+        @indexes = indexes
+      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)
+      end
+
+      private
+
+      def unflatten(squares, *remaining_indexes)
+        return row(*squares) if remaining_indexes.length == 1
+
+        squares
+          .each_slice(squares.length / remaining_indexes.fetch(0))
+          .to_a
+          .map { |sub_squares| unflatten(sub_squares, *remaining_indexes[1..]) }
+          .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 }
+      end
+    end
+  end
+end

data/lib/feen/dumper/inconsistent_size_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Dumper
+    # The inconsistent size error class.
+    class InconsistentSizeError < ::StandardError; end
+  end
+end

data/lib/feen/dumper/pieces_in_hand.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Dumper
+    # The pieces in hand class.
+    class PiecesInHand
+      # Serialize pieces in hand lists into a string.
+      #
+      # @param pieces_in_hand_by_players [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('/')
+      end
+
+      # @param pieces [Array] A list of pieces in hand.
+      def initialize(*pieces)
+        @pieces = pieces.sort
+      end
+
+      # @return [String] A string representing the pieces in hand.
+      def to_s
+        @pieces.join(',')
+      end
+    end
+  end
+end

data/lib/feen/dumper/turn.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Dumper
+    # The turn class.
+    module Turn
+      # @param active_side [Integer] The identifier of the active player.
+      # @param sides_count [Integer] The number of players.
+      #
+      # @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))
+      end
+    end
+  end
+end

data/lib/feen/parser.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'parser/board'
+require_relative 'parser/pieces_in_hand'
+require_relative 'parser/shape'
+require_relative 'parser/turn'
+
+module FEEN
+  # The parser module.
+  module Parser
+    # Parse a FEEN string into position params.
+    #
+    # @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 ///")
+    #   # => {
+    #   #      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
+    #   #      ]
+    #   #    }
+    #
+    # @return [Hash] The position params representing the position.
+    def self.call(feen)
+      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 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)
+      {
+        active_side: Turn.parse(active_side),
+        indexes: Shape.new(board).to_a,
+        pieces_in_hand_by_players: PiecesInHand.parse(in_hand),
+        squares: Board.new(board).to_a
+      }
+    end
+  end
+end

data/lib/feen/parser/board.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Parser
+    # The board class.
+    #
+    # @example Parse a Shogi problem board
+    #   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,
+    #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #   #      nil, nil, nil, nil, "+P", nil, nil, nil, nil,
+    #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #   #      nil, nil, nil, nil, nil, nil, nil, "+B", nil,
+    #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #   #      nil, nil, nil, nil, nil, nil, nil, nil, nil
+    #   #    ]
+    class Board
+      # @param board [String] The flatten board.
+      def initialize(board)
+        @board = board
+      end
+
+      # @return [Array] The list of squares on the board.
+      def to_a
+        @board
+          .split(%r{[/,]+})
+          .flat_map { |str| row(str) }
+      end
+
+      private
+
+      def row(string)
+        string.match?(/[0-9]+/) ? ::Array.new(Integer(string)) : string
+      end
+    end
+  end
+end

data/lib/feen/parser/pieces_in_hand.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Parser
+    # The pieces in hand class.
+    module PiecesInHand
+      # The list of pieces in hand grouped by players.
+      #
+      # @param pieces_in_hand_by_players_str [String] The serialized list of
+      #   pieces in hand grouped by players.
+      #
+      # @example Parse a list of serialized pieces in hand
+      #   parse("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")
+      #   # => [
+      #   #      %w[S],
+      #   #      %w[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 [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(',') }
+      end
+    end
+  end
+end

data/lib/feen/parser/shape.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Parser
+    # The shape class.
+    #
+    # @example Parse the shape of a shogiban
+    #   Shape.new("3,s,k,s,3/9/4,+P,4/9/7,+B,1/9/9/9/9").to_a # => [9, 9]
+    class Shape
+      # @param board [String] The flatten board.
+      def initialize(board)
+        @board = board
+      end
+
+      # @return [Array] The size of each dimension of the board.
+      def to_a
+        indexes(@board, @board.scan(%r{/+}).sort.fetch(-1))
+      end
+
+      private
+
+      def indexes(string, separator)
+        if separator.empty?
+          last_index = string.split(',').inject(0) do |counter, sub_string|
+            number = sub_string.match?(/[0-9]+/) ? Integer(sub_string) : 1
+            counter + number
+          end
+
+          return [last_index]
+        end
+
+        sub_strings = string.split(separator)
+        [sub_strings.length] + indexes(sub_strings.fetch(0), separator[1..])
+      end
+    end
+  end
+end

data/lib/feen/parser/turn.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FEEN
+  module Parser
+    # The turn class.
+    module Turn
+      # @param active_side_id [String] The identifier of bottom-side and
+      #   top-side.
+      #
+      # @example Parse the number that identify the player who have to play
+      #   parse("0") # => 0
+      #
+      # @return [Integer] The number that identify the player who have to play.
+      def self.parse(active_side_id)
+        Integer(active_side_id)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: feen
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !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: rubocop-performance
+  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: rubocop-thread_safety
+  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: simplecov
+  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: yard
+  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 Ruby interface for data serialization and deserialization in FEEN format.
+email: contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- 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
+- lib/feen/parser/board.rb
+- lib/feen/parser/pieces_in_hand.rb
+- lib/feen/parser/shape.rb
+- lib/feen/parser/turn.rb
+homepage: https://developer.sashite.com/specs/forsyth-edwards-expanded-notation
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/sashite/feen.rb/issues
+  documentation_uri: https://rubydoc.info/gems/feen/index
+  source_code_uri: https://github.com/sashite/feen.rb
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: FEEN support for the Ruby language.
+test_files: []