feat!: return interface instead of structs (#109)

ringsaturn · Mar 26, 2023 · a1ffcb2 · a1ffcb2
1 parent ff120b5
commit a1ffcb2
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 19 deletions.
diff --git a/cmd/comparetzpb/main.go b/cmd/comparetzpb/main.go
@@ -13,8 +13,8 @@ import (
 )
 
 var (
-	defaultfinder *tzf.DefaultFinder
-	fullFinder    *tzf.Finder
+	defaultfinder tzf.F
+	fullFinder    tzf.F
 )
 
 func init() {

diff --git a/cmd/tzf/main.go b/cmd/tzf/main.go
@@ -11,7 +11,7 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
-var finder *tzf.Finder
+var finder tzf.F
 
 func init() {
 	input := &pb.CompressedTimezones{}

diff --git a/f.go b/f.go
@@ -0,0 +1,7 @@
+package tzf
+
+type F interface {
+	GetTimezoneName(lng float64, lat float64) string
+	GetTimezoneNames(lng float64, lat float64) ([]string, error)
+	TimezoneNames() []string
+}
diff --git a/tzf.go b/tzf.go
@@ -98,15 +98,15 @@ type Finder struct {
 	opt     *Option
 }
 
-func NewFinderFromRawJSON(input *convert.BoundaryFile, opts ...OptionFunc) (*Finder, error) {
+func NewFinderFromRawJSON(input *convert.BoundaryFile, opts ...OptionFunc) (F, error) {
 	timezones, err := convert.Do(input)
 	if err != nil {
 		return nil, err
 	}
 	return NewFinderFromPB(timezones, opts...)
 }
 
-func NewFinderFromPB(input *pb.Timezones, opts ...OptionFunc) (*Finder, error) {
+func NewFinderFromPB(input *pb.Timezones, opts ...OptionFunc) (F, error) {
 	now := time.Now()
 	items := make([]*tzitem, 0)
 	names := make([]string, 0)
@@ -184,7 +184,7 @@ func NewFinderFromPB(input *pb.Timezones, opts ...OptionFunc) (*Finder, error) {
 	return finder, nil
 }
 
-func NewFinderFromCompressed(input *pb.CompressedTimezones, opts ...OptionFunc) (*Finder, error) {
+func NewFinderFromCompressed(input *pb.CompressedTimezones, opts ...OptionFunc) (F, error) {
 	tzs, err := reduce.Decompress(input)
 	if err != nil {
 		return nil, err

diff --git a/tzf_default_finder.go b/tzf_default_finder.go
@@ -12,12 +12,12 @@ import (
 //
 // It's designed for performance first and allow some not so correct return at some area.
 type DefaultFinder struct {
-	fuzzyFinder *FuzzyFinder
-	finder      *Finder
+	fuzzyFinder F
+	finder      F
 }
 
-func NewDefaultFinder() (*DefaultFinder, error) {
-	fuzzyFinder, err := func() (*FuzzyFinder, error) {
+func NewDefaultFinder() (F, error) {
+	fuzzyFinder, err := func() (F, error) {
 		input := &pb.PreindexTimezones{}
 		if err := proto.Unmarshal(tzfrel.PreindexData, input); err != nil {
 			panic(err)
@@ -28,7 +28,7 @@ func NewDefaultFinder() (*DefaultFinder, error) {
 		return nil, err
 	}
 
-	finder, err := func() (*Finder, error) {
+	finder, err := func() (F, error) {
 		input := &pb.CompressedTimezones{}
 		if err := proto.Unmarshal(tzfrel.LiteCompressData, input); err != nil {
 			panic(err)

diff --git a/tzf_default_finder_test.go b/tzf_default_finder_test.go
@@ -14,7 +14,7 @@ import (
 )
 
 var (
-	defaultFinder *tzf.DefaultFinder
+	defaultFinder tzf.F
 )
 
 func init() {

diff --git a/tzf_fuzzy.go b/tzf_fuzzy.go
@@ -18,7 +18,7 @@ type FuzzyFinder struct {
 	names   []string
 }
 
-func NewFuzzyFinderFromPB(input *pb.PreindexTimezones) (*FuzzyFinder, error) {
+func NewFuzzyFinderFromPB(input *pb.PreindexTimezones) (F, error) {
 	f := &FuzzyFinder{
 		m:       make(map[maptile.Tile][]string),
 		idxZoom: int(input.IdxZoom),

diff --git a/tzf_fuzzy_test.go b/tzf_fuzzy_test.go
@@ -14,7 +14,7 @@ import (
 )
 
 var (
-	fuzzyFinder *tzf.FuzzyFinder
+	fuzzyFinder tzf.F
 )
 
 func init() {

diff --git a/tzf_test.go b/tzf_test.go
@@ -20,8 +20,8 @@ import (
 )
 
 var (
-	finder     *tzf.Finder
-	fullFinder *tzf.Finder
+	finder     tzf.F
+	fullFinder tzf.F
 )
 
 func init() {
@@ -127,7 +127,7 @@ func ExampleFinder_GetTimezoneLoc() {
 		panic(err)
 	}
 	finder, _ := tzf.NewFinderFromPB(input)
-	fmt.Println(finder.GetTimezoneLoc(116.6386, 40.0786))
+	fmt.Println(finder.(*tzf.Finder).GetTimezoneLoc(116.6386, 40.0786))
 	// Output: Asia/Shanghai <nil>
 }
 
@@ -141,7 +141,7 @@ func ExampleFinder_GetTimezoneShapeByName() {
 		panic(err)
 	}
 	finder, _ := tzf.NewFinderFromPB(input)
-	pbtz, err := finder.GetTimezoneShapeByName("Asia/Shanghai")
+	pbtz, err := finder.(*tzf.Finder).GetTimezoneShapeByName("Asia/Shanghai")
 	fmt.Printf("%v %v\n", pbtz.Name, err)
 	// Output: Asia/Shanghai <nil>
 }
@@ -156,7 +156,7 @@ func ExampleFinder_GetTimezoneShapeByShift() {
 		panic(err)
 	}
 	finder, _ := tzf.NewFinderFromPB(input)
-	pbtzs, _ := finder.GetTimezoneShapeByShift(28800)
+	pbtzs, _ := finder.(*tzf.Finder).GetTimezoneShapeByShift(28800)
 
 	pbnames := make([]string, 0)
 	for _, pbtz := range pbtzs {