package fejkdata import ( crand "crypto/rand" "encoding/binary" "errors" "fmt" "io/fs" "math/rand/v2" "os" "reflect" "sort" "sync" ) // MaxRepeat caps a repeat, and caps the renders nested repeats multiply to along // any one path; the CLI's --repeat shares it. const MaxRepeat = 1 << 20 var _ [^uint(0)>>63 - 1]struct{} // docs/decisions.md#64-bit-targets-only // ErrNoData is returned by New when no source is loaded at all. var ErrNoData = errors.New("no data: WithoutShippedData needs at least one WithDataPath or WithDataFS") // Generator generates fake data from a namespace tree. Create one with [New]. // It is safe for concurrent use; a seeded sequence is reproducible only when drawn // from one goroutine. type Generator struct { // mu guards rand, records, structs and root, which gains a shipped category on the // first call reaching it. mu sync.Mutex rand *generatorState root folder // the categories as the node a path walks from, owned here so a walk allocates none records map[node]recordShape structs map[reflect.Type]structResult } // generatorState is one generator's draw state, kept across its renders: the seeded rng plus // the {seq()} counters. type generatorState struct { *rand.Rand counters map[string]uint64 } func (s *generatorState) next(key string) uint64 { s.counters[key]++ return s.counters[key] } type config struct { seed uint64 seeded bool shipped bool sources []dataSource } // Option configures a [Generator]. type Option func(*config) // WithSeed makes output reproducible: two generators with the same seed, version and // data emit identical sequences. func WithSeed(seed uint64) Option { return func(c *config) { c.seed, c.seeded = seed, true } } // WithDataPath layers a data directory over what is loaded before it. Repeat it to // layer several; the last wins a name clash. func WithDataPath(dir string) Option { return func(c *config) { c.sources = append(c.sources, dataSource{fsys: os.DirFS(dir), label: dir, onDisk: true, diskPath: dir}) } } // WithDataFS layers a data tree held in an [fs.FS], such as an embed.FS of your own. func WithDataFS(fsys fs.FS) Option { return func(c *config) { c.sources = append(c.sources, dataSource{fsys: fsys}) } } // WithoutShippedData leaves the shipped data set out, so only the sources given // with [WithDataPath] and [WithDataFS] load. func WithoutShippedData() Option { return func(c *config) { c.shipped = false } } // New builds a generator from the shipped data set and the options' sources, merged // in order with the last winning a name clash. Each JSON file becomes a category // named after the file (address.json -> "address") and each subdirectory a // namespace segment. It errors on a missing directory, invalid JSON, invalid data, // or no data at all. With only the shipped data, a category loads on the first call // reaching it; with WithDataPath or WithDataFS, every category loads here. func New(opts ...Option) (*Generator, error) { c := config{shipped: true} for _, opt := range opts { opt(&c) } root, err := c.load() if err != nil { return nil, fmt.Errorf("fejkdata: %w", err) } rng, err := newRand(c.seed, c.seeded) if err != nil { return nil, fmt.Errorf("fejkdata: %w", err) } return &Generator{rand: rng, root: root}, nil } // load is the tree New starts from. // docs/decisions.md#with-only-the-shipped-set-a-category-loads-on-the-first-call-reaching-it-beside-a---data-path-every-category-loads-in-new func (c config) load() (folder, error) { if c.shipped && len(c.sources) == 0 { return unloadedTree(), nil } var sources []dataSource if c.shipped { sources = append(sources, shippedSource) } sources = append(sources, c.sources...) if len(sources) == 0 { return folder{}, ErrNoData } cats, err := loadData(sources) return folder{children: cats}, err } // List returns the sorted dotted paths Fake renders: each category and every field, // column and linked table below it, a direct descent at a time. A choice consumes no // segment, so a path continues through one only where every variant carries it. func (f *Generator) List() []string { f.mu.Lock() defer f.mu.Unlock() out := paths(&f.root) sort.Strings(out) return out } // paths lists the dot paths addressable from n, relative to it, where "" is n // itself. A folder has no value of its own, so it contributes only its children's. func paths(n node) []string { switch n := n.(type) { case *folder: var out []string for _, name := range sortedNames(n.children) { for _, p := range paths(n.children[name]) { out = append(out, join(name, p)) } } for _, name := range sortedNames(n.unloaded) { for _, p := range n.unloaded[name].paths { out = append(out, join(name, p)) } } return out case *template: out := []string{""} for _, name := range sortedNames(n.fields) { for _, p := range paths(n.fields[name]) { out = append(out, join(name, p)) } } return out case *nullItem: return []string{""} case *table: return tablePaths(n) case *tableColumn, *tableRow: return []string{""} case *choice: out := []string{""} for p := range n.shared { out = append(out, p) } return out default: panic(internalError("paths has no case for node %T", n)) } } // tablePaths is a table's columns, then each table linked to it under its name: the // direct descents, a step at a time. func tablePaths(t *table) []string { out := append([]string{""}, t.header...) sort.Strings(out[1:]) for _, name := range sortedNames(t.children) { for _, p := range paths(t.children[name]) { out = append(out, join(name, p)) } } return out } // sharedPaths is the sub-paths every item carries — the only ones a path may step // through a choice to reach. It intersects, bailing as soon as the set // is empty, which is immediate for a choice of plain strings. func sharedPaths(items []node) map[string]bool { shared := subPaths(items[0]) for _, it := range items[1:] { if len(shared) == 0 { return nil } next := subPaths(it) for p := range shared { if !next[p] { delete(shared, p) } } } return shared } // subPaths is paths(n) as a set, without the empty path that means n itself. func subPaths(n node) map[string]bool { out := map[string]bool{} for _, p := range paths(n) { if p != "" { out[p] = true } } return out } func join(prefix, name string) string { switch { case prefix == "": return name case name == "": return prefix } return prefix + "." + name } // randomBytes seeds an unseeded generator. var randomBytes = crand.Read func newRand(seed uint64, seeded bool) (*generatorState, error) { var r *rand.Rand if seeded { r = rand.New(rand.NewPCG(seed, seed^0x9e3779b97f4a7c15)) } else { var b [16]byte if _, err := randomBytes(b[:]); err != nil { return nil, fmt.Errorf("seeding from crypto/rand: %w", err) } r = rand.New(rand.NewPCG(binary.LittleEndian.Uint64(b[:8]), binary.LittleEndian.Uint64(b[8:]))) } return &generatorState{Rand: r, counters: map[string]uint64{}}, nil } func internalError(format string, a ...any) string { return "fejkdata: internal error: " + fmt.Sprintf(format, a...) }