qi 10.0.0.beta6 → 10.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 638a4dafc9645e200d72d7799afb3f28cca3a81f7cd887e5f29c64974e5776e0
-  data.tar.gz: 5e74a8a31f894187b404a3c41ed1a1434916880925934f2fe627e19472f99084
+  metadata.gz: 816f97762efb0e9f7a603b93b5703b4b68c6a4629f438f39ed49d09227b9650a
+  data.tar.gz: 1c90d60785447ff965ef92816ed58e7a0d315ffb9b104c185c76d4d1da461435
 SHA512:
-  metadata.gz: 41a6e8c87db922ca87d992b62909c6cf5d87d8900d12c9bc0b43d94d1882040d168678ee9d3f6be85904b7f275a0eaa9c42e32364b0d7c5e4766ec84953fdb10
-  data.tar.gz: 14323df90b7e942fbae1a1db4f3e23f071c4fdd62bd969797a39909c710e599534c5eaa2fd4b6a01ffbe91f48d25122a28c32b599fc5731f9b3c14b72c2f8a74
+  metadata.gz: '0906bf4de292b88d43e88241a8690753ca6776320de3070a5f575eb44070913a68807dbf25e9836a46c0361e43fdd6cbe5f869c558695828174f7dbc548934b0'
+  data.tar.gz: 495dd33b36e4141be5d79e989b54c735f7e86edd52b323780448f19ba16530b125564ccfb3ac9d0a668c3d841d03c889a733e5775d52f2cf210ed7d0448d719b

data/README.md

@@ -13,7 +13,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "qi", ">= 10.0.0.beta5"
+gem "qi", ">= 10.0.0.beta8"
 ```
 
 And then execute:
@@ -45,8 +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.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.serialize       # => "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.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.to_a
 # [false,
@@ -61,8 +61,8 @@ 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.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.serialize       # => "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.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.to_a
 # [true,

data/lib/qi/error/drop.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Qi
+  module Error
+    class Drop < ::IndexError
+    end
+  end
+end

data/lib/qi.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "qi/error/drop"
+
 # A class that represents the state of a game.
 class Qi
   # @!attribute [r] north_captures
@@ -39,6 +41,30 @@ class Qi
     self.class.new(!north_turn?, *modified_captures, modified_squares)
   end
 
+  def side_name
+    if north_turn?
+      "north"
+    else
+      "south"
+    end
+  end
+
+  def other_captures
+    if north_turn?
+      south_captures
+    else
+      north_captures
+    end
+  end
+
+  def owned_captures
+    if north_turn?
+      north_captures
+    else
+      south_captures
+    end
+  end
+
   # Checks if it is the north turn or not.
   #
   # @return [Boolean] true if it is the north turn and false otherwise
@@ -69,6 +95,22 @@ class Qi
     ]
   end
 
+  # Returns a hash representation of the Qi object's attributes.
+  #
+  # @return [Hash{Symbol => Object}] a hash containing four key-value pairs:
+  #   - is_north_turn: a boolean value indicating whose turn it is
+  #   - north_captures: an array of pieces captured by the north player
+  #   - south_captures: an array of pieces captured by the south player
+  #   - squares: a hash of squares on the board
+  def to_h
+    {
+      is_north_turn:  north_turn?,
+      north_captures:,
+      south_captures:,
+      squares:
+    }
+  end
+
   # Returns a string representation of the Qi object's attributes.
   #
   # @return [String] a string containing three parts separated by "===":
@@ -76,7 +118,7 @@ class Qi
   #   - 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_turn     = "#{side_name}-turn"
     serialized_captures = (north_captures + south_captures).sort.join(",")
     serialized_squares  = squares.keys.map { |i| "#{i}:#{squares.fetch(i)}" }.join(",")
 
@@ -100,14 +142,11 @@ class Qi
   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
+    captures = if is_drop
+                 remove_from_captures(in_hand, *owned_captures)
+               else
+                 owned_captures + [in_hand]
+               end
 
     north_turn? ? [captures, other_captures] : [other_captures, captures]
   end
@@ -117,10 +156,10 @@ class Qi
   # @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
+  # @raise [Qi::Error::Drop] 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?
+    raise Error::Drop, "There are no #{piece} in hand." if index.nil?
 
     captures.delete_at(index)
     captures

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 10.0.0.beta6
+  version: 10.0.0.beta8
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-23 00:00:00.000000000 Z
+date: 2023-05-06 00:00:00.000000000 Z
 dependencies: []
 description: An abstraction that could help to update positions for games like Shogi.
 email: contact@cyril.email
@@ -19,6 +19,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/qi.rb
+- lib/qi/error/drop.rb
 homepage: https://github.com/sashite/qi.rb
 licenses:
 - MIT