diff --git a/pacman-rules/.exercism/config.json b/pacman-rules/.exercism/config.json new file mode 100644 index 0000000..ffcda9f --- /dev/null +++ b/pacman-rules/.exercism/config.json @@ -0,0 +1,24 @@ +{ + "authors": [ + "lpil" + ], + "files": { + "solution": [ + "src/pacman_rules.gleam" + ], + "test": [ + "test/pacman_rules_test.gleam" + ], + "exemplar": [ + ".meta/example.gleam" + ], + "invalidator": [ + "gleam.toml", + "manifest.toml" + ] + }, + "forked_from": [ + "elixir/pacman_rules" + ], + "blurb": "Learn about bools by implementing the rules of the Pac-Man game." +} diff --git a/pacman-rules/.exercism/metadata.json b/pacman-rules/.exercism/metadata.json new file mode 100644 index 0000000..234c261 --- /dev/null +++ b/pacman-rules/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"gleam","exercise":"pacman-rules","id":"7c358f94ccb149fba1cd23469615a463","url":"https://exercism.org/tracks/gleam/exercises/pacman-rules","handle":"fw353qwgs","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/pacman-rules/.gitignore b/pacman-rules/.gitignore new file mode 100644 index 0000000..170cca9 --- /dev/null +++ b/pacman-rules/.gitignore @@ -0,0 +1,4 @@ +*.beam +*.ez +build +erl_crash.dump diff --git a/pacman-rules/HELP.md b/pacman-rules/HELP.md new file mode 100644 index 0000000..78d7061 --- /dev/null +++ b/pacman-rules/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/pacman_rules.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/pacman-rules/HINTS.md b/pacman-rules/HINTS.md new file mode 100644 index 0000000..76481a2 --- /dev/null +++ b/pacman-rules/HINTS.md @@ -0,0 +1,27 @@ +# Hints + +## General + +- Don't worry about how the arguments are derived, just focus on combining the arguments to return the intended result. + +## 1. Define if pac-man can eat a ghost + +- The function must return a [bool][bool] value. +- You can use the [bool][bool] operator `&&` to combine the arguments for a result. + +## 2. Define if pac-man scores + +- The function must return a [bool][bool] value. +- You can use the [bool][bool] operator `||` to combine the arguments for a result. + +## 3. Define if pac-man loses + +- The function must return a [bool][bool] value. +- You can use the [bool][bool] operators `&&` and `!` to combine the arguments for a result. + +## 4. Define if pac-man wins + +- The function must return a [bool][bool] value. +- You can use the [bool][bool] operators `&&` and `!` to combine the arguments and results of one of the previously implemented functions. + +[bool]: https://gleam.run/book/tour/bools.html \ No newline at end of file diff --git a/pacman-rules/README.md b/pacman-rules/README.md new file mode 100644 index 0000000..2e71c1f --- /dev/null +++ b/pacman-rules/README.md @@ -0,0 +1,88 @@ +# Pacman Rules + +Welcome to Pacman Rules 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 + +## Bools + +Gleam represents true and false values with the `Bool` type. There are only two values: `True` and `False`. These values can be bound to a variable: + +```gleam +let true_variable = True +let false_variable = False +``` + +The `&&`, `||`, and `!` operators can be used to manipulate boolean values: + +```gleam +True && True // -> True +True && False // -> False + +False || True // -> True +False || False // -> False + +!False // -> True +!True // -> False +``` + +The `&&` and `||` operators use short-circuit evaluation, which means that the expression on the right-hand side of the operator is only evaluated if needed. + +Each of the operators has a different precedence, where `!` is evaluated before `&&` and `||`. Braces can be used to evaluate one part of the expression before the others: + +```gleam +!True && False // -> False +!{True && False} // -> True +``` + +## Instructions + +In this exercise, you need to translate some rules from the classic game Pac-Man into Gleam functions. + +You have four rules to translate, all related to the game states. + +> Don't worry about how the arguments are derived, just focus on combining the arguments to return the intended result. + +## 1. Define if Pac-Man eats a ghost + +Define the `eat_ghost` function that takes two arguments (_if Pac-Man has a power pellet active_ and _if Pac-Man is touching a ghost_) and returns a boolean value if Pac-Man is able to eat the ghost. The function should return `True` only if Pac-Man has a power pellet active and is touching a ghost. + +```gleam +eat_ghost(False, True) +// -> False +``` + +## 2. Define if Pac-Man scores + +Define the `score` function that takes two arguments (_if Pac-Man is touching a power pellet_ and _if Pac-Man is touching a dot_) and returns a boolean value if Pac-Man scored. The function should return `True` if Pac-Man is touching a power pellet or a dot. + +```gleam +score(True, True) +// -> True +``` + +## 3. Define if Pac-Man loses + +Define the `lose` function that takes two arguments (_if Pac-Man has a power pellet active_ and _if Pac-Man is touching a ghost_) and returns a boolean value if Pac-Man loses. The function should return `True` if Pac-Man is touching a ghost and does not have a power pellet active. + +```gleam +lose(False, True) +// -> True +``` + +## 4. Define if Pac-Man wins + +Define the `win` function that takes three arguments (_if Pac-Man has eaten all of the dots_, _if Pac-Man has a power pellet active_, and _if Pac-Man is touching a ghost_) and returns a boolean value if Pac-Man wins. The function should return `True` if Pac-Man has eaten all of the dots and has not lost based on the arguments defined in part 3. + +```gleam +win(False, True, False) +// -> False +``` + +## Source + +### Created by + +- @lpil \ No newline at end of file diff --git a/pacman-rules/gleam.toml b/pacman-rules/gleam.toml new file mode 100644 index 0000000..0aa3fd6 --- /dev/null +++ b/pacman-rules/gleam.toml @@ -0,0 +1,14 @@ +name = "pacman_rules" +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/pacman-rules/manifest.toml b/pacman-rules/manifest.toml new file mode 100644 index 0000000..7b32e9a --- /dev/null +++ b/pacman-rules/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/pacman-rules/src/pacman_rules.gleam b/pacman-rules/src/pacman_rules.gleam new file mode 100644 index 0000000..e49e78f --- /dev/null +++ b/pacman-rules/src/pacman_rules.gleam @@ -0,0 +1,19 @@ +pub fn eat_ghost(power_pellet_active: Bool, touching_ghost: Bool) -> Bool { + power_pellet_active && touching_ghost +} + +pub fn score(touching_power_pellet: Bool, touching_dot: Bool) -> Bool { + touching_power_pellet || touching_dot +} + +pub fn lose(power_pellet_active: Bool, touching_ghost: Bool) -> Bool { + !power_pellet_active && touching_ghost +} + +pub fn win( + has_eaten_all_dots: Bool, + power_pellet_active: Bool, + touching_ghost: Bool, +) -> Bool { + has_eaten_all_dots && !lose(power_pellet_active, touching_ghost) +} diff --git a/pacman-rules/test/pacman_rules_test.gleam b/pacman-rules/test/pacman_rules_test.gleam new file mode 100644 index 0000000..6d11803 --- /dev/null +++ b/pacman-rules/test/pacman_rules_test.gleam @@ -0,0 +1,58 @@ +import exercism/test_runner +import pacman_rules + +pub fn main() { + test_runner.main() +} + +pub fn ghost_gets_eaten_test() { + let assert True = pacman_rules.eat_ghost(True, True) +} + +pub fn ghost_does_not_get_eaten_because_no_power_pellet_active_test() { + let assert False = pacman_rules.eat_ghost(False, True) +} + +pub fn ghost_does_not_get_eaten_because_not_touching_ghost_test() { + let assert False = pacman_rules.eat_ghost(True, False) +} + +pub fn ghost_does_not_get_eaten_because_no_power_pellet_is_active_even_if_not_touching_ghost_test() { + let assert False = pacman_rules.eat_ghost(False, False) +} + +pub fn score_when_eating_dot_test() { + let assert True = pacman_rules.score(True, False) +} + +pub fn score_when_eating_power_pellet_test() { + let assert True = pacman_rules.score(False, True) +} + +pub fn no_score_when_nothing_eaten_test() { + let assert False = pacman_rules.score(False, False) +} + +pub fn lose_if_touching_ghost_without_power_pellet_active_test() { + let assert True = pacman_rules.lose(False, True) +} + +pub fn dont_lose_if_touching_ghost_with_power_pellet_active_test() { + let assert False = pacman_rules.lose(True, True) +} + +pub fn dont_lose_if_not_touching_ghost_test() { + let assert False = pacman_rules.lose(True, False) +} + +pub fn win_if_all_dots_eaten_test() { + let assert True = pacman_rules.win(True, False, False) +} + +pub fn dont_win_if_all_dots_eaten_but_touching_ghost_test() { + let assert False = pacman_rules.win(True, False, True) +} + +pub fn win_if_all_dots_eaten_and_touching_ghost_with_power_pellet_active_test() { + let assert True = pacman_rules.win(True, True, True) +}