feen 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0c53a0d0d53b43e1cb9f06511fe1c7bc3eee6c6552c4902b140133c32cc754
-  data.tar.gz: 843631005e3047239e98d485907bf57870dc56e45f4aa2848bf37976dd53e00d
+  metadata.gz: abb8a5158f3723e03a49a81c8770ac85bde5d0a88386d7fb9a40739736c1fefe
+  data.tar.gz: 43d49d36468e55b84df7020ba7ea5ae5b3b73ed34ca640593e1ba05e094260f4
 SHA512:
-  metadata.gz: efe66d045a3780bd4ec5e019f15e4e3302a42984a360c49e583d7e7f4ddf5fd9b13fefdc0807d8c2134fb87ac7c518fcae04bf91be8dc8dfdfef51c9dbb40f92
-  data.tar.gz: 7a003e96f398ac8c2d63f7164e182c3f6b36183f5dd1eb74e030bbeb77f54965b4922664d78766336b17a44cc0c3e87819c21976c32874724d57e8ea66da87ee
+  metadata.gz: b447df75705569f2017bf8647ea4f6564661e6ea3467343662c16e7a4a68052eddf8952263badbd33c40132e2c4b9323481eecd882ce3be0fc44660a572d0805
+  data.tar.gz: 98db4cc2b5565fcaadd95e3e1f5b3c0facf04560088ac84209daa107000d0a829702a23b31b1544f4b2cb923330eb259c12a585a4da7fa564d87485de96cb915

data/README.md

@@ -38,16 +38,16 @@ require "feen"
 
 # Dump a classic Tsume Shogi problem
 FEEN.dump(
-  "active_side_id": 0,
+  "side_id": 0,
   "board": {
      3 => "s",
-     4 => "k" ,
+     4 => "k",
      5 => "s",
     22 => "+P",
     43 => "+B"
   },
   "indexes": [9, 9],
-  "pieces_in_hand_grouped_by_sides": [
+  "hands": [
     %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]
   ]
@@ -56,21 +56,7 @@ FEEN.dump(
 
 # Parse a classic Tsume Shogi problem
 FEEN.parse("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_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[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]
-#      ]
-#    }
+# => {:board=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 43=>"+B"}, :indexes=>[9, 9], :hands=>[["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"]], :side_id=>0}
 ```
 
 ## License

data/lib/feen.rb

@@ -10,15 +10,15 @@ require_relative "feen/parser"
 module FEEN
   # @example Dumps position params into a FEEN string.
   #
-  # @param active_side_id [Integer] The identifier of the player who must play.
+  # @param 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_grouped_by_sides [Array] The list of pieces in hand
+  # @param hands [Array] The list of pieces in hand
   #   grouped by players.
   #
   # @example Dump a classic Tsume Shogi problem
   #   dump(
-  #     "active_side_id": 0,
+  #     "side_id": 0,
   #     "board": {
   #        3 => "s",
   #        4 => "k",
@@ -26,21 +26,21 @@ module FEEN
   #       22 => "+P",
   #       43 => "+B"
   #     },
-  #     "indexes": [9, 9],
-  #     "pieces_in_hand_grouped_by_sides": [
+  #     "hands": [
   #       %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]
-  #     ]
+  #     ],
+  #     "indexes": [9, 9]
   #   )
   #   # => "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.dump(active_side_id:, board: {}, indexes:, pieces_in_hand_grouped_by_sides:)
+  def self.dump(board:, hands:, indexes:, side_id:)
     Dumper.call(
-      active_side_id: active_side_id,
       board: board,
+      hands: hands,
       indexes: indexes,
-      pieces_in_hand_grouped_by_sides: pieces_in_hand_grouped_by_sides
+      side_id: side_id
     )
   end
 
@@ -51,7 +51,7 @@ module FEEN
   # @example Parse a classic Tsume Shogi problem
   #   parse("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_id": 0,
+  #   #      "side_id": 0,
   #   #      "board": {
   #   #         3 => "s",
   #   #         4 => "k",
@@ -59,11 +59,11 @@ module FEEN
   #   #        22 => "+P",
   #   #        43 => "+B"
   #   #      },
-  #   #      "indexes": [9, 9],
-  #   #      "pieces_in_hand_grouped_by_sides": [
+  #   #      "hands": [
   #   #        %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]
-  #   #      ]
+  #   #      ],
+  #   #      "indexes": [9, 9]
   #   #    }
   #
   # @return [Hash] The position params representing the position.

data/lib/feen/dumper.rb

@@ -9,15 +9,14 @@ module FEEN
   module Dumper
     # Dump position params into a FEEN string.
     #
-    # @param active_side_id [Integer] The identifier of the player who must play.
+    # @param 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_grouped_by_sides [Array] The list of pieces in hand
+    # @param hands [Array] The list of pieces in hand
     #   grouped by players.
     #
     # @example Dump a classic Tsume Shogi problem
     #   call(
-    #     "active_side_id": 0,
     #     "board": {
     #        3 => "s",
     #        4 => "k",
@@ -25,20 +24,21 @@ module FEEN
     #       22 => "+P",
     #       43 => "+B"
     #     },
-    #     "indexes": [9, 9],
-    #     "pieces_in_hand_grouped_by_sides": [
+    #     "hands": [
     #       %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]
-    #     ]
+    #     ],
+    #     "indexes": [9, 9],
+    #     "side_id": 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_id:, board:, indexes:, pieces_in_hand_grouped_by_sides:)
+    def self.call(board:, hands:, indexes:, side_id:)
       [
         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)
+        Turn.dump(side_id, hands.length),
+        PiecesInHand.dump(hands)
       ].join(" ")
     end
   end

data/lib/feen/dumper/pieces_in_hand.rb

@@ -13,13 +13,13 @@ module FEEN
     class PiecesInHand
       # Serialize pieces in hand lists into a string.
       #
-      # @param pieces_in_hand_grouped_by_sides [Array] The list of pieces in hand
+      # @param hands [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_grouped_by_sides)
-        pieces_in_hand_grouped_by_sides.map { |pieces| new(pieces).to_s }.join("/")
+      def self.dump(hands)
+        hands.map { |pieces| new(pieces).to_s }.join("/")
       end
 
       # @param pieces [Array] A list of pieces in hand.

data/lib/feen/dumper/turn.rb

@@ -4,15 +4,15 @@ module FEEN
   module Dumper
     # The turn module.
     module Turn
-      # @param active_side_id [Integer] The identifier of the active player.
+      # @param 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_id, sides_count)
-        String(Integer(active_side_id) % Integer(sides_count))
+      def self.dump(side_id, sides_count)
+        String(Integer(side_id) % Integer(sides_count))
       end
     end
   end

data/lib/feen/parser.rb

@@ -15,7 +15,6 @@ module FEEN
     # @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_id": 0,
     #   #      "board": {
     #   #         3 => "s",
     #   #         4 => "k",
@@ -23,22 +22,23 @@ module FEEN
     #   #        22 => "+P",
     #   #        43 => "+B"
     #   #      },
-    #   #      "indexes": [9, 9],
-    #   #      "pieces_in_hand_grouped_by_sides": [
+    #   #      "hands": [
     #   #        %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]
-    #   #      ]
+    #   #      ],
+    #   #      "indexes": [9, 9],
+    #   #      "side_id": 0
     #   #    }
     #
     # @return [Hash] The position params representing the position.
     def self.call(feen)
-      board, active_side_id, in_hand = feen.split(" ")
+      board, side_id, in_hand = feen.split(" ")
 
       {
-        active_side_id: Turn.parse(active_side_id),
         board: Board.new(board).to_h,
         indexes: Shape.new(board).to_a,
-        pieces_in_hand_grouped_by_sides: PiecesInHand.parse(in_hand)
+        hands: PiecesInHand.parse(in_hand),
+        side_id: Turn.parse(side_id)
       }
     end
   end

data/lib/feen/parser/board.rb

@@ -22,7 +22,7 @@ module FEEN
     #   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" ,
+    #   #       4 => "k",
     #   #       5 => "s",
     #   #      22 => "+P",
     #   #      43 => "+B"

data/lib/feen/parser/pieces_in_hand.rb

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

data/lib/feen/parser/turn.rb

@@ -4,15 +4,15 @@ module FEEN
   module Parser
     # The turn module.
     module Turn
-      # @param active_side_id [String] The identifier of bottom-side and
+      # @param 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)
+      def self.parse(side_id)
+        Integer(side_id)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feen
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="