xkit

xkit

The xkit Go package is a collection of handy functions and types, practically put in themed packages mimicking the Go standard library.

xkit is for personal projects the creator is working on. They can be handy for others, hence open sourced. Bugs can be reported and ideas/feature requests are appreciated.

Copyright (c) 2020, 2021, Geert JM Vanderkelen

Installation

go get github.com/geertjanvdk/xkit

Dependencies are kept to a minimum (see go.mod). In fact, most of what is in xkit is to prevent dependencies.

Overview

• xutil - sometimes silly functions like finding an int in a slice, but also OrderedMap which is map keeping order
• xsql - wrapper around the MySQL Go driver (the only dependency in xkit); providing handy things like HaveTrigger, HaveTable, etc..
• xpath - handy tools like IsRegularFile or IsDir, or FilesInDir.
• xnet - tools around networking like GetTCPPort and IsEmailAddress (which is very opinionated what an email address is)
• xid - the author does not like UUID because they are usually misused; this packages contains next to UUID implementation also nanoid
• xgraphql - writing a GraphQL client is easy; writing it over and over again is tedious
• xansi - basic ANSI things, mostly styling and coloring text
• xvenv - virtual environment tools; for example to figure out whether the application runs in a Docker container or not

xhttp - HTTP tools

The xhttp wraps around the Go http package offering a xhttp.Client which makes it a bit easier to communicate with, for example, web APIs.

It also offers xhttp.ServeReMux which is a multiplexer (mux) that uses regular expressions and can restrict HTTP methods. It can also capture values similar as what is provided by Django.

Example:

mux := xhttp.NewServeReMux()
mux.Handle("^/images", web.Static(), xhttp.MethodGet)
mux.Handle("^/person/<int:id>", PersonHandler(), xhttp.MethodGet)
mux.Handle("^/$", web.Home{}, xhttp.MethodGet)

In the PersonHandler() from above example, one would then access the captured value like this:

captures, ok := ctx.Value(xhttp.CapturesContextKey).(*xhttp.Captures)
fmt.Println("Person ID:", captures["id"].AsInt64())

xlog - logging

Heavily inspired by logrus (no longer maintained), this package provides the minimum for making logging a bit more enjoyable in Go. Some formatters might be added later on, but the text (with colors) and JSON formatters are in most cases enough.

xt - unit testing

Quite a few testing frameworks exists with fancy features, and pretty much all based on the stock Go testing package.

The xkit.xt package wraps also around the stock Go testing package providing just the basics:

• OK & KO functions to test whether error is returned
• Eq check equality (no, there is no Not-Eq)
• Assert checking if condition is true (can be used for anything, and is actually a wrapper around Eq)
• Panics checks if a function that must panic actually panics
• Match is probably something too much: uses regular expression to match a string

Example:

// excerpt from xkit.xlog.entry_test.go
func TestEntry_UnmarshalJSON(t *testing.T) {
    t.Run("field as time.Time", func (t *testing.T) {
        r, ok := (e).Fields["someTime"].(time.Time)
        xt.Assert(t, ok, "field is not time.Time")
        xt.Eq(t, now, r)
    })
}

Contributing

xkit is used for personal project, and meant to inspire others to start their own. That said, contributions, bug reports, features requests are welcome.

License

MIT licensed: see LICENSE.txt.