feat: add log interface to Ohbem conf struct (#15)

* fix: log to stdout by default

* feat: add log interface to Ohbem conf struct

* feat: rework log

ohbem.go

@@ -2,7 +2,6 @@ package gohbem
 
 import (
 	"encoding/json"
-	"log"
 	"math"
 	"os"
 	"reflect"
@@ -60,7 +59,7 @@ func (o *Ohbem) WatchPokemonData() error {
 		return ErrWatcherStarted
 	}
 
-	log.Printf("MasterFile Watcher Started")
+	o.log("MasterFile Watcher Started")
 	o.watcherChan = make(chan bool)
 	var interval time.Duration
 
@@ -77,20 +76,20 @@ func (o *Ohbem) WatchPokemonData() error {
 		for {
 			select {
 			case <-o.watcherChan:
-				log.Printf("MasterFile Watcher Stopped")
+				o.log("MasterFile Watcher Stopped")
 				ticker.Stop()
 				return
 			case <-ticker.C:
-				log.Printf("Checking remote MasterFile")
+				o.log("Checking remote MasterFile")
 				pokemonData, err := fetchMasterFile()
 				if err != nil {
-					log.Printf("Remote MasterFile fetch failed")
+					o.log("Remote MasterFile fetch failed")
 					continue
 				}
 				if reflect.DeepEqual(o.PokemonData, pokemonData) {
 					continue
 				} else {
-					log.Printf("New MasterFile found! Updating PokemonData")
+					o.log("New MasterFile found! Updating PokemonData")
 					o.PokemonData = pokemonData // overwrite PokemonData using new MasterFile
 					o.PokemonData.Initialized = true
 					o.ClearCache() // clean compactRankCache cache
@@ -114,7 +113,7 @@ func (o *Ohbem) StopWatchingPokemonData() error {
 func (o *Ohbem) ClearCache() {
 	if !o.DisableCache {
 		o.compactRankCache = sync.Map{}
-		log.Printf("Cache cleaned")
+		o.log("Cache cleaned")
 	}
 }
 

structs.go

@@ -16,6 +16,25 @@ type Ohbem struct {
 	WatcherInterval       time.Duration
 	compactRankCache      sync.Map
 	watcherChan           chan bool
+	Logger                Logger
+}
+
+// Logger interface
+//
+// Example implementation:
+//
+//	type CustomLogger struct{}
+//	func (cl *CustomLogger) Print(message string) {
+//		fmt.Println("CustomLogger:", message)
+//	}
+//	logger := &CustomLogger{}
+//	ohbem := Ohbem{Logger: logger, ...}
+//
+// Notes:
+//   - The implementation of the Logger interface defines the specific behavior of the logging operation.
+//   - The method should handle the formatting and output of the Log message according to the logger's rules.
+type Logger interface {
+	Print(message string)
 }
 
 // League struct is holding one entry of League configuration passed to Ohbem struct.

utils.go

@@ -60,3 +60,10 @@ func safetyCheck(o *Ohbem) error {
 	}
 	return nil
 }
+
+// log logs the given message using the provided logger, if available. If no logger is set, the message is ignored.
+func (o *Ohbem) log(message string) {
+	if o.Logger != nil {
+		o.Logger.Print(message)
+	}
+}