software_challenge_client 22.1.0.1 → 23.0.2

data/README.md

@@ -1,147 +1,172 @@
-# Software-Challenge Client
-
-This gem includes everything to build a client for the coding
-competition [Software-Challenge](http://www.software-challenge.de).
-
-------------------------------------------------------------------------
-
-_Language:_ Most documentation will be in german language, because it is intended
-to be used by pupils taking part in the Software-Challenge programming
-competition. Only internal documentation is in english.
-
-------------------------------------------------------------------------
-
-_Sprache:_ Ein Grossteil der Dokumentation ist in deutscher Sprache verfasst, da
-sie dazu gedacht ist, von am Programmierwettbewerb Software-Challenge
-teilnehmenden Schülerinnen und Schülern gelesen zu werden. Interne Dokumentation
-ist weiterhin in englisch.
-
-------------------------------------------------------------------------
-
-## Installation
-
-Um die Software-Challenge Bibliothek in deinem Computerspieler zu verwenden, füge folgende Zeile in das Gemfile deines Projektes ein:
-
-    gem 'software_challenge_client'
-
-Installiere das Gem dann mit dem Befehl:
-
-    $ bundle
-
-Oder installiere das Gem ohne ein Gemfile mit:
-
-    $ gem install software_challenge_client
-
-## Verwendung
-
-Ein Beispielprojekt zur Verwendung der Bibliothek findet man im Verzeichnis `example` ([Beispielprojekt auf GitHub](https://github.com/CAU-Kiel-Tech-Inf/socha_ruby_client/tree/master/example)).
-
-Du kannst den Beispielclient mittels
-
-    ruby main.rb
-
-in einer Konsole ausführen (dazu musst du dich im Verzeichnis `example` befinden).
-
-Damit dies funktioniert, muss das Gem bereits wie oben beschrieben installiert
-sein und es muss ein Spielserver auf eine Verbindung warten (also zum Beispiel
-ein Spiel mit einem manuell gestarteten Spieler in der grafischen Oberfläche
-angelegt worden sein).
-
-Neben Beiwerk wie dem Initialisieren der Verbindung zum Spielserver und
-Verarbeiten der Startparameter (was beides in `main.rb` des Beispielprojektes
-passiert), musst du nur eine Klasse implementieren, um einen lauffähigen
-Computerspieler zu haben (`client.rb` im Beispielprojekt):
-
-    require 'software_challenge_client'
-
-    class Client < ClientInterface
-      include Logging
-
-      attr_accessor :gamestate
-
-      def initialize(log_level)
-        logger.level = log_level
-        logger.info 'Einfacher Spieler wurde erstellt.'
-      end
-
-      # 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)}"
-        move = best_move
-        logger.debug "Zug gefunden: #{move}" unless move.nil?
-        move
-      end
-
-      def best_move
-        GameRuleLogic.possible_moves(gamestate).sample
-      end
-    end
-
-## Generating the Documentation
-
-Code documentation can be generated using YARD in the project root (source code
-needs to be checked out and `bundle` has to be executed,
-see [Installation](#installation)):
-
-    yard
-
-After generation, the docs can be found in the `doc` directory. Start at
-`index.html`.
-
-Documentation for the latest source can also be found
-on
-[rubydoc.info](http://www.rubydoc.info/github/CAU-Kiel-Tech-Inf/socha_ruby_client).
-
-When updating the docs, you may use
-
-    yard server --reload
-
-or inside a docker container
-
-    yard server --reload --bind 0.0.0.0
-
-to get a live preview of them at [http://localhost:8808](http://localhost:8808).
-
-## Development
-
-After checking out the repo, run `bin/setup` to install
-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 `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`.
-
-### Specs
-
-The gem is tested using RSpec. To run all tests, execute `rspec`. When
-developing, you may use Guard to execute tests when files change. To do this,
-execute `guard`. Tests will then be automatically run when you change a file.
-
-### Linting
-
-Linting by rubocop is included in the guard config. It is run when all specs
-pass.
-
-### Releasing
-
-To release a new version, update the version number in
-`lib/software_challenge_client/version.rb` and update RELEASES.md.
-
-Then run `bundle exec rake release`, which will create a git tag for the
-version, push git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org). You may also use the `release.sh` script
-which executes `bundle exec rake release` in a suitable docker container.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/CAU-Kiel-Tech-Inf/socha_ruby_client. This project is intended
-to be a safe, welcoming space for collaboration, and contributors are expected
-to adhere to the [code of
-conduct](https://github.com/CAU-Kiel-Tech-Inf/socha-client-ruby/blob/master/CODE_OF_CONDUCT.md)
-(from [Contributor Covenant](http://contributor-covenant.org)).
+# Software-Challenge Client
+
+This gem includes everything to build a client for the coding
+competition [Software-Challenge](http://www.software-challenge.de).
+
+------------------------------------------------------------------------
+
+_Language:_ Most documentation will be in german language, because it is intended
+to be used by pupils taking part in the Software-Challenge programming
+competition. Only internal documentation is in english.
+
+------------------------------------------------------------------------
+
+_Sprache:_ Ein Grossteil der Dokumentation ist in deutscher Sprache verfasst, da
+sie dazu gedacht ist, von am Programmierwettbewerb Software-Challenge
+teilnehmenden Schülerinnen und Schülern gelesen zu werden. Interne Dokumentation
+ist weiterhin in englisch.
+
+------------------------------------------------------------------------
+
+## Installation
+
+Um die Software-Challenge Bibliothek in deinem Computerspieler zu verwenden, füge folgende Zeile in das Gemfile deines Projektes ein:
+
+    $ gem 'software_challenge_client'
+
+Installiere das Gem dann mit dem Befehl:
+
+    $ bundle
+
+Oder installiere das Gem ohne ein Gemfile mit:
+
+    $ gem install software_challenge_client
+
+## Verwendung
+
+Ein Beispielprojekt zur Verwendung der Bibliothek findet man im Verzeichnis `example` ([Beispielprojekt auf GitHub](https://github.com/CAU-Kiel-Tech-Inf/socha_ruby_client/tree/master/example)).
+
+Du kannst den Beispielclient mittels
+
+    $ ruby main.rb
+
+in einer Konsole ausführen (dazu musst du dich im Verzeichnis `example` befinden).
+
+Damit dies funktioniert, muss das Gem bereits wie oben beschrieben installiert
+sein und es muss ein Spielserver auf eine Verbindung warten (also zum Beispiel
+ein Spiel mit einem manuell gestarteten Spieler in der grafischen Oberfläche
+angelegt worden sein).
+
+Neben Beiwerk wie dem Initialisieren der Verbindung zum Spielserver und
+Verarbeiten der Startparameter (was beides in `main.rb` des Beispielprojektes
+passiert), musst du nur eine Klasse implementieren, um einen lauffähigen
+Computerspieler zu haben (`client.rb` im Beispielprojekt):
+
+    require 'software_challenge_client'
+
+    class Client < ClientInterface
+      include Logging
+
+      attr_accessor :gamestate
+
+      def initialize(log_level)
+        logger.level = log_level
+        logger.info 'Einfacher Spieler wurde erstellt.'
+      end
+
+      # 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)}"
+        move = best_move
+        logger.debug "Zug gefunden: #{move}" unless move.nil?
+        move
+      end
+
+      def best_move
+        GameRuleLogic.possible_moves(gamestate).sample
+      end
+    end
+
+### Abgabe des Clients im SC Wettkampfsystem
+
+Da Ruby eine interpretierte Sprache ist, muss der Ruby-Quellcode direkt
+in ein ZIP-Archiv gepackt und auf das [Wettkampfsystem](https://docs.software-challenge.de/glossary/contest) hochgeladen
+werden. Auf dem [Wettkampfsystem](https://docs.software-challenge.de/glossary/contest) ist ein Ruby-Interpreter sowie das
+aktuellste `software_challenge_client` Gem installiert. Alle weiteren
+Bibliotheken müssen im ZIP-Archiv vorhanden sein. Nach dem Hochladen des ZIP-Archivs muss die auszuführende Hauptdatei im [Wettkampfsystem](https://docs.software-challenge.de/glossary/contest)
+ausgewählt werden. Diese wird dann zum Start des Computerspielers
+gestartet. Damit dies richtig funktioniert, ist es entscheidend, dass
+die Hauptdatei mit einer sogenannten "Shebang"-Zeile beginnt:
+
+    #!/usr/bin/env ruby
+
+Weiterhin ist es ratsam, den Magic-Comment zum Encoding direkt unter die
+Shebang-Zeile zu schreiben:
+
+    # encoding: UTF-8
+
+Ein vollständiges Beispiel für einen abgabefertigen Ruby-Computerspieler
+gibt es im [example Verzeichnis des Computerspieler-Gems bei
+Github](https://github.com/software-challenge/client-ruby/tree/main/example).
+Packt man die beiden Dateien `client.rb` und `main.rb` in ein
+ZIP-Archiv, hat man einen abgabefertigen Computerspieler. Beim Hochladen
+wählt man `main.rb` als Hauptdatei.
+
+## Generating the Documentation
+
+Code documentation can be generated using YARD in the project root (source code
+needs to be checked out and `bundle` has to be executed,
+see [Installation](#installation)):
+
+    $ yard
+
+After generation, the docs can be found in the `doc` directory. Start at
+`index.html`.
+
+Documentation for the latest source can also be found
+on
+[rubydoc.info](http://www.rubydoc.info/github/CAU-Kiel-Tech-Inf/socha_ruby_client).
+
+When updating the docs, you may use
+
+    $ yard server --reload
+
+or inside a docker container
+
+    $ yard server --reload --bind 0.0.0.0
+
+to get a live preview of them at [http://localhost:8808](http://localhost:8808).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+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 `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`.
+
+### Specs
+
+The gem is tested using RSpec. To run all tests, execute `rspec`. When
+developing, you may use Guard to execute tests when files change. To do this,
+execute `guard`. Tests will then be automatically run when you change a file.
+
+### Linting
+
+Linting by rubocop is included in the guard config. It is run when all specs
+pass.
+
+### Releasing
+
+To release a new version, update the version number in
+`lib/software_challenge_client/version.rb` and update RELEASES.md.
+
+Then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org). You may also use the `release.sh` script
+which executes `bundle exec rake release` in a suitable docker container.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/CAU-Kiel-Tech-Inf/socha_ruby_client. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [code of
+conduct](https://github.com/CAU-Kiel-Tech-Inf/socha-client-ruby/blob/master/CODE_OF_CONDUCT.md)
+(from [Contributor Covenant](http://contributor-covenant.org)).

data/RELEASES.md

@@ -1,140 +1,144 @@
-= 22.1.0
-
-Fix gamestate.round
-
-= 22.0.3
-
-First tagged Version for Osteseeschach
-
-= 21.2.0
-
-Adjustments for Backend version 21.2.0
-
-= 21.1.0
-
-Pieces are now mutable and `==` of pieces considers rotated shapes which result in the same covered board fields as equal.
-
-= 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
-
-= 20.2.0
-
-First version for game "Hive"
-
-= 19.1.0
-
-- winning condition is now set when changing a gamestate with Move#perform!
-
-= 19.0.4
-
-- fixed one more bug in in Move#perform! (thanks to wollw!)
-
-= 19.0.3
-
-- fixed another bug in in Move#perform! (thanks to wollw!)
-
-= 19.0.2
-
-- fixed bug in Move#perform! (thanks to wollw!)
-
-= 19.0.1
-
-- fixed bug in swarm size calculation (thanks to wollw!)
-
-= 19.0.0
-
-First version for game "Piranhas"
-
-= 1.2.1
-
-- fixed a bug which could lead to an infinite loop in the possible_move method
-
-= 1.2.0
-
-- fixed connection code
-- fixed bug which lead to a exception when testing for playability of fallback card
-
-= 1.1.0
-
-Added missing perform! methods for actions.
-
-= 1.0.0
-
-First version for game "Hase und Igel".
-
-= 0.3.4
-
-Last version for game "Mississippi Queen".
-
-- Renamed Turn#direction to Turn#turn_steps to make clearer that a number should be given, not a Direction instance.
-- Corrected generation of XML for Push-actions
-
-= 0.3.3
-
-- Corrected checking/updating of coal for decelerations.
-
-= 0.3.2
-
-- Corrected some return types in the documentation (thanks to wollw!).
-
-= 0.3.1
-
-- Fixed bug: Coal was not read from server-XML (thanks to wollw!)
-
-= 0.3.0
-
-- Fixed bug where wrong (old) method getMove was called, the new name is
-  move_requested
-- Improved end game handling
-
-= 0.2.0
-
-- First working version for Mississippi Queen
-
-= 0.1.5
-
-- Fixed bug in reservation code.
-
-= 0.1.4
-
-- Added support for reservation ID to let clients work on contest system.
-
-= 0.1.3
-
-- Fixed bug in makeClearBoard method (thanks to wollw!).
-
-= 0.1.2
-
-- Fixed bug in == (test for equality) method of connections (thanks to
-  wollw!).
-- Fixed link in readme to code of conduct.
-- Removed trailing whitespace.
-
-= 0.1.1
-
-Compatibility to Ruby 1.9 (source encoding issues)
-
-= 0.1.0
-
-First complete version.
+= 23.0.2
+
+First Version for "Hey, Danke für den Fisch"
+
+= 22.1.0
+
+Fix gamestate.round
+
+= 22.0.3
+
+First tagged Version for Osteseeschach
+
+= 21.2.0
+
+Adjustments for Backend version 21.2.0
+
+= 21.1.0
+
+Pieces are now mutable and `==` of pieces considers rotated shapes which result in the same covered board fields as equal.
+
+= 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
+
+= 20.2.0
+
+First version for game "Hive"
+
+= 19.1.0
+
+- winning condition is now set when changing a gamestate with Move#perform!
+
+= 19.0.4
+
+- fixed one more bug in in Move#perform! (thanks to wollw!)
+
+= 19.0.3
+
+- fixed another bug in in Move#perform! (thanks to wollw!)
+
+= 19.0.2
+
+- fixed bug in Move#perform! (thanks to wollw!)
+
+= 19.0.1
+
+- fixed bug in swarm size calculation (thanks to wollw!)
+
+= 19.0.0
+
+First version for game "Piranhas"
+
+= 1.2.1
+
+- fixed a bug which could lead to an infinite loop in the possible_move method
+
+= 1.2.0
+
+- fixed connection code
+- fixed bug which lead to a exception when testing for playability of fallback card
+
+= 1.1.0
+
+Added missing perform! methods for actions.
+
+= 1.0.0
+
+First version for game "Hase und Igel".
+
+= 0.3.4
+
+Last version for game "Mississippi Queen".
+
+- Renamed Turn#direction to Turn#turn_steps to make clearer that a number should be given, not a Direction instance.
+- Corrected generation of XML for Push-actions
+
+= 0.3.3
+
+- Corrected checking/updating of coal for decelerations.
+
+= 0.3.2
+
+- Corrected some return types in the documentation (thanks to wollw!).
+
+= 0.3.1
+
+- Fixed bug: Coal was not read from server-XML (thanks to wollw!)
+
+= 0.3.0
+
+- Fixed bug where wrong (old) method getMove was called, the new name is
+  move_requested
+- Improved end game handling
+
+= 0.2.0
+
+- First working version for Mississippi Queen
+
+= 0.1.5
+
+- Fixed bug in reservation code.
+
+= 0.1.4
+
+- Added support for reservation ID to let clients work on contest system.
+
+= 0.1.3
+
+- Fixed bug in makeClearBoard method (thanks to wollw!).
+
+= 0.1.2
+
+- Fixed bug in == (test for equality) method of connections (thanks to
+  wollw!).
+- Fixed link in readme to code of conduct.
+- Removed trailing whitespace.
+
+= 0.1.1
+
+Compatibility to Ruby 1.9 (source encoding issues)
+
+= 0.1.0
+
+First complete version.

data/Rakefile

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

data/bin/console

@@ -1,15 +1,15 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'software_challenge_client'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'software_challenge_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start