Skip to content

Added More Postal Code Formats #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aqibcs wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Added More Postal Code Formats #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
50cd37c
Add files via upload
aqibcs Feb 22, 2024
95d1006
Delete formats.go
aqibcs Feb 22, 2024
94cb216
Added more postal codes
aqibcs Feb 22, 2024
b14b454
Delete formats.go
aqibcs Feb 22, 2024
aa16403
Added More Postal Codes
aqibcs Feb 22, 2024
d815988
Delete formats.go
aqibcs Feb 22, 2024
08cb175
Added More Postal Code Formats
aqibcs Feb 22, 2024
11f9c66
Added more test cases
aqibcs Feb 22, 2024
8d000f5
Update test cases
aqibcs Feb 23, 2024
d7d9558
Updated README
aqibcs Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
postcode
========
# postcode (Fork)
[![Build Status](https://github.com/adrg/postcode/workflows/CI/badge.svg)](https://github.com/adrg/postcode/actions?query=workflow%3ACI)
[![Code coverage](https://codecov.io/gh/adrg/postcode/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/gh/adrg/postcode)
[![pkg.go.dev documentation](https://pkg.go.dev/badge/github.com/adrg/postcode)](https://pkg.go.dev/github.com/adrg/postcode)
Expand All @@ -8,18 +7,16 @@ postcode
[![GitHub issues](https://img.shields.io/github/issues/adrg/postcode)](https://github.com/adrg/postcode/issues)
[![Buy me a coffee](https://img.shields.io/static/v1.svg?label=%20&message=Buy%20me%20a%20coffee&color=579fbf&logo=buy%20me%20a%20coffee&logoColor=white)](https://ko-fi.com/T6T72WATK)

Small package for validating postal codes. While the validation process does
not guarantee that the postcode actually exists, it does guarantee that the
format of the provided input is valid.
**Note: This repository is a fork of the original [postcode](https://github.com/adrg/postcode) library. The original repository seems to be inactive, and this fork is actively maintained and updated. Please consider using this fork for any new projects or updates.**

The reason for creating this package is that there is no good regular
expression for validating postal codes, and even if it existed, it would have
been huge and inefficient.
Small package for validating postal codes. While the validation process does not guarantee that the postcode actually exists, it does guarantee that the format of the provided input is valid.

Full documentation can be found at: https://pkg.go.dev/github.com/adrg/postcode.
The reason for creating this package is that there is no good regular expression for validating postal codes, and even if it existed, it would have been huge and inefficient.

Full documentation can be found at: https://godoc.org/github.com/adrg/postcode.

## Installation
go get github.com/adrg/postcode
go get git@github.com:aqibcs/postcode.git

## Usage

Expand Down
132 changes: 86 additions & 46 deletions formats.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,52 +7,91 @@ package postcode
// * N = number
// * CC = ISO 3166-1 alpha-2 country code
var formats = map[string]struct{}{
"AA NNNNN": {},
"AA-NNNN": {},
"AAA NNNN": {},
"AAA NNNN-NNNN": {},
"AAA": {},
"AAAA NAA": {},
"AAN NAA": {},
"AAN": {},
"AANA": {},
"AANN NAA": {},
"AANN NNN": {},
"AANN": {},
"AANNNN": {},
"AN": {},
"ANA NAN": {},
"ANA": {},
"ANN": {},
"ANNN": {},
"CC NNNN": {},
"CC-NNNN": {},
"CC-NNNNN": {},
"CCN NAA": {},
"CCN-NNNN": {},
"CCNN NAA": {},
"CCNNN": {},
"CCNNNN": {},
"CCNNNNN": {},
"NN": {},
"NN-NNN": {},
"NNN NN": {},
"NNN NNN": {},
"NNN": {},
"NNN-NN": {},
"NNN-NNNN": {},
"NNNN NNNN": {},
"NNNN": {},
"NNNN-A": {},
"NNNN-NNN": {},
"NNNNN": {},
"NNNNN-NNN": {},
"NNNNN-NNNN": {},
"NNNNNN": {},
"NNNNNNN": {},
"NNNNNNNNNN": {},
"NNNNAA": {},
"NNNN AA": {},
"AA NNNNN": {},
"AA-NNNN": {},
"AAA NNNN": {},
"AAA NNNN-NNNN": {},
"AAA": {},
"AAAA NAA": {},
"AAN NAA": {},
"AAN": {},
"AANA": {},
"AANN NAA": {},
"AANN NNN": {},
"AANN": {},
"AANNNN": {},
"AN": {},
"ANA NAN": {},
"ANA": {},
"ANN": {},
"ANNN": {},
"CC NNNN": {},
"CC-NNNN": {},
"CC-NNNNN": {},
"CCN NAA": {},
"CCN-NNNN": {},
"CCNN NAA": {},
"CCNNN": {},
"CCNNNN": {},
"CCNNNNN": {},
"NN": {},
"NN-NNN": {},
"NNN NN": {},
"NNN NNN": {},
"NNN": {},
"NNN-NN": {},
"NNN-NNNN": {},
"NNNN NNNN": {},
"NNNN": {},
"NNNN-A": {},
"NNNN-NNN": {},
"NNNNN": {},
"NNNNN-NNN": {},
"NNNNN-NNNN": {},
"NNNNNN": {},
"NNNNNNN": {},
"NNNNNNNNNN": {},
"NNNNAA": {},
"NNNN AA": {},
"AI-2640": {},
"BIQQ 1ZZ": {},
"BBND 1ZZ": {},
"120000": {},
"FIQQ 1ZZ": {},
"CC-NNN": {},
"973NN": {},
"987NN": {},
"A?NNN": {},
"A?NNNN": {},
"A?NNNNN": {},
"GX11 1AA": {},
"971NN": {},
"NNNNN-NNNNN": {},
"972NN": {},
"976NN": {},
"980NN": {},
"MSR NNNN": {},
"988NN": {},
"PCRN 1ZZ": {},
"974NN": {},
"97133": {},
"AAAA 1ZZ": {},
"CCNN NNN": {},
"97150": {},
"97500": {},
"4789N": {},
"SIQQ 1ZZ": {},
"NNN-NNN": {},
"TKCA 1ZZ": {},
"A[A]N[A/N]": {},
"96898": {},
"00120": {},
"986NN": {},
"ANNNNAAA": {},
"AA NN": {},
"AA AA": {},
"A[A]N[A/N] NAA": {},
"[D6W/ANN] [A/N][A/N][A/N][A/N]": {},
}

// Source: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Expand Down Expand Up @@ -306,4 +345,5 @@ var countryCodes = map[string]struct{}{
"ZA": {},
"ZM": {},
"ZW": {},
"XK": {},
}
25 changes: 10 additions & 15 deletions postcode_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,28 @@ func TestValidate(t *testing.T) {
expected error
}{
{
description: "Paris, France",
input: " 75008 ",
description: "Canada, Port Colborne",
input: " L3K 4V9 ",
expected: nil,
},
{
description: "Brussels, Belgium",
input: " 1000 ",
description: "India , New Delhi",
input: " 110002 ",
expected: nil,
},
{
description: "Utrecht, The Netherlands",
input: " 3511 ax ",
description: "Mexico, Mexico City",
input: " 01030 ",
expected: nil,
},
{
description: "Utrecht, The Netherlands, Alt",
input: " 3511AX ",
description: "Japan, Tokyo",
input: " 100-0012 ",
expected: nil,
},
{
description: "Hannover, Germany",
input: " 30179 ",
expected: nil,
},
{
description: "Vilnius, Lithuania",
input: "LT-00200",
description: "W N St, Aberdeen AB24, UK",
input: " AB24 ",
expected: nil,
},
{
Expand Down