software_challenge_client 20.2.2 → 20.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fae378685b67cd4b5e9568aa6da7f59734266680819f15fa97297e2a532fa34
-  data.tar.gz: 1d2592e9d328f2cc079a21aa6fcc5901395b1e18b9edf3505e06a7805623fcc4
+  metadata.gz: 60c420d04b5a4e4698dfdcbefbeab11ab0654275d22d034862ca0d905c70c9c8
+  data.tar.gz: 350efa8b2c7a859ac8c8cb03af9b98f1df32a2edb1a40e4361db77fb7ae62225
 SHA512:
-  metadata.gz: 53b31ae3336f7cc0544de8099ddc39156a0d4e7ae7c118c1cff160072e4d7085ce6852b004c028404378ec4e0024b1ea5b8e58e6aad1ae096a629e79a349e35d
-  data.tar.gz: ab4d43ca12dcc42969887613908b1e1f49b85148cb4324901e9afb74cfe6498acbca72865b8517553da4101384370950f018492c25a34c1c95497d3cc236b259
+  metadata.gz: 381e43a1d2ba588ae698c1bbfa6da502893cf9dac3005d2c33bcde6f58d772b7c28e27e7b193954688a61d5ca3bb7f17d97ae23d4c53285ea8d24cdbc9a2845f
+  data.tar.gz: 7c5780b519aef624d543c1aa26a1af9718adef54f93156ed56be352b00f449c6e4714958f97271e77f7d3b6b5e7cc32f91d977e2f961fb20a59e9a3b0f17b71c

data/RELEASES.md

@@ -1,3 +1,7 @@
+= 20.2.3
+
+Improve method documentation
+
 = 20.2.1 & 20.2.2
 
 Bugfixes for performing moves on a gamestate

data/Rakefile

@@ -3,5 +3,4 @@ require "yard"
 
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb']   # optional
-  t.options = ['--any', '--extra', '--opts'] # optional
 end

data/lib/software_challenge_client/board.rb

@@ -15,11 +15,14 @@ class Board
   #   seiner x und y CubeCoordinates im Array gespeichert.
   attr_reader :fields
 
+  # Anzahl der Felder eines hexagonalen Spielfeldes
+  # @param radius [Integer] Radius des Spielfeldes
   def self.field_amount(radius)
     return 1 if radius == 1
     (radius - 1) * 6 + Board.field_amount(radius - 1)
   end
 
+  # Anzahl der Felder des fuer Hive verwendeten Spielfeldes
   FIELD_AMOUNT = Board.field_amount((BOARD_SIZE + 1)/2)
 
   # Erstellt ein neues leeres Spielbrett.
@@ -28,6 +31,7 @@ class Board
     fields.each{ |f| add_field(f) }
   end
 
+  # @return [Array] leere Felder entsprechend des Spielbrettes angeordnet
   def self.empty_game_field
     fields = []
     (-SHIFT..SHIFT).to_a.each do |x|
@@ -39,10 +43,12 @@ class Board
     fields
   end
 
+  # Entfernt alle Felder des Spielfeldes
   def clear
     @fields = []
   end
 
+  # @return [Array] Liste aller Felder
   def field_list
     @fields.flatten.select{ |e| !e.nil? }
   end
@@ -90,21 +96,23 @@ class Board
     field_list.select{ |f| f.color == color }
   end
 
+  # @return [Array] Liste aller Spielsteine, die auf dem Spielbrett platziert wurden
   def pieces
     field_list.map(&:pieces).flatten
   end
 
+  # @param [PlayerColor] Spielerfarbe
+  # @return [Array] Liste aller Spielsteine eines Spielers, die auf dem Spielbrett platziert wurden
   def deployed_pieces(color)
     pieces.select { |p| p.color == color }
   end
 
+  # @return eine unabhaengige Kopie des Spielbretts
   def clone
     Marshal.load(Marshal.dump(self))
   end
 
-  # Gibt eine textuelle Repräsentation des Spielbrettes aus. Hier steht R für
-  # einen roten Fisch, B für einen blauen, ~ für ein leeres Feld und O für ein
-  # Kraken-Feld.
+  # Gibt eine textuelle Repräsentation des Spielbrettes aus.
   def to_s
     field_list.sort_by(&:z).map{ |f| f.obstructed ? 'OO' : f.empty? ? '--' : f.pieces.last.to_s }.join
   end

data/lib/software_challenge_client/condition.rb

@@ -12,7 +12,8 @@ class Condition
   attr_reader :reason
 
   # Initializes the winning Condition with a player
-  # @param winer [Player] winning player
+  # @param winner [Player] winning player
+  # @param reason [String] why the player has won
   def initialize(winner, reason)
     @winner = winner
     @reason = reason

data/lib/software_challenge_client/cube_coordinates.rb

@@ -1,3 +1,5 @@
+# CubeCoordinates erleichtern viele Berechnungen auf einem hexagonalen Spielfeld. Siehe
+# https://www.redblobgames.com/grids/hexagons/#coordinates-cube
 class CubeCoordinates
 
   attr_reader :x, :y, :z

data/lib/software_challenge_client/direction.rb

@@ -22,9 +22,9 @@ class Direction < TypesafeEnum::Base
 
   # Verschiebt den durch das Koordinatenpaar angegebenen Punkt in die
   # entsprechende Richtung. Der resultierende Punkt kann ausserhalb des
-  # Spielbrettes liegen. Dies kann mit {GameRuleLogic#inside_bounds?} geprüft
+  # Spielbrettes liegen. Dies kann mit {GameRuleLogic.is_on_board} geprüft
   # werden.
-  # @param coordinates [CubeCoordinates] Das zu verschiebende Koordinatenpaar.
+  # @param start [CubeCoordinates] Das zu verschiebende Koordinatenpaar.
   # @param distance [Integer] Um wieviele Felder in die Richtung verschoben werden soll.
   def translate(start, distance = 1)
     shiftX = start.x

data/lib/software_challenge_client/drag_move.rb

@@ -1,5 +1,6 @@
 require_relative 'has_hints'
 
+# Ein Zug, der einen auf dem Spielbrett befindlichen Spielstein bewegt.
 class DragMove
 
   include HasHints
@@ -7,6 +8,8 @@ class DragMove
   attr_reader :start
   attr_reader :destination
 
+  # @param start [CubeCoordinates]
+  # @param destination [CubeCoordinates]
   def initialize(start, destination)
     @start = start
     @destination = destination

data/lib/software_challenge_client/field.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 
 # Ein Feld des Spielfelds. Ein Spielfeld ist durch die Koordinaten eindeutig identifiziert.
-# Das type Attribut gibt an, um welchen Feldtyp es sich handelt
 class Field
   # @!attribute [rw] pieces
   # @return [Array<Piece>] Spielsteine auf dem Feld, beginnend beim untersten Stein
@@ -15,7 +14,6 @@ class Field
 
   # Konstruktor
   #
-  # @param type [FieldType] Feldtyp
   # @param x [Integer] X-Koordinate
   # @param y [Integer] Y-Koordinate
   # @param pieces [Array<Piece>] Spielsteine auf dem Feld
@@ -46,10 +44,12 @@ class Field
     coordinates.z
   end
 
+  # @return [Boolean] true, wenn eine Spielsteine auf dem Feld liegen und es nicht durch eine Brombeere blockiert ist
   def empty?
     pieces.empty? && !obstructed
   end
 
+  # @return [Boolean] true, es nicht durch eine Brombeere blockiert ist
   def obstructed?
     obstructed
   end
@@ -58,10 +58,13 @@ class Field
     pieces.push(piece)
   end
 
+  # Entfernt den obersten Spielstein
+  # @return [Piece] entfernten Spielstein oder nil
   def remove_piece
     pieces.pop
   end
 
+  # @return [PlayerColor] Farbe des Spielers, der den obersten Spielstein kontrolliert. Ohne Spielsteine nil
   def color
     pieces.last&.color
   end

data/lib/software_challenge_client/protocol.rb

@@ -205,7 +205,7 @@ class Protocol
 
   # send a string
   #
-  # @param document [String] The string that will be send to the connected server.
+  # @param string [String] The string that will be send to the connected server.
   def sendString(string)
     @network.sendString("<room roomId=\"#{@roomId}\">#{string}</room>")
   end

data/lib/software_challenge_client/util/constants.rb

@@ -5,7 +5,7 @@
 module Constants
   ROUND_LIMIT = 30 # Rundenbegrenzung. Nach Ende der angegebenen Runde endet auch das Spiel.
   GAME_IDENTIFIER = 'swc_2020_hive' # Der Identifikator des Spiels. Für die Kommunikation mit dem Spielserver.
-  STARTING_PIECES = 'QSSSGGBBAAA'
-  BOARD_SIZE = 11
-  SHIFT = ((BOARD_SIZE - 1) / 2)
+  STARTING_PIECES = 'QSSSGGBBAAA' # Spielsteine, die jeder Spieler am Anfang des Spiels bekommt in textueller Repraesentation
+  BOARD_SIZE = 11 # Durchmesser des Spielbretts in Feldern
+  SHIFT = ((BOARD_SIZE - 1) / 2) # Wert, den man auf eine CubeCoordinate addieren muss, um einen positiven Index (fuer das Feld-Array) zu bekommen
 end

data/lib/software_challenge_client/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module SoftwareChallengeClient
-  VERSION = "20.2.2"
+  VERSION = "20.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: software_challenge_client
 version: !ruby/object:Gem::Version
-  version: 20.2.2
+  version: 20.2.3
 platform: ruby
 authors:
 - 'kwollw '
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typesafe_enum