Merge pull request #188 from hearchco/names

fix: refactor some engines.Names and config defaults logic
hearchco · Feb 7, 2024 · 6f66cd9 · 6f66cd9
2 parents ea5ff1f + 79e3c90
commit 6f66cd9
Show file tree

Hide file tree

Showing 16 changed files with 43 additions and 100 deletions.
diff --git a/src/config/defaults.go b/src/config/defaults.go
@@ -1,6 +1,7 @@
 package config
 
 import (
+	"log"
 	"time"
 
 	"github.com/hearchco/hearchco/src/category"
@@ -9,80 +10,36 @@ import (
 
 const DefaultLocale string = "en_US"
 
-func NewRanking() Ranking {
-	return Ranking{
-		REXP: 0.5,
-		A:    1,
-		B:    0,
-		C:    1,
-		D:    0,
-		TRA:  1,
-		TRB:  0,
-		TRC:  1,
-		TRD:  0,
-		Engines: map[string]EngineRanking{
-			engines.BING.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.BRAVE.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.DUCKDUCKGO.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.ETOOLS.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.GOOGLE.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.GOOGLESCHOLAR.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.MOJEEK.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.PRESEARCH.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.QWANT.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.STARTPAGE.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.SWISSCOWS.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.YAHOO.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.YANDEX.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-			engines.YEP.ToLower(): {
-				Mul:   1,
-				Const: 0,
-			},
-		},
+func EmptyRanking() Ranking {
+	rnk := Ranking{
+		REXP:    0.5,
+		A:       1,
+		B:       0,
+		C:       1,
+		D:       0,
+		TRA:     1,
+		TRB:     0,
+		TRC:     1,
+		TRD:     0,
+		Engines: map[string]EngineRanking{},
+	}
+
+	for _, eng := range engines.Names() {
+		rnk.Engines[eng.ToLower()] = EngineRanking{
+			Mul:   1,
+			Const: 0,
+		}
 	}
+
+	return rnk
+}
+
+func NewRanking() Ranking {
+	return EmptyRanking()
 }
 
 func NewSettings() map[engines.Name]Settings {
-	return map[engines.Name]Settings{
+	mp := map[engines.Name]Settings{
 		engines.BING: {
 			Shortcut: "bi",
 		},
@@ -123,24 +80,20 @@ func NewSettings() map[engines.Name]Settings {
 			Shortcut: "yep",
 		},
 	}
+
+	// Check if all search engines have a shortcut set
+	for _, eng := range engines.Names() {
+		if _, ok := mp[eng]; !ok {
+			log.Fatalf("config.NewSettings(): %v doesn't have a shortcut set.", eng)
+			// ^FATAL
+		}
+	}
+
+	return mp
 }
 
 func NewAllEnabled() []engines.Name {
-	return []engines.Name{
-		engines.BING,
-		engines.BRAVE,
-		engines.DUCKDUCKGO,
-		engines.ETOOLS,
-		engines.GOOGLE,
-		engines.GOOGLESCHOLAR,
-		engines.MOJEEK,
-		engines.PRESEARCH,
-		engines.QWANT,
-		engines.STARTPAGE,
-		engines.SWISSCOWS,
-		engines.YAHOO,
-		engines.YEP,
-	}
+	return engines.Names()
 }
 
 func NewGeneral() []engines.Name {

diff --git a/src/engines/bing/options.go b/src/engines/bing/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.BING,
 	URL:            "https://www.bing.com/search?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.BING},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/brave/options.go b/src/engines/brave/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.BRAVE,
 	URL:            "https://search.brave.com/search?q=",
 	ResultsPerPage: 20,
-	Crawlers:       []engines.Name{engines.BRAVE, engines.GOOGLE},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/duckduckgo/options.go b/src/engines/duckduckgo/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.DUCKDUCKGO,
 	URL:            "https://lite.duckduckgo.com/lite/",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.BING},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/etools/options.go b/src/engines/etools/options.go
@@ -9,7 +9,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.ETOOLS,
 	URL:            "https://www.etools.ch/searchSubmit.do",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.BING, engines.GOOGLE, engines.MOJEEK, engines.YANDEX},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/google/options.go b/src/engines/google/options.go
@@ -9,7 +9,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.GOOGLE,
 	URL:            "https://www.google.com/search?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.GOOGLE},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/googlescholar/options.go b/src/engines/googlescholar/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.GOOGLESCHOLAR,
 	URL:            "https://scholar.google.com/scholar?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.GOOGLE},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/mojeek/options.go b/src/engines/mojeek/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.MOJEEK,
 	URL:            "https://www.mojeek.com/search?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.MOJEEK},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/name.go b/src/engines/name.go
@@ -20,10 +20,14 @@ const (
 	STARTPAGE
 	SWISSCOWS
 	YAHOO
-	YANDEX
 	YEP
 )
 
+// Returns Engine Names without UNDEFINED
+func Names() []Name {
+	return _NameValues[1:]
+}
+
 func (n Name) ToLower() string {
 	return strings.ToLower(n.String())
 }
diff --git a/src/engines/presearch/options.go b/src/engines/presearch/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.PRESEARCH,
 	URL:            "https://presearch.com/search?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.GOOGLE},
 }
 
 /*

diff --git a/src/engines/qwant/options.go b/src/engines/qwant/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.QWANT,
 	URL:            "https://api.qwant.com/v3/search/web?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.BING},
 }
 
 var Support engines.SupportedSettings = engines.SupportedSettings{

diff --git a/src/engines/startpage/options.go b/src/engines/startpage/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.STARTPAGE,
 	URL:            "https://www.startpage.com/sp/search?q=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.GOOGLE},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/structs.go b/src/engines/structs.go
@@ -35,7 +35,6 @@ type Info struct {
 	Name           Name
 	URL            string
 	ResultsPerPage int
-	Crawlers       []Name
 }
 
 type DOMPaths struct {

diff --git a/src/engines/swisscows/options.go b/src/engines/swisscows/options.go
@@ -7,7 +7,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.SWISSCOWS,
 	URL:            "https://api.swisscows.com/web/search?",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.BING},
 }
 
 var Support engines.SupportedSettings = engines.SupportedSettings{

diff --git a/src/engines/yahoo/options.go b/src/engines/yahoo/options.go
@@ -11,7 +11,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.YAHOO,
 	URL:            "https://search.yahoo.com/search?p=",
 	ResultsPerPage: 10,
-	Crawlers:       []engines.Name{engines.BING},
 }
 
 var dompaths engines.DOMPaths = engines.DOMPaths{

diff --git a/src/engines/yep/options.go b/src/engines/yep/options.go
@@ -9,7 +9,6 @@ var Info engines.Info = engines.Info{
 	Name:           engines.YEP,
 	URL:            "https://api.yep.com/fs/2/search?",
 	ResultsPerPage: 20,
-	Crawlers:       []engines.Name{engines.YEP},
 }
 
 /*