upgrade libraries, move cache to better directory+boltdb

Author: kylegrantlucas

go.mod

@@ -3,16 +3,17 @@ module github.com/kylegrantlucas/lyricpiece
 go 1.19
 
 require (
-	github.com/andybrewer/mack v0.0.0-20200226161639-15be3d47cc54
+	github.com/andybrewer/mack v0.0.0-20220307193339-22e922cc18af
+	github.com/boltdb/bolt v1.3.1
 	github.com/rhnvrm/lyric-api-go v0.1.4
-	gopkg.in/mattes/go-expand-tilde.v1 v1.0.0-20150330173918-cb884138e64c
 )
 
 require (
-	github.com/PuerkitoBio/goquery v1.4.1 // indirect
-	github.com/andybalholm/cascadia v1.0.0 // indirect
+	github.com/PuerkitoBio/goquery v1.8.0 // indirect
+	github.com/andybalholm/cascadia v1.3.1 // indirect
 	github.com/gopherjs/gopherjs v1.17.2 // indirect
-	github.com/gosimple/slug v1.2.0 // indirect
-	github.com/rainycape/unidecode v0.0.0-20150907023854-cb7f23ec59be // indirect
-	golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d // indirect
+	github.com/gosimple/slug v1.13.0 // indirect
+	github.com/gosimple/unidecode v1.0.1 // indirect
+	golang.org/x/net v0.0.0-20220930213112-107f3e3c3b0b // indirect
+	golang.org/x/sys v0.0.0-20220928140112-f11e5e49a4ec // indirect
 )

go.sum

@@ -1,16 +1,22 @@
-github.com/PuerkitoBio/goquery v1.4.1 h1:smcIRGdYm/w7JSbcdeLHEMzxmsBQvl8lhf0dSw2nzMI=
 github.com/PuerkitoBio/goquery v1.4.1/go.mod h1:T9ezsOHcCrDCgA8aF1Cqr3sSYbO/xgdy8/R/XiIMAhA=
-github.com/andybalholm/cascadia v1.0.0 h1:hOCXnnZ5A+3eVDX8pvgl4kofXv2ELss0bKcqRySc45o=
+github.com/PuerkitoBio/goquery v1.8.0 h1:PJTF7AmFCFKk1N6V6jmKfrNH9tV5pNE6lZMkG0gta/U=
+github.com/PuerkitoBio/goquery v1.8.0/go.mod h1:ypIiRMtY7COPGk+I/YbZLbxsxn9g5ejnI2HSMtkjZvI=
 github.com/andybalholm/cascadia v1.0.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y=
-github.com/andybrewer/mack v0.0.0-20200226161639-15be3d47cc54 h1:uZMWs9VZiUv6J6gHdlDUA4Y11ckPLe+qYagoHfQb6BY=
-github.com/andybrewer/mack v0.0.0-20200226161639-15be3d47cc54/go.mod h1:unYm1XWSUgGRVv0MaRe3DFEGh2OEcUQ/sFSGxXjXBfI=
+github.com/andybalholm/cascadia v1.3.1 h1:nhxRkql1kdYCc8Snf7D5/D3spOX+dBgjA6u8x004T2c=
+github.com/andybalholm/cascadia v1.3.1/go.mod h1:R4bJ1UQfqADjvDa4P6HZHLh/3OxWWEqc0Sk8XGwHqvA=
+github.com/andybrewer/mack v0.0.0-20220307193339-22e922cc18af h1:PNE0xdyuLeOTujftqZs8DlhDoi+T54ONZhiGOxH5t2A=
+github.com/andybrewer/mack v0.0.0-20220307193339-22e922cc18af/go.mod h1:oUO968BJnuljnB5tntrY3w3zDfI5/PqnQ+RuiZ8aFhk=
+github.com/boltdb/bolt v1.3.1 h1:JQmyP4ZBrce+ZQu0dY660FMfatumYDLun9hBCUVIkF4=
+github.com/boltdb/bolt v1.3.1/go.mod h1:clJnj/oiGkjum5o1McbSZDSLxVThjynRyGBgiAx27Ps=
 github.com/gopherjs/gopherjs v1.17.2 h1:fQnZVsXk8uxXIStYb0N4bGk7jeyTalG/wsZjQ25dO0g=
 github.com/gopherjs/gopherjs v1.17.2/go.mod h1:pRRIvn/QzFLrKfvEz3qUuEhtE/zLCWfreZ6J5gM2i+k=
-github.com/gosimple/slug v1.2.0 h1:DqQXHQLprYBsiO4ZtdadqBeKh7CFnl5qoVNkKkVI7No=
 github.com/gosimple/slug v1.2.0/go.mod h1:ER78kgg1Mv0NQGlXiDe57DpCyfbNywXXZ9mIorhxAf0=
+github.com/gosimple/slug v1.13.0 h1:w4W2sU2a/JcAkI+LN316Cn/NE4CXopoXto9aloYTic0=
+github.com/gosimple/slug v1.13.0/go.mod h1:UiRaFH+GEilHstLUmcBgWcI42viBN7mAb818JrYOeFQ=
+github.com/gosimple/unidecode v1.0.1 h1:hZzFTMMqSswvf0LBJZCZgThIZrpDHFXux9KeGmn6T/o=
+github.com/gosimple/unidecode v1.0.1/go.mod h1:CP0Cr1Y1kogOtx0bJblKzsVWrqYaqfNOnHzpgWw4Awc=
 github.com/jtolds/gls v4.2.1+incompatible h1:fSuqC+Gmlu6l/ZYAoZzx2pyucC8Xza35fpRVWLVmUEE=
 github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
-github.com/rainycape/unidecode v0.0.0-20150907023854-cb7f23ec59be h1:ta7tUOvsPHVHGom5hKW5VXNc2xZIkfCKP8iaqOyYtUQ=
 github.com/rainycape/unidecode v0.0.0-20150907023854-cb7f23ec59be/go.mod h1:MIDFMn7db1kT65GmV94GzpX9Qdi7N/pQlwb+AN8wh+Q=
 github.com/rhnvrm/lyric-api-go v0.1.4 h1:E3n6+H4PyVJCesc3NNIbLxKlFpyMVDiq2niKSZK7K1s=
 github.com/rhnvrm/lyric-api-go v0.1.4/go.mod h1:mxXSk7lWgck4BEMLsOgse2AiE+qoXIc9mcfxF2YQCHs=
@@ -20,7 +26,13 @@ github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a h1:JSvGDIbm
 github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a/go.mod h1:XDJAKZRPZ1CvBcN2aX5YOUTYGHki24fSF0Iv48Ibg0s=
 golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
-golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d h1:LO7XpTYMwTqxjLcGWPijK3vRXg1aWdlNOVOHRq45d7c=
-golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-gopkg.in/mattes/go-expand-tilde.v1 v1.0.0-20150330173918-cb884138e64c h1:/Onz8dZtKBCmB8P0JU7+WSCfMekXry7BflVO0SQQrCU=
-gopkg.in/mattes/go-expand-tilde.v1 v1.0.0-20150330173918-cb884138e64c/go.mod h1:j6QavCO5cYWud1+2/PFTXL1y6tjjkhSs+qcWgibOIc0=
+golang.org/x/net v0.0.0-20210916014120-12bc252f5db8/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220930213112-107f3e3c3b0b h1:uKO3Js8lXGjpjdc4J3rqs0/Ex5yDKUGfk43tTYWVLas=
+golang.org/x/net v0.0.0-20220930213112-107f3e3c3b0b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20220928140112-f11e5e49a4ec h1:BkDtF2Ih9xZ7le9ndzTA7KJow28VbQW3odyk/8drmuI=
+golang.org/x/sys v0.0.0-20220928140112-f11e5e49a4ec/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

lyricpiece/client.go

@@ -0,0 +1,125 @@
+package lyricpiece
+
+import (
+	"fmt"
+	"math/rand"
+	"strings"
+	"time"
+
+	"github.com/boltdb/bolt"
+	lyrics "github.com/rhnvrm/lyric-api-go"
+)
+
+type Client struct {
+	db *bolt.DB
+}
+
+func NewClient(dbfile string) (*Client, error) {
+	db, err := bolt.Open(dbfile, 0600, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return &Client{
+		db: db,
+	}, nil
+}
+
+func (lp *Client) Close() error {
+	return lp.db.Close()
+}
+
+func (lp *Client) GetLyricPiece(song Song) (string, error) {
+	rand.Seed(time.Now().Unix())
+
+	lyrics, err := lp.getLyrics(lp.db, song)
+	if err != nil {
+		fmt.Println(err)
+		return "", err
+	}
+	chunkedLyrics := strings.Split(lyrics, "\n\n")
+
+	fullLyrics := []string{}
+	for _, s := range chunkedLyrics {
+		if strings.TrimSpace(s) != "" {
+			fullLyrics = append(fullLyrics, s)
+		}
+	}
+
+	if len(fullLyrics) > 0 {
+		return strings.TrimSpace(
+			fullLyrics[rand.Intn(len(fullLyrics))],
+		), nil
+	}
+
+	return "", nil
+}
+
+func (lp *Client) getLyrics(db *bolt.DB, song Song) (string, error) {
+	lyrics, err := lp.queryDBForLyrics(db, song)
+	if err != nil {
+		return lyrics, err
+	}
+
+	if lyrics == "" {
+		downloadedLyrics, err := lp.queryLyrics(song)
+		if err != nil {
+			return lyrics, err
+		}
+
+		if downloadedLyrics != "" {
+			err = lp.writeLyricsToDB(db, song, downloadedLyrics)
+			if err != nil {
+				return lyrics, err
+			}
+		}
+
+		lyrics = downloadedLyrics
+	}
+
+	return lyrics, nil
+}
+
+func (lp *Client) queryDBForLyrics(db *bolt.DB, song Song) (string, error) {
+	var lyrics string
+	err := db.View(func(tx *bolt.Tx) error {
+		b := tx.Bucket([]byte("lyrics"))
+		if b == nil {
+			// we don't care if we can't find the bucket
+			return nil
+		}
+		lyrics = string(b.Get([]byte(song.buildLyricKey())))
+
+		return nil
+	})
+	if err != nil {
+		return lyrics, err
+	}
+
+	return lyrics, nil
+}
+
+func (lp *Client) writeLyricsToDB(db *bolt.DB, song Song, lyrics string) error {
+	err := db.Update(func(tx *bolt.Tx) error {
+		bucket, err := tx.CreateBucketIfNotExists([]byte("lyrics"))
+		if err != nil {
+			return fmt.Errorf("create bucket: %s", err)
+		}
+		return bucket.Put([]byte(song.buildLyricKey()), []byte(lyrics))
+	})
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (lp *Client) queryLyrics(song Song) (string, error) {
+	l := lyrics.New()
+	lyric, err := l.Search(song.Artist, song.Title)
+	if err != nil {
+		return "", err
+	}
+
+	return lyric, nil
+}

lyricpiece/song.go

@@ -0,0 +1,10 @@
+package lyricpiece
+
+type Song struct {
+	Title  string
+	Artist string
+}
+
+func (s Song) buildLyricKey() string {
+	return s.Artist + "/" + s.Title
+}

main.go

@@ -2,37 +2,50 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
-	"math/rand"
 	"os"
-	"strings"
 	"sync"
-	"time"
 
 	"github.com/andybrewer/mack"
-	lyrics "github.com/rhnvrm/lyric-api-go"
-	tilde "gopkg.in/mattes/go-expand-tilde.v1"
+	"github.com/kylegrantlucas/lyricpiece/lyricpiece"
 )
 
 func main() {
-	song := getCurrentSong()
+	dbPath, err := buildDBPath()
+	if err != nil {
+		fmt.Fprintln(os.Stderr, err)
+	}
 
-	lyrics, err := getLyrics(song)
+	client, err := lyricpiece.NewClient(dbPath)
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err)
 	}
+	defer client.Close()
 
-	lyricPiece := getRandomLyricPiece(lyrics)
+	song := getCurrentSong()
+	lyricPiece, err := client.GetLyricPiece(song)
+	if err != nil {
+		fmt.Fprintln(os.Stderr, err)
+	}
 
 	fmt.Print(lyricPiece)
 }
 
-type Song struct {
-	Title  string
-	Artist string
+func buildDBPath() (string, error) {
+	homedir, err := os.UserHomeDir()
+	if err != nil {
+		return "", err
+	}
+
+	path := homedir + "/.cache/lyricpiece"
+	err = os.MkdirAll(path, os.ModePerm)
+	if err != nil {
+		return "", err
+	}
+
+	return path + "/lyricpiece.db", nil
 }
 
-func getCurrentSong() Song {
+func getCurrentSong() lyricpiece.Song {
 	var track, artist string
 	wg := &sync.WaitGroup{}
 	wg.Add(2)
@@ -49,76 +62,5 @@ func getCurrentSong() Song {
 
 	wg.Wait()
 
-	return Song{Title: track, Artist: artist}
-}
-
-func getLyrics(song Song) (string, error) {
-	var lyrics string
-	filename, err := tilde.Expand(fmt.Sprintf("~/lyrics/%s-%s.txt", strings.TrimSpace(song.Title), strings.TrimSpace(song.Artist)))
-	if err != nil {
-		return lyrics, err
-	}
-
-	if fileExists(filename) {
-		file, err := ioutil.ReadFile(filename)
-		if err != nil {
-			return lyrics, err
-		}
-		lyrics = string(file)
-	} else {
-		downloadedLyrics, err := queryLyrics(song)
-		if err != nil {
-			return lyrics, err
-		}
-
-		if downloadedLyrics != "" {
-			err = ioutil.WriteFile(filename, []byte(downloadedLyrics), 0644)
-			if err != nil {
-				return lyrics, err
-			}
-		}
-
-		lyrics = downloadedLyrics
-	}
-
-	return lyrics, nil
-}
-
-func getRandomLyricPiece(lyrics string) string {
-	rand.Seed(time.Now().Unix())
-
-	chunkedLyrics := strings.Split(lyrics, "\n\n")
-
-	fullLyrics := []string{}
-	for _, s := range chunkedLyrics {
-		if strings.TrimSpace(s) != "" {
-			fullLyrics = append(fullLyrics, s)
-		}
-	}
-
-	if len(fullLyrics) > 0 {
-		return strings.TrimSpace(
-			fullLyrics[rand.Intn(len(fullLyrics))],
-		)
-	}
-
-	return ""
-}
-
-func fileExists(filename string) bool {
-	info, err := os.Stat(filename)
-	if os.IsNotExist(err) {
-		return false
-	}
-	return !info.IsDir()
-}
-
-func queryLyrics(song Song) (string, error) {
-	l := lyrics.New()
-	lyric, err := l.Search(song.Artist, song.Title)
-	if err != nil {
-		return "", err
-	}
-
-	return lyric, nil
+	return lyricpiece.Song{Title: track, Artist: artist}
 }