diff --git a/high-school-sweetheart/.exercism/config.json b/high-school-sweetheart/.exercism/config.json new file mode 100644 index 0000000..838df19 --- /dev/null +++ b/high-school-sweetheart/.exercism/config.json @@ -0,0 +1,24 @@ +{ + "authors": [ + "lpil" + ], + "files": { + "solution": [ + "src/high_school_sweetheart.gleam" + ], + "test": [ + "test/high_school_sweetheart_test.gleam" + ], + "exemplar": [ + ".meta/example.gleam" + ], + "invalidator": [ + "gleam.toml", + "manifest.toml" + ] + }, + "forked_from": [ + "elixir/high-school-sweetheart" + ], + "blurb": "Learn about the pipe operator by helping high school sweethearts profess their love on social media via ASCII art." +} diff --git a/high-school-sweetheart/.exercism/metadata.json b/high-school-sweetheart/.exercism/metadata.json new file mode 100644 index 0000000..f755a0c --- /dev/null +++ b/high-school-sweetheart/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"gleam","exercise":"high-school-sweetheart","id":"496bd682b8cc4070ab04077da46db44f","url":"https://exercism.org/tracks/gleam/exercises/high-school-sweetheart","handle":"fw353qwgs","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/high-school-sweetheart/.gitignore b/high-school-sweetheart/.gitignore new file mode 100644 index 0000000..170cca9 --- /dev/null +++ b/high-school-sweetheart/.gitignore @@ -0,0 +1,4 @@ +*.beam +*.ez +build +erl_crash.dump diff --git a/high-school-sweetheart/HELP.md b/high-school-sweetheart/HELP.md new file mode 100644 index 0000000..3d3461c --- /dev/null +++ b/high-school-sweetheart/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/high_school_sweetheart.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/high-school-sweetheart/HINTS.md b/high-school-sweetheart/HINTS.md new file mode 100644 index 0000000..70340bc --- /dev/null +++ b/high-school-sweetheart/HINTS.md @@ -0,0 +1,30 @@ +# Hints + +## General + +- Browse the [functions available in the _string module_][string-module-functions] to discover which operations on strings Gleam's standard library offers. + +## 1. Get the name's first letter + +- There is a [function][string-first] to get the first character from a string. +- There are multiple [functions][string-trim] to remove leading, trailing, or leading and trailing whitespaces from a string. + +## 2. Format the first letter as an initial + +- There is a [function][string-upcase] to convert all characters in a string to their uppercase variant. +- The `<>` operator can be used to concatenate strings. + +## 3. Split the full name into the first name and the last name + +- There is a [function][string-split] that splits a string on whitespace characters. +- A few first elements of a list can be assigned to variables by pattern matching on the list. + +## 4. Put the initials inside of the heart + +- The `<>` operator can be used to concatenate strings. + +[string-module-functions]: https://hexdocs.pm/gleam_stdlib/gleam/string.html +[string-first]: https://hexdocs.pm/gleam_stdlib/gleam/string.html#first +[string-trim]: https://hexdocs.pm/gleam_stdlib/gleam/string.html#trim +[string-upcase]: https://hexdocs.pm/gleam_stdlib/gleam/string.html#uppercase +[string-split]: https://hexdocs.pm/gleam_stdlib/gleam/string.html#split \ No newline at end of file diff --git a/high-school-sweetheart/README.md b/high-school-sweetheart/README.md new file mode 100644 index 0000000..552b4fc --- /dev/null +++ b/high-school-sweetheart/README.md @@ -0,0 +1,127 @@ +# High School Sweetheart + +Welcome to High School Sweetheart 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 + +## Pipe Operator + +The `|>` operator is called the pipe operator. It can be used to chain function calls together in such a way that the value returned by the previous function call is passed to the next function call. + +```gleam +"hello" +|> string.uppercase +|> string.append("?!") +// -> "HELLO?!" +``` + +The above code is equivalent to the following: + +```gleam +string.append(string.uppercase("hello"), "?!") +``` + +The pipe operator will either pass the value as the first argument to the function call, or the only argument to a new call, selecting whichever would have the correct type. + +```gleam +100 +|> function_that_takes_two_arguments(1) + +// Is equivalent to +function_that_takes_two_arguments(100, 1) +``` + +```gleam +100 +|> function_that_returns_a_function(1) + +// Is equivalent to +function_that_returns_a_function(1)(100) +``` + +Sometimes we want to pass the value into another position, in this case the `_` placeholder can be used to indicate where the value should be inserted. + +```gleam +100 +|> some_function(1, _, 2) +``` + +## Instructions + +In this exercise, you are going to help high school sweethearts profess their love on social media by generating an ASCII heart with their initials: + +``` + ****** ****** + ** ** ** ** + ** ** ** ** +** * ** +** ** +** J. K. + M. B. ** + ** ** + ** ** + ** ** + ** ** + ** ** + ** ** + *** + * +``` + +## 1. Get the name's first letter + +Implement the `first_letter` function. It should take a name and return its first letter. It should clean up any unnecessary whitespace from the name. + +```gleam +first_letter("Jane") +// -> "J" +``` + +## 2. Format the first letter as an initial + +Implement the `initial` function. It should take a name and return its first letter, uppercase, followed by a dot. Make sure to reuse `first_letter` that you defined in the previous step. + +```gleam +initial("Robert") +// -> "R." +``` + +## 3. Split the full name into the first name and the last name + +Implement the `initials` function. It should take a full name, consisting of a first name and a last name separated by a space, and return the initials. Make sure to reuse `initial` that you defined in the previous step. + +```gleam +initials("Lance Green") +// -> "L. G." +``` + +## 4. Put the initials inside of the heart + +Implement the `pair` function. It should take two full names and return the initials inside an ASCII heart. Make sure to reuse `initials` that you defined in the previous step. + +```gleam +pair("Blake Miller", "Riley Lewis") +// -> " +// ****** ****** +// ** ** ** ** +// ** ** ** ** +// ** * ** +// ** ** +// ** B. M. + R. L. ** +// ** ** +// ** ** +// ** ** +// ** ** +// ** ** +// ** ** +// *** +// * +// " +``` + +## Source + +### Created by + +- @lpil \ No newline at end of file diff --git a/high-school-sweetheart/gleam.toml b/high-school-sweetheart/gleam.toml new file mode 100644 index 0000000..6464308 --- /dev/null +++ b/high-school-sweetheart/gleam.toml @@ -0,0 +1,14 @@ +name = "high_school_sweetheart" +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/high-school-sweetheart/manifest.toml b/high-school-sweetheart/manifest.toml new file mode 100644 index 0000000..7b32e9a --- /dev/null +++ b/high-school-sweetheart/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/high-school-sweetheart/src/high_school_sweetheart.gleam b/high-school-sweetheart/src/high_school_sweetheart.gleam new file mode 100644 index 0000000..43ae648 --- /dev/null +++ b/high-school-sweetheart/src/high_school_sweetheart.gleam @@ -0,0 +1,40 @@ +import gleam/list +import gleam/string + +pub fn first_letter(name: String) { + case string.first(string.trim(name)) { + Error(_) -> "" + Ok(first) -> first + } +} + +pub fn initial(name: String) { + first_letter(name) |> string.uppercase <> "." +} + +pub fn initials(full_name: String) { + case string.split(full_name, " ") { + [] -> "" + [first, last] -> initial(first) <> " " <> initial(last) + _ -> "" + } +} + +pub fn pair(full_name1: String, full_name2: String) { + " + ****** ****** + ** ** ** ** + ** ** ** ** +** * ** +** ** +** " <> initials(full_name1) <> " + " <> initials(full_name2) <> " ** + ** ** + ** ** + ** ** + ** ** + ** ** + ** ** + *** + * +" +} diff --git a/high-school-sweetheart/test/high_school_sweetheart_test.gleam b/high-school-sweetheart/test/high_school_sweetheart_test.gleam new file mode 100644 index 0000000..9a688f0 --- /dev/null +++ b/high-school-sweetheart/test/high_school_sweetheart_test.gleam @@ -0,0 +1,59 @@ +import exercism/should +import exercism/test_runner +import high_school_sweetheart + +pub fn main() { + test_runner.main() +} + +pub fn first_letter_test() { + high_school_sweetheart.first_letter("Mary") + |> should.equal("M") +} + +pub fn first_letter_does_not_change_case_test() { + high_school_sweetheart.first_letter("john") + |> should.equal("j") +} + +pub fn first_letter_removes_whitespace_test() { + high_school_sweetheart.first_letter("\n\t Sarah ") + |> should.equal("S") +} + +pub fn initial_test() { + high_school_sweetheart.initial("Betty") + |> should.equal("B.") +} + +pub fn initial_uppercases_letter_test() { + high_school_sweetheart.initial("james") + |> should.equal("J.") +} + +pub fn initials_test() { + high_school_sweetheart.initials("Linda Miller") + |> should.equal("L. M.") +} + +pub fn pair_test() { + high_school_sweetheart.pair("Avery Bryant", "Charlie Dixon") + |> should.equal( + " + ****** ****** + ** ** ** ** + ** ** ** ** +** * ** +** ** +** A. B. + C. D. ** + ** ** + ** ** + ** ** + ** ** + ** ** + ** ** + *** + * +", + ) +}