Merge branch 'sams96:main' into master

Author: ljbade

.github/workflows/continuous-integration.yml

@@ -1,17 +1,19 @@
 name: continuous-integration
+
 on:
   push:
     branches:
       - 'master'
   pull_request:
+
 jobs:
   ubuntu:
     runs-on: ubuntu-latest
     steps:
-    - name: Set up Go 1.19
+    - name: Set up Go 1.24
       uses: actions/setup-go@v1
       with:
-        go-version: 1.19.x
+        go-version: 1.24.x
       id: go
 
     - name: Check out code into the Go module directory
@@ -38,10 +40,10 @@ jobs:
   macOS:
     runs-on: macos-latest
     steps:
-    - name: Set up Go 1.19
+    - name: Set up Go 1.24
       uses: actions/setup-go@v1
       with:
-        go-version: 1.19.x
+        go-version: 1.24.x
       id: go
 
     - name: Check out code into the Go module directory
@@ -59,10 +61,10 @@ jobs:
   windows:
     runs-on: windows-latest
     steps:
-    - name: Set up Go 1.19
+    - name: Set up Go 1.24
       uses: actions/setup-go@v1
       with:
-        go-version: 1.19.x
+        go-version: 1.24.x
       id: go
 
     - name: Check out code into the Go module directory

.gitignore

@@ -11,8 +11,11 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# IDEs
+.idea/
+
 # Dependency directories (remove the comment below to include it)
 # vendor/
 
 *.geojson
-datagen/datagen
+datagen/datagen

CHANGELOG.md

@@ -5,12 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.0] - 2025-03-08
+
+### Added
+ - New `Build` method, see below
+
+### Changed
+ - Make `ReverseGeocode` thread safe, thanks to @mologie (#34)
+	- This makes the first call to `ReverseGeocode` much slower. This can be
+	mitigated by calling `Build` first.
+ -  Optimizations: Only link used datasets, avoid copies, avoid pkg/errors
+ dependency, thanks to @mologie (#26)
+ - Update natural earth data to v5.1.2, thanks to @SaTae66
+ - Bump dependency versions, thanks to @dependabot
+
 ## [1.2.0] - 2023-01-03
 
 It's been a while since the last release, so all of the dependencies have been
 updated, but this is mostly about the first user contribution.
 
-## Changed
+### Changed
  - Moved to using Go embed for the data files, thanks to @benjojo (#18)
  - Updated to Go 1.19
  - Updated other dependencies

README.md

@@ -16,6 +16,20 @@ the data beforehand (links to which are in the files). If you want to use your
 own dataset, check out
 [datagen](https://github.com/sams96/rgeo/tree/master/datagen).
 
+## Current status
+
+Rgeo is not being activly developed. I will try to keep dependencies up to date
+but no new features will be added. You can read more
+[here](https://sams96.github.io/rgeo-5-years-on) if you are interested. If you
+are looking for an alternative, I recommend:
+ - [smilyorg/tinygpkg](https://github.com/smilyorg/tinygpkg) - Very nice package
+ inspired by Rgeo. It uses a different approach to vastly reduce startup time at
+ the cost of slightly slower queries.
+ - [authenticvision/rgeo](https://github.com/authenticvision/rgeo) - The most
+ active fork of Rgeo, and most of the contributions I’ve had have come from
+ these guys.
+Otherwise it should be fine to keep using Rgeo with its existing features.
+
 ## Key Features
 
  - **Fast** - So I haven't _actually_ benchmarked other reverse geocoding tools
@@ -143,9 +157,4 @@ fmt.Printf("%s\n", loc.SubRegion)
 
 ## Contributing
 
-Contributions are welcome, I haven't got any guidelines or anything so maybe
-just make an issue first.
-
-## Projects using rgeo
-
- - [rgeoSrv](https://github.com/sams96/rgeoSrv) - rgeo as a microservice
+I'm not accepting new features for the time being, see above.

data/Provinces10.gz

@@ -102,10 +102,13 @@ func main() {
 	}
 
 	f, _ := os.Create(fmt.Sprintf("%s.gz", *outFileName))
-	io.Copy(f, &buf)
+	_, err = io.Copy(f, &buf)
+	if err != nil {
+		log.Fatal(err)
+	}
 
 	fReadme, _ := os.Create(fmt.Sprintf("%s.txt", *outFileName))
-	fReadme.WriteString(fmt.Sprintf("%s %s", strings.TrimSuffix(*outFileName, ".go"), "uses data from "+printSlice(prefixSlice(pre, files))))
+	fmt.Fprintf(fReadme, "%s %s", strings.TrimSuffix(*outFileName, ".go"), "uses data from "+printSlice(prefixSlice(pre, files)))
 }
 
 func readInputs(in []string, mergeFileName string) (*geojson.FeatureCollection, error) {

datagen/datagen.go

@@ -1,36 +1,32 @@
 package rgeo
 
-import (
-	"embed"
-	"fmt"
-	"io"
-)
+// embedding files individually here to allow the linker to strip out unused ones
+import _ "embed"
 
-//go:embed data/*
-var dataDir embed.FS
+//go:embed data/Cities10.gz
+var cities10 []byte
 
 func Cities10() []byte {
-	return readEmbedFile("Cities10.gz")
+	return cities10
 }
 
+//go:embed data/Countries10.gz
+var countries10 []byte
+
 func Countries10() []byte {
-	return readEmbedFile("Countries10.gz")
+	return countries10
 }
 
-func Countries110() []byte {
-	return readEmbedFile("Countries110.gz")
-}
+//go:embed data/Countries110.gz
+var countries110 []byte
 
-func Provinces10() []byte {
-	return readEmbedFile("Provinces10.gz")
+func Countries110() []byte {
+	return countries110
 }
 
-func readEmbedFile(name string) []byte {
-	f, err := dataDir.Open(fmt.Sprintf("data/%s", name))
-	if err != nil {
-		panic(fmt.Sprintf("internal embedded geojson open error %v", err))
-	}
+//go:embed data/Provinces10.gz
+var provinces10 []byte
 
-	b, _ := io.ReadAll(f)
-	return b
+func Provinces10() []byte {
+	return provinces10
 }

embed.go

@@ -1,10 +1,11 @@
 module github.com/swift-nav/rgeo
 
-go 1.19
+go 1.22
+
+toolchain go1.24.1
 
 require (
-	github.com/go-test/deep v1.1.0
-	github.com/golang/geo v0.0.0-20200730024412-e86565bf3f35
-	github.com/pkg/errors v0.9.1
-	github.com/twpayne/go-geom v1.4.4
+	github.com/go-test/deep v1.1.1
+	github.com/golang/geo v0.0.0-20230421003525-6adc56603217
+	github.com/twpayne/go-geom v1.6.0
 )

go.mod

@@ -1,12 +1,12 @@
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/go-test/deep v1.1.0 h1:WOcxcdHcvdgThNXjw0t76K42FXTU7HpNQWHpA2HHNlg=
-github.com/go-test/deep v1.1.0/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
-github.com/golang/geo v0.0.0-20200730024412-e86565bf3f35 h1:enTowfyfjtomBQhxX9mhUD+0tZhpe4rIzStO4aNlou8=
-github.com/golang/geo v0.0.0-20200730024412-e86565bf3f35/go.mod h1:QZ0nwyI2jOfgRAoBvP+ab5aRr7c9x7lhGEJrKvBwjWI=
-github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
-github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
-github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/twpayne/go-geom v1.4.4 h1:bcCPAvvNSzjmpUqR0Uqh39ClCKtPx6kZVR7EakQaVJI=
-github.com/twpayne/go-geom v1.4.4/go.mod h1:Kz4sX4LtdesDQgkhsMERazLlH/NiCg90s6FPaNr0KNI=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+github.com/alecthomas/assert/v2 v2.10.0 h1:jjRCHsj6hBJhkmhznrCzoNpbA3zqy0fYiUcYZP/GkPY=
+github.com/alecthomas/assert/v2 v2.10.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k=
+github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc=
+github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
+github.com/go-test/deep v1.1.1 h1:0r/53hagsehfO4bzD2Pgr/+RgHqhmf+k1Bpse2cTu1U=
+github.com/go-test/deep v1.1.1/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
+github.com/golang/geo v0.0.0-20230421003525-6adc56603217 h1:HKlyj6in2JV6wVkmQ4XmG/EIm+SCYlPZ+V4GWit7Z+I=
+github.com/golang/geo v0.0.0-20230421003525-6adc56603217/go.mod h1:8wI0hitZ3a1IxZfeH3/5I97CI8i5cLGsYe7xNhQGs9U=
+github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
+github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
+github.com/twpayne/go-geom v1.6.0 h1:WPOJLCdd8OdcnHvKQepLKwOZrn5BzVlNxtQB59IDHRE=
+github.com/twpayne/go-geom v1.6.0/go.mod h1:Kr+Nly6BswFsKM5sd31YaoWS5PeDDH2NftJTK7Gd028=