Merge remote-tracking branch 'origin/v2-fluent-functional-options'

Author: cody-smarty

csv/column_scanner.go

@@ -25,7 +25,7 @@ type ColumnScanner struct {
 // to be the header.  It calls Scan once to read the header; subsequent
 // calls to Scan will return the remaining records.
 func NewColumnScanner(reader io.Reader, options ...Option) (*ColumnScanner, error) {
-	inner := NewScanner(reader, append(options, FieldsPerRecord(0))...)
+	inner := NewScanner(reader, append(options, Options.FieldsPerRecord(0))...)
 	if !inner.Scan() {
 		return nil, inner.Error()
 	}

csv/example_test.go

@@ -5,7 +5,7 @@ import (
 	"log"
 	"strings"
 
-	"github.com/smarty/scanners/csv"
+	"github.com/smarty/scanners/v2/csv"
 )
 
 func ExampleScanner() {
@@ -43,7 +43,7 @@ func ExampleScanner_options() {
 		`"Robert";"Griesemer";"gri"`,
 	}, "\n")
 
-	scanner := csv.NewScanner(strings.NewReader(in), csv.Comma(';'), csv.Comment('#'))
+	scanner := csv.NewScanner(strings.NewReader(in), csv.Options.Comma(';'), csv.Options.Comment('#'))
 
 	for scanner.Scan() {
 		fmt.Println(scanner.Record())

csv/options.go

@@ -4,6 +4,11 @@ package csv
 // Each one allows configuration of the scanner and/or its internal *csv.Reader.
 type Option func(*Scanner)
 
+// Options (a singleton instance) provides access to built-in functional options.
+var Options options
+
+type options struct{}
+
 // ContinueOnError controls scanner behavior in error scenarios.
 // If true is passed, continue scanning until io.EOF is reached.
 // If false is passed (default), any error encountered during scanning
@@ -14,32 +19,47 @@ type Option func(*Scanner)
 // See the error variables starting at [csv.ErrBareQuote], and the
 // [csv.ParseError] type, for more information regarding possible
 // error values.
-func ContinueOnError(continue_ bool) Option {
-	return func(s *Scanner) { s.continueOnError = continue_ }
+func (options) ContinueOnError(continue_ bool) Option {
+	return func(s *Scanner) {
+		s.continueOnError = continue_
+	}
 }
-
-// See the [csv.Reader.Comma] field.
-func Comma(comma rune) Option { return func(s *Scanner) { s.reader.Comma = comma } }
-
-// See the [csv.Reader.Comment] field.
-func Comment(comment rune) Option { return func(s *Scanner) { s.reader.Comment = comment } }
-
-// See the [csv.Reader.FieldsPerRecord] field.
-func FieldsPerRecord(fields int) Option {
-	return func(s *Scanner) { s.reader.FieldsPerRecord = fields }
+func (options) Comma(comma rune) Option {
+	return func(s *Scanner) {
+		s.reader.Comma = comma
+	}
 }
-
-// See the [csv.Reader.LazyQuotes] field.
-func LazyQuotes(lazy bool) Option { return func(s *Scanner) { s.reader.LazyQuotes = lazy } }
-
-// See the [csv.Reader.ReuseRecord] field.
-func ReuseRecord(reuse bool) Option { return func(s *Scanner) { s.reader.ReuseRecord = reuse } }
-
-// See the [csv.Reader.TrimLeadingSpace] field.
-func TrimLeadingSpace(trim bool) Option { return func(s *Scanner) { s.reader.TrimLeadingSpace = trim } }
-
-func SkipHeaderRecord() Option { return SkipRecords(1) }
-func SkipRecords(count int) Option {
+func (options) Comment(comment rune) Option {
+	return func(s *Scanner) {
+		s.reader.Comment = comment
+	}
+}
+func (options) FieldsPerRecord(fields int) Option {
+	return func(s *Scanner) {
+		s.reader.FieldsPerRecord = fields
+	}
+}
+func (options) LazyQuotes(lazy bool) Option {
+	return func(s *Scanner) {
+		s.reader.LazyQuotes = lazy
+	}
+}
+func (options) ReuseRecord(reuse bool) Option {
+	return func(s *Scanner) {
+		s.reader.ReuseRecord = reuse
+	}
+}
+func (options) TrimLeadingSpace(trim bool) Option {
+	return func(s *Scanner) {
+		s.reader.TrimLeadingSpace = trim
+	}
+}
+func (options) SkipHeaderRecord() Option {
+	return func(s *Scanner) {
+		s.Scan()
+	}
+}
+func (options) SkipRecords(count int) Option {
 	return func(s *Scanner) {
 		for x := 0; x < count; x++ {
 			s.Scan()

csv/scanner_test.go

@@ -38,24 +38,24 @@ func (this *ScanAllFixture) scanAll(inputs []string, options ...Option) (scanned
 }
 
 func (this *ScanAllFixture) TestCanonical() {
-	scanned := this.scanAll(csvCanon, Comma(','), FieldsPerRecord(3))
+	scanned := this.scanAll(csvCanon, Options.Comma(','), Options.FieldsPerRecord(3))
 	this.So(scanned, should.Resemble, expectedScannedOutput)
 }
 
 func (this *ScanAllFixture) TestCanonicalWithOptions() {
-	scanned := this.scanAll(csvCanonRequiringConfigOptions, Comma(';'), Comment('#'))
+	scanned := this.scanAll(csvCanonRequiringConfigOptions, Options.Comma(';'), Options.Comment('#'))
 	this.So(scanned, should.Resemble, expectedScannedOutput)
 }
 
 func (this *ScanAllFixture) TestOptions() {
-	scanner := NewScanner(nil, ReuseRecord(true), TrimLeadingSpace(true), LazyQuotes(true))
+	scanner := NewScanner(nil, Options.ReuseRecord(true), Options.TrimLeadingSpace(true), Options.LazyQuotes(true))
 	this.So(scanner.reader.ReuseRecord, should.BeTrue)
 	this.So(scanner.reader.LazyQuotes, should.BeTrue)
 	this.So(scanner.reader.TrimLeadingSpace, should.BeTrue)
 }
 
 func (this *ScanAllFixture) TestInconsistentFieldCounts_ContinueOnError() {
-	scanned := this.scanAll(csvCanonInconsistentFieldCounts, ContinueOnError(true))
+	scanned := this.scanAll(csvCanonInconsistentFieldCounts, Options.ContinueOnError(true))
 	this.So(scanned, should.Resemble, []Record{
 		{line: 1, record: []string{"1", "2", "3"}, err: nil},
 		{line: 2, record: []string{"1", "2", "3", "4"}, err: &csv.ParseError{StartLine: 2, Line: 2, Column: 1, Err: csv.ErrFieldCount}},
@@ -72,7 +72,7 @@ func (this *ScanAllFixture) TestInconsistentFieldCounts_HaltOnError() {
 }
 
 func (this *ScanAllFixture) TestCallsToScanAfterEOFReturnFalse() {
-	scanner := NewScanner(strings.NewReader("1,2,3"), Comma(','))
+	scanner := NewScanner(strings.NewReader("1,2,3"), Options.Comma(','))
 
 	this.So(scanner.Scan(), should.BeTrue)
 	this.So(scanner.Record(), should.Resemble, []string{"1", "2", "3"})
@@ -86,7 +86,7 @@ func (this *ScanAllFixture) TestCallsToScanAfterEOFReturnFalse() {
 }
 
 func (this *ScanAllFixture) TestSkipHeader() {
-	scanned := this.scanAll(csvCanon, Comma(','), SkipHeaderRecord())
+	scanned := this.scanAll(csvCanon, Options.Comma(','), Options.SkipHeaderRecord())
 	this.So(scanned, should.Resemble, []Record{
 		{line: 1, record: []string{"Rob", "Pike", "rob"}},
 		{line: 2, record: []string{"Ken", "Thompson", "ken"}},
@@ -95,7 +95,7 @@ func (this *ScanAllFixture) TestSkipHeader() {
 }
 
 func (this *ScanAllFixture) TestRecords() {
-	scanned := this.scanAll(csvCanon, Comma(','), SkipRecords(3))
+	scanned := this.scanAll(csvCanon, Options.Comma(','), Options.SkipRecords(3))
 	this.So(scanned, should.Resemble, []Record{
 		{line: 1, record: []string{"Robert", "Griesemer", "gri"}},
 	})

fields/example_test.go

@@ -5,7 +5,7 @@ import (
 	"log"
 	"strings"
 
-	"github.com/smarty/scanners/fields"
+	"github.com/smarty/scanners/v2/fields"
 )
 
 // Justification of fields should not affect the scanned values.

fixedwidth/example_test.go

@@ -5,7 +5,7 @@ import (
 	"log"
 	"strings"
 
-	fw "github.com/smarty/scanners/fixedwidth"
+	fw "github.com/smarty/scanners/v2/fixedwidth"
 )
 
 func ExampleScanner() {

go.mod

@@ -1,4 +1,4 @@
-module github.com/smarty/scanners
+module github.com/smarty/scanners/v2
 
 go 1.17