Skip to content

Commit

Permalink
[New Concept]: Range (#1569)
Browse files Browse the repository at this point in the history
* Add range concept

* Add config.json

* Update examples and formatting fixes

* Fixes and added contributors

* Remove mentions that a range doesnt have a beginning or end

* Update concepts/ranges/about.md

Co-authored-by: Victor Goff <[email protected]>

* Add changes across files

* Various grammar fixes

---------

Co-authored-by: Victor Goff <[email protected]>
  • Loading branch information
meatball133 and kotp authored Sep 20, 2023
1 parent 5c48d3f commit bd07012
Show file tree
Hide file tree
Showing 13 changed files with 585 additions and 2 deletions.
7 changes: 7 additions & 0 deletions concepts/ranges/.meta/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"blurb": "Ruby has a Range object which represents an interval between two values.",
"authors": [
"meatball133"
],
"contributors": ["ihid", "kotp", "ryanplusplus"]
}
127 changes: 127 additions & 0 deletions concepts/ranges/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# Ranges

[Ranges][ranges] represent an interval between two values.
The most common types that support ranges are `Int` 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` initializer.

```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 the otherwise will the method 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] # => "Wor"
```

## 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"]
```

## Custom objects in ranges

````exercism/advanced
Ruby allows you to use custom objects in ranges.
The requirement for this is that the object implements the following:
- include the `Comparable` module
- `succ` method
- `<=>` method
These methods make it so that the range can iterate over the object and compare the objects in the range.
```ruby
class Foo
include Comparable
attr_reader :value
def initialize(value)
@value = value
end
def succ
Foo.new(value + 1)
end
def <=>(other)
value <=> other.value
end
end
(Foo.new(1)..Foo.new(5))
# => #<Foo:0x7f3552bebe70 @value=1>, #<Foo:0x7f3552bebe50 @value=2>, #<Foo:0x7f3552bebe40 @value=3>, #<Foo:0x7f3552bebe30 @value=4>, #<Foo:0x7f3552bebe20 @value=5>
```
````

[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
91 changes: 91 additions & 0 deletions concepts/ranges/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Ranges

[Ranges][ranges] represent an interval between two values.
The most common types that support ranges are `Int` 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` initializer.

```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 the otherwise will the method 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] # => "Wor"
```

## 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
11 changes: 11 additions & 0 deletions concepts/ranges/links.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[
{
"url": "https://www.rubyguides.com/2016/06/ruby-ranges-how-do-they-work/",
"description": "Ruby Guides: Ruby Ranges: How Do They Work?"
},
{
"url": "https://rubyapi.org/o/range",
"description": "Ruby api: Ranges"
}
]

21 changes: 19 additions & 2 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,17 @@
"conditionals"
]
},
{
"slug": "chess-game",
"name": "Chess Game",
"uuid": "3b107bdb-42a1-43de-95d4-ad1370a70cfc",
"concepts": [
"ranges"
],
"prerequisites": [
"symbols"
]
},
{
"slug": "bird-count",
"name": "Bird Count",
Expand All @@ -130,7 +141,8 @@
"instance-variables",
"booleans",
"symbols",
"conditionals"
"conditionals",
"ranges"
]
},
{
Expand Down Expand Up @@ -1655,7 +1667,12 @@
"uuid": "4b0f3718-cc06-4aa6-8b0f-7db3bbe6af5d",
"slug": "symbols",
"name": "Symbols"
},
},
{
"uuid": "ec83aa13-0861-46d4-a126-2ebf6b8705d3",
"slug": "ranges",
"name": "Ranges"
},
{
"uuid": "0189a402-ed46-47ee-9f5b-cfa5f557720d",
"slug": "enumeration",
Expand Down
31 changes: 31 additions & 0 deletions exercises/concept/chess-game/.docs/hints.md
Original file line number Diff line number Diff line change
@@ -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 [`Int`][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
71 changes: 71 additions & 0 deletions exercises/concept/chess-game/.docs/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# 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 int 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"
```
Loading

0 comments on commit bd07012

Please sign in to comment.