Merge pull request #31 from midwire/add-dockerfile

Add Dockerfile for containerized data generation

Author: midwire

.dockerignore

@@ -0,0 +1,10 @@
+.git
+vendor/bundle
+pkg
+stubs
+spec
+data
+build
+.claude
+docs
+*.sqlite3

Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:3.4-slim
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends build-essential git pkg-config && \
+    rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY Gemfile Gemfile.lock free_zipcode_data.gemspec .ruby-version ./
+COPY lib/free_zipcode_data/version.rb lib/free_zipcode_data/version.rb
+RUN git init && git add . && \
+    bundle config set --local without development && \
+    bundle install
+
+COPY . .
+RUN git add .
+
+ENV COUNTRY=""
+VOLUME /output
+
+ENTRYPOINT ["./docker-entrypoint.sh"]

README.md

@@ -105,6 +105,41 @@ create table zipcodes (
 
 Both `lat` and `lon`, geocodes, are populated for each zipcode record.
 
+## Docker
+
+If you prefer not to install Ruby locally, you can use Docker to generate the database. You only need [Docker](https://docs.docker.com/get-docker/) installed.
+
+### Build the image
+
+```bash
+$ git clone https://github.com/midwire/free_zipcode_data.git
+$ cd free_zipcode_data
+$ docker build -t free_zipcode_data .
+```
+
+### Generate data
+
+Use the `COUNTRY` environment variable to specify a 2-letter country code. Omit it to process all available countries.
+
+**Single country (e.g., US):**
+
+```bash
+$ docker run --rm -v $(pwd)/output:/output -e COUNTRY=US free_zipcode_data
+```
+
+**All countries:**
+
+```bash
+$ docker run --rm -v $(pwd)/output:/output free_zipcode_data
+```
+
+The following files will be written to the `./output/` directory on your host:
+
+* `free_zipcode_data.sqlite3` - SQLite database with countries, states, counties, and zipcodes tables
+* `countries.csv`, `states.csv`, `counties.csv`, `zipcodes.csv` - CSV exports of each table
+
+Look up supported country codes at [GeoNames](http://download.geonames.org/export/zip/).
+
 ## Data License
 
 The zipcode data is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 Unported License</a>, carried forward from [GeoNames](http://www.geonames.org).<br />

docker-entrypoint.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+args=(--work-dir /output --generate-files --clobber)
+
+if [ -n "${COUNTRY:-}" ]; then
+  if [[ ! "$COUNTRY" =~ ^[A-Z]{2}$ ]]; then
+    echo "Error: COUNTRY must be a 2-letter uppercase code (e.g., US, AD)" >&2
+    exit 1
+  fi
+  args+=(--country "$COUNTRY")
+fi
+
+exec bundle exec ruby bin/free_zipcode_data "${args[@]}"