chore: init CI and fix lint issues

Author: S0obi

.github/release.yml

@@ -0,0 +1,20 @@
+# .github/release.yml
+
+changelog:
+  exclude:
+    authors:
+      - octocat
+  categories:
+    - title: ⭐ New features
+      labels:
+        - feature
+        - enhancement
+    - title: 🛠 Fixes
+      labels:
+        - bug
+    - title: ⚙️ Dependency updates
+      labels:
+        - dependencies
+    - title: 🧰 Other changes
+      labels:
+        - "*"

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+on:
+  pull_request:
+    branches: [ main ]
+    types: [opened, synchronize, reopened]
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: [^1.23]
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 1 
+
+      - name: Set up Go
+        uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint
+
+      - name: Run Go Tests
+        run: go test -coverprofile=coverage.out ./...

.gitignore

@@ -0,0 +1 @@
+coverage.out

README.md

@@ -30,7 +30,7 @@ seconds on a modest laptop.
 import (
     "log"
 
-    "github.com/lloyd/wnram"
+    "github.com/coreruleset/wnram"
 )
 
 func main() {

go.mod

@@ -0,0 +1,3 @@
+module github.com/coreruleset/wnram
+
+go 1.23.0

parser.go

@@ -8,40 +8,6 @@ import (
 	"unicode/utf8"
 )
 
-type tokenType uint8
-
-const (
-	tNone tokenType = iota
-	tEOL
-	tNumber
-	tPOS
-)
-
-func (t tokenType) GoString() string {
-	return t.String()
-}
-
-func (t tokenType) String() string {
-	switch t {
-	case tNone:
-		return "none"
-	case tEOL:
-		return "eol"
-	case tNumber:
-		return "number"
-	case tPOS:
-		return "pos"
-	}
-	return "unknown"
-}
-
-type token struct {
-	t tokenType
-	v string
-	n int64
-	p PartOfSpeech
-}
-
 type lexable string
 
 func (l *lexable) chomp() {
@@ -97,7 +63,7 @@ func (l *lexable) lexDecimalNumber() (int64, error) {
 func (l *lexable) lexWord() (string, error) {
 	l.chomp()
 	var word []byte
-	buf := make([]byte, 4, 4)
+	buf := make([]byte, 4)
 	for {
 		if r, ok := l.peek(); !ok || unicode.IsSpace(r) {
 			break
@@ -155,7 +121,7 @@ func (l *lexable) lexOffset() (string, error) {
 			return "", fmt.Errorf("invalid chars in offset: %s", string((*l)[0:8]))
 		}
 	}
-	cpy := make([]byte, 8, 8)
+	cpy := make([]byte, 8)
 	copy(cpy, (*l)[0:8])
 	*l = (*l)[8:]
 	return string(cpy), nil
@@ -267,7 +233,7 @@ type parsed struct {
 	rels       []parsedRel
 }
 
-func parseLine(data []byte, line, offset int64) (*parsed, error) {
+func parseLine(data []byte, line int64) (*parsed, error) {
 	l := lexable(data)
 
 	l.chomp()
@@ -303,12 +269,12 @@ func parseLine(data []byte, line, offset int64) (*parsed, error) {
 	for ; wordcount > 0; wordcount-- {
 		value, err := l.lexWord()
 		if err != nil {
-			return nil, fmt.Errorf("word expected: %s")
+			return nil, fmt.Errorf("word expected: %s", err)
 		}
 		// XXX: handle syntactic markers
 		sense, err := l.lexHexNumber()
 		if err != nil {
-			return nil, fmt.Errorf("sense id expected: %s")
+			return nil, fmt.Errorf("sense id expected: %s", err)
 		}
 		p.words = append(p.words, word{
 			word:  value,

read.go

@@ -2,6 +2,7 @@ package wnram
 
 import (
 	"bufio"
+	"fmt"
 	"io"
 	"os"
 )
@@ -27,7 +28,6 @@ func inPlaceReadLine(s io.Reader, cb func([]byte, int64, int64) error) error {
 	}
 	// If we reached end of file and the line contents are empty, don't return an additional line.
 	if err == io.EOF {
-		err = nil
 		if len(line) > 0 {
 			return cb(line, count, offset)
 		}
@@ -42,6 +42,10 @@ func inPlaceReadLineFromPath(filePath string, cb func([]byte, int64, int64) erro
 	if err != nil {
 		return err
 	}
-	defer f.Close()
+	defer func() {
+		if cerr := f.Close(); cerr != nil {
+			fmt.Println("Error closing file:", cerr)
+		}
+	}()
 	return inPlaceReadLine(f, cb)
 }

wordnet.go

@@ -16,12 +16,6 @@ type Handle struct {
 	db    []*cluster
 }
 
-type index struct {
-	pos   PartOfSpeech
-	lemma string
-	sense uint8
-}
-
 // The results of a search against the wordnet database
 type Lookup struct {
 	word    string   // the word the user searched for
@@ -158,7 +152,7 @@ func (w *Lookup) Gloss() string {
 
 func (w *Lookup) DumpStr() string {
 	s := fmt.Sprintf("Word: %s\n", w.String())
-	s += fmt.Sprintf("Synonyms: ")
+	s += "Synonyms: "
 	words := []string{}
 	for _, w := range w.cluster.words {
 		words = append(words, w.word)
@@ -240,8 +234,8 @@ func New(dir string) (*Handle, error) {
 
 		err = inPlaceReadLineFromPath(filename, func(data []byte, line, offset int64) error {
 			cnt++
-			if p, err := parseLine(data, line, offset); err != nil {
-				return fmt.Errorf("%s:%d: %s", err)
+			if p, err := parseLine(data, line); err != nil {
+				return fmt.Errorf("%s", err)
 			} else if p != nil {
 				// first, let's identify the cluster
 				index := ix{p.byteOffset, p.pos}
@@ -299,15 +293,15 @@ func New(dir string) (*Handle, error) {
 	}
 	for _, c := range byOffset {
 		if len(c.words) == 0 {
-			return nil, fmt.Errorf("ERROR, internal consistency error -> cluster without words %v\n", c)
+			return nil, fmt.Errorf("ERROR, internal consistency error -> cluster without words %v", c)
 		}
 		// add to the global slice of synsets (supports iteration)
 		h.db = append(h.db, c)
 
 		// now index all the strings
 		for _, w := range c.words {
 			key := normalize(w.word)
-			v, _ := h.index[key]
+			v := h.index[key]
 			v = append(v, c)
 			h.index[key] = v
 		}
@@ -331,7 +325,7 @@ func (h *Handle) Lookup(crit Criteria) ([]Lookup, error) {
 		return nil, fmt.Errorf("empty string passed as criteria to lookup")
 	}
 	searchStr := normalize(crit.Matching)
-	clusters, _ := h.index[searchStr]
+	clusters := h.index[searchStr]
 	found := []Lookup{}
 	for _, c := range clusters {
 		if len(crit.POS) > 0 {

wordnet_test.go

@@ -154,10 +154,13 @@ func TestHyponyms(t *testing.T) {
 
 func TestIterate(t *testing.T) {
 	count := 0
-	wnInstance.Iterate(PartOfSpeechList{Noun}, func(l Lookup) error {
+	err := wnInstance.Iterate(PartOfSpeechList{Noun}, func(l Lookup) error {
 		count++
 		return nil
 	})
+	if err != nil {
+		t.Fatalf("Iterate failed: %v", err)
+	}
 	if count != 82192 {
 		t.Errorf("Missing nouns!")
 	}