software_challenge_client 20.2.2 → 21.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fae378685b67cd4b5e9568aa6da7f59734266680819f15fa97297e2a532fa34
-  data.tar.gz: 1d2592e9d328f2cc079a21aa6fcc5901395b1e18b9edf3505e06a7805623fcc4
+  metadata.gz: c65e973b488cf092e716716135e61c348b62d899a77c821aae0e44e340667888
+  data.tar.gz: 1d4511f7ba6c1dffc6344b523cc3cf04ef3e114a962d3edf2d0cc8dd9382190b
 SHA512:
-  metadata.gz: 53b31ae3336f7cc0544de8099ddc39156a0d4e7ae7c118c1cff160072e4d7085ce6852b004c028404378ec4e0024b1ea5b8e58e6aad1ae096a629e79a349e35d
-  data.tar.gz: ab4d43ca12dcc42969887613908b1e1f49b85148cb4324901e9afb74cfe6498acbca72865b8517553da4101384370950f018492c25a34c1c95497d3cc236b259
+  metadata.gz: 9e9416cc5a08cd30f7c969edc29a5a5f8c496cc3fa5a1b3c4c7222f4a1ecc653fb2777c1d64e4ac389801d2ad4288901b956366c500835bfc58f51b02d256aa3
+  data.tar.gz: d7aabbb618c88b80f8845e72199a4ccf377980aa82f7ed260de1cb9c6c52435d5d0ef4b985a2fff786737c40b6f8fea422dae08a4a906591bbe83daffa695a94

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.4
   DefaultFormatter: fuubar
   DisplayStyleGuide: true

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.5.5

data/.vscode/launch.json

@@ -0,0 +1,41 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Ruby - Main",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "test/main.rb"
+        },
+        {
+            "name": "Ruby - Gem Main",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "example/main.rb"
+        },
+        {
+            "name": "RSpec - Active spec File only",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "C:/tools/ruby27/bin/rspec",
+            "args": [
+                "-I",
+                "${workspaceRoot}",
+                "${file}"
+            ]
+        },
+        {
+            "name": "RSpec - All",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "C:/tools/ruby27/bin/rspec",
+            "args": [
+                "-I",
+                "${workspaceRoot}"
+            ]
+        },
+    ]
+}

data/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "spellright.language": [
+        "de"
+    ],
+    "spellright.documentTypes": [
+        "markdown",
+        "latex",
+        "plaintext"
+    ]
+}

data/Dockerfile

@@ -1,3 +1,3 @@
-FROM ruby:2.4.2
+FROM ruby:2.6.5
 
 RUN gem install --no-document software_challenge_client

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in SoftwareChallengeClient.gemspec

data/Guardfile

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/README.md

@@ -73,7 +73,7 @@ Computerspieler zu haben (`client.rb` im Beispielprojekt):
       end
 
       def best_move
-        gamestate.possible_moves.sample
+        GameRuleLogic.possible_moves(gamestate).sample
       end
     end
 
@@ -109,8 +109,9 @@ dependencies. Then, run `rspec` to run the tests. You can also
 run `bin/console` for an interactive prompt that will allow you to
 experiment.
 
-To install this gem onto your local machine, run `bundle exec rake
-install`.
+To install this gem onto your local machine, run `gem uninstall
+software_challenge_client` to remove an existing gem and then `bundle exec rake
+install` to install the current version.
 
 To develop inside a docker container, make sure you have Docker installed and execute
 `develop.sh`.

data/RELEASES.md

@@ -1,3 +1,23 @@
+= 21.0.2
+
+Fixed problem which caused `last_move` of a `GameState` always be `nil` (thanks to wollw!).
+
+= 21.0.1
+
+Improved performance and defined Ruby version 2.5.5 as minimum requirement
+
+= 21.0.0
+
+First version for game "Blokus"
+
+= 20.2.4
+
+Update game name in documentation
+
+= 20.2.3
+
+Improve method documentation
+
 = 20.2.1 & 20.2.2
 
 Bugfixes for performing moves on a gamestate

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
-require "yard"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'yard'
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']   # optional
-  t.options = ['--any', '--extra', '--opts'] # optional
+  t.files = ['lib/**/*.rb'] # optional
 end

data/example/client.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 require 'software_challenge_client'
 
 # This is an example of a client playing the game using the software challenge
@@ -16,21 +17,17 @@ class Client < ClientInterface
   # gets called, when it's your turn
   def move_requested
     logger.info "Spielstand: #{gamestate.points_for_player(gamestate.current_player)} - #{gamestate.points_for_player(gamestate.other_player)}"
-    logger.debug "Board: #{gamestate.board.to_s}"
+    logger.debug "Board: #{gamestate.board}"
     move = best_move
     logger.debug "Zug gefunden: #{move}" unless move.nil?
     move
   end
 
   def best_move
-    #gamestate.board.add_field(Field.new(5, 0))
-    logger.debug "Berechne zuege fuer Board #{gamestate.board.to_s}"
-    logger.debug "Felder"
-    gamestate.board.field_list.each do |f|
-      if !f.empty?
-        logger.debug "Feld (#{f.x}, #{f.y}) #{f.obstructed ? 'OO' : f.pieces.last.to_s}"
-      end
-    end
+    # gamestate.board.add_field(Field.new(5, 0))
+    logger.debug "Berechne zuege fuer Board #{gamestate.board}"
+
+    # all possible moves can't be calculated in under two seconds
     possible_moves = GameRuleLogic.possible_moves(gamestate)
     logger.debug "#{possible_moves.size} moegliche Zuege gefunden"
     possible_moves.sample

data/example/main.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 require 'software_challenge_client'
 require 'optparse'
 require 'ostruct'
@@ -8,31 +9,30 @@ require_relative 'client'
 
 options = OpenStruct.new
 options.host = '127.0.0.1'
-options.port = 13050
+options.port = 13_050
 options.reservation = ''
 
 opt_parser = OptionParser.new do |opt|
-  opt.banner = "Usage: main.rb [OPTIONS]"
-  opt.separator  ""
-  opt.separator  "Options"
+  opt.banner = 'Usage: main.rb [OPTIONS]'
+  opt.separator  ''
+  opt.separator  'Options'
 
-  opt.on("-p","--port PORT", Integer,"connect to the server at PORT (default #{options.port})") do |p|
+  opt.on('-p', '--port PORT', Integer, "connect to the server at PORT (default #{options.port})") do |p|
     options.port = p
   end
 
-  opt.on("-h","--host HOST","the host's IP address (default #{options.host})") do |h|
+  opt.on('-h', '--host HOST', "the host's IP address (default #{options.host})") do |h|
     options.host = h
   end
 
-  opt.on("-r","--reservation RESERVATION","the host's RESERVATION (default #{options.reservation})") do |r|
+  opt.on('-r', '--reservation RESERVATION', "the host's RESERVATION (default #{options.reservation})") do |r|
     options.reservation = r
   end
 
-  opt.on_tail("-?", "--help", "Show this message") do
+  opt.on_tail('-?', '--help', 'Show this message') do
     puts opt
     exit
   end
-
 end
 
 opt_parser.parse!(ARGV)

data/lib/software_challenge_client.rb

@@ -1,25 +1,28 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module SoftwareChallengeClient
-  require 'software_challenge_client/version'
-  require 'software_challenge_client/logging'
-  require 'software_challenge_client/invalid_move_exception'
-  require 'software_challenge_client/board'
-  require 'software_challenge_client/client_interface'
-  require 'software_challenge_client/condition'
-  require 'software_challenge_client/debug_hint'
-  require 'software_challenge_client/field'
-  require 'software_challenge_client/piece'
-  require 'software_challenge_client/piece_type'
-  require 'software_challenge_client/game_state'
-  require 'software_challenge_client/set_move'
-  require 'software_challenge_client/drag_move'
-  require 'software_challenge_client/skip_move'
-  require 'software_challenge_client/network'
-  require 'software_challenge_client/player'
-  require 'software_challenge_client/player_color'
-  require 'software_challenge_client/protocol'
-  require 'software_challenge_client/runner'
-  require 'software_challenge_client/game_rule_logic'
-  require 'software_challenge_client/direction'
-  require 'software_challenge_client/cube_coordinates'
+  require 'software_challenge_client/board.rb'
+  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'
+  require 'software_challenge_client/game_rule_logic.rb'
+  require 'software_challenge_client/game_state.rb'
+  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/network.rb'
+  require 'software_challenge_client/piece.rb'
+  require 'software_challenge_client/piece_shape.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/util/constants.rb'
+  require 'software_challenge_client/version.rb'
 end

data/lib/software_challenge_client/board.rb

@@ -5,46 +5,54 @@ require_relative './util/constants'
 require_relative 'game_state'
 require_relative 'field'
 
-# Ein Spielbrett fuer Hive
+# Ein Spielbrett fuer Blokus
 class Board
-
   include Constants
   # @!attribute [r] fields
   # @note Besser über die {#field} Methode auf Felder zugreifen.
   # @return [Array<Array<Field>>] Ein Feld wird an der Position entsprechend
-  #   seiner x und y CubeCoordinates im Array gespeichert.
+  #   seiner x und y Coordinates im Array gespeichert.
   attr_reader :fields
 
-  def self.field_amount(radius)
-    return 1 if radius == 1
-    (radius - 1) * 6 + Board.field_amount(radius - 1)
-  end
+  # @!attribute [r] deployed_blue_pieces
+  # @return [Array<PieceShape>] Die blauen, gesetzten Spielsteine
+  attr_accessor :deployed_blue_pieces
+
+  # @!attribute [r] deployed_yellow_pieces
+  # @return [Array<PieceShape>] Die gelben, gesetzten Spielsteine
+  attr_accessor :deployed_yellow_pieces
+
+  # @!attribute [r] deployed_red_pieces
+  # @return [Array<PieceShape>] Die roten, gesetzten Spielsteine
+  attr_accessor :deployed_red_pieces
 
-  FIELD_AMOUNT = Board.field_amount((BOARD_SIZE + 1)/2)
+  # @!attribute [r] deployed_green_pieces
+  # @return [Array<PieceShape>] Die grünen, gesetzten Spielsteine
+  attr_accessor :deployed_green_pieces
 
   # Erstellt ein neues leeres Spielbrett.
   def initialize(fields = [])
     @fields = Board.empty_game_field
-    fields.each{ |f| add_field(f) }
+    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|
-      fields[x + SHIFT] ||= []
-      ([-SHIFT, -x-SHIFT].max..[SHIFT, -x+SHIFT].min).to_a.each do |y|
-        fields[x + SHIFT][y + SHIFT] = Field.new(x, y)
+    (0...BOARD_SIZE).to_a.map do |x|
+      (0...BOARD_SIZE).to_a.map do |y|
+        Field.new(x, y)
       end
     end
-    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? }
+    @fields.flatten.reject(&:nil?)
   end
 
   # Vergleicht zwei Spielbretter. Gleichheit besteht, wenn zwei Spielbretter die
@@ -53,26 +61,27 @@ class Board
     field_list == other.field_list
   end
 
-  # Fügt ein Feld dem Spielbrett hinzu. Das übergebene Feld ersetzt das an den Koordinaten bestehende Feld.
+  # Fügt ein Feld dem Spielbrett hinzu. Das übergebene Feld ersetzt das an den
+  # Koordinaten bestehende Feld.
   #
   # @param field [Field] Das einzufügende Feld.
   def add_field(field)
-    @fields[field.x + SHIFT][field.y + SHIFT] = field
+    @fields[field.x][field.y] = field
   end
 
   # Zugriff auf die Felder des Spielfeldes
   #
   # @param x [Integer] Die X-Koordinate des Feldes.
   # @param y [Integer] Die Y-Koordinate des Feldes.
-  # @return [Field] Das Feld mit den gegebenen Koordinaten. Falls das Feld nicht exisitert, wird nil zurückgegeben.
+  # @return [Field] Das Feld mit den gegebenen Koordinaten. Falls das Feld nicht
+  #                 exisitert, wird nil zurückgegeben.
   def field(x, y)
-    return nil if (x < -SHIFT) || (y < -SHIFT)
-    fields.dig(x + SHIFT, y + SHIFT) # NOTE that #dig requires ruby 2.3+
+    fields.dig(x, y) # NOTE that #dig requires ruby 2.3+
   end
 
   # Zugriff auf die Felder des Spielfeldes über ein Koordinaten-Paar.
   #
-  # @param coordinates [CubeCoordinates] X- und Y-Koordinate als Paar, sonst wie
+  # @param coordinates [Coordinates] X- und Y-Koordinate als Paar, sonst wie
   # bei {Board#field}.
   #
   # @return [Field] Wie bei {Board#field}.
@@ -82,31 +91,87 @@ class Board
     field(coordinates.x, coordinates.y)
   end
 
-  # Liefert alle Felder die dem Spieler mit der gegebenen Farbe gehoeren
+  # TODO: Redo this recursively, starting from the corresponding corner and then moving alongside edges and corners
+
+  # Alle Felder einer bestimmten Farbe
   #
-  # @param color [PlayerColor] Die Spielerfarbe
-  # @return [Array<Field>] Alle Felder der angegebenen Farbe die das Spielbrett enthält.
-  def fields_of_color(color)
-    field_list.select{ |f| f.color == color }
+  # @param color [Color] Die Farbe der Felder
+  # @return [Array<Field>] Eine Liste aller felder, die die gegebene Farbe haben
+  def fields_of_color(color, fields = [Coordinates.new(0, 0),
+                                       Coordinates.new(0, BOARD_SIZE - 1),
+                                       Coordinates.new(BOARD_SIZE - 1, BOARD_SIZE - 1),
+                                       Coordinates.new(BOARD_SIZE - 1, 0)].select { |it| field_at(it).color == color })
+    copy = Array.new(fields)
+
+    copy.each do |field|
+      [Coordinates.new(1, 0),
+       Coordinates.new(1, -1),
+       Coordinates.new(0, -1),
+       Coordinates.new(-1, -1),
+       Coordinates.new(-1, 0),
+       Coordinates.new(-1, 1),
+       Coordinates.new(0, 1),
+       Coordinates.new(1, 1)].each do |neighbor|
+        new_field = field + neighbor
+        next unless Board.contains(new_field) && @fields[new_field.x][new_field.y].color == color
+
+        fields << new_field unless fields.include?(new_field)
+      end
+    end
+
+    if copy.count == fields.count
+      fields
+    else
+      fields_of_color(color, fields)
+    end
   end
 
-  def pieces
-    field_list.map(&:pieces).flatten
+  # @param it [Coordinates] Die zu untersuchenden Koordinaten
+  # @return [Boolean] Ob die gegebenen Koordinaten auf dem Board liegen oder nicht
+  def in_bounds?(it)
+    it.x >= 0 && it.y >= 0 && it.x < BOARD_SIZE && it.y < BOARD_SIZE
   end
 
+  # @param color [Color] Die Farbe der Steine
+  # @return [Array<PieceShape>] Eine Liste aller Steintypen, die die gegebene Farbe noch nicht gespielt hat
   def deployed_pieces(color)
-    pieces.select { |p| p.color == color }
+    case color
+    when Color::RED
+      deployed_red_pieces
+    when Color::BLUE
+      deployed_blue_pieces
+    when Color::YELLOW
+      deployed_yellow_pieces
+    when Color::GREEN
+      deployed_green_pieces
+    end
   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.
+  # @param coords [Coordinates] Die Koordinaten des Felds
+  # @return Das Feld an den gegebenen Koordinaten
+  def [](coords)
+    field_at(coords)
+  end
+
+  # 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
+    "\n" +
+      (0...BOARD_SIZE).to_a.map do |y|
+        (0...BOARD_SIZE).to_a.map do |x|
+          @fields[x][y].to_s
+        end.join(' ')
+      end.join("\n")
   end
 
+  # @param position [Coordinates] Die zu überprüfenden Koordinaten
+  # @return Ob die gegebenen Koordinaten auf dem board liegen
+  def self.contains(position)
+    position.x >= 0 && position.x < BOARD_SIZE &&
+      position.y >= 0 && position.y < BOARD_SIZE
+  end
 end