qi 10.0.0.beta7 → 10.0.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e850bab495ea23b4c438ec54439eb4b4b0486d0b6d1afd23f9d9d870eca46e43
-  data.tar.gz: 0f0e3271857d1a513069416bcb246b439f3fb99b3f550a9a9f1e1bc15b286a35
+  metadata.gz: 807fc7b14621e81663ea476f2d737352d455d4d2ab1d49efbe722c3ce571ed15
+  data.tar.gz: 9244deacf36f2717897a23b56de132af40ce308cd5977ee92899f57c49368f0e
 SHA512:
-  metadata.gz: c94b483676c67796e208e2b354420c9fd20d0f286d2e3f4c6145a70945d61f601b8803af2ebed7bca964435881a27499a63f18151073f8bcf04126a65b265e2a
-  data.tar.gz: 62665dedc27de056316e923fcf5e6e604de42c399b00b2b015b5a2e44049fae9f05cee3a95d08aaaf655f77a54f1ae923ebcfe69ec373ba37657aa45bb656b52
+  metadata.gz: 87cedbb94ddcecb3026647893aac63ce6559c92d37dc65121850efca0eb1ddd7a1616e441a0c40463a2bbe664de59d4498bbcfcfd3aa3caae6075a65851c57c5
+  data.tar.gz: 62a213dcaeb4d68cc6c4bc01b4d9b4a2df33b3d8bcca09c5e494e6a5b0eb349b236907437caa12c11777c6eaac559402e927f3db972f89acb4cd07f77408c4d9

data/README.md

@@ -13,7 +13,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "qi", ">= 10.0.0.beta7"
+gem "qi", ">= 10.0.0.beta9"
 ```
 
 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,8 @@
 # frozen_string_literal: true
 
+require "digest"
+require_relative "qi/error/drop"
+
 # A class that represents the state of a game.
 class Qi
   # @!attribute [r] north_captures
@@ -39,6 +42,37 @@ class Qi
     self.class.new(!north_turn?, *modified_captures, modified_squares)
   end
 
+  def eql?(other)
+    return false unless other.respond_to?(:serialize)
+
+    other.serialize == serialize
+  end
+  alias == eql?
+
+  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
+
+  def side_name
+    if north_turn?
+      "north"
+    else
+      "south"
+    end
+  end
+
   # Checks if it is the north turn or not.
   #
   # @return [Boolean] true if it is the north turn and false otherwise
@@ -85,6 +119,11 @@ class Qi
     }
   end
 
+  # Returns the hash-code for the position.
+  def hash
+    ::Digest::SHA256.hexdigest(serialize)
+  end
+
   # Returns a string representation of the Qi object's attributes.
   #
   # @return [String] a string containing three parts separated by "===":
@@ -92,7 +131,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(",")
 
@@ -116,14 +155,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
@@ -133,10 +169,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.beta7
+  version: 10.0.0.beta9
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 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