Initial commit

Author: fmenezes

README.md

@@ -0,0 +1,7 @@
+# CODEOWNERS Decoder
+
+CodeOwners decoder provides funcionality to evaluate CODEOWNERS file in Go.
+
+## Documentation
+
+To find documentation follow https://godoc.org/github.com/fmenezes/codeowners

codeowners.go

@@ -0,0 +1,84 @@
+// Package codeowners provides funcionality to evaluate CODEOWNERS file.
+package codeowners // import "github.com/fmenezes/codeowners"
+
+import (
+	"bufio"
+	"io"
+	"strings"
+)
+
+// DefaultLocations provides default locations for the CODEOWNERS file
+var DefaultLocations = [...]string{"CODEOWNERS", "docs/CODEOWNERS", ".github/CODEOWNERS"}
+
+// Decoder providers functionality to read CODEOWNERS data
+type Decoder struct {
+	scanner *bufio.Scanner
+	line    *string
+	done    bool
+}
+
+// New generates a new CodeOwnersScanner instance. The reader should be a reader containing the contents of the CODEOWNERS file
+func New(r io.Reader) *Decoder {
+	return &Decoder{
+		scanner: bufio.NewScanner(r),
+		line:    nil,
+		done:    false,
+	}
+}
+
+func (s *Decoder) peek() {
+	if !s.scanner.Scan() {
+		s.done = true
+	}
+	line := sanitiseLine(s.scanner.Text())
+	s.line = &line
+	if len(*s.line) == 0 && !s.done {
+		s.peek()
+	}
+}
+
+func sanitiseLine(line string) string {
+	i := strings.Index(line, "#")
+	if i >= 0 {
+		line = line[:i]
+	}
+	return strings.Trim(line, " ")
+}
+
+// More returns if there are available CODEOWNERS lines to be scanned
+func (s *Decoder) More() bool {
+	s.peek()
+	return !s.done
+}
+
+// Token parses the next available line in the CODEOWNERS file
+func (s *Decoder) Token() Token {
+	line := strings.ReplaceAll(*s.line, "\\ ", "\\s")
+
+	data := strings.Split(line, " ")
+
+	for i := range data {
+		data[i] = strings.ReplaceAll(data[i], "\\s", " ")
+	}
+
+	return Token{
+		path:   data[0],
+		owners: data[1:],
+	}
+}
+
+// Token providers reading capabilities for every CODEOWNERS line
+type Token struct {
+	path   string
+	owners []string
+}
+
+// Path returns the file path pattern
+func (t Token) Path() string {
+	return t.path
+}
+
+// Owners returns the owners
+func (t Token) Owners() []string {
+	return t.owners
+}

codeowners_test.go

@@ -0,0 +1,92 @@
+package codeowners_test
+
+import (
+	"reflect"
+	"strings"
+	"testing"
+
+	"github.com/fmenezes/codeowners"
+)
+
+func exec(input string) ([][]string, int) {
+	scanner := codeowners.New(strings.NewReader(input))
+	got := [][]string{}
+	c := 0
+	for scanner.More() {
+		c++
+		token := scanner.Token()
+		got = append(got, append([]string{token.Path()}, token.Owners()...))
+	}
+	return got, c
+}
+
+func assert(t *testing.T, input string, want [][]string) {
+	got, gotCount := exec(input)
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("Input: %v, Want: %v, Got: %v", input, want, got)
+	}
+	if gotCount != len(want) {
+		t.Errorf("Input: %v, Want: %v scans, Got: %v scans", input, len(want), gotCount)
+	}
+}
+
+func TestSimple(t *testing.T) {
+	assert(t, `* test@example.org`, [][]string{
+		{"*", "test@example.org"},
+	})
+}
+
+func TestMultipleOwners(t *testing.T) {
+	assert(t, `* test@example.org @owner @company/team`, [][]string{
+		{"*", "test@example.org", "@owner", "@company/team"},
+	})
+}
+
+func TestFilesWithSpaces(t *testing.T) {
+	assert(t, `file\ with\ spaces @owner`, [][]string{
+		{"file with spaces", "@owner"},
+	})
+}
+
+func TestMultipleLines(t *testing.T) {
+	assert(t, `* test@example.org
+file @owner`, [][]string{
+		{"*", "test@example.org"},
+		{"file", "@owner"},
+	})
+}
+
+func TestEmptyFile(t *testing.T) {
+	assert(t, ``, [][]string{})
+}
+
+func TestEmptyLines(t *testing.T) {
+	assert(t, `* test@example.org
+
+
+
+file @owner
+
+
+
+
+`, [][]string{
+		{"*", "test@example.org"},
+		{"file", "@owner"},
+	})
+}
+
+func TestIgnoreComments(t *testing.T) {
+	assert(t, `* test@example.org # comment
+# comment
+file @owner`, [][]string{
+		{"*", "test@example.org"},
+		{"file", "@owner"},
+	})
+}
+
+func TestNoOwners(t *testing.T) {
+	assert(t, `*`, [][]string{
+		{"*"},
+	})
+}

example_codeowners_test.go

@@ -0,0 +1,20 @@
+package codeowners_test
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/fmenezes/codeowners"
+)
+
+func Example() {
+	codeownerDecoder := codeowners.New(strings.NewReader(`* test@example.org`))
+	for codeownerDecoder.More() {
+		token := codeownerDecoder.Token()
+		fmt.Printf("File Pattern: %s\n", token.Path())
+		fmt.Printf("Owners: %v\n", token.Owners())
+	}
+	// Output:
+	// File Pattern: *
+	// Owners: [test@example.org]
+}

go.mod

@@ -0,0 +1,3 @@
+module github.com/fmenezes/codeowners
+
+go 1.14