uk_county_locator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f80e2a756a051daa471e931e2a6a873d3bcd6cb1cb70982615db766d640e121a
+  data.tar.gz: 84f0c67cdc2e61b1a10b0a7df7de88f3d71c6ad304935f2527128c85c9f9e405
+SHA512:
+  metadata.gz: b1f68ea7ca094210af2fb2f3802e07226309bf612a6b8dd25d79c55c60baa7ee959bcc4262f794456d19db06173f2aa915c650de1650328b74f2538b082eebfc
+  data.tar.gz: 4346bc8f9577b663a8b57a139d11ee8fab609a4c8373ecb8573845437dfd7d448f7f15781ba1efea4e0cc591d757c43b6db467e1937b64a4205882fc50cfc58a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 200

data/Appraisals

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+appraise 'rails_5.0' do
+  gem 'rails', '~> 5.0'
+end
+
+appraise 'rails_5.2' do
+  gem 'rails', '~> 5.2'
+end
+
+appraise 'rails_6.0' do
+  gem 'rails', '~> 6.0'
+end
+
+appraise 'rails_6.1' do
+  gem 'rails', '~> 6.1'
+end
+
+appraise 'rails_7.0' do
+  gem 'rails', '~> 7.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ed@homeflow.co.uk. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 EdBeese
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Edward Beesley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+# UK County Locator
+
+## Overview
+
+`UkCountyLocator` is a Ruby gem that determines the county of a given set of coordinates within the UK. It supports multiple county classification types, including ceremonial, historic, and current administrative boundaries. The gem also provides functionality for retrieving county boundary polygons.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uk_county_locator'
+```
+
+Then execute:
+
+```sh
+bundle install
+```
+
+Or install it manually:
+
+```sh
+gem install uk_county_locator
+```
+
+## Usage
+
+### Finding a County by Coordinates
+
+```ruby
+require 'uk_county_locator'
+
+lat = 51.5074
+lng = -0.1278
+
+county = UkCountyLocator.find_county(lat: lat, lng: lng)
+puts county # => "Greater London"
+```
+By default, the gem will return the Ceremonial County of the coordinates.
+
+An optional `type` argument, which will accept the following supported county types:
+
+- `:current` – Modern administrative counties and Unitary Authorities
+- `:ceremonial` – Traditional ceremonial counties
+- `:historic` – Historic counties
+- `:all` – Includes all available types
+
+Assuming the same coordinates above:
+
+```ruby
+county_data = UkCountyLocator.find_county(lat: 51.5074, lng: -0.1278, type: :all)
+puts county_data
+# => {:current_county_or_unitary_authority=>"Westminster", :ceremonial_county=>"Greater London", :historic_county=>"Middlesex"}
+```
+### Fetching County Boundaries
+The polygons are stored as encoded strings, using the [Polylines Gem](https://github.com/joshuaclayton/polylines).
+
+You can retrieve the encoded string, which can then be decoded using the Polylines Gem.
+
+```ruby
+polygon = UkCountyLocator.find_polygon(county: 'Greater London', type: :ceremonial)
+puts polygon # => "iah@mrgyHs@tTkk@zc@jz@h{@kLnr@jo@rWal@}Rrk@za@UjMdhAb_@t|Bjn@`h@|mAzs@kMl\\h..."
+```
+
+The gem will support a number of common aliases for county names, in as far as is feasible, including shorthand abbreviations, such as 'Herts', 'Beds' and 'Bucks', as well as Welsh, Irish and Scots Gaelic languages, and more subtle alternative names.
+
+#### Fetching the County List
+
+It is also possible to fetch the list of counties, per type (alphabetised):
+```ruby
+county_list = UkCountyLocator.county_list(type: :ceremonial)
+puts county_list # => ["Bedfordshire", "Berkshire", "Bristol", "Buckinghamshire", "Cambridgeshire", ...]
+```
+
+## County Type Definitions
+There are three sets of county data within the gem.  The definitions between the three sets will differ between the four constituent countries of the United Kingdom, but are defined as per these Wikipedia links:
+
+### Ceremonial Counties `type: :ceremonial`
+#### England
+[Ceremonial counties of England](https://en.wikipedia.org/wiki/Ceremonial_counties_of_England)
+#### Wales
+[Preserved Counties of Wales](https://en.wikipedia.org/wiki/Preserved_counties_of_Wales)
+#### Scotland
+[Local government areas of Scotland (1975–1996)](https://en.wikipedia.org/wiki/Local_government_areas_of_Scotland_(1975%E2%80%931996))
+#### Northern Ireland
+[Counties of Northern Ireland](https://en.wikipedia.org/wiki/Counties_of_Northern_Ireland)
+### Current Counties & Unitary Authorities `type: :current`
+#### England
+This is a combined map of the different current administrative areas, namely:
+
+[County Councils](https://en.wikipedia.org/wiki/List_of_county_councils_in_England)
+
+[Unitary Authorities](https://en.wikipedia.org/wiki/Unitary_authorities_of_England)
+
+[Metropolitan Boroughs](https://en.wikipedia.org/wiki/Metropolitan_borough)
+
+[London Boroughs](https://en.wikipedia.org/wiki/London_boroughs)
+#### Wales
+[Welsh Local Authorities](https://en.wikipedia.org/wiki/Local_government_in_Wales)
+#### Scotland
+[Council Areas of Scotland](https://simple.wikipedia.org/wiki/Council_areas_of_Scotland)
+#### Northern Ireland
+[Local Government Districts of Northern Ireland](https://en.wikipedia.org/wiki/Local_government_in_Northern_Ireland)
+### Historic Counties `type: :historic`
+#### England
+[Historic Counties of England](https://en.wikipedia.org/wiki/Historic_counties_of_England)
+#### Wales
+[Historic Counties of Wales](https://en.wikipedia.org/wiki/Historic_counties_of_Wales)
+#### Scotland
+[Shire Counties of Scotland (1889-1975)](https://en.wikipedia.org/wiki/Shires_of_Scotland#Counties_from_1889_to_1975)
+#### Northern Ireland
+[Counties of Northern Ireland](https://en.wikipedia.org/wiki/Counties_of_Northern_Ireland)
+
+## Considerations & Limitations
+### Single Polygon Shapes
+It should be noted that this gem stores the county polygons as encoded strings.  In order for these to be encoded, a polygon must be one, continuous shape, rather than a collection of separate, unconnected polygons.
+
+To this end, the polygons may cover areas of water that connect separated land masses, such as islands.
+
+See image of Orkney Islands polygon:
+
+![Image of Orkney Islands Polygon](https://res.cloudinary.com/dnhuvsfil/image/upload/v1740658412/Screenshot_from_2025-02-27_11-24-31_gquyhu.png)
+
+
+### Rivers, Tributaries and Coastal Lines
+In order to compress the polygon areas, the boundaries that cover coastal lines have been more roughly drawn, with fewer coordinate points.  The polygons are continuous where larger rivers and tributaries, where the same county on both sides.  This means that coordinates that fall in the river will return the county as a result.
+
+For example, coordinates that fall within the river Thames, where Greater London is on both sides of the river, will return 'Greater London' as the ceremonial county.
+
+![Excerpt of Greater London Polygon](https://res.cloudinary.com/dnhuvsfil/image/upload/v1740658346/london_ektehn.png)
+
+This means that the gem would not be an appropriate tool to verify that given coordinates are within the land masses of the UK.
+
+## Data Sources
+The data to compile these polygon areas has been taken from a number of sources, including:
+- [OpenStreetMap](https://www.openstreetmap.org/)
+- [Office of National Statistics (ONS)](https://www.ons.gov.uk/aboutus)
+- [UK Ceremonial Counties](https://github.com/evansd/uk-ceremonial-counties/blob/master/uk-ceremonial-counties.geojson)
+- [The Association of British Counties](https://abcounties.com/)
+
+## Performance Optimization
+
+The gem utilizes the `Parallel` gem to speed up polygon lookups.
+
+## Compatibility
+
+The gem is tested against multiple versions of Rails using Appraisal, ensuring broad compatibility with different Ruby on Rails applications.
+
+## Contributing
+
+### Polygon Mapping
+The polygons included within this gem have been generated using the data sources listed above, within an acceptable tollerance of accuracy.  However, there may be small errors at the boundaries of polygons.
+
+If such an error is noted, pull requests to update the polygons are welcome.  Please include details of the area(s) that has been altered within a PR, in order to more efficiently confirm accuracy.
+
+### Submitting Fixes and Improvements
+These and all other bug reports and pull requests are welcome on GitHub.
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature-branch`)
+3. Commit your changes (`git commit -m 'Add new feature'`)
+4. Push to the branch (`git push origin feature-branch`)
+5. Create a new Pull Request
+
+## License
+
+This project is licensed under the MIT License.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/uk_county_locator/aliases/ceremonial_county_aliases.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module UkCountyLocator
+  module Aliases
+    module CeremonialCountyAliases
+      CEREMONIAL_COUNTY_ALIASES = {
+        'London' => 'Greater London',
+        'Lon' => 'Greater London',
+        'Manchester' => 'Greater Manchester',
+        'S Yorkshire' => 'South Yorkshire',
+        'S Yorks' => 'South Yorkshire',
+        'South Yorks' => 'South Yorkshire',
+        'Tyne & Wear' => 'Tyne and Wear',
+        'W Midlands' => 'West Midlands',
+        'W Yorkshire' => 'West Yorkshire',
+        'W Yorks' => 'West Yorkshire',
+        'West Yorks' => 'West Yorkshire',
+        'N Yorkshire' => 'North Yorkshire',
+        'N Yorks' => 'North Yorkshire',
+        'North Yorks' => 'North Yorkshire',
+        'Durham' => 'County Durham',
+        'Co Durham' => 'County Durham',
+        'Co Dur' => 'County Durham',
+        'Dur' => 'County Durham',
+        'Ches' => 'Cheshire',
+        'Lancs' => 'Lancashire',
+        'East Yorkshire' => 'East Riding of Yorkshire',
+        'East Yorks' => 'East Riding of Yorkshire',
+        'E Yorkshire' => 'East Riding of Yorkshire',
+        'E Yorks' => 'East Riding of Yorkshire',
+        'Lincs' => 'Lincolnshire',
+        'Derbs' => 'Derbyshire',
+        'Rutlandshire' => 'Rutland',
+        'Rut' => 'Rutland',
+        'Notts' => 'Nottinghamshire',
+        'Somersetshire' => 'Somerset',
+        'Som' => 'Somerset',
+        'Glos' => 'Gloucestershire',
+        'Gloucs' => 'Gloucestershire',
+        'Dev' => 'Devon',
+        'Dor' => 'Dorset',
+        'Cambs' => 'Cambridgeshire',
+        'Beds' => 'Bedfordshire',
+        'Berks' => 'Berkshire',
+        'E Sussex' => 'East Sussex',
+        'East Sx' => 'East Sussex',
+        'E Sx' => 'East Sussex',
+        'E Ssx' => 'East Sussex',
+        'East Ssx' => 'East Sussex',
+        'East Suss' => 'East Sussex',
+        'E Suss' => 'East Sussex',
+        'Hants' => 'Hampshire',
+        'Bucks' => 'Buckinghamshire',
+        'Cumberland' => 'Cumbria',
+        'Cumb' => 'Cumbria',
+        'Herts' => 'Hertfordshire',
+        'Leics' => 'Leicestershire',
+        'Norf' => 'Norfolk',
+        'Northants' => 'Northamptonshire',
+        'Oxon' => 'Oxfordshire',
+        'Staffs' => 'Staffordshire',
+        'Staf' => 'Staffordshire',
+        'Suff' => 'Suffolk',
+        'Surr' => 'Surrey',
+        'Sy' => 'Surrey',
+        'Warks' => 'Warwickshire',
+        'War' => 'Warwickshire',
+        'Warw' => 'Warwickshire',
+        'W Sussex' => 'West Sussex',
+        'West Sx' => 'West Sussex',
+        'W Sx' => 'West Sussex',
+        'W Ssx' => 'West Sussex',
+        'West Ssx' => 'West Sussex',
+        'West Suss' => 'West Sussex',
+        'W Suss' => 'West Sussex',
+        'Worcs' => 'Worcestershire',
+        'Worsts' => 'Worcestershire',
+        'Shrops' => 'Shropshire',
+        'Salop' => 'Shropshire',
+        'Corn' => 'Cornwall',
+        'Cornw' => 'Cornwall',
+        'Wilts' => 'Wiltshire',
+        'Isle Wight' => 'Isle of Wight',
+        'Northumb' => 'Northumberland',
+        'Northd' => 'Northumberland',
+        'Here' => 'Herefordshire',
+        'Heref' => 'Herefordshire',
+        'Gramp' => 'Grampian',
+        "Roinn a' Mhonaidh" => 'Grampian',
+        'Strath' => 'Strathclyde',
+        'Srath Chluaidh' => 'Strathclyde',
+        'Central Scotland' => 'Central (Scotland)',
+        'Cent Scotland' => 'Central (Scotland)',
+        'C Scotland' => 'Central (Scotland)',
+        'Roinn Meadhanach' => 'Central (Scotland)',
+        'Dumfries & Galloway' => 'Dumfries and Galloway',
+        'Dumfries' => 'Dumfries and Galloway',
+        'Galloway' => 'Dumfries and Galloway',
+        'Dùn Phris is Gall-Ghaidhealaibh' => 'Dumfries and Galloway',
+        'Dun Phris is Gall-Ghaidhealaibh' => 'Dumfries and Galloway',
+        'Dùn Phris' => 'Dumfries and Galloway',
+        'Dun Phris' => 'Dumfries and Galloway',
+        'Gall-Ghaidhealaibh' => 'Dumfries and Galloway',
+        'Loth' => 'Lothian',
+        'Lodainn' => 'Lothian',
+        'Eilean Siar' => 'Eilean Siar (Western Isles)',
+        'Western Isles' => 'Eilean Siar (Western Isles)',
+        'Outer Hebrides' => 'Eilean Siar (Western Isles)',
+        'Na h-Eileanan Siar' => 'Eilean Siar (Western Isles)',
+        'Orkney' => 'Orkney Islands',
+        'Arcaibh' => 'Orkney Islands',
+        'Borders' => 'Scottish Borders',
+        'Crìochan na h-Alba' => 'Scottish Borders',
+        'Criochan na h-Alba' => 'Scottish Borders',
+        'Shetland' => 'Shetland Islands',
+        'Zetland' => 'Shetland Islands',
+        'Sealtainn' => 'Shetland Islands',
+        'W Glamorgan' => 'West Glamorgan',
+        'West Glam' => 'West Glamorgan',
+        'W Glam' => 'West Glamorgan',
+        'Gorllewin Morgannwg' => 'West Glamorgan',
+        'M Glamorgan' => 'Mid Glamorgan',
+        'Mid Glam' => 'Mid Glamorgan',
+        'M Glam' => 'Mid Glamorgan',
+        'Morgannwg Ganol' => 'Mid Glamorgan',
+        'S Glamorgan' => 'South Glamorgan',
+        'South Glam' => 'South Glamorgan',
+        'S Glam' => 'South Glamorgan',
+        'De Morgannwg' => 'South Glamorgan',
+        'Co Tyrone' => 'County Tyrone',
+        'Tyrone' => 'County Tyrone',
+        'Tir Eoghain' => 'County Tyrone',
+        'Tír Eoghain' => 'County Tyrone',
+        'Contae Tír Eoghain' => 'County Tyrone',
+        'Contae Tir Eoghain' => 'County Tyrone',
+        'Coontie Owenslann' => 'County Tyrone',
+        'Owenslann' => 'County Tyrone',
+        'Co Armagh' => 'County Armagh',
+        'Armagh' => 'County Armagh',
+        'Contae Ard Mhacha' => 'County Armagh',
+        'Ard Mhacha' => 'County Armagh',
+        'Coontie Airmagh' => 'County Armagh',
+        'Airmagh' => 'County Armagh',
+        'Coontie Armagh' => 'County Armagh',
+        'Down' => 'County Down',
+        'Co Down' => 'County Down',
+        'Contae an Dúin' => 'County Down',
+        'Contae an Duin' => 'County Down',
+        'Dúin' => 'County Down',
+        'Duin' => 'County Down',
+        'Coontie Doon' => 'County Down',
+        'Doon' => 'County Down',
+        'Countie Doun' => 'County Down',
+        'Doun' => 'County Down',
+        'Co Londonderry' => 'County Londonderry',
+        'Londonderry' => 'County Londonderry',
+        'County Derry' => 'County Londonderry',
+        'Derry' => 'County Londonderry',
+        'Co Derry' => 'County Londonderry',
+        'Contae Dhoire' => 'County Londonderry',
+        'Dhoire' => 'County Londonderry',
+        'Coontie Lunnonderrie' => 'County Londonderry',
+        'Lunnonderrie' => 'County Londonderry',
+        'Antrim' => 'County Antrim',
+        'Co Antrim' => 'County Antrim',
+        'Contae Aontroma' => 'County Antrim',
+        'Aontroma' => 'County Antrim',
+        'Coontie Antrìm' => 'County Antrim',
+        'Fermanagh' => 'County Fermanagh',
+        'Co Fermanagh' => 'County Fermanagh',
+        'Contae Fhear Manach' => 'County Fermanagh',
+        'Fhear Manach' => 'County Fermanagh',
+        'Contae Fir Manach' => 'County Fermanagh',
+        'Fir Manach' => 'County Fermanagh',
+        'Coontie Fermanay' => 'County Fermanagh',
+        'Fermanay' => 'County Fermanagh'
+      }.freeze
+    end
+  end
+end