Initial commit

Author: cblanc

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,38 @@
+# Postcodes
+
+Utility methods for UK Postcodes
+
+## Getting Started
+
+Install with `npm install postcode`
+
+Create an instance of Postcode to perform utility methods, like so
+
+```
+var Postcode = require("postcode");
+
+var postcode = new Postcode("id11qd");
+```
+
+Perform simple validations, parsing and normalisation
+
+```
+postcode.valid()      // => True
+postcode.outcode()    // => "ID1"
+postcode.incode()     // => "1QD"
+postcode.normalise()  // => "ID1 1QD"
+```
+
+## Testing
+
+```npm test```
+
+## Note on Postcode Validation
+
+Postcodes cannot be validated just using just a regular expression. Proper postcode validation requires having a full list of postcodes to check against. 
+
+Please do not solely rely on a regex to check postcodes or you're bound to get false postives/negatives.
+
+## License
+
+MIT

index.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var validationRegex = /^[a-z0-9]{1,4}\s?\d[a-z]{2}$/i,
+		incodeRegex = /^[a-z0-9]{1,4}/i,
+		outcodeRegex = /\d[a-z]{2}$/i;
+
+function isValidPostcode (postcode) {
+	return !!postcode.match(validationRegex);
+}
+
+function parseIncode (postcode) {
+	return postcode.match(incodeRegex)[0];
+}
+
+function parseOutcode (postcode) {
+	return postcode.match(outcodeRegex)[0];
+}
+
+function Postcode (rawPostcode) {
+	this._raw = rawPostcode;
+	this._valid = isValidPostcode(rawPostcode);
+
+	if (!this._valid) {
+		return null;
+	}
+}
+
+Postcode.prototype.valid = function () {
+	return this._valid;
+}
+
+Postcode.prototype.incode = function () {
+	if (!this._valid) return null;
+	if (this._incode) return this._incode;
+	this._incode = parseIncode(this._raw);
+	return this._incode;
+}
+
+Postcode.prototype.outcode = function () {
+	if (!this._valid) return null;
+	if (this._outcode) return this._outcode;
+	this._outcode = parseOutcode(this._raw);
+	return this._outcode;
+}
+
+Postcode.prototype.normalise = function () {
+	if (!this._valid) return null;
+	if (this.postcode) return this.postcode;
+	return [this.incode().toUpperCase()," ", this.outcode().toUpperCase()].join("");
+}
+
+module.exports = Postcode;

tests/data/normalisation.json

@@ -0,0 +1,24 @@
+{
+	"tests" : [
+		{
+			"base" : "L27 8XY",
+			"expected" : "L27 8XY"
+		},
+		{
+			"base" : "NR10 3EZ",
+			"expected" : "NR10 3EZ"
+		},
+		{
+			"base" : "NE69 7AW",
+			"expected" : "NE69 7AW"
+		},
+		{
+			"base" : "SE23 2NF",
+			"expected" : "SE23 2NF"
+		},
+		{
+			"base" : "Definitely wrong",
+			"expected" : null
+		}
+	]
+}

tests/data/validation.json

@@ -0,0 +1,36 @@
+{
+	"tests" : [
+		{
+			"base" : "L27 8XY",
+			"expected" : true
+		},
+		{
+			"base" : "NR103EZ",
+			"expected" : true
+		},
+		{
+			"base" : "RG45AY",
+			"expected" : true
+		},
+		{
+			"base" : "NE69 7AW",
+			"expected" : true
+		},
+		{
+			"base" : "SE23 2NF",
+			"expected" : true
+		},
+		{
+			"base" : "Definitely wrong",
+			"expected" : false
+		},
+		{
+			"base" : "12FSSD",
+			"expected" : false
+		},
+		{
+			"base" : "BT35 8GE",
+			"expected" : true
+		}
+	]
+}

tests/unit.js

@@ -0,0 +1,81 @@
+var assert = require("chai").assert,
+		fs = require("fs"),
+		path = require("path"),
+		dataDir = path.join(__dirname, "/data"),
+		Postcode = require(path.join(__dirname, "../index")),
+		testData, testResult;
+
+describe("Postcode#Valid", function () {
+	before(function (done) {
+		testData = fs.readFile(path.join(dataDir, "validation.json"), function (error, data) {
+			if (error) throw error;
+			testData = JSON.parse(data);
+			done();
+		});
+	});
+
+	it ("should return true for postcodes that look correct", function () {
+		testData.tests.forEach(function (elem) {
+			assert.equal(new Postcode(elem.base).valid(), elem.expected);
+		});
+	});
+});
+
+describe("Postcode normalisation", function () {
+	before(function (done) {
+		testData = fs.readFile(path.join(dataDir, "normalisation.json"), function (error, data) {
+			if (error) throw error;
+			testData = JSON.parse(data);
+			done();
+		});
+	});
+
+	it ("should correctly normalise postcodes", function () {
+		testData.tests.forEach(function (elem) {
+			assert.equal(new Postcode(elem.base).normalise(), elem.expected);
+		})
+	});
+
+	it ("should return null if invalid postcode", function () {
+		assert.isNull(new Postcode("Definitly bogus").normalise());
+	});
+});
+
+describe("Incode parsing", function () {
+	before(function (done) {
+		testData = fs.readFile(path.join(dataDir, "incode.json"), function (error, data) {
+			if (error) throw error;
+			testData = JSON.parse(data);
+			done();
+		});
+	});	
+
+	it ("should correctly parse incodes", function () {
+		testData.tests.forEach(function (elem) {
+			assert.equal(new Postcode(elem.base).incode(), elem.expected);
+		});
+	});
+
+	it ("should return null if invalid postcode", function () {
+		assert.isNull(new Postcode("Definitly bogus").incode());
+	});
+});
+
+describe("Outcode parsing", function () {
+	before(function (done) {
+		testData = fs.readFile(path.join(dataDir, "outcode.json"), function (error, data) {
+			if (error) throw error;
+			testData = JSON.parse(data);
+			done();
+		});
+	});	
+
+	it ("should correctly parse outcodes", function () {
+		testData.tests.forEach(function (elem) {
+			assert.equal(new Postcode(elem.base).outcode(), elem.expected);
+		});
+	});
+	it ("should return null if invalid postcode", function () {
+		assert.isNull(new Postcode("Definitly bogus").outcode());
+	});
+});