software_challenge_client 20.2.4 → 21.2.0

data/lib/software_challenge_client/player.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 # Ein Spieler
 class Player
@@ -6,15 +7,15 @@ class Player
   # @return [String] der Name des Spielers, hat keine Auswirkungen auf das Spiel
   attr_reader :name
 
-  # @!attribute [r] color
-  # @return [PlayerColor] die Farbe des Spielers, Rot oder Blau
-  attr_reader :color
+  # @!attribute [r] type
+  # @return [PlayerType] erster (PlayerType::ONE) oder zweiter (PlayerType::TWO) Spieler
+  attr_reader :type
 
   # Konstruktor
-  # @param color [PlayerColor] Farbe
+  # @param type [PlayerType] Erster oder zweiter
   # @param name [String] Name
-  def initialize(color, name)
-    @color = color
+  def initialize(type, name)
+    @type = type
     @name = name
   end
 

data/lib/software_challenge_client/player_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'typesafe_enum'
+
+# Erster oder zweiter Spieler:
+#
+#   ONE
+#   TWO
+#
+# Zugriff z.B. mit PlayerType::ONE
+class PlayerType < TypesafeEnum::Base
+  new :ONE
+  new :TWO
+end

data/lib/software_challenge_client/protocol.rb

@@ -3,7 +3,6 @@
 require 'socket'
 require_relative 'board'
 require_relative 'set_move'
-require_relative 'drag_move'
 require_relative 'skip_move'
 require_relative 'player'
 require_relative 'network'
@@ -41,7 +40,7 @@ class Protocol
   #
   # @param text [String] the xml-string that will be parsed
   def process_string(text)
-    logger.debug "Parse XML:\n#{text}\n----END XML"
+    #logger.debug "Parse XML:\n#{text}\n----END XML"
     begin
       REXML::Document.parse_stream(text, self)
     rescue REXML::ParseException => e
@@ -50,7 +49,6 @@ class Protocol
     end
   end
 
-
   # called when text is encountered
   def text(text)
     @context[:last_text] = text
@@ -63,6 +61,27 @@ class Protocol
     case name
     when 'board'
       logger.debug @gamestate.board.to_s
+    when 'color'
+      if @context[:color] == :valid_colors
+        @gamestate.valid_colors << Color.to_a.find {|s| s.key == @context[:last_text].to_sym }
+      end
+    when 'shape'
+      case @context[:piece_target] 
+      when :blue_shapes
+        last = @context[:last_text]
+        arr = PieceShape.to_a
+        shape = arr.find {|s| s.key == @context[:last_text].to_sym }
+        @gamestate.undeployed_blue_pieces << shape
+      when :yellow_shapes
+        shape = PieceShape.to_a.find {|s| s.key == @context[:last_text].to_sym }
+        @gamestate.undeployed_yellow_pieces << shape
+      when :red_shapes
+        shape = PieceShape.to_a.find {|s| s.key == @context[:last_text].to_sym }
+        @gamestate.undeployed_red_pieces << shape
+      when :green_shapes
+        shape = PieceShape.to_a.find {|s| s.key == @context[:last_text].to_sym }
+        @gamestate.undeployed_green_pieces << shape
+      end
     end
   end
 
@@ -98,58 +117,67 @@ class Protocol
       logger.debug 'new gamestate'
       @gamestate = GameState.new
       @gamestate.turn = attrs['turn'].to_i
-      @gamestate.start_player_color = attrs['startPlayerColor'] == 'RED' ? PlayerColor::RED : PlayerColor::BLUE
-      @gamestate.current_player_color = attrs['currentPlayerColor'] == 'RED' ? PlayerColor::RED : PlayerColor::BLUE
-      logger.debug "Turn: #{@gamestate.turn}"
-    when 'red'
-      logger.debug 'new red player'
-      player = parsePlayer(attrs)
-      if player.color != PlayerColor::RED
-        throw new IllegalArgumentException("expected #{PlayerColor::RED} Player but got #{player.color}")
-      end
+      @gamestate.round = attrs['round'].to_i
+      @gamestate.start_piece = PieceShape.to_a.find {|s| s.key == attrs['startPiece'].to_sym }
+      logger.debug "Round: #{@gamestate.round}, Turn: #{@gamestate.turn}"
+    when 'first'
+      logger.debug 'new first player'
+      player = Player.new(PlayerType::ONE, attrs['displayName'])
       @gamestate.add_player(player)
       @context[:player] = player
-    when 'blue'
-      logger.debug 'new blue player'
-      player = parsePlayer(attrs)
-      if player.color != PlayerColor::BLUE
-        throw new IllegalArgumentException("expected #{PlayerColor::BLUE} Player but got #{player.color}")
-      end
+      @context[:color] = :one
+    when 'second'
+      logger.debug 'new second player'
+      player = Player.new(PlayerType::TWO, attrs['displayName'])
       @gamestate.add_player(player)
       @context[:player] = player
+      @context[:color] = :two
+    when 'validColors'
+      @context[:color] = :valid_colors
+      @gamestate.valid_colors = []
     when 'board'
       logger.debug 'new board'
-      @gamestate.board = Board.new
+      @gamestate.board = Board.new()
     when 'field'
       x = attrs['x'].to_i
       y = attrs['y'].to_i
-      obstructed = attrs['isObstructed'] == 'true'
-      field = Field.new(x, y, [], obstructed)
+      color = Color.find_by_key(attrs['content'].to_sym)
+      field = Field.new(x, y, color)
       @gamestate.board.add_field(field)
       @context[:piece_target] = :field
       @context[:field] = field
+    when 'blueShapes'
+      @context[:piece_target] = :blue_shapes
+      @gamestate.undeployed_blue_pieces = []
+    when 'yellowShapes'
+      @context[:piece_target] = :yellow_shapes
+      @gamestate.undeployed_yellow_pieces = []
+    when 'redShapes'
+      @context[:piece_target] = :red_shapes
+      @gamestate.undeployed_red_pieces = []
+    when 'greenShapes'
+      @context[:piece_target] = :green_shapes
+      @gamestate.undeployed_green_pieces = []
     when 'piece'
-      owner = PlayerColor.find_by_key(attrs['owner'].to_sym)
-      type = PieceType.find_by_key(attrs['type'].to_sym)
-      piece = Piece.new(owner, type)
+      color = Color.find_by_key(attrs['color'].to_sym)
+      kind = PieceShape.find_by_key(attrs['kind'].to_sym)
+      rotation = Rotation.find_by_key(attrs['rotation'].to_sym)
+      is_flipped = attrs['isFlipped'].downcase == "true"
+      piece = Piece.new(color, kind, rotation, is_flipped, Coordinates.origin)
       case @context[:piece_target]
-      when :field
-        @context[:field].add_piece(piece)
-      when :undeployed_red_pieces
-        @gamestate.undeployed_red_pieces << piece
-      when :undeployed_blue_pieces
+      when :blue_shapes
         @gamestate.undeployed_blue_pieces << piece
+      when :yellow_shapes
+        @gamestate.undeployed_yellow_pieces << piece
+      when :red_shapes 
+        @gamestate.green_red_pieces << piece
+      when :green_shapes
+        @gamestate.undeployed_green_pieces << piece
       when :last_move
         @context[:last_move_piece] = piece
       else
         raise "unknown piece target #{@context[:piece_target]}"
       end
-    when 'undeployedRedPieces'
-      @context[:piece_target] = :undeployed_red_pieces
-      @gamestate.undeployed_red_pieces = []
-    when 'undeployedBluePieces'
-      @context[:piece_target] = :undeployed_blue_pieces
-      @gamestate.undeployed_blue_pieces = []
     when 'lastMove'
       type = attrs['class']
       if type == 'skipmove'
@@ -158,24 +186,24 @@ class Protocol
         @context[:last_move_type] = type
         @context[:piece_target] = :last_move
       end
-    when 'start'
-      @context[:last_move_start] = CubeCoordinates.new(attrs['x'].to_i, attrs['y'].to_i, attrs['z'].to_i)
-    when 'destination'
-      destination = CubeCoordinates.new(attrs['x'].to_i, attrs['y'].to_i, attrs['z'].to_i)
-      case @context[:last_move_type]
-      when 'setmove'
-        @gamestate.last_move = SetMove.new(@context[:last_move_piece], destination)
-      when 'dragmove'
-        @gamestate.last_move = SetMove.new(@context[:last_move_start], destination)
+    when 'position'
+      case @context[:piece_target] 
+      when :last_move
+        x = attrs['x'].to_i
+        y = attrs['y'].to_i
+        piece = @context[:last_move_piece]
+        @gamestate.last_move = SetMove.new(Piece.new(piece.color, piece.kind, piece.rotation, piece.is_flipped, Coordinates.new(x, y)))
       end
+    when 'startColor'
+      @gamestate.start_color = Color::BLUE
     when 'winner'
-    # TODO
-      #winning_player = parsePlayer(attrs)
-      #@gamestate.condition = Condition.new(winning_player, @gamestate.condition.reason)
+      # TODO
+      # winning_player = parsePlayer(attrs)
+      # @gamestate.condition = Condition.new(winning_player, @gamestate.condition.reason)
     when 'score'
       # TODO
       # there are two score tags in the result, but reason attribute should be equal on both
-      #@gamestate.condition = Condition.new(@gamestate.condition.winner, attrs['reason'])
+      # @gamestate.condition = Condition.new(@gamestate.condition.winner, attrs['reason'])
     when 'left'
       logger.debug 'got left event, terminating'
       @network.disconnect
@@ -185,17 +213,6 @@ class Protocol
     end
   end
 
-  # Converts XML attributes for a Player to a new Player object
-  #
-  # @param attributes [Hash] Attributes for the new Player.
-  # @return [Player] The created Player object.
-  def parsePlayer(attributes)
-    Player.new(
-      PlayerColor.find_by_key(attributes['color'].to_sym),
-      attributes['displayName']
-    )
-  end
-
   # send a xml document
   #
   # @param document [REXML::Document] the document, that will be send to the connected server
@@ -228,26 +245,17 @@ class Protocol
     # structures.
     case move
     when SetMove
-      builder.data(class: 'setmove') do |data|
-        data.piece(owner: move.piece.owner.key, type: move.piece.type.key)
-        d = move.destination
-        data.destination(x: d.x, y: d.y, z: d.z)
-        move.hints.each do |hint|
-          data.hint(content: hint.content)
+      builder.data(class: 'sc.plugin2021.SetMove') do |data|
+        data.piece(color: move.piece.color, kind: move.piece.kind, rotation: move.piece.rotation, isFlipped: move.piece.is_flipped) do |piece|
+          piece.position(x: move.piece.position.x, y: move.piece.position.y)
         end
-      end
-    when DragMove
-      builder.data(class: 'dragmove') do |data|
-        s = move.start
-        data.start(x: s.x, y: s.y, z: s.z)
-        d = move.destination
-        data.destination(x: d.x, y: d.y, z: d.z)
         move.hints.each do |hint|
           data.hint(content: hint.content)
         end
       end
     when SkipMove
-      builder.data(class: 'skipmove') do |data|
+      builder.data(class: 'sc.plugin2021.SkipMove') do |data|
+        data.color(@gamestate.current_color.key.to_s)
         move.hints.each do |hint|
           data.hint(content: hint.content)
         end
@@ -255,5 +263,4 @@ class Protocol
     end
     builder.target!
   end
-
 end

data/lib/software_challenge_client/rotation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'typesafe_enum'
+
+# Die Drehung eines Steins
+class Rotation < TypesafeEnum::Base
+  new :NONE, 0
+  new :RIGHT, 1
+  new :MIRROR, 2
+  new :LEFT, 3
+
+  # Summiere beide Rotationen auf.
+  # (Die resultierende Rotation hat den gleichen Effekt wie die beiden Rotationen einzeln).
+  def rotate(rotation)
+    Rotation.to_a[(value + rotation.value) % Rotation.size]
+  end
+
+  # Gibt den rotation namen zurück
+  def to_s
+    self.key.to_s
+  end
+end

data/lib/software_challenge_client/runner.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 require_relative 'board'
 require_relative 'client_interface'
 require_relative 'network'
@@ -8,7 +9,7 @@ class Runner
   include Logging
 
   def initialize(host, port, client, reservation = nil)
-    logger.info 'Software Challenge 2019'
+    logger.info 'Software Challenge 2021'
     logger.info 'Ruby Client'
     logger.info "Host: #{host}"
     logger.info "Port: #{port}"

data/lib/software_challenge_client/set_move.rb

@@ -1,15 +1,24 @@
+# frozen_string_literal: true
+
 require_relative 'has_hints'
 
+# Ein SetMove platziert einen Stein auf dem Spielbrett
 class SetMove
-
   include HasHints
 
   attr_reader :piece
-  attr_reader :destination
 
-  def initialize(piece, destination)
+  # Erstellt ein neuen leeren Legezug.
+  def initialize(piece)
     @piece = piece
-    @destination = destination
     @hints = []
   end
+
+  def ==(other)
+    piece == other.piece
+  end
+
+  def to_s
+    "SetMove(#{piece}"
+  end
 end

data/lib/software_challenge_client/skip_move.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'has_hints'
+
+# Ein SkipMove ziegt an, dass die aktuelle Farbe keinen Stein platzieren will
 class SkipMove
   include HasHints
 
+  # Erstellt ein neuen leeren Aussetzzug.
   def initialize
     @hints = []
   end

data/lib/software_challenge_client/util/constants.rb

@@ -4,8 +4,7 @@
 # Konstanten zum aktuellen Spiel.
 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' # 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
+  GAME_IDENTIFIER = 'swc_2021_blokus' # Der Identifikator des Spiels. Für die Kommunikation mit dem Spielserver.
+  BOARD_SIZE = 20 # Seitenlänge des Spielbretts in Feldern
+  TOTAL_PIECE_SHAPES = 21
 end

data/lib/software_challenge_client/version.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 module SoftwareChallengeClient
-  VERSION = "20.2.4"
+  VERSION = '21.2.0'
 end

data/lib/update_client_module.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# This creates a entrypoint for the gem named 'software_challenge_client.rb'
+# which includes all ruby files under lib. Making sure that everthing is
+# included after some files were added or removed (in the process of updating
+# the gem for a new game).
+shopt -s globstar || exit 1
+cd lib || exit 1
+FILENAME='software_challenge_client.rb'
+
+echo "# frozen_string_literal: true
+module SoftwareChallengeClient" > $FILENAME
+for file in software_challenge_client/**/*.rb; do
+    echo "  require '${file}'"
+done >> $FILENAME;
+echo "end" >> $FILENAME

data/software_challenge_client.gemspec

@@ -1,39 +1,41 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'software_challenge_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "software_challenge_client"
+  spec.name          = 'software_challenge_client'
   spec.version       = SoftwareChallengeClient::VERSION
   spec.authors       = File.readlines('AUTHORS').select { |l| l[' <'] }.map { |l| l.match(/^(.*) *</)[1] }
   spec.email         = File.readlines('AUTHORS').select { |l| l[' <'] }.map { |l| l.match(/<(.*)>/)[1] }
 
-  spec.summary       = 'This gem provides functions to build a client for the coding competition Software-Challenge 2017.'
+  spec.summary       = 'Provides functions to build a client for the coding competition Software-Challenge Germany.'
   spec.description   = ''
   spec.homepage      = 'http://www.software-challenge.de'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
-  spec.add_dependency 'typesafe_enum'
+  spec.required_ruby_version = '>= 2.5.5'
   spec.add_dependency 'builder'
+  spec.add_dependency 'typesafe_enum'
 
   spec.add_development_dependency 'bundler', '>= 1.10'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'yard', '>= 0.8'
-  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'fuubar'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'pry-rescue'
-  spec.add_development_dependency 'pry-coolline'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-coolline'
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'solargraph'
+  spec.add_development_dependency 'yard', '>= 0.8'
 end