qi 10.0.0.beta5 → 10.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73eb059b5776d83c165ffe3a37592221e2c28a449cc271b74be2644c9e8e1ed3
-  data.tar.gz: 37f4b7fe311e4ed0ce178031b17dd45e19281a9778b16785a0e829580c52d93b
+  metadata.gz: 638a4dafc9645e200d72d7799afb3f28cca3a81f7cd887e5f29c64974e5776e0
+  data.tar.gz: 5e74a8a31f894187b404a3c41ed1a1434916880925934f2fe627e19472f99084
 SHA512:
-  metadata.gz: c9feb0ac434f46f4b1d0c6c201ae0d64c084bc4b5b76b82eff8002eb1109580f018d2df65906a0c098129a28d1a2da06744252bcbb04ef1934b926c50ec4cd89
-  data.tar.gz: 89cbfe6706285b7f482161c2b7188afcc6b94c69aa002bb9f42218b7d246c2066876dc73506a83fcd63ea84430302c4f92feda6f4685749ef9200dba9f8ad2cf
+  metadata.gz: 41a6e8c87db922ca87d992b62909c6cf5d87d8900d12c9bc0b43d94d1882040d168678ee9d3f6be85904b7f275a0eaa9c42e32364b0d7c5e4766ec84953fdb10
+  data.tar.gz: 14323df90b7e942fbae1a1db4f3e23f071c4fdd62bd969797a39909c710e599534c5eaa2fd4b6a01ffbe91f48d25122a28c32b599fc5731f9b3c14b72c2f8a74

data/README.md

@@ -45,7 +45,8 @@ qi0.south_captures  # => ["S"]
 qi0.squares         # => {3=>"s", 4=>"k", 5=>"s", 22=>"+P", 43=>"+B"}
 qi0.north_turn?     # => false
 qi0.south_turn?     # => true
-qi0.inspect         # => "<Qi south-turn 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 3:s,4:k,5:s,22:+P,43:+B>"
+qi0.serialize       # => "SouthTurn===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===3:s,4:k,5:s,22:+P,43:+B"
+qi0.inspect         # => "<Qi SouthTurn===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===3:s,4:k,5:s,22:+P,43:+B>"
 
 qi0.to_a
 # [false,
@@ -53,20 +54,6 @@ qi0.to_a
 #  ["S"],
 #  {3=>"s", 4=>"k", 5=>"s", 22=>"+P", 43=>"+B"}]
 
-qi0.display(81, 9)
-# [["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"],
-#  [[". ", ". ", ". ", "s ", "k ", "s ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", "+P", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", "+B", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "]],
-#  ["S"],
-#  "Turn to south"]
-
 qi1 = qi0.commit({ 43 => nil, 13 => "+B" })
 
 qi1.north_captures  # => ["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"]
@@ -74,27 +61,14 @@ qi1.south_captures  # => ["S"]
 qi1.squares         # => {3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}
 qi1.north_turn?     # => true
 qi1.south_turn?     # => false
-qi1.inspect         # => "<Qi north-turn 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 3:s,4:k,5:s,22:+P,13:+B>"
+qi1.serialize       # => "NorthTurn===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===3:s,4:k,5:s,22:+P,13:+B"
+qi1.inspect         # => "<Qi NorthTurn===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===3:s,4:k,5:s,22:+P,13:+B>"
 
 qi1.to_a
 # [true,
 #  ["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"],
 #  ["S"],
 #  {3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}]
-
-qi1.display(81, 9)
-# [["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"],
-#  [[". ", ". ", ". ", "s ", "k ", "s ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", "+B", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", "+P", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "],
-#   [". ", ". ", ". ", ". ", ". ", ". ", ". ", ". ", ". "]],
-#  ["S"],
-#  "Turn to north"]
 ```
 
 ## License

data/lib/qi.rb

@@ -10,11 +10,12 @@ class Qi
   #   @return [Hash] a hash of pieces on the board
   attr_reader :north_captures, :south_captures, :squares
 
-  # Initializes a new Qi object with the given parameters.
+  # Initializes a new Qi object with the given attributes.
+  #
   # @param is_north_turn [Boolean] a boolean value indicating whose turn it is
-  # @param north_captures [Array] an array of pieces captured by the north player
-  # @param south_captures [Array] an array of pieces captured by the south player
-  # @param squares [Hash] a hash of pieces on the board
+  # @param north_captures [Array<Object>] an array of pieces captured by the north player
+  # @param south_captures [Array<Object>] an array of pieces captured by the south player
+  # @param squares [Hash<Object, Object>] a hash of squares on the board
   def initialize(is_north_turn, north_captures, south_captures, squares)
     # Assign the parameters to instance variables.
     @is_north_turn  = is_north_turn
@@ -24,48 +25,37 @@ class Qi
   end
 
   # Returns a new Qi object that represents the state after applying the given changes.
-  # @param diffs [Hash] a hash of changes to apply to the squares hash
+  #
+  # @param diffs [Hash<Object, Object>] a hash of changes to apply to the squares hash
   # @param in_hand [Object, nil] the piece that is in hand or nil if none
   # @param is_drop [Boolean] a boolean value indicating whether the in hand piece is dropped or not
-  # @return [Qi] a new Qi object with modified attributes
-  def commit(diffs = {}, in_hand = nil, is_drop = false)
+  # @return [Qi] a new Qi object with modified attributes, where:
+  #   - the turn is switched
+  #   - the captures are updated according to the in hand piece and the drop flag
+  #   - the squares are merged with the diffs hash
+  def commit(diffs = {}, in_hand = nil, is_drop: false)
     modified_squares = squares.merge(diffs)
-
-    if in_hand.nil?
-      self.class.new(south_turn?, north_captures, south_captures, modified_squares)
-    elsif north_turn?
-      modified_captures = if is_drop
-                            remove_from_captures(in_hand, *north_captures)
-                          else
-                            north_captures + [in_hand]
-                          end
-
-      self.class.new(false, modified_captures, south_captures, modified_squares)
-    else
-      modified_captures = if is_drop
-                            remove_from_captures(in_hand, *south_captures)
-                          else
-                            south_captures + [in_hand]
-                          end
-
-      self.class.new(true, north_captures, modified_captures, modified_squares)
-    end
+    modified_captures = update_captures(in_hand, is_drop:)
+    self.class.new(!north_turn?, *modified_captures, modified_squares)
   end
 
   # Checks if it is the north turn or not.
+  #
   # @return [Boolean] true if it is the north turn and false otherwise
   def north_turn?
     @is_north_turn
   end
 
   # Checks if it is not the north turn or not.
+  #
   # @return [Boolean] true if it is not the north turn and false otherwise
   def south_turn?
     !north_turn?
   end
 
   # Returns an array representation of the Qi object's attributes.
-  # @return [Array] an array containing four elements:
+  #
+  # @return [Array(Boolean, Array<Object>, Array<Object>, Hash<Object, Object>)] an array containing four elements:
   #   - a boolean value indicating whose turn it is
   #   - an array of pieces captured by the north player
   #   - an array of pieces captured by the south player
@@ -79,48 +69,60 @@ class Qi
     ]
   end
 
-  # Returns an array representation of the Qi object's attributes for display purposes.
-  # @param size [Integer] the number of squares on the board
-  # @param cols [Integer] the number of columns on the board
-  # @return [Array] an array containing four elements:
-  #   - an array of pieces captured by the north player
-  #   - a nested array of strings representing the squares on the board
-  #   - an array of pieces captured by the south player
-  #   - a string indicating whose turn it is
-  def display(size, cols)
-    square_size = squares.values.max_by(&:length).length
-    board = (0...size).to_a.map { |i| squares.fetch(i, ".") }.map { |square| square.center(square_size) }.each_slice(cols).to_a
-    turn = (north_turn? ? "Turn to north" : "Turn to south")
+  # Returns a string representation of the Qi object's attributes.
+  #
+  # @return [String] a string containing three parts separated by "===":
+  #   - the current turn, either "NorthTurn" or "SouthTurn"
+  #   - the captures, sorted and joined by ","
+  #   - the squares, mapped to "coordinate:piece" pairs and joined by ","
+  def serialize
+    serialized_turn     = (north_turn? ? "NorthTurn" : "SouthTurn")
+    serialized_captures = (north_captures + south_captures).sort.join(",")
+    serialized_squares  = squares.keys.map { |i| "#{i}:#{squares.fetch(i)}" }.join(",")
 
-    [
-      north_captures,
-      board,
-      south_captures,
-      turn
-    ]
+    "#{serialized_turn}===#{serialized_captures}===#{serialized_squares}"
   end
 
-  # Returns a string representation of the Qi object's attributes.
-  # @return [String] a string containing the turn, the captures and the squares in a formatted way.
+  # Returns a human-readable representation of the Qi object.
+  #
+  # @return [String] a string containing the class name and the serialized attributes
   def inspect
-    serialized_turn     = (north_turn? ? "north-turn" : "south-turn")
-    serialized_captures = captures.join(",")
-    serialized_squares  = squares.keys.map { |i| "#{i}:#{squares.fetch(i)}" }.join(",")
-
-    "<Qi #{serialized_turn} #{serialized_captures} #{serialized_squares}>"
+    "<#{self.class} #{serialize}>"
   end
 
   private
 
-  def captures
-    south_captures + north_captures
-  end
+  # Updates the captures arrays based on the piece in hand and whether it is dropped or not.
+  #
+  # @param in_hand [Object, nil] the piece that is in hand or nil if none
+  # @param is_drop [Boolean] a boolean value indicating whether the in hand piece is dropped or not
+  # @return [Array] an array containing the updated north and south captures arrays
+  def update_captures(in_hand, is_drop:)
+    return [north_captures, south_captures] if in_hand.nil?
+
+    captures = north_turn? ? north_captures : south_captures
+    other_captures = north_turn? ? south_captures : north_captures
+
+    if is_drop
+      captures = remove_from_captures(in_hand, *captures)
+    else
+      captures += [in_hand]
+    end
 
-  def remove_from_captures(captured_piece, *captured_pieces)
-    capture_id = captured_pieces.rindex(captured_piece)
-    raise ::IndexError, "#{captured_piece} not found!" if capture_id.nil?
+    north_turn? ? [captures, other_captures] : [other_captures, captures]
+  end
 
-    captured_pieces.delete_at(capture_id)
-    captured_pieces
+  # Removes the last occurrence of a piece from an array of captures and returns the modified array.
+  #
+  # @param piece [Object] the piece to be removed
+  # @param captures [Array<Object>] the array of captures
+  # @return [Array<Object>] the modified array of captures
+  # @raise [IndexError] if the piece is not found in the array
+  def remove_from_captures(piece, *captures)
+    index = captures.rindex(piece)
+    raise ::IndexError, "#{piece} not found!" if index.nil?
+
+    captures.delete_at(index)
+    captures
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 10.0.0.beta5
+  version: 10.0.0.beta6
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-22 00:00:00.000000000 Z
+date: 2023-04-23 00:00:00.000000000 Z
 dependencies: []
 description: An abstraction that could help to update positions for games like Shogi.
 email: contact@cyril.email