Implement chess-game in ruby

ruby/chess-game/HELP.md

@@ -0,0 +1,54 @@
+# Help
+
+## Running the tests
+
+For running the tests provided, you will need the Minitest gem. Open a
+terminal window and run the following command to install minitest:
+
+```
+gem install minitest
+```
+
+
+Run the tests from the exercise directory using the following command:
+
+```
+ruby <snake-case-exercise>_test.rb
+```
+
+Please replace `<snake-case-exercise>` with your exercise name in snake_case.
+
+## Color output
+
+You can `require 'minitest/pride'` or run the following command to get colored output:
+
+```
+ruby -r minitest/pride <snake-case-exercise>_test.rb
+```
+
+## Submitting your solution
+
+You can submit your solution using the `exercism submit chess_game.rb` command.
+This command will upload your solution to the Exercism website and print the solution page's URL.
+
+It's possible to submit an incomplete solution which allows you to:
+
+- See how others have completed the exercise
+- Request help from a mentor
+
+## Need to get help?
+
+If you'd like help solving the exercise, check the following pages:
+
+- The [Ruby track's documentation](https://exercism.org/docs/tracks/ruby)
+- The [Ruby track's programming category on the forum](https://forum.exercism.org/c/programming/ruby)
+- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
+- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
+
+Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
+
+To get help if you're having trouble, you can use one of the following resources:
+
+- [Ruby Documentation](http://ruby-doc.org/)
+- [StackOverflow](http://stackoverflow.com/questions/tagged/ruby)
+- [/r/ruby](https://www.reddit.com/r/ruby) is the Ruby subreddit.

ruby/chess-game/HINTS.md

@@ -0,0 +1,31 @@
+# Hints
+
+## 1. Define rank & file range
+
+- You need to define two [constant][constants] that should hold a [`Range`][range] of ranks and files.
+- The ranks should be an [`Integer`][integers] `range` from 1 to 8.
+- The files should be a [`String`][string] `Range` from 'A' to 'H'.
+- The constant needs to be defined in the `Chess` [module][module].
+
+## 2. Check if square is valid
+
+- You need to check if a value is within a range.
+- There is [a method][include] that can be used to check if a value is within a range.
+
+## 3. Get player's nickname
+
+- You can get a slice by using a `Range` as input.
+- There is a [method][upcase] that can be used to upcase a string.
+
+## 4. Create move message
+
+- You can index the square string to get the rank and file.
+- You can use already defined methods to get the nickname of the player and to check if the move is valid.
+
+[constants]: https://www.rubyguides.com/2017/07/ruby-constants/
+[integers]: https://rubyapi.org/o/integer
+[string]: https://rubyapi.org/o/string
+[module]: https://rubyapi.org/o/module
+[include]: https://rubyapi.org/o/range#method-i-include-3F
+[range]: https://rubyapi.org/o/range
+[upcase]: https://rubyapi.org/o/string#method-i-upcase

ruby/chess-game/README.md

@@ -0,0 +1,179 @@
+# Chess Game
+
+Welcome to Chess Game on Exercism's Ruby Track.
+If you need help running the tests or submitting your code, check out `HELP.md`.
+If you get stuck on the exercise, check out `HINTS.md`, but try and solve it without using those first :)
+
+## Introduction
+
+[Ranges][range] represent an interval between two values.
+The most common types that support ranges are `Integer` and `String`.
+They can be used for many things like quickly creating a collection, slicing strings, checking if a value is in a range, and iteration.
+They are created using the range operator `..` or `...` (inclusive and exclusive, respectively).
+
+```ruby
+1..5  # => 1..5
+1...5 # => 1...5
+
+(1..5).to_a # => [1, 2, 3, 4, 5]
+(1...5).to_a # => [1, 2, 3, 4]
+```
+
+The reason for having two range operators is to allow to create ranges that are inclusive or exclusive of the end value, which can be useful when for example working with indexes that are zero based.
+
+Ranges can also be created using the `Range` constructor, `new`.
+
+```ruby
+Range.new(1, 5) # A range containing 1, 2, 3, 4, 5
+```
+
+~~~~exercism/note
+When creating a range in Ruby using the range operators `..` or `...`, and wanting to call a method on the range, you need to wrap the range in parentheses.
+This is because, otherwise, the method will be called on the 2nd argument of the range operator.
+
+```ruby
+(1..5).sum # => 15
+1..5.sum # => Error: undefined method `sum' for 5:Integer (NoMethodError)
+```
+~~~~
+
+## Getting substrings
+
+When wanting to slice a string, you can use the range operator to get a substring.
+That is, by creating a range with the start and end index of the sub-string.
+
+```ruby
+"Hello World"[0..4] # => "Hello"
+"Hello World"[6..10] # => "World"
+```
+
+You can also use negative indexes to get the substring from the end of the string.
+
+```ruby
+"Hello World"[-5..-1] # => "World"
+"Hello World"[6..-4] # => "Wo"
+```
+
+## Range methods
+
+Ranges do have a set of methods that can be used to work with them.
+For example, these methods can be used to get the sum of all the values in the range or check if the range includes a value.
+
+| Method                  | Description                                                             | Example                         |
+| ----------------------- | ----------------------------------------------------------------------- | ------------------------------- |
+| [`sum`][sum]            | Returns the sum of all the values in the range                          | `(1..5).sum # => 15`            |
+| [`size`][size]          | Returns the size of the range                                           | `(1..5).size # => 5`            |
+| [`include?`][indlude]   | Returns `true` if the range includes the given value, otherwise `false` | `(1..5).include?(3) # => true` |
+
+## Endless & Beginless ranges
+
+A range can be endless and beginless.
+The endless or beginless range has their start or end value being `nil`, but when defining the range the `nil` can be omitted.
+
+Using beginless and endless ranges is useful when you want to, for example, slice a string from the beginning or to the end.
+
+```ruby
+"Hello World"[0..] # => "Hello World"
+"Hello World"[4..] # => "o World"
+"Hello World"[..5] # => "Hello "
+```
+
+~~~~exercism/caution
+If not used on a collection, the endless range can cause an endless sequence, if not used with caution.
+~~~~
+
+## String ranges
+
+Strings can also be used in ranges and allow one to get an interval of strings between two strings.
+Its behavior can be a bit unexpected when using certain strings, so use it with caution.
+
+```ruby
+("aa".."az").to_a # => ["aa", "ab", "ac", ..., "az"]
+```
+
+[range]: https://rubyapi.org/o/range
+[sum]: https://rubyapi.org/o/enumerable#method-i-sum
+[size]: https://rubyapi.org/o/range#method-i-size
+[indlude]: https://rubyapi.org/o/range#method-i-include-3F
+
+## Instructions
+
+As a chess enthusiast, you would like to write your own version of the game.
+Yes, there maybe plenty of implementations of chess available online already, but yours will be unique!
+
+You start with implementing a basic movement system for the pieces.
+
+The chess game will be played on a board that is 8 squares wide and 8 squares long.
+The squares are identified by a letter and a number.
+
+## 1. Define rank & file range
+
+The game will have to store the ranks of the board.
+The ranks are the rows of the board, and are numbered from 1 to 8.
+
+The game will also have to store the files of the board.
+The files are the columns of the board and are identified by the letters A to H.
+
+Define the `Chess::RANKS` and `Chess::FILES` constants that store the range of ranks and files respectively.
+
+```ruby
+Chess::RANKS
+# => 1..8
+
+Chess::FILES
+# => 'A'..'H'
+```
+
+## 2. Check if square is valid
+
+The game will have to check if a square is valid.
+A square is valid if the rank and file are within the ranges of the ranks and files.
+
+Define the `Chess.valid_square?` method that takes the arguments `rank` that holds an integer of the rank and `file` that holds a char of the file.
+The method should return `true` if the rank and file are within the ranges of the ranks and files and return `false` otherwise.
+
+```ruby
+Chess.valid_square?(1, 'A')
+# => true
+```
+
+## 3. Get player's nickname
+
+The game will have to get the nickname of the player.
+The nickname is the first 2 characters of the player's first name and the last 2 characters of the player's last name.
+The nickname should be capitalized.
+
+Define the `Chess.nickname` method that takes the arguments `first_name` that holds a string of the player's first name and `last_name` that holds a string of the player's last name.
+The method should return the nickname of the player as capitalized string.
+
+```ruby
+Chess.nickname("John", "Doe")
+# => "JOOE"
+```
+
+## 4. Create move message
+
+The game will have to create a message for a move to say which player moved to which square.
+The message should use the player's nickname and the square they moved to.
+The game also has to determine if the move is valid by checking if the file and rank of the square are within the ranges of the files and ranks.
+
+If the move is valid, the message should be: `"{nickname} moved to {square}}"`
+If the move is invalid, the message should be: `"{nickname} attempted to move to {square}, but that is not a valid square"`
+
+Define the `Chess.move_message` method that takes the arguments `first_name` that holds a string of the player's first_name, `last_name` that holds a string of the player's last_name, and `square` that holds a string of the square the player moved to.
+The method should return the message for the move as a string.
+
+```ruby
+Chess.move_message("John", "Doe", "A1")
+# => "JOOE moved to A1"
+```
+
+## Source
+
+### Created by
+
+- @meatball133
+
+### Contributed to by
+
+- @kotp

ruby/chess-game/chess_game.rb

@@ -0,0 +1,22 @@
+module Chess
+  RANKS = 1..8
+  FILES = 'A'..'H'
+
+  def self.valid_square?(rank, file)
+    RANKS.include? rank and FILES.include? file
+  end
+
+  def self.nick_name(first_name, last_name)
+    (first_name[..1] + last_name[-2..]).upcase
+  end
+
+  def self.move_message(first_name, last_name, square)
+    rank = square[1].to_i
+    file = square[0]
+    if valid_square?(rank, file) then
+      "#{nick_name(first_name, last_name)} moved to #{square}"
+    else 
+      "#{nick_name(first_name, last_name)} attempted to move to #{square}, but that is not a valid square"
+    end
+  end
+end

ruby/chess-game/chess_game_test.rb

@@ -0,0 +1,60 @@
+require 'minitest/autorun'
+require_relative 'chess_game'
+
+class ChessTest < Minitest::Test
+  def test_have_8_files
+    assert_equal 'A'..'H', Chess::FILES
+  end
+
+  def test_have_8_ranks
+    assert_equal 1..8, Chess::RANKS
+  end
+
+  def test_true_when_given_a_valid_square
+    assert Chess.valid_square?(1, 'A')
+  end
+
+  def test_true_for_another_valid_square
+    assert Chess.valid_square?(8, 'H')
+  end
+
+  def test_false_when_rank_is_out_of_range
+    refute Chess.valid_square?(9, 'B')
+  end
+
+  def test_false_when_file_is_out_of_range
+    refute Chess.valid_square?(1, 'I')
+  end
+
+  def test_false_when_rank_is_less_than_one
+    refute Chess.valid_square?(0, 'A')
+  end
+
+  def test_correct_player_nick_name
+    assert_equal "JOOE", Chess.nick_name("John", "Doe")
+  end
+
+  def test_correct_nickname_for_2_letter_last_name
+    assert_equal "LILI", Chess.nick_name("Lisa", "Li")
+  end
+
+  def test_correct_nickname_for_2_letter_first_name
+    assert_equal "DJER", Chess.nick_name("Dj", "Walker")
+  end
+
+  def test_correct_message_for_a_move
+    assert_equal "JOOE moved to A2", Chess.move_message("John", "Doe", "A2")
+  end
+
+  def test_correct_message_when_moving_to_corner
+    assert_equal "LILI moved to H8", Chess.move_message("Lisa", "Li", "H8")
+  end
+
+  def test_incorrect_message_when_out_of_board
+    assert_equal "DJER attempted to move to I9, but that is not a valid square", Chess.move_message("Dj", "Walker", "I9")
+  end
+
+  def test_incorrect_message_when_being_on_rank_0
+    assert_equal "TOON attempted to move to A0, but that is not a valid square", Chess.move_message("Tore", "Anderson", "A0")
+  end
+end