refactor!: separate out data from implementation (#14)

* refactor!: separate out data from implementation

* Using new data set

* Corrects CHANGELOG

* Adds lint command to package.json

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Install dependencies
         run: npm install
       - name: Run Eslint
-        run: npx eslint --ignore-pattern 'node_modules' --ignore-pattern 'coverage' .
+        run: npm run lint
   test:
     runs-on: ubuntu-latest
     strategy:

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v4.0.0 (2021-07-12)
+
+* Separates DAD address data into a separate repo (https://github.com/justintime50/dad), removes tooling and references to data and focuses instead on implementing a way to retrieve that data via Node
+* Removed the `addresses` key as inherently each list is a set of addresses already
+* Bumped dependencies, additional small tweaks
+
 ## v3.1.0 (2021-05-26)
 
 * Drops support for Node 10 and pins Node 12 as the minimum version

README.md

@@ -1,19 +1,19 @@
 <div align="center">
 
-# Dummy Address Data (DAD)
+# Dummy Address Data (DAD) Node Library
 
 Dummy Address Data (DAD) - Retrieve real addresses from all around the world.
 
-[![Build Status](https://github.com/Justintime50/dad/workflows/build/badge.svg)](https://github.com/Justintime50/dad/actions)
-[![Coverage Status](https://coveralls.io/repos/github/Justintime50/dad/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/dad?branch=main)
+[![Build Status](https://github.com/Justintime50/dad-node/workflows/build/badge.svg)](https://github.com/Justintime50/dad-node/actions)
+[![Coverage Status](https://coveralls.io/repos/github/Justintime50/dad-node/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/dad-node?branch=main)
 [![NPM](https://img.shields.io/npm/v/dad-tool)](https://www.npmjs.com/package/dad-tool)
-[![Licence](https://img.shields.io/github/license/justintime50/dad)](https://opensource.org/licenses/mit-license.php)
+[![Licence](https://img.shields.io/github/license/justintime50/dad-node)](https://opensource.org/licenses/mit-license.php)
 
 <img src="assets/showcase.png" alt="Showcase">
 
 </div>
 
-DAD is the perfect companion to quickly bootstrap address data in your application. DAD provides real addresses from all over the world with a consistent data structure so you can spend less time looking up addresses and address rules and more time coding. Rigorously tested with 2000+ tests, rest easy knowing your address data is uniform, accurate, and performant.
+The DAD Node library is the perfect companion to quickly bootstrap address data in your application. DAD provides real addresses from all over the world with a consistent data structure so you can spend less time looking up addresses and address rules and more time coding. Rigorously tested with 2000+ tests, rest easy knowing your address data is uniform, accurate, and performant.
 
 ## Install
 
@@ -140,11 +140,9 @@ A sample address object will look like the following:
 
 ## Development
 
-When adding or editing a list, ensure the file is minimized and does not exceed 100 records.
-
 ```bash
-# Lint a file
-npx eslint index.js
+# Lint the project
+npm run lint
 
 # Run tests
 npm run test
@@ -153,24 +151,7 @@ npm run test
 npm run coverage
 ```
 
-### Utilities
-
-To create the slim lists from a larger dataset, use the `create-slim-json.js` tool in the `utils` folder. See the script for additional information. This tool will grab 100 random addresses (by default) from a larger JSON dataset and create a new slim file that can be added to DAD.
-
-```bash
-DATA_SET=path/to/dataset.json STATE=UT COUNTRY=US node utils/create-slim-json.js
-```
-
-## Contributing
-
-This data is very laborious to build - any contributions are welcome! Open a PR or issue with additions or fixes.
-
-## Disclaimer
-
-As these addresses are public knowledge and open sourced, I take no responsibility for their use. If you'd like an address removed from the list, submit an issue.
-
 ## Attribution
 
-- Addresses provided from the [OpenAddress Project](https://openaddresses.io).
-- `DAD` is conceptually based on [RRAD](https://github.com/EthanRBrown/rrad).
+- Addresses provided by [DAD](https://github.com/justintime50/dad).
 - Showcase icon made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>.

data/addresses/australia/vt-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"45 Tennyson Street","street2":"","city":"Kensington","state":"VIC","zip":"3031","country":"AU"},{"street1":"217 Errol Street","street2":"","city":"North Melbourne","state":"VIC","zip":"3051","country":"AU"},{"street1":"57 Aurora Lane","street2":"","city":"Docklands","state":"VIC","zip":"3008","country":"AU"},{"street1":"212 Little Palmerston Street","street2":"","city":"Carlton","state":"VIC","zip":"3053","country":"AU"},{"street1":"45 Hancock Street","street2":"","city":"Southbank","state":"VIC","zip":"3006","country":"AU"}]

data/addresses/canada/bc-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"1725 E Broadway","street2":"","city":"Vancouver","state":"BC","zip":"V5N 1V9","country":"CA"},{"street1":"3580 Turner St","street2":"","city":"Vancouver","state":"BC","zip":"V5K 2H9","country":"CA"},{"street1":"3328 Garden Dr","street2":"","city":"Vancouver","state":"BC","zip":"V5N 4Y4","country":"CA"},{"street1":"6688 Gladstone St","street2":"","city":"Vancouver","state":"BC","zip":"V5P 4E7","country":"CA"},{"street1":"351 Abbott St","street2":"","city":"Vancouver","state":"BC","zip":"V6B 0G6","country":"CA"}]

data/addresses/china/bj-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"95 Yong An Road","street2":"","city":"Beijing","state":"BJ","zip":"100050","country":"CN"},{"street1":"63 RENMIN LU","street2":"","city":"QINGDAO SHI","state":"SHANDONG","zip":"266033","country":"CN"},{"street1":"13 West Chang An Street","street2":"","city":"BEIJING","state":"BJ","zip":"100804","country":"CN"},{"street1":"1, Hongqiao Road","street2":"","city":"Shanghai","state":"","zip":"200002","country":"CN"},{"street1":"269 Middle Fangbang Road","street2":"","city":"Shanghai","state":"","zip":"200002","country":"CN"}]

data/addresses/china/hk-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"1 Expo Drive","street2":"","city":"WAN CHAI","state":"Hong Kong","zip":"","country":"CN"},{"street1":"12 Harbour Road","street2":"","city":"Wan Chai","state":"Hong Kong","zip":"","country":"CN"},{"street1":"66 Gloucester Road","street2":"","city":"Wan Chai","state":"Hong Kong","zip":"","country":"CN"},{"street1":"2 Tim Mei Avenue","street2":"","city":"Wan Chai","state":"Hong Kong","zip":"","country":"CN"},{"street1":"5 Edinburgh Place","street2":"","city":"Wan Chai","state":"Hong Kong","zip":"","country":"CN"}]

data/addresses/europe/de-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"Aaper Weg 77","street2":"","city":"Wesel","state":"","zip":"46485","country":"DE"},{"street1":"Albert-Schweitzer-Weg 8","street2":"","city":"Wesel","state":"","zip":"46487","country":"DE"},{"street1":"Hansaring 22","street2":"","city":"Wesel","state":"","zip":"46483","country":"DE"},{"street1":"Kormoranweg 9","street2":"","city":"Wesel","state":"","zip":"46487","country":"DE"},{"street1":"Perricher Weg 45","street2":"","city":"Wesel","state":"","zip":"46487","country":"DE"}]

data/addresses/europe/es-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"Calle Alpera, 1","street2":"","city":"Almansa","state":"Albacete","zip":"02640","country":"ES"},{"street1":"Calle de la Carrera, 37","street2":"","city":"Ontígola","state":"Toledo","zip":"45340","country":"ES"},{"street1":"Pasaje de San Pascual, 12","street2":"","city":"Los Molinos","state":"Madrid","zip":"28460","country":"ES"},{"street1":"Calle de Santa Lucía, 91","street2":"","city":"Alpedrete","state":"Madrid","zip":"28430","country":"ES"},{"street1":"Calle Grimaldo, 22","street2":"","city":"Mirabel","state":"Caceres","zip":"10540","country":"ES"}]

data/addresses/europe/uk-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"2 Park Lane","street2":"","city":"DONCASTER","state":"","zip":"DN4 5LG","country":"UK"},{"street1":"10 Downing Street","street2":"","city":"Cambridge","state":"","zip":"CB2 3DS","country":"UK"},{"street1":"221b Baker Street","street2":"","city":"London","state":"","zip":"NW1 6XE","country":"UK"},{"street1":"46 Harley Street","street2":"","city":"London","state":"","zip":"W1G 9QY","country":"UK"},{"street1":"18 George St","street2":"","city":"Chester","state":"","zip":"CH1 3EQ","country":"UK"}]

data/addresses/mexico/mx-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"Calle Plaza de la Constitucion","street2":"Centro-Area 1","city":"Cuauhtemoc","state":"CDMX","zip":"06060","country":"MX"},{"street1":"Avenida Plaza de la Constitucion 1","street2":"Centro-Area 1","city":"Cuauhtemoc","state":"CDMX","zip":"06060","country":"MX"},{"street1":"Paseo de la Reforma y Calzada Gandhi","street2":"Chapultepec Polanco","city":"Miguel Hidalgo","state":"CDMX","zip":"11560","country":"MX"},{"street1":"Avenida Juarez","street2":"Esquina eje central, centro historico","city":"Ciudad de Mexico","state":"DF","zip":"06010","country":"MX"},{"street1":"Avenida Hidalgo","street2":"Centro-Area 2","city":"Cuauhtemoc","state":"CDMX","zip":"06010","country":"MX"}]

data/addresses/united-states/az-addresses.min.json

@@ -0,0 +1 @@
+[{"street1":"281 W WARNER RD","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"1534 E STIRRUP CT","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"2603 E HICKORY ST","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"7696 S BARLOW DR","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"935 N WHALERS COVE DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"6930 S SEVILLE BLVD  W","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"1672 S MARTINGALE RD","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"1916 S BUCHANAN ST","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"845 S CANCUN DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"3319 E REDFIELD RD","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"736 W DESERT AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"1736 S FALCON DR","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"2273 E VICTOR RD","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"45 E BETSY LN","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"21606 S GREENFIELD RD","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"488 N ACACIA DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"685 W GOLDEN ST","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"1392 S QUAIL LN","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"15312 E MELROSE ST","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":" ","street2":"","city":"Gilbert","state":"AZ","zip":"","country":"US"},{"street1":"499 N SWALLOW LN","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"1335 E PARKSIDE DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"307 S GOLDEN KEY DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"17318 E BROOKS FARM RD","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"2227 E CORTEZ DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"4138 E WALNUT RD","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"1475 E SIERRA MADRE AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"4334 E OAKLAND ST","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"2680 S VAL VISTA DR","street2":"136","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"925 S STORMENT LN","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"4030 E CONSTITUTION CT","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"1234 E SEA BREEZE DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"1725 E DOGWOOD LN","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":" ","street2":"","city":"Gilbert","state":"AZ","zip":"","country":"US"},{"street1":"5879 S TUCANA LN","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"302 N COBBLESTONE ST","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":" ","street2":"","city":"Gilbert","state":"AZ","zip":"","country":"US"},{"street1":"4184 E MEADOWVIEW DR","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"3440 S JACANA LN","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"2715 E CALLE DEL NORTE DR","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"4565 E LAUREL AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"3698 S SETON AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"669 S OAK ST","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"3338 E BONANZA RD","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"4050 S RANCH HOUSE PKWY","street2":"178","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"3269 E ANIKA DR","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"269 E SAGEBRUSH ST","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"3149 E COLDWATER BLVD","street2":"","city":"Gilbert","state":"AZ","zip":"85142","country":"US"},{"street1":"1336 E WASHINGTON AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"688 N ABALONE DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"889 E FRANCES LN","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"841 W CALYPSO DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"3934 E TURLEY ST","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"792 S MARTINIQUE DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"1689 W LEAH LN","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"1026 S GILBERT RD","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":" ","street2":"","city":"Gilbert","state":"AZ","zip":"","country":"US"},{"street1":"428 S PORT DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"459 S GRANITE ST","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"413 E LINDA LN","street2":"D","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"302 N COBBLESTONE ST","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"4537 E TOWNE LN","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"239 N TIAGO DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"1142 E BAJOR ST","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"4046 E PAGE AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"3637 E PINON CT","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"1172 N SAN BENITO DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"3420 E INDIGO ST","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"1850 E LAKECREST DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"3311 E LOMA VISTA ST","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"1242 E AZURE SEA LN","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"4550 E APRICOT LN","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"4075 E JASPER DR","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"1102 S ANNIE LN","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"1026 N BLACKBIRD DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"1143 W REDONDO DR","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"6089 S 174TH PL","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"2920 E TEMPLE CT","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"2728 S SULLEY DR","street2":"103","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":" ","street2":"","city":"Gilbert","state":"AZ","zip":"","country":"US"},{"street1":"331 N REDROCK ST","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"712 E SHEFFIELD AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"2527 E VIA DEL ARBOLES","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"3528 E SANTA FE LN","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"2316 E CORTEZ DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"2679 E SADDLEBROOK RD","street2":"","city":"Gilbert","state":"AZ","zip":"85298","country":"US"},{"street1":"3886 E MORELOS ST","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"1208 N CAYMAN DR","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"2632 S HARMONY AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"2062 E APPALOOSA RD","street2":"","city":"Gilbert","state":"AZ","zip":"85296","country":"US"},{"street1":"3141 E HAMPTON LN","street2":"","city":"Gilbert","state":"AZ","zip":"85295","country":"US"},{"street1":"2012 E GONDOLA LN","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"124 E VAUGHN AVE","street2":"","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"725 W ORCHARD WY","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"853 E FURNESS DR","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"1663 E BASELINE RD","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"},{"street1":"3484 S JACANA LN","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"4216 E BONANZA RD","street2":"","city":"Gilbert","state":"AZ","zip":"85297","country":"US"},{"street1":"1633 E LAKESIDE DR","street2":"144","city":"Gilbert","state":"AZ","zip":"85234","country":"US"},{"street1":"460 W SAN REMO ST","street2":"","city":"Gilbert","state":"AZ","zip":"85233","country":"US"}]