✨ switch from code gen to package

Author: jxlxx

.goreleaser.yaml

@@ -3,14 +3,7 @@ before:
     - go mod tidy
 
 builds:
-  - env:
-      - CGO_ENABLED=0
-    ldflags:
-      - -s -w -X github.com/jxlxx/geid.Version={{.Version}}
-    goos:
-      - linux
-      - windows
-      - darwin
+  - skip: true
 
 archives:
   - format: tar.gz

README.md

@@ -8,7 +8,7 @@ Example: `ab-ce093c1`
 
 - :sparkles: Optional prefixes: IDs will be of the form `prefix-*`
 - :sparkles: Safe to use with goroutines: New IDs require data from a counter which has a lock
-- :sparkles: Safe to use with multiple machines: Each ID requires a "machine ID" int coming from the environment
+- :sparkles: Safe to use with multiple machines: Can set a unique "Machine ID" for each instance
 - :sparkles: Optional custom epoch: Can override the default epoch of January 1st, 1970
 
 ## Install
@@ -17,122 +17,50 @@ Example: `ab-ce093c1`
 go install github.com/jxlxx/geid@latest
 ```
 
-## Configuration
-
-Epoch is optional. The default epoch is January 1st, 1970.
-
-```yaml
-package: animals
-epoch:
-  year: 2024
-  month: 6
-  day: 14
-ids:
-  - name: Cat
-    prefix: cat-
-  - name: Dog
-    prefix: dog-
-  - name: something # this id will not have a prefix 
-```
-
 ## Getting Started
 
-Generate code:
-
-```sh
-geid -c config.yaml > ids.go
-```
+Epoch is optional. The default epoch is January 1st, 1970. Setting the epoch to a later date means short IDs.
 
-Generated code:
+MachineID is optional. The default machine ID is "1". This is useful if you have many instances of identical
+ID generators running at the same time.
 
 ```go
-package animals
+package main
 
 import (
 	"fmt"
-	"log"
-	"os"
-	"strconv"
-	"sync"
 	"time"
-)
 
-const CatIDPrefix = "cat-"
-const DogIDPrefix = "dog-"
-const somethingIDPrefix = ""
-
-func newCatID() string {
-	return fmt.Sprintf("%s%s", CatIDPrefix, generateCode())
-}
-
-func newDogID() string {
-	return fmt.Sprintf("%s%s", DogIDPrefix, generateCode())
-}
-
-func newsomethingID() string {
-	return fmt.Sprintf("%s%s", somethingIDPrefix, generateCode())
-}
-
-func generateCode() string {
-	s := getSequenceNumber()
-	t := getSecondsSinceEpoch()
-	m := getMachineID()
-	hex := fmt.Sprintf("%x%x%x", s, t, m)
-	return hex
-}
-
-type Counter struct {
-	mu sync.Mutex
-	x  int
-}
+	"github.com/jxlxx/geid"
+)
 
-var counter = Counter{}
+type Cat struct{}
 
-func getSequenceNumber() int {
-	counter.mu.Lock()
-	defer counter.mu.Unlock()
-	counter.x = (counter.x + 1) % 4096
-	return counter.x + 170 // adding 170 so that the first few IDs are prettier
+func (c Cat) Prefix() string {
+	return "cat-"
 }
 
-var customEpoch = time.Date(2024, time.June, 14, 0, 0, 0, 0, time.UTC).Unix()
+func main() {
+	c := Cat{}
+	g := geid.New(c)
 
-func getSecondsSinceEpoch() int64 {
-	return time.Now().Unix() - customEpoch
-}
+	t := time.Now()
+	geid.SetCustomEpoch(time.Date(t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second(), t.Nanosecond(), time.UTC))
 
-func getMachineID() int {
-	machineID := mustGetEnv("MACHINE_ID")
-	i, err := strconv.Atoi(machineID)
-	if err != nil {
-		log.Fatalf("cannot parse machine id into int. (MACHINE_ID = %s) ", machineID)
+	for i := 0; i < 100; i++ {
+		fmt.Println(g.NewID())
 	}
-	return i
-}
-
-func mustGetEnv(key string) string {
-	v, ok := os.LookupEnv(key)
-	if !ok {
-		log.Fatalf("%s environment key not found.\n", key)
-	}
-	return v
 }
 ```
+
 ## Examples
 
 ```sh
 cat-ab-ce093c1
 cat-ac-ce093c1
 cat-ad-ce093c1
-dog-ae-ce093c1
-dog-af-ce093c1
-dog-b0-ce093c1
-b1-ce093c1
-b2-ce093c1
-b3-ce093c1
 ```
 
-
 ## Design
 
 The implementation is loosely based on the following article: [Creating User-Facing, Short Unique IDs: What are the options? - Hwee Lin Yeo, Alexandra](https://medium.com/teamocard/creating-user-facing-short-unique-id-ids-what-are-the-options-464a19283d98)

Taskfile.yml

@@ -8,11 +8,6 @@ vars:
   VERSION: v0.0.{{ .VERSION_NUMBER }}
 
 tasks:
-  build:
-    description: build a local binary
-    cmds:
-      - go build -o bin/geid -ldflags="-s -w -X github.com/jxlxx/geid.Version={{.VERSION}}"
-
   release:
     cmds:
       - goreleaser release --clean

example/main.go

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/jxlxx/geid"
+)
+
+type Cat struct{}
+
+func (c Cat) Prefix() string {
+	return "cat-"
+}
+
+func main() {
+	c := Cat{}
+	g := geid.New(c)
+
+	t := time.Now()
+	geid.SetCustomEpoch(time.Date(t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second(), t.Nanosecond(), time.UTC))
+
+	for i := 0; i < 100; i++ {
+		fmt.Println(g.NewID())
+	}
+}

geid.go

@@ -0,0 +1,62 @@
+package geid
+
+import (
+	"fmt"
+	"sync"
+	"time"
+)
+
+type Prefix interface {
+	Prefix() string
+}
+
+type Generator struct {
+	prefix string
+}
+
+func New(p Prefix) *Generator {
+	return &Generator{
+		prefix: p.Prefix(),
+	}
+}
+
+func (i Generator) NewID() string {
+	return fmt.Sprintf("%s%s", i.prefix, generateCode())
+}
+
+var machineID = "1"
+
+func SetMachineID(s string) {
+	machineID = s
+}
+
+var epoch = time.Date(0, 0, 0, 0, 0, 0, 0, time.UTC).Unix()
+
+func SetCustomEpoch(t time.Time) {
+	epoch = t.Unix()
+}
+
+func getSecondsSinceEpoch() int64 {
+	return time.Now().Unix() - epoch
+}
+
+func generateCode() string {
+	s := getSequenceNumber()
+	t := getSecondsSinceEpoch()
+	hex := fmt.Sprintf("%x%x%x", s, t, machineID)
+	return hex
+}
+
+type Counter struct {
+	mu sync.Mutex
+	x  int
+}
+
+var counter = Counter{}
+
+func getSequenceNumber() int {
+	counter.mu.Lock()
+	defer counter.mu.Unlock()
+	counter.x = (counter.x + 1) % 4096
+	return counter.x + 170
+}

go.mod

@@ -1,8 +1,3 @@
 module github.com/jxlxx/geid
 
 go 1.21.4
-
-require (
-	github.com/spf13/pflag v1.0.5
-	gopkg.in/yaml.v3 v3.0.1
-)

go.sum

@@ -1,6 +0,0 @@
-github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
-github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=