Refactor structure

Author: nhooyr

internal/slogfmt/humanfmt.go renamed to internal/entryhuman/entry.go

@@ -1,5 +1,6 @@
-// Package slogfmt contains the code to format slog.SinkEntry.
-package slogfmt
+// Package entryhuman contains the code to format slog.SinkEntry
+// for humans.
+package entryhuman
 
 import (
 	"bytes"
@@ -8,7 +9,6 @@ import (
 	"io"
 	"os"
 	"path/filepath"
-	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -21,11 +21,6 @@ import (
 	"cdr.dev/slog"
 )
 
-// FilterJSONField filters the json field f from j.
-func FilterJSONField(j, f string) string {
-	return regexp.MustCompile(`"`+f+`":[^,]+,`).ReplaceAllString(j, "")
-}
-
 // StripTimestamp strips the timestamp from entry and returns
 // it and the rest of the entry.
 func StripTimestamp(ent string) (time.Time, string, error) {
@@ -47,14 +42,14 @@ func c(w io.Writer, attrs ...color.Attribute) *color.Color {
 	return c
 }
 
-// HumanEntry returns a human readable format for ent.
+// Fmt returns a human readable format for ent.
 //
 // We never return with a trailing newline because Go's testing framework adds one
 // automatically and if we include one, then we'll get two newlines.
 // We also do not indent the fields as go's test does that automatically
 // for extra lines in a log so if we did it here, the fields would be indented
 // twice in test logs. So the Stderr logger indents all the fields itself.
-func HumanEntry(w io.Writer, ent slog.SinkEntry) string {
+func Fmt(w io.Writer, ent slog.SinkEntry) string {
 	var ents string
 	ts := ent.Time.Format(TimeFormat)
 	ents += ts + " "

internal/slogfmt/humanfmt_test.go renamed to internal/entryhuman/entry_test.go

@@ -1,4 +1,4 @@
-package slogfmt_test
+package entryhuman_test
 
 import (
 	"io/ioutil"
@@ -9,7 +9,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/internal/assert"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryhuman"
 )
 
 var kt = time.Date(2000, time.February, 5, 4, 4, 4, 4, time.UTC)
@@ -18,7 +18,7 @@ func TestEntry(t *testing.T) {
 	t.Parallel()
 
 	test := func(t *testing.T, in slog.SinkEntry, exp string) {
-		act := slogfmt.HumanEntry(ioutil.Discard, in)
+		act := entryhuman.Fmt(ioutil.Discard, in)
 		assert.Equal(t, exp, act, "entry")
 	}
 
@@ -71,7 +71,7 @@ line2`)
 	t.Run("color", func(t *testing.T) {
 		t.Parallel()
 
-		act := slogfmt.HumanEntry(slogfmt.ForceColorWriter, slog.SinkEntry{
+		act := entryhuman.Fmt(entryhuman.ForceColorWriter, slog.SinkEntry{
 			Level: slog.LevelCritical,
 			Fields: slog.M(
 				slog.F("hey", "hi"),

internal/slogfmt/export_test.go renamed to internal/entryhuman/export_test.go

@@ -1,3 +1,3 @@
-package slogfmt
+package entryhuman
 
 var ForceColorWriter = forceColorWriter

internal/slogfmt/json.go renamed to internal/entryhuman/json.go

@@ -1,4 +1,4 @@
-package slogfmt
+package entryhuman
 
 import (
 	"bytes"

internal/entryjson/slogjson.go

@@ -0,0 +1,10 @@
+package entryjson
+
+import (
+	"regexp"
+)
+
+// Filter filters the json field f from j.
+func Filter(j, f string) string {
+	return regexp.MustCompile(`"`+f+`":[^,]+,`).ReplaceAllString(j, "")
+}

s_test.go

@@ -6,7 +6,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/internal/assert"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryhuman"
 	"cdr.dev/slog/sloggers/sloghuman"
 )
 
@@ -20,7 +20,7 @@ func TestStdlib(t *testing.T) {
 	stdlibLog := slog.Stdlib(bg, l)
 	stdlibLog.Println("stdlib")
 
-	et, rest, err := slogfmt.StripTimestamp(b.String())
+	et, rest, err := entryhuman.StripTimestamp(b.String())
 	assert.Success(t, err, "strip timestamp")
 	assert.False(t, et.IsZero(), "timestamp")
 	assert.Equal(t, " [INFO]\t(stdlib)\t<s_test.go:21>\tstdlib\t{\"hi\": \"we\"}\n", rest, "entry")

sloggers/sloghuman/sloghuman.go

@@ -10,7 +10,7 @@ import (
 	"golang.org/x/xerrors"
 
 	"cdr.dev/slog"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryhuman"
 	"cdr.dev/slog/internal/syncwriter"
 )
 
@@ -31,7 +31,7 @@ type humanSink struct {
 }
 
 func (s humanSink) LogEntry(ctx context.Context, ent slog.SinkEntry) error {
-	str := slogfmt.HumanEntry(s.w2, ent)
+	str := entryhuman.Fmt(s.w2, ent)
 	lines := strings.Split(str, "\n")
 
 	// We need to add 4 spaces before every field line for readability.

sloggers/sloghuman/sloghuman_test.go

@@ -7,7 +7,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/internal/assert"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryhuman"
 	"cdr.dev/slog/sloggers/sloghuman"
 )
 
@@ -21,7 +21,7 @@ func TestMake(t *testing.T) {
 	l.Info(bg, "line1\n\nline2", slog.F("wowow", "me\nyou"))
 	l.Sync()
 
-	et, rest, err := slogfmt.StripTimestamp(b.String())
+	et, rest, err := entryhuman.StripTimestamp(b.String())
 	assert.Success(t, err, "strip timestamp")
 	assert.False(t, et.IsZero(), "timestamp")
 	assert.Equal(t, " [INFO]\t<sloghuman_test.go:21>\t...\t{\"wowow\": \"me\\nyou\"}\n  \"msg\": line1\n\n  line2\n", rest, "entry")

sloggers/slogjson/slogjson_test.go

@@ -11,7 +11,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/internal/assert"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryjson"
 	"cdr.dev/slog/sloggers/slogjson"
 )
 
@@ -27,7 +27,7 @@ func TestMake(t *testing.T) {
 	l := slogjson.Make(b)
 	l.Error(ctx, "line1\n\nline2", slog.F("wowow", "me\nyou"))
 
-	j := slogfmt.FilterJSONField(b.String(), "ts")
+	j := entryjson.Filter(b.String(), "ts")
 	exp := fmt.Sprintf(`{"level":"ERROR","component":"","msg":"line1\n\nline2","caller":"%v:28","func":"cdr.dev/slog/sloggers/slogjson_test.TestMake","trace":"%v","span":"%v","fields":{"wowow":"me\nyou"}}
 `, slogjsonTestFile, s.SpanContext().TraceID, s.SpanContext().SpanID)
 	assert.Equal(t, exp, j, "entry")

sloggers/slogstackdriver/slogstackdriver_test.go

@@ -12,7 +12,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/internal/assert"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryjson"
 	"cdr.dev/slog/sloggers/slogstackdriver"
 )
 
@@ -30,7 +30,7 @@ func TestStackdriver(t *testing.T) {
 	l = l.Named("meow")
 	l.Error(ctx, "line1\n\nline2", slog.F("wowow", "me\nyou"))
 
-	j := slogfmt.FilterJSONField(b.String(), "timestamp")
+	j := entryjson.Filter(b.String(), "timestamp")
 	exp := fmt.Sprintf(`{"severity":"ERROR","message":"line1\n\nline2","logging.googleapis.com/sourceLocation":"file:\"%v\" line:31 function:\"cdr.dev/slog/sloggers/slogstackdriver_test.TestStackdriver\" ","logging.googleapis.com/operation":"producer:\"meow\" ","logging.googleapis.com/trace":"projects//traces/%v","logging.googleapis.com/spanId":"%v","logging.googleapis.com/trace_sampled":false,"logging.googleapis.com/labels":{"label":2},"wowow":"me\nyou"}
 `, slogstackdriverTestFile, s.SpanContext().TraceID, s.SpanContext().SpanID)
 	assert.Equal(t, exp, j, "entry")