refactor, code review, version up

.metadata/version

@@ -1 +1 @@
-2.0.12
+2.0.13

README.md

@@ -78,3 +78,9 @@ docker run --rm $IMG
 ```
 
 Clean up manually afterwards (i.e. remove images).
+
+Generate screenshots by first installing [termshot](https://github.com/homeport/termshot) and then executing the following command:
+
+```sh
+bash ./screenshots/gen.sh path_to_termshot_executable path_to_cpdiff_executable
+```

cli/command.go

@@ -116,22 +116,28 @@ func showComparisonEntry(
 	return true, nil
 }
 
-func readLinesToChannel(buf *bufio.Scanner, ch chan string, opts options) {
-	for buf.Scan() {
-		line := buf.Text()
+func readLinesToChannel(buf *bufio.Scanner, opts options) <-chan string {
+	ch := make(chan string, chSize)
 
-		if opts.trim {
-			line = strings.TrimSpace(line)
-		}
+	go func() {
+		for buf.Scan() {
+			line := buf.Text()
+
+			if opts.trim {
+				line = strings.TrimSpace(line)
+			}
 
-		if shouldSkipLine(line, opts) {
-			continue
+			if shouldSkipLine(line, opts) {
+				continue
+			}
+
+			ch <- line
 		}
 
-		ch <- line
-	}
+		close(ch)
+	}()
 
-	close(ch)
+	return ch
 }
 
 func getFile(path string) (*os.File, error) {
@@ -171,7 +177,7 @@ func getBothFiles(args []string) ([]*os.File, error) {
 }
 
 func listenEntries(
-	entries chan cmp.ComparisonEntry,
+	entries <-chan cmp.ComparisonEntry,
 	opts options,
 ) (*fullResult, error) {
 	res := newFullResult()
@@ -213,19 +219,16 @@ func mainCommand(opts options, args []string) error {
 	lhs := bufio.NewScanner(files[0])
 	rhs := bufio.NewScanner(files[1])
 
-	entries := make(chan cmp.ComparisonEntry, chSize)
-	lhsCh := make(chan string, chSize)
-	rhsCh := make(chan string, chSize)
+	lhsCh := readLinesToChannel(lhs, opts)
+	rhsCh := readLinesToChannel(rhs, opts)
 
-	go readLinesToChannel(lhs, lhsCh, opts)
-	go readLinesToChannel(rhs, rhsCh, opts)
-	go cmp.Process(
+	entries := cmp.Process(
 		lhsCh,
 		rhsCh,
 		opts.error,
 		opts.useRelativeError,
 		opts.numbers,
-		entries,
+		chSize,
 	)
 
 	fullResult, err := listenEntries(entries, opts)

cmp/parser.go

@@ -5,39 +5,39 @@ import (
 	"strings"
 )
 
-func toNumArray(s string) ([]big.Decimal, bool) {
+func toNumArray(s string) []big.Decimal {
 	parts := strings.Fields(s)
 	res := []big.Decimal{}
 
 	if len(parts) == 0 {
-		return nil, false
+		return nil
 	}
 
 	for _, part := range parts {
 		if len(part) > 1 && part[0] == '0' && part[1] != '.' {
-			return nil, false
+			return nil
 		}
 
 		val, ok := big.NewFromString(part)
 
 		if !ok {
-			return nil, false
+			return nil
 		}
 
 		res = append(res, val)
 	}
 
-	return res, true
+	return res
 }
 
 func newComparable(line string) Comparable {
 	if len(line) == 0 {
 		return Empty{}
 	}
 
-	nums, ok := toNumArray(line)
+	nums := toNumArray(line)
 
-	if ok {
+	if nums != nil {
 		return NumArray{nums: nums, rawData: line}
 	}
 

cmp/process.go

@@ -76,36 +76,42 @@ func applyStringFallbackHeuristic(lhs, rhs *Comparable, line1, line2 string) {
 
 func Process(
 	lhsCh,
-	rhsCh chan string,
+	rhsCh <-chan string,
 	allowedError big.Decimal,
 	useRelativeErr bool,
 	useNumbers bool,
-	entriesCh chan ComparisonEntry,
-) {
-	for {
-		line1, ok1 := <-lhsCh
-		line2, ok2 := <-rhsCh
-
-		if !ok1 && !ok2 {
-			break
-		}
+	chSize int,
+) <-chan ComparisonEntry {
+	entries := make(chan ComparisonEntry, chSize)
 
-		var lhs, rhs Comparable
+	go func() {
+		for {
+			line1, ok1 := <-lhsCh
+			line2, ok2 := <-rhsCh
 
-		if useNumbers {
-			lhs = newComparable(line1)
-			rhs = newComparable(line2)
+			if !ok1 && !ok2 {
+				break
+			}
 
-			applyStringFallbackHeuristic(&lhs, &rhs, line1, line2)
-		} else {
-			lhs = newComparableNonNumeric(line1)
-			rhs = newComparableNonNumeric(line2)
-		}
+			var lhs, rhs Comparable
 
-		ranges, maxErr := lhs.compare(rhs, useRelativeErr, allowedError)
+			if useNumbers {
+				lhs = newComparable(line1)
+				rhs = newComparable(line2)
 
-		entriesCh <- newComparisonEntry(lhs, rhs, ranges, maxErr)
-	}
+				applyStringFallbackHeuristic(&lhs, &rhs, line1, line2)
+			} else {
+				lhs = newComparableNonNumeric(line1)
+				rhs = newComparableNonNumeric(line2)
+			}
+
+			ranges, maxErr := lhs.compare(rhs, useRelativeErr, allowedError)
+
+			entries <- newComparisonEntry(lhs, rhs, ranges, maxErr)
+		}
+
+		close(entries)
+	}()
 
-	close(entriesCh)
+	return entries
 }

main.go

@@ -37,5 +37,3 @@ func main() {
 		os.Exit(1)
 	}
 }
-
-// TODO: This project needs a massive code review.