feat: Add phone-number exercise (#180)

Author: keiravillekode

config.json

@@ -145,6 +145,14 @@
         "prerequisites": [],
         "difficulty": 3
       },
+      {
+        "slug": "phone-number",
+        "name": "Phone Number",
+        "uuid": "8af4128a-59c4-477f-9903-bec44f3e1555",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 3
+      },
       {
         "uuid": "4af029c7-3154-4781-8c49-4269d84cadad",
         "slug": "triangle",

exercises/practice/phone-number/.docs/instructions.md

@@ -0,0 +1,34 @@
+# Instructions
+
+Clean up user-entered phone numbers so that they can be sent SMS messages.
+
+The **North American Numbering Plan (NANP)** is a telephone numbering system used by many countries in North America like the United States, Canada or Bermuda.
+All NANP-countries share the same international country code: `1`.
+
+NANP numbers are ten-digit numbers consisting of a three-digit Numbering Plan Area code, commonly known as _area code_, followed by a seven-digit local number.
+The first three digits of the local number represent the _exchange code_, followed by the unique four-digit number which is the _subscriber number_.
+
+The format is usually represented as
+
+```text
+NXX NXX-XXXX
+```
+
+where `N` is any digit from 2 through 9 and `X` is any digit from 0 through 9.
+
+Sometimes they also have the country code (represented as `1` or `+1`) prefixed.
+
+Your task is to clean up differently formatted telephone numbers by removing punctuation and the country code if present.
+
+For example, the inputs
+
+- `+1 (613)-995-0253`
+- `613-995-0253`
+- `1 613 995 0253`
+- `613.995.0253`
+
+should all produce the output
+
+`6139950253`
+
+**Note:** As this exercise only deals with telephone numbers used in NANP-countries, only 1 is considered a valid country code.

exercises/practice/phone-number/.meta/config.json

@@ -0,0 +1,19 @@
+{
+  "authors": [
+    "keiravillekode"
+  ],
+  "files": {
+    "solution": [
+      "phone-number.v"
+    ],
+    "test": [
+      "run_test.v"
+    ],
+    "example": [
+      ".meta/example.v"
+    ]
+  },
+  "blurb": "Clean up user-entered phone numbers so that they can be sent SMS messages.",
+  "source": "Exercise by the JumpstartLab team for students at The Turing School of Software and Design.",
+  "source_url": "https://turing.edu"
+}

exercises/practice/phone-number/.meta/example.v

@@ -0,0 +1,55 @@
+module main
+
+import strings
+
+fn clean(phrase string) !string {
+	mut builder := strings.new_builder(phrase.len)
+	for ch in phrase {
+		if ch.is_letter() {
+			return error('letters not permitted')
+		}
+
+		if ch.is_digit() {
+			builder << ch
+		} else if !' ()+-.'.contains_u8(ch) {
+			return error('punctuations not permitted')
+		}
+	}
+
+	num_digits := builder.len
+
+	if num_digits < 10 {
+		return error('must not be fewer than 10 digits')
+	}
+
+	if num_digits > 11 {
+		return error('must not be greater than 11 digits')
+	}
+
+	if num_digits == 11 && builder[0] != `1` {
+		return error('11 digits must start with 1')
+	}
+
+	mut result := builder.str()
+	if num_digits == 11 {
+		result = result.substr(1, 11)
+	}
+
+	if result[0] == `0` {
+		return error('area code cannot start with zero')
+	}
+
+	if result[0] == `1` {
+		return error('area code cannot start with one')
+	}
+
+	if result[3] == `0` {
+		return error('exchange code cannot start with zero')
+	}
+
+	if result[3] == `1` {
+		return error('exchange code cannot start with one')
+	}
+
+	return result
+}

exercises/practice/phone-number/.meta/tests.toml

@@ -0,0 +1,77 @@
+# This is an auto-generated file. Regular comments will be removed when this
+# file is regenerated. Regenerating will not touch any manually added keys,
+# so comments can be added in a "comment" key.
+
+[79666dce-e0f1-46de-95a1-563802913c35]
+description = "cleans the number"
+
+[c360451f-549f-43e4-8aba-fdf6cb0bf83f]
+description = "cleans numbers with dots"
+
+[08f94c34-9a37-46a2-a123-2a8e9727395d]
+description = "cleans numbers with multiple spaces"
+
+[598d8432-0659-4019-a78b-1c6a73691d21]
+description = "invalid when 9 digits"
+include = false
+
+[2de74156-f646-42b5-8638-0ef1d8b58bc2]
+description = "invalid when 9 digits"
+reimplements = "598d8432-0659-4019-a78b-1c6a73691d21"
+
+[57061c72-07b5-431f-9766-d97da7c4399d]
+description = "invalid when 11 digits does not start with a 1"
+
+[9962cbf3-97bb-4118-ba9b-38ff49c64430]
+description = "valid when 11 digits and starting with 1"
+
+[fa724fbf-054c-4d91-95da-f65ab5b6dbca]
+description = "valid when 11 digits and starting with 1 even with punctuation"
+
+[c6a5f007-895a-4fc5-90bc-a7e70f9b5cad]
+description = "invalid when more than 11 digits"
+include = false
+
+[4a1509b7-8953-4eec-981b-c483358ff531]
+description = "invalid when more than 11 digits"
+reimplements = "c6a5f007-895a-4fc5-90bc-a7e70f9b5cad"
+
+[63f38f37-53f6-4a5f-bd86-e9b404f10a60]
+description = "invalid with letters"
+include = false
+
+[eb8a1fc0-64e5-46d3-b0c6-33184208e28a]
+description = "invalid with letters"
+reimplements = "63f38f37-53f6-4a5f-bd86-e9b404f10a60"
+
+[4bd97d90-52fd-45d3-b0db-06ab95b1244e]
+description = "invalid with punctuations"
+include = false
+
+[065f6363-8394-4759-b080-e6c8c351dd1f]
+description = "invalid with punctuations"
+reimplements = "4bd97d90-52fd-45d3-b0db-06ab95b1244e"
+
+[d77d07f8-873c-4b17-8978-5f66139bf7d7]
+description = "invalid if area code starts with 0"
+
+[c7485cfb-1e7b-4081-8e96-8cdb3b77f15e]
+description = "invalid if area code starts with 1"
+
+[4d622293-6976-413d-b8bf-dd8a94d4e2ac]
+description = "invalid if exchange code starts with 0"
+
+[4cef57b4-7d8e-43aa-8328-1e1b89001262]
+description = "invalid if exchange code starts with 1"
+
+[9925b09c-1a0d-4960-a197-5d163cbe308c]
+description = "invalid if area code starts with 0 on valid 11-digit number"
+
+[3f809d37-40f3-44b5-ad90-535838b1a816]
+description = "invalid if area code starts with 1 on valid 11-digit number"
+
+[e08e5532-d621-40d4-b0cc-96c159276b65]
+description = "invalid if exchange code starts with 0 on valid 11-digit number"
+
+[57b32f3d-696a-455c-8bf1-137b6d171cdf]
+description = "invalid if exchange code starts with 1 on valid 11-digit number"

exercises/practice/phone-number/phone-number.v

@@ -0,0 +1,4 @@
+module main
+
+fn clean(phrase string) !string {
+}

exercises/practice/phone-number/run_test.v

@@ -0,0 +1,143 @@
+module main
+
+fn test_cleans_the_number() {
+	phrase := '(223) 456-7890'
+	assert clean(phrase)! == '2234567890'
+}
+
+fn test_cleans_numbers_with_dots() {
+	phrase := '223.456.7890'
+	assert clean(phrase)! == '2234567890'
+}
+
+fn test_cleans_numbers_with_multiple_spaces() {
+	phrase := '223 456   7890   '
+	assert clean(phrase)! == '2234567890'
+}
+
+fn test_invalid_when_9_digits() {
+	phrase := '123456789'
+	if res := clean(phrase) {
+		assert false, 'invalid when 9 digits should return an error'
+	} else {
+		assert err.msg() == 'must not be fewer than 10 digits'
+	}
+}
+
+fn test_invalid_when_11_digits_does_not_start_with_a_1() {
+	phrase := '22234567890'
+	if res := clean(phrase) {
+		assert false, 'invalid when 11 digits does not start with a 1 should return an error'
+	} else {
+		assert err.msg() == '11 digits must start with 1'
+	}
+}
+
+fn test_valid_when_11_digits_and_starting_with_1() {
+	phrase := '12234567890'
+	assert clean(phrase)! == '2234567890'
+}
+
+fn test_valid_when_11_digits_and_starting_with_1_even_with_punctuation() {
+	phrase := '+1 (223) 456-7890'
+	assert clean(phrase)! == '2234567890'
+}
+
+fn test_invalid_when_more_than_11_digits() {
+	phrase := '321234567890'
+	if res := clean(phrase) {
+		assert false, 'invalid when more than 11 digits should return an error'
+	} else {
+		assert err.msg() == 'must not be greater than 11 digits'
+	}
+}
+
+fn test_invalid_with_letters() {
+	phrase := '523-abc-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid with letters should return an error'
+	} else {
+		assert err.msg() == 'letters not permitted'
+	}
+}
+
+fn test_invalid_with_punctuations() {
+	phrase := '523-@:!-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid with punctuations should return an error'
+	} else {
+		assert err.msg() == 'punctuations not permitted'
+	}
+}
+
+fn test_invalid_if_area_code_starts_with_0() {
+	phrase := '(023) 456-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if area code starts with 0 should return an error'
+	} else {
+		assert err.msg() == 'area code cannot start with zero'
+	}
+}
+
+fn test_invalid_if_area_code_starts_with_1() {
+	phrase := '(123) 456-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if area code starts with 1 should return an error'
+	} else {
+		assert err.msg() == 'area code cannot start with one'
+	}
+}
+
+fn test_invalid_if_exchange_code_starts_with_0() {
+	phrase := '(223) 056-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if exchange code starts with 0 should return an error'
+	} else {
+		assert err.msg() == 'exchange code cannot start with zero'
+	}
+}
+
+fn test_invalid_if_exchange_code_starts_with_1() {
+	phrase := '(223) 156-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if exchange code starts with 1 should return an error'
+	} else {
+		assert err.msg() == 'exchange code cannot start with one'
+	}
+}
+
+fn test_invalid_if_area_code_starts_with_0_on_valid_11_digit_number() {
+	phrase := '1 (023) 456-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if area code starts with 0 on valid 11-digit number should return an error'
+	} else {
+		assert err.msg() == 'area code cannot start with zero'
+	}
+}
+
+fn test_invalid_if_area_code_starts_with_1_on_valid_11_digit_number() {
+	phrase := '1 (123) 456-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if area code starts with 1 on valid 11-digit number should return an error'
+	} else {
+		assert err.msg() == 'area code cannot start with one'
+	}
+}
+
+fn test_invalid_if_exchange_code_starts_with_0_on_valid_11_digit_number() {
+	phrase := '1 (223) 056-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if exchange code starts with 0 on valid 11-digit number should return an error'
+	} else {
+		assert err.msg() == 'exchange code cannot start with zero'
+	}
+}
+
+fn test_invalid_if_exchange_code_starts_with_1_on_valid_11_digit_number() {
+	phrase := '1 (223) 156-7890'
+	if res := clean(phrase) {
+		assert false, 'invalid if exchange code starts with 1 on valid 11-digit number should return an error'
+	} else {
+		assert err.msg() == 'exchange code cannot start with one'
+	}
+}