Giter Site home page Giter Site logo

lithammer / shortuuid Goto Github PK

View Code? Open in Web Editor NEW
1.1K 11.0 55.0 105 KB

:mushroom: A generator library for concise, unambiguous and URL-safe UUIDs

Home Page: https://pkg.go.dev/github.com/lithammer/shortuuid/v4

License: MIT License

Go 100.00%
shortuuid uuid go golang

shortuuid's Introduction

shortuuid

Build Status Godoc

A Go library that generates concise, unambiguous, URL-safe UUIDs. Based on and compatible with the Python library shortuuid.

Often, one needs to use non-sequential IDs in places where users will see them, but the IDs must be as concise and easy to use as possible. shortuuid solves this problem by generating UUIDs using google/uuid and then translating them to base57 using lowercase and uppercase letters and digits, and removing similar-looking characters such as l, 1, I, O and 0.

Usage

package main

import (
	"fmt"

	"github.com/lithammer/shortuuid/v4"
)

func main() {
	u := shortuuid.New()
	fmt.Println(u) // KwSysDpxcBU9FNhGkn2dCf
}

To use UUID v5 (instead of the default v4), use NewWithNamespace(name string) instead of New().

shortuuid.NewWithNamespace("http://example.com")

It's possible to use a custom alphabet as well, though it has to be 57 characters long.

alphabet := "23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxy="
shortuuid.NewWithAlphabet(alphabet) // iZsai==fWebXd5rLRWFB=u

Bring your own encoder! For example, base58 is popular among bitcoin.

package main

import (
	"fmt"

	"github.com/btcsuite/btcutil/base58"
	"github.com/google/uuid"
	"github.com/lithammer/shortuuid/v4"
)

type base58Encoder struct{}

func (enc base58Encoder) Encode(u uuid.UUID) string {
	return base58.Encode(u[:])
}

func (enc base58Encoder) Decode(s string) (uuid.UUID, error) {
	return uuid.FromBytes(base58.Decode(s))
}

func main() {
	enc := base58Encoder{}
	fmt.Println(shortuuid.NewWithEncoder(enc)) // 6R7VqaQHbzC1xwA5UueGe6
}

License

MIT

shortuuid's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

shortuuid's Issues

Why base57?

Support for custom character length alphabets

Now we can custom alphabets with 57 lengths limited by base57 inside.

Can we support custom character length alphabets? The logic should be similar to base57 except the output length will be changed.

not enough arguments in call to uuid.Must

After bumping this lib with dep, I get the following error:

vendor/github.com/renstrom/shortuuid/shortuuid.go:21:40: not enough arguments in call to uuid.Must
	have (uuid.UUID)
	want (uuid.UUID, error)

Seems to affect v2.0.1

cannot find package "github.com/lithammer/shortuuid/v3"

Hello
I tried the example on README:

package main

import (
    "fmt"

    "github.com/lithammer/shortuuid/v3"
)

func main() {
    u := shortuuid.New() // Cekw67uyMpBGZLRP2HFVbe
}

When I run:

go get -t -v ./...

I got this error:

github.com/lithammer/shortuuid (download)
cannot find package "github.com/lithammer/shortuuid/v3" in any of:
	/usr/local/go/src/github.com/lithammer/shortuuid/v3 (from $GOROOT)
	/home/marcos/go/src/github.com/lithammer/shortuuid/v3 (from $GOPATH)

but the package is available in: /home/marcos/go/src/github.com/lithammer/shortuuid

what was my mistake?

Using a 0 instead of an error in alphabet.Index

It results in a bug, where the first character of the alphabet is always considered as non-present. PR #2 adds an error return value to the function, integrates it with the others and includes tests for this case. Thus fixing this issue.

go get error

PS C:\Users\Anla-E\Desktop> go get github.com/renstrom/shortuuid
# github.com/renstrom/shortuuid
..\go\src\github.com\renstrom\shortuuid\shortuuid.go:21:30: too many arguments in call to DefaultEncoder.Encode
        have (uuid.UUID, error)
        want (uuid.UUID)
..\go\src\github.com\renstrom\shortuuid\shortuuid.go:26:19: too many arguments in call to enc.Encode
        have (uuid.UUID, error)
        want (uuid.UUID)
..\go\src\github.com\renstrom\shortuuid\shortuuid.go:35:17: multiple-value uuid.NewV4() in single-value context
..\go\src\github.com\renstrom\shortuuid\shortuuid.go:49:19: too many arguments in call to enc.Encode
        have (uuid.UUID, error)
        want (uuid.UUID)

`Encode()` produces wrong value when low half of UUID is zero

base57.numToString() uses number.Uint64() which is undefined if number
"cannot be represented in a uint64" which is the case since it starts off containing a 128 bit integer.

This causes incorrect encoding of any UUID whose low half bits are all zero (along with any other cases where those bits were zero after some number of divisions by b.alphabet.Length()).

00000000-0000-0000-8000-000000000000 encodes to "z7C8BNkRBVT22", but 00000000-0000-0001-0000-000000000000 erroneously encodes to "2222222222222" which clashes with the encoding of 00000000-0000-0000-0000-000000000000 as opposed to the expected "yDNELiVqLxt22".

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.