diff --git a/guessing-game/.exercism/config.json b/guessing-game/.exercism/config.json new file mode 100644 index 0000000..22e8bb6 --- /dev/null +++ b/guessing-game/.exercism/config.json @@ -0,0 +1,24 @@ +{ + "authors": [ + "lpil" + ], + "files": { + "solution": [ + "src/guessing_game.gleam" + ], + "test": [ + "test/guessing_game_test.gleam" + ], + "exemplar": [ + ".meta/example.gleam" + ], + "invalidator": [ + "gleam.toml", + "manifest.toml" + ] + }, + "forked_from": [ + "fsharp/guessing-game" + ], + "blurb": "Learn about case expressions by implementing a simple game in which the player needs to guess a secret number" +} diff --git a/guessing-game/.exercism/metadata.json b/guessing-game/.exercism/metadata.json new file mode 100644 index 0000000..5175791 --- /dev/null +++ b/guessing-game/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"gleam","exercise":"guessing-game","id":"b9bfee8ac59540e181cca949a9681fb2","url":"https://exercism.org/tracks/gleam/exercises/guessing-game","handle":"fw353qwgs","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/guessing-game/.gitignore b/guessing-game/.gitignore new file mode 100644 index 0000000..170cca9 --- /dev/null +++ b/guessing-game/.gitignore @@ -0,0 +1,4 @@ +*.beam +*.ez +build +erl_crash.dump diff --git a/guessing-game/HELP.md b/guessing-game/HELP.md new file mode 100644 index 0000000..f5d57be --- /dev/null +++ b/guessing-game/HELP.md @@ -0,0 +1,32 @@ +# Help + +## Running the tests + +To run the tests, run the command `gleam test` from within the exercise directory. + +## Submitting your solution + +You can submit your solution using the `exercism submit src/guessing_game.gleam` 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 [Gleam track's documentation](https://exercism.org/docs/tracks/gleam) +- The [Gleam track's programming category on the forum](https://forum.exercism.org/c/programming/gleam) +- [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: + +- [gleam.run](https://gleam.run/documentation/) is the gleam official documentation. +- [Discord](https://discord.gg/Fm8Pwmy) is the discord channel. +- [StackOverflow](https://stackoverflow.com/questions/tagged/gleam) can be used to search for your problem and see if it has been answered already. You can also ask and answer questions. \ No newline at end of file diff --git a/guessing-game/HINTS.md b/guessing-game/HINTS.md new file mode 100644 index 0000000..aeb500f --- /dev/null +++ b/guessing-game/HINTS.md @@ -0,0 +1,23 @@ +# Hints + +## General + +- [This page][case-expressions] has a nice introduction to case expressions in Gleam. + +## 1. Reply to a correct guess + +- You can use a literal pattern to match on a specific number. + +## 2. Reply to a close guess + +- You can either use a literal pattern or a variable pattern and a guard. + +## 3. Reply to too low guesses + +- You can use a combination of a variable pattern and a guard. + +## 4. Reply to too high guesses + +- You can use a combination of a variable pattern and a guard, or a discard pattern. + +[case-expressions]: https://gleam.run/book/tour/case-expressions.html \ No newline at end of file diff --git a/guessing-game/README.md b/guessing-game/README.md new file mode 100644 index 0000000..c98979a --- /dev/null +++ b/guessing-game/README.md @@ -0,0 +1,132 @@ +# Guessing Game + +Welcome to Guessing Game on Exercism's Gleam 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 + +## Case Expressions + +In Gleam a `case` expression can be used to conditionally execute code. With a case expression a value can be tested against one or more _patterns_. An example of such a pattern is the _literal pattern_, which matches a value against a literal value (e.g. `1` or `"hello"`). + +Case expressions are written with the `case` keyword: + +```gleam +pub fn describe(number: Int) -> String { + case number { + 0 -> "Zero" + 1 -> "One" + } +} +``` + +While this may look like `switch` statements in other languages, pattern matching starts to shine when also using other patterns. One such pattern is the _variable pattern_, which allows one to assign a value to a variable. In this example, the variable `i` will be assigned the value of `number` if it is not `0`: + +```gleam +pub fn describe(number: Int) -> String { + case number { + 0 -> "Zero" + i -> "Non zero" + } +} +``` + +In some cases, you may want to add an additional condition to a pattern. This is known as a _guard_ (clause), which can be added using the `if` keyword: + +```gleam +pub fn describe(number: Int) -> String { + case number { + 0 -> "Zero" + i if i < 0 -> "Negative number" + } +} +``` + +For performance reasons only basic mathematical and boolean operators are allowed in guards, other functions cannot be used in guards. + +In the above example, not all possible input will have a matching pattern. The compiler will detect this and output an error. This is known as _exhaustive checking_. To solve the warning, one has to handle all cases. For this, the _discard pattern_ can be used, which is a pattern that matches on any value: + +```gleam +pub fn describe(number: Int) -> String { + case number { + 0 -> "Zero" + i if i < 0 -> "Negative number" + _ -> "Positive number" + } +} + +// No compiler error +``` + +Multiple patterns can be matched against in one clause using the `|` to separate between each pattern. Only one guard can be added to a clause: + +```gleam +pub fn describe(number: Int) -> String { + let yell = True + case number { + 0 -> "Zero" + 3 | 5 -> "One of the first odd prime numbers" + 2 | 4 | 6 | 8 if !yell -> "One of the even numbers less than 10" + i if i % 2 == 0 && yell -> "[Yelling] I'm telling you! It's a even nunber" + i if i < 0 -> "Negative number" + _ -> "Positive number" + } +} +// No compiler error +``` + +Case expressions will test a value against each pattern from top to bottom, until it finds a matching pattern and executes the logic associated with that pattern. The order of patterns matters! + +## Instructions + +In this exercise, you are playing a number guessing game with a friend. The rules are simple: you secretly choose a number between `1` and `100` and your friend tries to guess what number you've chosen. To help your friend, you respond differently depending on how close the guess was to the number you've chosen (`42`). These are the rules for the different replies: + +- If the guess is `42`: "Correct" +- If the guess is `41` or `43`: "So close" +- If the guess is less than `41`: "Too low" +- If the guess is greater than `43`: "Too high" + +You have four tasks to encode the replies to the guesses. + +## 1. Reply to a correct guess + +Implement the `reply` function to reply to a correct guess: + +```gleam +reply(42) +// -> "Correct" +``` + +## 2. Reply to a close guess + +Modify the `reply` function to reply to close guesses: + +```gleam +reply(41) +// -> "So close" +``` + +## 3. Reply to too low guesses + +Modify the `reply` function to reply to too low guesses: + +```gleam +reply(25) +// -> "Too low" +``` + +## 4. Reply to too high guesses + +Modify the `reply` function to reply to too high guesses: + +```gleam +reply(88) +// -> "Too high" +``` + +## Source + +### Created by + +- @lpil \ No newline at end of file diff --git a/guessing-game/gleam.toml b/guessing-game/gleam.toml new file mode 100644 index 0000000..d2dbd18 --- /dev/null +++ b/guessing-game/gleam.toml @@ -0,0 +1,14 @@ +name = "guessing_game" +version = "0.1.0" + +[dependencies] +gleam_otp = "~> 0.7 or ~> 1.0" +gleam_stdlib = ">= 0.54.0 or ~> 1.0" +simplifile = "~> 1.0" +gleam_erlang = ">= 0.25.0 and < 1.0.0" +gleam_yielder = ">= 1.1.0 and < 2.0.0" +gleam_regexp = ">= 1.1.0 and < 2.0.0" +gleam_deque = ">= 1.0.0 and < 2.0.0" + +[dev-dependencies] +exercism_test_runner = "~> 1.9" diff --git a/guessing-game/manifest.toml b/guessing-game/manifest.toml new file mode 100644 index 0000000..7b32e9a --- /dev/null +++ b/guessing-game/manifest.toml @@ -0,0 +1,31 @@ +# This file was generated by Gleam +# You typically do not need to edit this file + +packages = [ + { name = "argv", version = "1.0.2", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "BA1FF0929525DEBA1CE67256E5ADF77A7CDDFE729E3E3F57A5BDCAA031DED09D" }, + { name = "exercism_test_runner", version = "1.9.0", build_tools = ["gleam"], requirements = ["argv", "gap", "glance", "gleam_community_ansi", "gleam_erlang", "gleam_json", "gleam_stdlib", "simplifile"], otp_app = "exercism_test_runner", source = "hex", outer_checksum = "0B17BB25F2FF1E60266467C24FE0CA04005410306AA05E9A4B41B1852D72865C" }, + { name = "filepath", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "filepath", source = "hex", outer_checksum = "67A6D15FB39EEB69DD31F8C145BB5A421790581BD6AA14B33D64D5A55DBD6587" }, + { name = "gap", version = "1.1.3", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_stdlib"], otp_app = "gap", source = "hex", outer_checksum = "6EF5E3B523FDFBC317E9EA28D5163EE04744A97C007106F90207569789612291" }, + { name = "glance", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "glexer"], otp_app = "glance", source = "hex", outer_checksum = "E155BA1A787FD11827048355021C0390D2FE9A518485526F631A9D472858CC6D" }, + { name = "gleam_community_ansi", version = "1.4.3", build_tools = ["gleam"], requirements = ["gleam_community_colour", "gleam_regexp", "gleam_stdlib"], otp_app = "gleam_community_ansi", source = "hex", outer_checksum = "8A62AE9CC6EA65BEA630D95016D6C07E4F9973565FA3D0DE68DC4200D8E0DD27" }, + { name = "gleam_community_colour", version = "2.0.0", build_tools = ["gleam"], requirements = ["gleam_json", "gleam_stdlib"], otp_app = "gleam_community_colour", source = "hex", outer_checksum = "FDD6AC62C6EC8506C005949A4FCEF032038191D5EAAEC3C9A203CD53AE956ACA" }, + { name = "gleam_deque", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_deque", source = "hex", outer_checksum = "64D77068931338CF0D0CB5D37522C3E3CCA7CB7D6C5BACB41648B519CC0133C7" }, + { name = "gleam_erlang", version = "0.34.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "0C38F2A128BAA0CEF17C3000BD2097EB80634E239CE31A86400C4416A5D0FDCC" }, + { name = "gleam_json", version = "2.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_json", source = "hex", outer_checksum = "C55C5C2B318533A8072D221C5E06E5A75711C129E420DD1CE463342106012E5D" }, + { name = "gleam_otp", version = "0.16.1", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "50DA1539FC8E8FA09924EB36A67A2BBB0AD6B27BCDED5A7EF627057CF69D035E" }, + { name = "gleam_regexp", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_regexp", source = "hex", outer_checksum = "7F5E0C0BBEB3C58E57C9CB05FA9002F970C85AD4A63BA1E55CBCB35C15809179" }, + { name = "gleam_stdlib", version = "0.55.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "32D8F4AE03771516950047813A9E359249BD9FBA5C33463FDB7B953D6F8E896B" }, + { name = "gleam_yielder", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_yielder", source = "hex", outer_checksum = "8E4E4ECFA7982859F430C57F549200C7749823C106759F4A19A78AEA6687717A" }, + { name = "glexer", version = "2.2.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "glexer", source = "hex", outer_checksum = "5C235CBDF4DA5203AD5EAB1D6D8B456ED8162C5424FE2309CFFB7EF438B7C269" }, + { name = "simplifile", version = "1.7.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "1D5DFA3A2F9319EC85825F6ED88B8E449F381B0D55A62F5E61424E748E7DDEB0" }, +] + +[requirements] +exercism_test_runner = { version = "~> 1.9" } +gleam_deque = { version = ">= 1.0.0 and < 2.0.0" } +gleam_erlang = { version = ">= 0.25.0 and < 1.0.0" } +gleam_otp = { version = "~> 0.7 or ~> 1.0" } +gleam_regexp = { version = ">= 1.1.0 and < 2.0.0" } +gleam_stdlib = { version = ">= 0.54.0 or ~> 1.0" } +gleam_yielder = { version = ">= 1.1.0 and < 2.0.0" } +simplifile = { version = "~> 1.0" } diff --git a/guessing-game/src/guessing_game.gleam b/guessing-game/src/guessing_game.gleam new file mode 100644 index 0000000..bbb9929 --- /dev/null +++ b/guessing-game/src/guessing_game.gleam @@ -0,0 +1,8 @@ +pub fn reply(guess: Int) -> String { + case guess { + n if n < 41 -> "Too low" + 41 | 43 -> "So close" + n if n > 43 -> "Too high" + _ -> "Correct" + } +} diff --git a/guessing-game/test/guessing_game_test.gleam b/guessing-game/test/guessing_game_test.gleam new file mode 100644 index 0000000..f759296 --- /dev/null +++ b/guessing-game/test/guessing_game_test.gleam @@ -0,0 +1,42 @@ +import exercism/should +import exercism/test_runner +import guessing_game + +pub fn main() { + test_runner.main() +} + +pub fn reply_42_test() { + guessing_game.reply(42) + |> should.equal("Correct") +} + +pub fn reply_41_test() { + guessing_game.reply(41) + |> should.equal("So close") +} + +pub fn reply_43_test() { + guessing_game.reply(43) + |> should.equal("So close") +} + +pub fn reply_40_test() { + guessing_game.reply(40) + |> should.equal("Too low") +} + +pub fn reply_1_test() { + guessing_game.reply(1) + |> should.equal("Too low") +} + +pub fn reply_44_test() { + guessing_game.reply(44) + |> should.equal("Too high") +} + +pub fn reply_100_test() { + guessing_game.reply(100) + |> should.equal("Too high") +}