diff --git a/bettys-bike-shop/.exercism/config.json b/bettys-bike-shop/.exercism/config.json new file mode 100644 index 0000000..50708ca --- /dev/null +++ b/bettys-bike-shop/.exercism/config.json @@ -0,0 +1,21 @@ +{ + "authors": [ + "lpil" + ], + "files": { + "solution": [ + "src/bettys_bike_shop.gleam" + ], + "test": [ + "test/bettys_bike_shop_test.gleam" + ], + "exemplar": [ + ".meta/example.gleam" + ], + "invalidator": [ + "gleam.toml", + "manifest.toml" + ] + }, + "blurb": "Learn about modules by helping Betty to display her bikes prices." +} diff --git a/bettys-bike-shop/.exercism/metadata.json b/bettys-bike-shop/.exercism/metadata.json new file mode 100644 index 0000000..d9b2836 --- /dev/null +++ b/bettys-bike-shop/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"gleam","exercise":"bettys-bike-shop","id":"45556bba3539448d9a731d74deeee93a","url":"https://exercism.org/tracks/gleam/exercises/bettys-bike-shop","handle":"fw353qwgs","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/bettys-bike-shop/.gitignore b/bettys-bike-shop/.gitignore new file mode 100644 index 0000000..170cca9 --- /dev/null +++ b/bettys-bike-shop/.gitignore @@ -0,0 +1,4 @@ +*.beam +*.ez +build +erl_crash.dump diff --git a/bettys-bike-shop/HELP.md b/bettys-bike-shop/HELP.md new file mode 100644 index 0000000..64b3579 --- /dev/null +++ b/bettys-bike-shop/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/bettys_bike_shop.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/bettys-bike-shop/HINTS.md b/bettys-bike-shop/HINTS.md new file mode 100644 index 0000000..88a9cde --- /dev/null +++ b/bettys-bike-shop/HINTS.md @@ -0,0 +1,13 @@ +# Hints + +## General + +- Int and float operators are described in [the language tour][tour]. +- Functions for working with ints are defined in the [`gleam/int` module][int]. +- Functions for working with floats are defined in the [`gleam/float` module][float]. +- Functions for working with strings are defined in the [`gleam/string` module][string]. + +[tour]: https://gleam.run/book/tour/ints-and-floats.html +[int]: https://hexdocs.pm/gleam_stdlib/gleam/int.html +[float]: https://hexdocs.pm/gleam_stdlib/gleam/float.html +[string]: https://hexdocs.pm/gleam_stdlib/gleam/string.html \ No newline at end of file diff --git a/bettys-bike-shop/README.md b/bettys-bike-shop/README.md new file mode 100644 index 0000000..0f8fc5f --- /dev/null +++ b/bettys-bike-shop/README.md @@ -0,0 +1,175 @@ +# Betty's Bike Shop + +Welcome to Betty's Bike Shop 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 + +## Ints + +There are two different kinds of numbers in Gleam - ints and floats. + +Ints are whole numbers. + +```gleam +let integer = 3 +// -> 3 +``` + +Gleam has several operators that work with ints. + +```gleam +1 + 1 // -> 2 +5 - 1 // -> 4 +5 / 2 // -> 2 +3 * 3 // -> 9 +5 % 2 // -> 1 + +2 > 1 // -> True +2 < 1 // -> False +2 >= 1 // -> True +2 <= 1 // -> False +``` + +## Floats + +Floats are numbers with one or more digits behind the decimal separator. + +```gleam +let float = 3.45 +// -> 3.45 +``` + +Floats also have their own set of operators. + +```gleam +1.0 +. 1.4 // -> 2.4 +5.0 -. 1.5 // -> 3.5 +5.0 /. 2.0 // -> 2.5 +3.0 *. 3.1 // -> 9.3 + +2.0 >. 1.0 // -> True +2.0 <. 1.0 // -> False +2.0 >=. 1.0 // -> True +2.0 <=. 1.0 // -> False +``` + +## Modules + +### Modules + +Gleam code is organised into modules, and each file is one Gleam module. + +Up until now we have written functions with the `pub fn` syntax, which defines a function that is publicly available to other modules. Functions defined with `fn` are private to the module they are defined in and cannot be used by other modules. + +```gleam +// This function is public +pub fn add(x, y) { + x + y +} + +// This function is private +fn subtract(x, y) { + x - y +} +``` + +Gleam modules have names, and the name is based on their file path within the `src` or `test` directory. + +For example, a module defined in `src\geometry\rectangle.gleam` (on Windows) or `src/geometry/rectangle.gleam` (on UNIX-like operating systems) would be named `geometry/rectangle`. + +### Importing functions from other modules + +Accessing functions defined in other modules is done via imports. +All functions within that module that were exposed by it are made accessible when importing that module. +But how they are accessed varies depending on how the module is imported. + +Qualified imports are the default, and accessing a function within such module (for example the `map` function in the `gleam/list` module) is done by prefixing the module name (`list.map`). + +```gleam +// Import the int module +import gleam/int + +pub fn run(x: Int) -> String { + // Use the to_string function from the int module + int.to_string(x) +} +``` + +By default the name used to refer to the module is the last part of the module name, in this case `int`, but this can be changed by using the `as` keyword. + +```gleam +// Import the int module and refer to it as i +import gleam/int as i + +pub fn run(x: Int) -> String { + i.to_string(x) +} +``` + +Unqualified imports enable direct access to the exposed functions within that module, without prefixing. + +```gleam +// Import the to_string function from the int module +import gleam/int.{to_string} + +pub fn run(x: Int) -> String { + to_string(x) +} +``` + +Qualified imports are preferred as they make it clearer to the reader where a function comes from, and to avoid name clashes. + + +### Standard library + +Gleam has a rich and well-documented standard library. The documentation is available online at [hexdocs.pm/gleam_stdlib][docs]. Save this link somewhere - you will use it a lot! + +Most built-in data types have a corresponding module that offers functions for working with that data type, e.g. there's the `gleam/int` module for ints, `gleam/string` module for strings, `gleam/list` module for lists and so on. + +[docs]: https://hexdocs.pm/gleam_stdlib/ + +## Instructions + +In this exercise you're going to write some code to help Betty's Bike Shop, an online shop for bikes and parts. +You have three tasks, aiming at correctly displaying the bikes and parts prices on the website. + +## 1. Export the `pence_to_pounds` function + +Your colleague has already written the skeleton of the module, the incomplete functions `pence_to_pounds` and `pounds_to_string`. +However, they have forgotten to export the `pence_to_pounds` function, so it is currently not visible by other modules or by the test suite. + +Export the `pence_to_pounds` function. + +## 2. Convert pence to pounds + +Currently, the price is stored as an integer number of *pence* (the bike shop is based in the UK). +On the website, we want to show the price in *pounds*, where 1.00 pound amounts to 100 pence. +Your first task is to implement the `pence_to_pounds` function, taking an `Int` amount of pence, and converting it into its equivalent pounds as a `Float`. +You should also add type annotations for that function. + +```gleam +pence_to_pounds(106) +// -> 1.06 +``` + +## 3. Format the price for display on the website + +Since Betty's bikes are sold in pounds, prices should be displayed with the symbol "£". +Your second task is thus to implement the `pounds_to_string` function, taking an amount of pounds as a `Float` and returning its price displayed as a `String` with the pound symbol prepended. + +You should import the `gleam/float` and `gleam/string` modules before using them. + +You should also define the type annotation for `pounds_to_string`. + +```gleam +pounds_to_string(1.06) +// -> "£1.06" +``` + +## Source + +### Created by + +- @lpil \ No newline at end of file diff --git a/bettys-bike-shop/gleam.toml b/bettys-bike-shop/gleam.toml new file mode 100644 index 0000000..eb35fb1 --- /dev/null +++ b/bettys-bike-shop/gleam.toml @@ -0,0 +1,14 @@ +name = "bettys_bike_shop" +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/bettys-bike-shop/manifest.toml b/bettys-bike-shop/manifest.toml new file mode 100644 index 0000000..7b32e9a --- /dev/null +++ b/bettys-bike-shop/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/bettys-bike-shop/src/bettys_bike_shop.gleam b/bettys-bike-shop/src/bettys_bike_shop.gleam new file mode 100644 index 0000000..988cf57 --- /dev/null +++ b/bettys-bike-shop/src/bettys_bike_shop.gleam @@ -0,0 +1,14 @@ +import gleam/float +import gleam/int +import gleam/string + +// TODO: import the `gleam/float` module +// TODO: import the `gleam/string` module + +pub fn pence_to_pounds(pence: Int) -> Float { + int.to_float(pence) /. 100.0 +} + +pub fn pounds_to_string(pounds: Float) -> String { + string.append("£", float.to_string(pounds)) +} diff --git a/bettys-bike-shop/test/bettys_bike_shop_test.gleam b/bettys-bike-shop/test/bettys_bike_shop_test.gleam new file mode 100644 index 0000000..e752857 --- /dev/null +++ b/bettys-bike-shop/test/bettys_bike_shop_test.gleam @@ -0,0 +1,27 @@ +import bettys_bike_shop +import exercism/should +import exercism/test_runner + +pub fn main() { + test_runner.main() +} + +pub fn pence_to_pounds_599_is_5_99_pounds_test() { + bettys_bike_shop.pence_to_pounds(599) + |> should.equal(5.99) +} + +pub fn pence_to_pounds_33_is_0_33_pounds_test() { + bettys_bike_shop.pence_to_pounds(33) + |> should.equal(0.33) +} + +pub fn pounds_to_string_5_99_test() { + bettys_bike_shop.pounds_to_string(5.99) + |> should.equal("£5.99") +} + +pub fn pounds_to_string_0_33_test() { + bettys_bike_shop.pounds_to_string(0.33) + |> should.equal("£0.33") +}