Add relative date support (#10)

Author: mortenson

.github/workflows/lint.yml

@@ -20,4 +20,4 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.60.1
+          version: v1.64.5

README.md

@@ -43,12 +43,13 @@ For more (sometimes wildly complex) examples, see `./testdata`.
 
 ## More on valueFuncs
 
-valueFuncs allow you to generate random data that's seeded with a static string. This ensures that repeat runs of ripoff are deterministic, which enables upserts (consistent primary keys).
+Most valueFuncs allow you to generate random data that's seeded with a static string. This ensures that repeat runs of ripoff are deterministic, which enables upserts (consistent primary keys).
 
 ripoff provides:
 
 - `uuid(seedString)` - generates a v1 UUID
 - `int(seedString)` - generates an integer (note: might be awkward on auto incrementing tables)
+- `naturalDate(human readable text)` - generates a date using syntax defined by [go-naturaldate](https://github.com/tj/go-naturaldate), for example `naturalDate(one day ago)` (note: non-deterministic)
 
 and also all functions from [gofakeit](https://github.com/brianvoe/gofakeit?tab=readme-ov-file#functions) that have no arguments and return a string (called in camelcase, ex: `email(seedString)`). For the full list, see `./gofakeit.go`.
 

db.go

@@ -10,12 +10,14 @@ import (
 	"math/rand"
 	"regexp"
 	"strings"
+	"time"
 
 	"github.com/brianvoe/gofakeit/v7"
 	"github.com/dominikbraun/graph"
 	"github.com/google/uuid"
 	"github.com/jackc/pgx/v5"
 	"github.com/lib/pq"
+	"github.com/tj/go-naturaldate"
 )
 
 // Runs ripoff from start to finish, without committing the transaction.
@@ -117,6 +119,7 @@ func prepareValue(rawValue string) (string, error) {
 	}
 	methodName := valueFuncMatches[1]
 	value := valueFuncMatches[2]
+	valueParts := strings.Split(strings.ReplaceAll(" ", "", valueFuncMatches[2]), ",")
 
 	// Create a new random seed based on a sha256 hash of the value.
 	h := sha256.New()
@@ -136,11 +139,14 @@ func prepareValue(rawValue string) (string, error) {
 		return fmt.Sprint(randSeed.Int()), nil
 	case "literal":
 		return value, nil
+	case "naturalDate":
+		parsed, err := naturaldate.Parse(value, time.Now())
+		return parsed.Format(time.RFC3339), err
 	}
 
 	// Assume the user meant to call a gofakeit.Faker method.
 	faker := gofakeit.NewFaker(randSeed, true)
-	fakerResult, err := callFakerMethod(methodName, faker)
+	fakerResult, err := callFakerMethod(methodName, faker, valueParts...)
 	if err != nil {
 		return "", err
 	}

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/jackc/pgx/v5 v5.6.0
 	github.com/lib/pq v1.10.9
 	github.com/stretchr/testify v1.9.0
+	github.com/tj/go-naturaldate v1.3.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
@@ -21,7 +22,7 @@ require (
 	github.com/kr/text v0.2.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rogpeppe/go-internal v1.12.0 // indirect
-	golang.org/x/crypto v0.17.0 // indirect
+	golang.org/x/crypto v0.21.0 // indirect
 	golang.org/x/sync v0.3.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 )

go.sum

@@ -28,18 +28,24 @@ github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU
 github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
-golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
+github.com/tj/assert v0.0.0-20190920132354-ee03d75cd160 h1:NSWpaDaurcAJY7PkL8Xt0PhZE7qpvbZl5ljd8r6U0bI=
+github.com/tj/assert v0.0.0-20190920132354-ee03d75cd160/go.mod h1:mZ9/Rh9oLWpLLDRpvE+3b7gP/C2YyLFYxNmcLnPTMe0=
+github.com/tj/go-naturaldate v1.3.0 h1:OgJIPkR/Jk4bFMBLbxZ8w+QUxwjqSvzd9x+yXocY4RI=
+github.com/tj/go-naturaldate v1.3.0/go.mod h1:rpUbjivDKiS1BlfMGc2qUKNZ/yxgthOfmytQs8d8hKk=
+golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
+golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
 golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E=
 golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

gofakeit.go

@@ -2,18 +2,42 @@ package ripoff
 
 import (
 	"fmt"
+	"strconv"
 
 	"github.com/brianvoe/gofakeit/v7"
 )
 
+// Helper method to cast user-supplied args to ints if provided.
+func defaultArgsInt(args []string, defaults []int) ([]int, error) {
+	if len(args) != len(defaults) {
+		return defaults, nil
+	}
+	ret := make([]int, len(defaults))
+	for i := 0; i < len(defaults); i++ {
+		argInt, err := strconv.Atoi(args[i])
+		if err != nil {
+			return []int{}, err
+		}
+		ret[i] = argInt
+	}
+	return ret, nil
+}
+
 // Calls a `func() string` shaped method in a given faker instance.
-func callFakerMethod(method string, faker *gofakeit.Faker) (string, error) {
+func callFakerMethod(method string, faker *gofakeit.Faker, args ...string) (string, error) {
 	switch method {
-	// Note: added these in for my own use, probably should let valueFuncs take multiple params
 	case "loremIpsumSentence":
-		return faker.LoremIpsumSentence(20), nil
+		argsInt, err := defaultArgsInt(args[1:], []int{20})
+		if err != nil {
+			return "", err
+		}
+		return faker.LoremIpsumSentence(argsInt[0]), nil
 	case "loremIpsumParagraph":
-		return faker.LoremIpsumParagraph(1, 4, 20, ""), nil
+		argsInt, err := defaultArgsInt(args[1:], []int{1, 4, 20})
+		if err != nil {
+			return "", err
+		}
+		return faker.LoremIpsumParagraph(argsInt[0], argsInt[1], argsInt[2], ""), nil
 	case "achAccount":
 		return faker.AchAccount(), nil
 	case "achRouting":

testdata/import/faker/faker.yml

@@ -1,3 +1,4 @@
 rows:
   users:uuid(fooBar):
     email: email(fooBar)
+    last_logged_in_at: naturalDate(10 days ago)

testdata/import/faker/schema.sql

@@ -1,5 +1,6 @@
 CREATE TABLE users (
   id UUID NOT NULL,
   email TEXT NOT NULL,
+  last_logged_in_at TIMESTAMPTZ NOT NULL,
   PRIMARY KEY (id)
 );

testdata/import/faker/validate.sql

@@ -2,6 +2,7 @@ WITH test AS (
   SELECT count(*) as count FROM users
   WHERE email = '[email protected]'
   AND id = '6b30cfb0-a35b-4584-a035-1334515f846b'
+  AND date_trunc('day', last_logged_in_at) = date_trunc('day', now() - interval '10 days')
 )
-SELECT (select count from test),'email: ' || users.email || ' id: ' || users.id
+SELECT (select count from test),'email: ' || users.email || ' id: ' || users.id || ' last_logged_in_at: ' || users.last_logged_in_at
 FROM users;