Skip to content

Commit

Permalink
[gleam] complete rotational-cipher
Browse files Browse the repository at this point in the history
  • Loading branch information
joaofnds committed Jul 16, 2024
1 parent 2a22269 commit b865ddb
Show file tree
Hide file tree
Showing 7 changed files with 198 additions and 0 deletions.
4 changes: 4 additions & 0 deletions gleam/rotational-cipher/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.beam
*.ez
build
erl_crash.dump
32 changes: 32 additions & 0 deletions gleam/rotational-cipher/HELP.md
Original file line number Diff line number Diff line change
@@ -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/rotational_cipher.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.
44 changes: 44 additions & 0 deletions gleam/rotational-cipher/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Rotational Cipher

Welcome to Rotational Cipher on Exercism's Gleam Track.
If you need help running the tests or submitting your code, check out `HELP.md`.

## Instructions

Create an implementation of the rotational cipher, also sometimes called the Caesar cipher.

The Caesar cipher is a simple shift cipher that relies on transposing all the letters in the alphabet using an integer key between `0` and `26`.
Using a key of `0` or `26` will always yield the same output due to modular arithmetic.
The letter is shifted for as many values as the value of the key.

The general notation for rotational ciphers is `ROT + <key>`.
The most commonly used rotational cipher is `ROT13`.

A `ROT13` on the Latin alphabet would be as follows:

```text
Plain: abcdefghijklmnopqrstuvwxyz
Cipher: nopqrstuvwxyzabcdefghijklm
```

It is stronger than the Atbash cipher because it has 27 possible keys, and 25 usable keys.

Ciphertext is written out in the same formatting as the input including spaces and punctuation.

## Examples

- ROT5 `omg` gives `trl`
- ROT0 `c` gives `c`
- ROT26 `Cool` gives `Cool`
- ROT13 `The quick brown fox jumps over the lazy dog.` gives `Gur dhvpx oebja sbk whzcf bire gur ynml qbt.`
- ROT13 `Gur dhvpx oebja sbk whzcf bire gur ynml qbt.` gives `The quick brown fox jumps over the lazy dog.`

## Source

### Created by

- @erikschierboom

### Based on

Wikipedia - https://en.wikipedia.org/wiki/Caesar_cipher
12 changes: 12 additions & 0 deletions gleam/rotational-cipher/gleam.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name = "rotational_cipher"
version = "0.1.0"

[dependencies]
gleam_bitwise = "~> 1.2"
gleam_otp = "~> 0.7 or ~> 1.0"
gleam_stdlib = "~> 0.32 or ~> 1.0"
simplifile = "~> 1.0"
gleam_erlang = ">= 0.25.0 and < 1.0.0"

[dev-dependencies]
exercism_test_runner = "~> 1.4"
27 changes: 27 additions & 0 deletions gleam/rotational-cipher/manifest.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# This file was generated by Gleam
# You typically do not need to edit this file

packages = [
{ name = "argv", version = "1.0.1", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "A6E9009E50BBE863EB37D963E4315398D41A3D87D0075480FC244125808F964A" },
{ name = "exercism_test_runner", version = "1.7.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 = "2FC1BADB19BEC2AE77BFD2D3A606A014C85412A7B874CAFC4BA8CF04B0B257CD" },
{ name = "gap", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_stdlib"], otp_app = "gap", source = "hex", outer_checksum = "2EE1B0A17E85CF73A0C1D29DA315A2699117A8F549C8E8D89FA8261BE41EDEB1" },
{ name = "glance", version = "0.8.2", build_tools = ["gleam"], requirements = ["gleam_stdlib", "glexer"], otp_app = "glance", source = "hex", outer_checksum = "ACF09457E8B564AD7A0D823DAFDD326F58263C01ACB0D432A9BEFDEDD1DA8E73" },
{ name = "gleam_bitwise", version = "1.3.1", build_tools = ["gleam"], requirements = [], otp_app = "gleam_bitwise", source = "hex", outer_checksum = "B36E1D3188D7F594C7FD4F43D0D2CE17561DE896202017548578B16FE1FE9EFC" },
{ name = "gleam_community_ansi", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_community_colour", "gleam_stdlib"], otp_app = "gleam_community_ansi", source = "hex", outer_checksum = "FE79E08BF97009729259B6357EC058315B6FBB916FAD1C2FF9355115FEB0D3A4" },
{ name = "gleam_community_colour", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_community_colour", source = "hex", outer_checksum = "A49A5E3AE8B637A5ACBA80ECB9B1AFE89FD3D5351FF6410A42B84F666D40D7D5" },
{ name = "gleam_erlang", version = "0.25.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "054D571A7092D2A9727B3E5D183B7507DAB0DA41556EC9133606F09C15497373" },
{ name = "gleam_json", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "8B197DD5D578EA6AC2C0D4BDC634C71A5BCA8E7DB5F47091C263ECB411A60DF3" },
{ name = "gleam_otp", version = "0.10.0", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "0B04FE915ACECE539B317F9652CAADBBC0F000184D586AAAF2D94C100945D72B" },
{ name = "gleam_stdlib", version = "0.36.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "C0D14D807FEC6F8A08A7C9EF8DFDE6AE5C10E40E21325B2B29365965D82EB3D4" },
{ name = "glexer", version = "0.7.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "glexer", source = "hex", outer_checksum = "4484942A465482A0A100936E1E5F12314DB4B5AC0D87575A7B9E9062090B96BE" },
{ name = "simplifile", version = "1.5.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "EB9AA8E65E5C1E3E0FDCFC81BC363FD433CB122D7D062750FFDF24DE4AC40116" },
{ name = "thoas", version = "0.4.1", build_tools = ["rebar3"], requirements = [], otp_app = "thoas", source = "hex", outer_checksum = "4918D50026C073C4AB1388437132C77A6F6F7C8AC43C60C13758CC0ADCE2134E" },
]

[requirements]
exercism_test_runner = { version = "~> 1.4" }
gleam_bitwise = { version = "~> 1.2" }
gleam_erlang = { version = ">= 0.25.0 and < 1.0.0"}
gleam_otp = { version = "~> 0.7 or ~> 1.0" }
gleam_stdlib = { version = "~> 0.32 or ~> 1.0" }
simplifile = { version = "~> 1.0" }
22 changes: 22 additions & 0 deletions gleam/rotational-cipher/src/rotational_cipher.gleam
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import gleam/dict
import gleam/list
import gleam/result
import gleam/string

pub fn rotate(shift_key: Int, text: String) -> String {
let alphabet = string.to_graphemes("abcdefghijklmnopqrstuvwxyz")

let cipher_map =
list.drop(alphabet, shift_key)
|> list.append(list.take(alphabet, shift_key))
|> list.zip(alphabet, _)
|> list.flat_map(fn(x) {
[x, #(string.uppercase(x.0), string.uppercase(x.1))]
})
|> dict.from_list

text
|> string.to_graphemes
|> list.map(fn(char) { result.unwrap(dict.get(cipher_map, char), char) })
|> string.concat
}
57 changes: 57 additions & 0 deletions gleam/rotational-cipher/test/rotational_cipher_test.gleam
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import exercism/should
import exercism/test_runner
import rotational_cipher

pub fn main() {
test_runner.main()
}

pub fn rotate_a_by_0_same_output_as_input_test() {
rotational_cipher.rotate(0, "a")
|> should.equal("a")
}

pub fn rotate_a_by_1_test() {
rotational_cipher.rotate(1, "a")
|> should.equal("b")
}

pub fn rotate_a_by_26_same_output_as_input_test() {
rotational_cipher.rotate(26, "a")
|> should.equal("a")
}

pub fn rotate_m_by_13_test() {
rotational_cipher.rotate(13, "m")
|> should.equal("z")
}

pub fn rotate_n_by_13_with_wrap_around_alphabet_test() {
rotational_cipher.rotate(13, "n")
|> should.equal("a")
}

pub fn rotate_capital_letters_test() {
rotational_cipher.rotate(5, "OMG")
|> should.equal("TRL")
}

pub fn rotate_spaces_test() {
rotational_cipher.rotate(5, "O M G")
|> should.equal("T R L")
}

pub fn rotate_numbers_test() {
rotational_cipher.rotate(4, "Testing 1 2 3 testing")
|> should.equal("Xiwxmrk 1 2 3 xiwxmrk")
}

pub fn rotate_punctuation_test() {
rotational_cipher.rotate(21, "Let's eat, Grandma!")
|> should.equal("Gzo'n zvo, Bmviyhv!")
}

pub fn rotate_all_letters_test() {
rotational_cipher.rotate(13, "The quick brown fox jumps over the lazy dog.")
|> should.equal("Gur dhvpx oebja sbk whzcf bire gur ynml qbt.")
}

0 comments on commit b865ddb

Please sign in to comment.