software_challenge_client 21.1.0 → 22.1.0

data/lib/software_challenge_client/protocol.rb

@@ -1,267 +1,201 @@
-# encoding: UTF-8
-# frozen_string_literal: true
-require 'socket'
-require_relative 'board'
-require_relative 'set_move'
-require_relative 'skip_move'
-require_relative 'player'
-require_relative 'network'
-require_relative 'client_interface'
-require 'rexml/document'
-require 'rexml/streamlistener'
-require 'builder'
-
-# This class handles communication to the server over the XML communication
-# protocol. Messages from the server are parsed and moves are serialized and
-# send back.
-class Protocol
-  include Logging
-  include REXML::StreamListener
-
-  # @!attribute [r] gamestate
-  # @return [Gamestate] current gamestate
-  attr_reader :gamestate
-  # @!attribute [rw] roomId
-  # @return [String] current room id
-  attr_accessor :roomId
-  # @!attribute [r] client
-  # @return [ClientInterface] current client
-  attr_reader :client
-
-  def initialize(network, client)
-    @gamestate = GameState.new
-    @network = network
-    @client = client
-    @context = {} # for saving context when stream-parsing the XML
-    @client.gamestate = @gamestate
-  end
-
-  # starts xml-string parsing
-  #
-  # @param text [String] the xml-string that will be parsed
-  def process_string(text)
-    #logger.debug "Parse XML:\n#{text}\n----END XML"
-    begin
-      REXML::Document.parse_stream(text, self)
-    rescue REXML::ParseException => e
-      # to parse incomplete xml, ignore missing end tag exceptions
-      raise e unless e.message =~ /Missing end tag/
-    end
-  end
-
-  # called when text is encountered
-  def text(text)
-    @context[:last_text] = text
-  end
-
-  # called if an end-tag is read
-  #
-  # @param name [String] the end-tag name, that was read
-  def tag_end(name)
-    case name
-    when 'board'
-      logger.debug @gamestate.board.to_s
-    when 'color'
-      if @context[:color] == :ordered_colors
-        @gamestate.ordered_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
-
-  # called if a start tag is read
-  # Depending on the tag the gamestate is updated
-  # or the client will be asked for a move
-  #
-  # @param name [String] the start-tag, that was read
-  # @param attrs [Dictionary<String, String>] Attributes attached to the tag
-  def tag_start(name, attrs)
-    case name
-    when 'room'
-      @roomId = attrs['roomId']
-      logger.info 'roomId : ' + @roomId
-    when 'data'
-      logger.debug "data(class) : #{attrs['class']}"
-      @context[:data_class] = attrs['class']
-      if attrs['class'] == 'sc.framework.plugins.protocol.MoveRequest'
-        @client.gamestate = gamestate
-        move = @client.move_requested
-        sendString(move_to_xml(move))
-      end
-      if attrs['class'] == 'error'
-        logger.info "Game ended - ERROR: #{attrs['message']}"
-        @network.disconnect
-      end
-      if attrs['class'] == 'result'
-        logger.info 'Got game result'
-        @network.disconnect
-        @gamestate.condition = Condition.new(nil, '')
-      end
-    when 'state'
-      logger.debug 'new gamestate'
-      @gamestate = GameState.new
-      @gamestate.current_color_index = attrs['currentColorIndex'].to_i
-      @gamestate.turn = attrs['turn'].to_i
-      @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
-      @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 'orderedColors'
-      @context[:color] = :ordered_colors
-      @gamestate.ordered_colors = []
-    when 'board'
-      logger.debug 'new board'
-      @gamestate.board = Board.new()
-    when 'field'
-      x = attrs['x'].to_i
-      y = attrs['y'].to_i
-      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'
-      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 :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 'lastMove'
-      type = attrs['class']
-      if type == 'skipmove'
-        @gamestate.last_move = SkipMove.new
-      else
-        @context[:last_move_type] = type
-        @context[:piece_target] = :last_move
-      end
-    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)
-    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'])
-    when 'left'
-      logger.debug 'got left event, terminating'
-      @network.disconnect
-    when 'sc.protocol.responses.CloseConnection'
-      logger.debug 'got left close connection event, terminating'
-      @network.disconnect
-    end
-  end
-
-  # send a xml document
-  #
-  # @param document [REXML::Document] the document, that will be send to the connected server
-  def sendXml(document)
-    @network.sendXML(document)
-  end
-
-  # send a string
-  #
-  # @param string [String] The string that will be send to the connected server.
-  def sendString(string)
-    @network.sendString("<room roomId=\"#{@roomId}\">#{string}</room>")
-  end
-
-  # converts "this_snake_case" to "thisSnakeCase"
-  def snake_case_to_lower_camel_case(string)
-    string.split('_').inject([]) do |result, e|
-      result + [result.empty? ? e : e.capitalize]
-    end.join
-  end
-
-  # Converts a move to XML for sending to the server.
-  #
-  # @param move [Move] The move to convert to XML.
-  def move_to_xml(move)
-    builder = Builder::XmlMarkup.new(indent: 2)
-    # Converting every the move here instead of requiring the Move
-    # class interface to supply a method which returns the XML
-    # because XML-generation should be decoupled from internal data
-    # structures.
-    case move
-    when SetMove
-      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
-        move.hints.each do |hint|
-          data.hint(content: hint.content)
-        end
-      end
-    when SkipMove
-      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
-      end
-    end
-    builder.target!
-  end
-end
+# encoding: UTF-8
+# frozen_string_literal: true
+require 'socket'
+require_relative 'board'
+require_relative 'move'
+require_relative 'piece_type'
+require_relative 'player'
+require_relative 'network'
+require_relative 'client_interface'
+require 'rexml/document'
+require 'rexml/streamlistener'
+require 'builder'
+
+# This class handles communication to the server over the XML communication
+# protocol. Messages from the server are parsed and moves are serialized and
+# send back.
+class Protocol
+  include Logging
+  include REXML::StreamListener
+
+  # @!attribute [r] gamestate
+  # @return [Gamestate] current gamestate
+  attr_reader :gamestate
+  # @!attribute [rw] roomId
+  # @return [String] current room id
+  attr_accessor :roomId
+  # @!attribute [r] client
+  # @return [ClientInterface] current client
+  attr_reader :client
+
+  def initialize(network, client)
+    @gamestate = GameState.new
+    @network = network
+    @client = client
+    @context = {} # for saving context when stream-parsing the XML
+    @client.gamestate = @gamestate
+  end
+
+  # starts xml-string parsing
+  #
+  # @param text [String] the xml-string that will be parsed
+  def process_string(text)
+    #logger.debug "Parse XML:\n#{text}\n----END XML"
+    begin
+      REXML::Document.parse_stream(text, self)
+    rescue REXML::ParseException => e
+      # to parse incomplete xml, ignore missing end tag exceptions
+      raise e unless e.message =~ /Missing end tag/
+    end
+  end
+
+  # called when text is encountered
+  def text(text)
+    @context[:last_text] = text
+  end
+
+  # called if an end-tag is read
+  #
+  # @param name [String] the end-tag name, that was read
+  def tag_end(name)
+    case name
+    when 'board'
+      logger.debug @gamestate.board.to_s
+    when 'startTeam'
+      @gamestate.add_player(Player.new(Color::RED, "ONE", 0))
+      @gamestate.add_player(Player.new(Color::BLUE, "TWO", 0))
+      if @context[:last_text] == "ONE"
+        @gamestate.start_team = @gamestate.player_one
+      else
+        @gamestate.start_team = @gamestate.player_two
+      end
+    when 'team'
+      @context[:team] = @context[:last_text]
+    when 'int'
+      if @context[:team] == "ONE"
+        logger.info 'Got player one amber'
+        @gamestate.player_one.amber = @context[:last_text].to_i
+      else
+        logger.info 'Got player two amber'
+        @gamestate.player_two.amber = @context[:last_text].to_i
+      end
+    end
+  end
+
+  # called if a start tag is read
+  # Depending on the tag the gamestate is updated
+  # or the client will be asked for a move
+  #
+  # @param name [String] the start-tag, that was read
+  # @param attrs [Dictionary<String, String>] Attributes attached to the tag
+  def tag_start(name, attrs)
+    case name
+    when 'room'
+      @roomId = attrs['roomId']
+      logger.info 'roomId : ' + @roomId
+    when 'data'
+      logger.debug "data(class) : #{attrs['class']}"
+      @context[:data_class] = attrs['class']
+      if attrs['class'] == 'moveRequest'
+        @client.gamestate = gamestate
+        move = @client.move_requested
+        sendString(move_to_xml(move))
+      end
+      if attrs['class'] == 'error'
+        logger.info "Game ended - ERROR: #{attrs['message']}"
+        @network.disconnect
+      end
+      if attrs['class'] == 'result'
+        logger.info 'Got game result'
+        @network.disconnect
+        @gamestate.condition = Condition.new(nil, '')
+      end
+    when 'state'
+      logger.debug 'new gamestate'
+      @gamestate = GameState.new
+      @gamestate.turn = attrs['turn'].to_i
+      logger.debug "Round: #{@gamestate.round}, Turn: #{@gamestate.turn}"
+    when 'board'
+      logger.debug 'new board'
+      @gamestate.board = Board.new()
+    when 'pieces'
+      @context[:entry] = :pieces
+    when 'coordinates'
+      @context[:x] = attrs['x'].to_i
+      @context[:y] = attrs['y'].to_i
+    when 'piece'
+      x = @context[:x]
+      y = @context[:y]
+      team = Team.find_by_key(attrs['team'].to_sym)
+      type = PieceType.find_by_key(attrs['type'].to_sym)
+      count = attrs['count'].to_i
+      field = Field.new(x, y, Piece.new(team.to_c, type, Coordinates.new(x, y), count))
+      @gamestate.board.add_field(field)
+    when 'from'
+      @context[:from] = Coordinates.new(attrs['x'].to_i, attrs['y'].to_i)
+    when 'to'
+      from = @context[:from]
+      @gamestate.last_move = Move.new(Coordinates.new(from.x, from.y), Coordinates.new(attrs['x'].to_i, attrs['y'].to_i))
+    when 'ambers'
+      @context[:entry] = :ambers
+    when 'winner'
+      # 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'])
+    when 'left'
+      logger.debug 'got left event, terminating'
+      @network.disconnect
+    when 'sc.protocol.responses.CloseConnection'
+      logger.debug 'got left close connection event, terminating'
+      @network.disconnect
+    end
+  end
+
+  # send a xml document
+  #
+  # @param document [REXML::Document] the document, that will be send to the connected server
+  def sendXml(document)
+    @network.sendXML(document)
+  end
+
+  # send a string
+  #
+  # @param string [String] The string that will be send to the connected server.
+  def sendString(string)
+    @network.sendString("<room roomId=\"#{@roomId}\">#{string}</room>")
+  end
+
+  # converts "this_snake_case" to "thisSnakeCase"
+  def snake_case_to_lower_camel_case(string)
+    string.split('_').inject([]) do |result, e|
+      result + [result.empty? ? e : e.capitalize]
+    end.join
+  end
+
+  # Converts a move to XML for sending to the server.
+  #
+  # @param move [Move] The move to convert to XML.
+  def move_to_xml(move)
+    builder = Builder::XmlMarkup.new(indent: 2)
+
+    if move.nil?
+      raise 'nil moves are not sendable!'
+    end
+
+    # Converting every the move here instead of requiring the Move
+    # class interface to supply a method which returns the XML
+    # because XML-generation should be decoupled from internal data
+    # structures.
+
+    builder.data(class: 'move') do |d|
+      d.from(x: move.from.x, y: move.from.y)
+      d.to(x: move.to.x, y: move.to.y)
+    end
+    
+    builder.target!
+  end
+end

data/lib/software_challenge_client/runner.rb

@@ -9,7 +9,7 @@ class Runner
   include Logging
 
   def initialize(host, port, client, reservation = nil)
-    logger.info 'Software Challenge 2021'
+    logger.info 'Software Challenge 2022'
     logger.info 'Ruby Client'
     logger.info "Host: #{host}"
     logger.info "Port: #{port}"

data/lib/software_challenge_client/team.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'typesafe_enum'
+
+require_relative 'color'
+
+# Erster oder zweiter Spieler:
+#
+#   ONE
+#   TWO
+#
+# Zugriff z.B. mit Team::ONE
+class Team < TypesafeEnum::Base
+  new :ONE, 'Red'
+  new :TWO, 'Blue'
+
+  # @return [Color] Gibt die zugehörige Farbe zurück
+  def to_c
+    if self.key == :ONE
+      Color::RED
+    else
+      Color::BLUE
+    end
+  end
+end

data/lib/software_challenge_client/util/constants.rb

@@ -4,7 +4,6 @@
 # Konstanten zum aktuellen Spiel.
 module Constants
   ROUND_LIMIT = 30 # Rundenbegrenzung. Nach Ende der angegebenen Runde endet auch das Spiel.
-  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
+  GAME_IDENTIFIER = 'swc_2022_ostseeschach' # Der Identifikator des Spiels. Für die Kommunikation mit dem Spielserver.
+  BOARD_SIZE = 8 # Seitenlänge des Spielbretts in Feldern
 end

data/lib/software_challenge_client/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 module SoftwareChallengeClient
-  VERSION = '21.1.0'
+  VERSION = '22.1.0'
 end

data/lib/software_challenge_client.rb

@@ -4,7 +4,6 @@ module SoftwareChallengeClient
   require 'software_challenge_client/client_interface.rb'
   require 'software_challenge_client/color.rb'
   require 'software_challenge_client/condition.rb'
-  require 'software_challenge_client/coordinate_set.rb'
   require 'software_challenge_client/coordinates.rb'
   require 'software_challenge_client/debug_hint.rb'
   require 'software_challenge_client/field.rb'
@@ -13,16 +12,14 @@ module SoftwareChallengeClient
   require 'software_challenge_client/has_hints.rb'
   require 'software_challenge_client/invalid_move_exception.rb'
   require 'software_challenge_client/logging.rb'
+  require 'software_challenge_client/move.rb'
   require 'software_challenge_client/network.rb'
   require 'software_challenge_client/piece.rb'
-  require 'software_challenge_client/piece_shape.rb'
+  require 'software_challenge_client/piece_type.rb'
   require 'software_challenge_client/player.rb'
-  require 'software_challenge_client/player_type.rb'
   require 'software_challenge_client/protocol.rb'
-  require 'software_challenge_client/rotation.rb'
   require 'software_challenge_client/runner.rb'
-  require 'software_challenge_client/set_move.rb'
-  require 'software_challenge_client/skip_move.rb'
+  require 'software_challenge_client/team.rb'
   require 'software_challenge_client/util/constants.rb'
   require 'software_challenge_client/version.rb'
 end

data/push_image_production.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+server=flut
+docker build . -t sc-ruby
+docker tag sc-ruby localhost:5000/sc-ruby
+ssh -M -S ssh-ctrl-socket -fnNT -L 5000:localhost:5000 $server
+ssh -S ssh-ctrl-socket -O check $server || exit 1
+docker login localhost:5000 || exit 1
+docker push localhost:5000/sc-ruby
+ssh -S ssh-ctrl-socket -O exit $server
+ssh $server 'sudo docker pull localhost:5000/sc-ruby'
+ssh $server 'sudo docker tag localhost:5000/sc-ruby sc-ruby'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: software_challenge_client
 version: !ruby/object:Gem::Version
-  version: 21.1.0
+  version: 22.1.0
 platform: ruby
 authors:
 - 'kwollw '
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -286,7 +286,6 @@ files:
 - lib/software_challenge_client/client_interface.rb
 - lib/software_challenge_client/color.rb
 - lib/software_challenge_client/condition.rb
-- lib/software_challenge_client/coordinate_set.rb
 - lib/software_challenge_client/coordinates.rb
 - lib/software_challenge_client/debug_hint.rb
 - lib/software_challenge_client/field.rb
@@ -295,19 +294,18 @@ files:
 - lib/software_challenge_client/has_hints.rb
 - lib/software_challenge_client/invalid_move_exception.rb
 - lib/software_challenge_client/logging.rb
+- lib/software_challenge_client/move.rb
 - lib/software_challenge_client/network.rb
 - lib/software_challenge_client/piece.rb
-- lib/software_challenge_client/piece_shape.rb
+- lib/software_challenge_client/piece_type.rb
 - lib/software_challenge_client/player.rb
-- lib/software_challenge_client/player_type.rb
 - lib/software_challenge_client/protocol.rb
-- lib/software_challenge_client/rotation.rb
 - lib/software_challenge_client/runner.rb
-- lib/software_challenge_client/set_move.rb
-- lib/software_challenge_client/skip_move.rb
+- lib/software_challenge_client/team.rb
 - lib/software_challenge_client/util/constants.rb
 - lib/software_challenge_client/version.rb
 - lib/update_client_module.sh
+- push_image_production.sh
 - release.sh
 - software_challenge_client.gemspec
 homepage: http://www.software-challenge.de
@@ -328,8 +326,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Provides functions to build a client for the coding competition Software-Challenge