refactor to use package zero instead of null, and null instead of nuller

This commit is contained in:
Greg 2014-09-02 03:22:17 +09:00
parent 53ccf98d65
commit 406494f0f8
17 changed files with 1326 additions and 209 deletions

View file

@ -1,59 +1,58 @@
## null [![GoDoc](https://godoc.org/github.com/guregu/null?status.svg)](https://godoc.org/github.com/guregu/null) [![Coverage](http://gocover.io/_badge/github.com/guregu/null)](http://gocover.io/github.com/guregu/null) ## null [![GoDoc](https://godoc.org/github.com/guregu/null?status.svg)](https://godoc.org/github.com/guregu/null) [![Coverage](http://gocover.io/_badge/github.com/guregu/null)](http://gocover.io/github.com/guregu/null)
`import "gopkg.in/guregu/null.v1"` `import "gopkg.in/guregu/null.v2"`
null is a library with opinions on how to deal with nullable SQL and JSON values null is a library with opinions on how to deal with nullable SQL and JSON values
There are two packages: `null` and `nuller`. There are two packages: `null` and its subpackage `zero`.
Types in `null` are treated like zero values in Go: blank string input will produce a null `null.String`, and null Strings will JSON encode to `""`. If you need zero and null treated the same, use these. Types in `null` will only be considered null on null input, and will JSON encode to `null`. If you need zero and null be considered separate values, use these.
Types in `nuller` will only be considered null on null input, and will JSON encode to `null`. If you need zero and null be considered separate values, use these. Types in `zero` are treated like zero values in Go: blank string input will produce a null `null.String`, and null Strings will JSON encode to `""`. If you need zero and null treated the same, use these.
All types implement `sql.Scanner` and `driver.Valuer`, so you can use this library in place of `sql.NullXXX`. All types also implement: `encoding.TextMarshaler`, `encoding.TextUnmarshaler`, `json.Marshaler`, and `json.Unmarshaler`. All types implement `sql.Scanner` and `driver.Valuer`, so you can use this library in place of `sql.NullXXX`. All types also implement: `encoding.TextMarshaler`, `encoding.TextUnmarshaler`, `json.Marshaler`, and `json.Unmarshaler`.
#### null.String #### zero.String
A nullable string. A nullable string.
Will marshal to a blank string if null. Blank string input produces a null String. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullString` JSON input. Will marshal to a blank string if null. Blank string input produces a null String. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullString` JSON input.
#### null.Int #### zero.Int
A nullable int64. A nullable int64.
Will marshal to 0 if null. Blank string or 0 input produces a null Int. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullInt64` JSON input. Will marshal to 0 if null. Blank string or 0 input produces a null Int. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullInt64` JSON input.
#### null.Float #### zero.Float
A nullable float64. A nullable float64.
Will marshal to 0 if null. Blank string or 0 input produces a null Float. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullFloat64` JSON input. Will marshal to 0 if null. Blank string or 0 input produces a null Float. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullFloat64` JSON input.
#### null.Bool #### zero.Bool
A nullable bool. A nullable bool.
Will marshal to false if null. Blank string or false input produces a null Float. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullBool` JSON input. Will marshal to false if null. Blank string or false input produces a null Float. In other words, null values and empty values are considered equivalent. Can unmarshal from `sql.NullBool` JSON input.
#### nuller.String #### null.String
An even nuller nullable string. An even nuller nullable string.
Unlike `null.String`, `nuller.String` will marshal to null if null. Zero (blank) input will not produce a null String. Can unmarshal from `sql.NullString` JSON input. Unlike `zero.String`, `null.String` will marshal to null if null. Zero (blank) input will not produce a null String. Can unmarshal from `sql.NullString` JSON input.
#### nuller.Int #### null.Int
An even nuller nullable int64. An even nuller nullable int64.
Unlike `null.Int`, `nuller.Int` will marshal to null if null. Zero input will not produce a null Int. Can unmarshal from `sql.NullInt64` JSON input. Unlike `zero.Int`, `null.Int` will marshal to null if null. Zero input will not produce a null Int. Can unmarshal from `sql.NullInt64` JSON input.
#### nuller.Float #### null.Float
An even nuller nullable float64. An even nuller nullable float64.
Unlike `null.Float`, `nuller.Float` will marshal to null if null. Zero input will not produce a null Float. Can unmarshal from `sql.NullFloat64` JSON input. Unlike `zero.Float`, `null.Float` will marshal to null if null. Zero input will not produce a null Float. Can unmarshal from `sql.NullFloat64` JSON input.
#### nuller.Bool #### null.Bool
An even nuller nullable float64. An even nuller nullable float64.
Unlike `null.Bool`, `nuller.Bool` will marshal to null if null. False input will not produce a null Bool. Can unmarshal from `sql.NullBool` JSON input. Unlike `zero.Bool`, `null.Bool` will marshal to null if null. False input will not produce a null Bool. Can unmarshal from `sql.NullBool` JSON input.
### Bugs ### Bugs
`json`'s `",omitempty"` struct tag does not work correctly right now. It will never omit a null or empty String. This should be [fixed in Go 1.4](https://code.google.com/p/go/issues/detail?id=4357). `json`'s `",omitempty"` struct tag does not work correctly right now. It will never omit a null or empty String. This should be [fixed in Go 1.4](https://code.google.com/p/go/issues/detail?id=4357).
### License ### License
BSD BSD

40
bool.go
View file

@ -6,7 +6,9 @@ import (
"errors" "errors"
) )
// Bool is a nullable bool. // Bool is an even nuller nullable bool.
// It does not consider false values to be null.
// It will decode to null, not false, if null.
type Bool struct { type Bool struct {
sql.NullBool sql.NullBool
} }
@ -21,12 +23,12 @@ func NewBool(b bool, valid bool) Bool {
} }
} }
// BoolFrom creates a new Bool that will be null if false. // BoolFrom creates a new Bool that will always be valid.
func BoolFrom(b bool) Bool { func BoolFrom(b bool) Bool {
return NewBool(b, b) return NewBool(b, true)
} }
// BoolFromPtr creates a new Bool that be null if b is nil. // BoolFromPtr creates a new String that be null if f is nil.
func BoolFromPtr(b *bool) Bool { func BoolFromPtr(b *bool) Bool {
if b == nil { if b == nil {
return NewBool(false, false) return NewBool(false, false)
@ -35,7 +37,8 @@ func BoolFromPtr(b *bool) Bool {
} }
// UnmarshalJSON implements json.Unmarshaler. // UnmarshalJSON implements json.Unmarshaler.
// "false" will be considered a null Bool. // It supports number and null input.
// 0 will not be considered a null Bool.
// It also supports unmarshalling a sql.NullBool. // It also supports unmarshalling a sql.NullBool.
func (b *Bool) UnmarshalJSON(data []byte) error { func (b *Bool) UnmarshalJSON(data []byte) error {
var err error var err error
@ -50,13 +53,13 @@ func (b *Bool) UnmarshalJSON(data []byte) error {
b.Valid = false b.Valid = false
return nil return nil
} }
b.Valid = (err == nil) && b.Bool b.Valid = err == nil
return err return err
} }
// UnmarshalText implements encoding.TextUnmarshaler. // UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null Bool if the input is a false or not a bool. // It will unmarshal to a null Bool if the input is a blank or not an integer.
// It will return an error if the input is not a float, blank, or "null". // It will return an error if the input is not an integer, blank, or "null".
func (b *Bool) UnmarshalText(text []byte) error { func (b *Bool) UnmarshalText(text []byte) error {
str := string(text) str := string(text)
switch str { switch str {
@ -71,23 +74,29 @@ func (b *Bool) UnmarshalText(text []byte) error {
b.Valid = false b.Valid = false
return errors.New("invalid input:" + str) return errors.New("invalid input:" + str)
} }
b.Valid = b.Bool b.Valid = true
return nil return nil
} }
// MarshalJSON implements json.Marshaler. // MarshalJSON implements json.Marshaler.
// It will encode null if this Bool is null. // It will encode null if this Bool is null.
func (b Bool) MarshalJSON() ([]byte, error) { func (b Bool) MarshalJSON() ([]byte, error) {
if !b.Valid || !b.Bool { if !b.Valid {
return []byte("null"), nil
}
if !b.Bool {
return []byte("false"), nil return []byte("false"), nil
} }
return []byte("true"), nil return []byte("true"), nil
} }
// MarshalText implements encoding.TextMarshaler. // MarshalText implements encoding.TextMarshaler.
// It will encode a zero if this Bool is null. // It will encode a blank string if this Bool is null.
func (b Bool) MarshalText() ([]byte, error) { func (b Bool) MarshalText() ([]byte, error) {
if !b.Valid || !b.Bool { if !b.Valid {
return []byte{}, nil
}
if !b.Bool {
return []byte("false"), nil return []byte("false"), nil
} }
return []byte("true"), nil return []byte("true"), nil
@ -99,7 +108,7 @@ func (b *Bool) SetValid(v bool) {
b.Valid = true b.Valid = true
} }
// Ptr returns a poBooler to this Bool's value, or a nil poBooler if this Bool is null. // Ptr returns a pointer to this Bool's value, or a nil pointer if this Bool is null.
func (b Bool) Ptr() *bool { func (b Bool) Ptr() *bool {
if !b.Valid { if !b.Valid {
return nil return nil
@ -107,7 +116,8 @@ func (b Bool) Ptr() *bool {
return &b.Bool return &b.Bool
} }
// IsZero returns true for null or zero Bools, for future omitempty support (Go 1.4?) // IsZero returns true for invalid Bools, for future omitempty support (Go 1.4?)
// A non-null Bool with a 0 value will not be considered zero.
func (b Bool) IsZero() bool { func (b Bool) IsZero() bool {
return !b.Valid || !b.Bool return !b.Valid
} }

View file

@ -9,7 +9,6 @@ var (
boolJSON = []byte(`true`) boolJSON = []byte(`true`)
falseJSON = []byte(`false`) falseJSON = []byte(`false`)
nullBoolJSON = []byte(`{"Bool":true,"Valid":true}`) nullBoolJSON = []byte(`{"Bool":true,"Valid":true}`)
invalidJSON = []byte(`:)`)
) )
func TestBoolFrom(t *testing.T) { func TestBoolFrom(t *testing.T) {
@ -17,14 +16,14 @@ func TestBoolFrom(t *testing.T) {
assertBool(t, b, "BoolFrom()") assertBool(t, b, "BoolFrom()")
zero := BoolFrom(false) zero := BoolFrom(false)
if zero.Valid { if !zero.Valid {
t.Error("BoolFrom(false)", "is valid, but should be invalid") t.Error("BoolFrom(false)", "is invalid, but should be valid")
} }
} }
func TestBoolFromPtr(t *testing.T) { func TestBoolFromPtr(t *testing.T) {
v := true n := true
bptr := &v bptr := &n
b := BoolFromPtr(bptr) b := BoolFromPtr(bptr)
assertBool(t, b, "BoolFromPtr()") assertBool(t, b, "BoolFromPtr()")
@ -36,41 +35,29 @@ func TestUnmarshalBool(t *testing.T) {
var b Bool var b Bool
err := json.Unmarshal(boolJSON, &b) err := json.Unmarshal(boolJSON, &b)
maybePanic(err) maybePanic(err)
assertBool(t, b, "float json") assertBool(t, b, "bool json")
var nb Bool var nb Bool
err = json.Unmarshal(nullBoolJSON, &nb) err = json.Unmarshal(nullBoolJSON, &nb)
maybePanic(err) maybePanic(err)
assertBool(t, nb, "sql.NullBool json") assertBool(t, nb, "sq.NullBool json")
var zero Bool
err = json.Unmarshal(falseJSON, &zero)
maybePanic(err)
assertNullBool(t, zero, "zero json")
var null Bool var null Bool
err = json.Unmarshal(nullJSON, &null) err = json.Unmarshal(nullJSON, &null)
maybePanic(err) maybePanic(err)
assertNullBool(t, null, "null json") assertNullBool(t, null, "null json")
var invalid Bool
err = invalid.UnmarshalText(invalidJSON)
if err == nil {
panic("err should not be nil")
}
assertNullBool(t, invalid, "invalid json")
} }
func TestTextUnmarshalBool(t *testing.T) { func TestTextUnmarshalBool(t *testing.T) {
var b Bool var b Bool
err := b.UnmarshalText(boolJSON) err := b.UnmarshalText([]byte("true"))
maybePanic(err) maybePanic(err)
assertBool(t, b, "UnmarshalText() bool") assertBool(t, b, "UnmarshalText() bool")
var zero Bool var zero Bool
err = zero.UnmarshalText(falseJSON) err = zero.UnmarshalText([]byte("false"))
maybePanic(err) maybePanic(err)
assertNullBool(t, zero, "UnmarshalText() zero bool") assertFalseBool(t, zero, "UnmarshalText() false")
var blank Bool var blank Bool
err = blank.UnmarshalText([]byte("")) err = blank.UnmarshalText([]byte(""))
@ -78,9 +65,16 @@ func TestTextUnmarshalBool(t *testing.T) {
assertNullBool(t, blank, "UnmarshalText() empty bool") assertNullBool(t, blank, "UnmarshalText() empty bool")
var null Bool var null Bool
err = null.UnmarshalText(nullJSON) err = null.UnmarshalText([]byte("null"))
maybePanic(err) maybePanic(err)
assertNullBool(t, null, `UnmarshalText() "null"`) assertNullBool(t, null, `UnmarshalText() "null"`)
var invalid Bool
err = invalid.UnmarshalText([]byte(":D"))
if err == nil {
panic("err should not be nil")
}
assertNullBool(t, invalid, "invalid json")
} }
func TestMarshalBool(t *testing.T) { func TestMarshalBool(t *testing.T) {
@ -89,11 +83,16 @@ func TestMarshalBool(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "true", "non-empty json marshal") assertJSONEquals(t, data, "true", "non-empty json marshal")
// invalid values should be encoded as false zero := NewBool(false, true)
data, err = json.Marshal(zero)
maybePanic(err)
assertJSONEquals(t, data, "false", "zero json marshal")
// invalid values should be encoded as null
null := NewBool(false, false) null := NewBool(false, false)
data, err = json.Marshal(null) data, err = json.Marshal(null)
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "false", "null json marshal") assertJSONEquals(t, data, "null", "null json marshal")
} }
func TestMarshalBoolText(t *testing.T) { func TestMarshalBoolText(t *testing.T) {
@ -102,11 +101,16 @@ func TestMarshalBoolText(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "true", "non-empty text marshal") assertJSONEquals(t, data, "true", "non-empty text marshal")
// invalid values should be encoded as zero zero := NewBool(false, true)
data, err = zero.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "false", "zero text marshal")
// invalid values should be encoded as null
null := NewBool(false, false) null := NewBool(false, false)
data, err = null.MarshalText() data, err = null.MarshalText()
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "false", "null text marshal") assertJSONEquals(t, data, "", "null text marshal")
} }
func TestBoolPointer(t *testing.T) { func TestBoolPointer(t *testing.T) {
@ -135,8 +139,8 @@ func TestBoolIsZero(t *testing.T) {
} }
zero := NewBool(false, true) zero := NewBool(false, true)
if !zero.IsZero() { if zero.IsZero() {
t.Errorf("IsZero() should be true") t.Errorf("IsZero() should be false")
} }
} }
@ -161,7 +165,16 @@ func TestBoolScan(t *testing.T) {
func assertBool(t *testing.T, b Bool, from string) { func assertBool(t *testing.T, b Bool, from string) {
if b.Bool != true { if b.Bool != true {
t.Errorf("bad %s bool: %d ≠ %d\n", from, b.Bool, true) t.Errorf("bad %s bool: %v ≠ %v\n", from, b.Bool, true)
}
if !b.Valid {
t.Error(from, "is invalid, but should be valid")
}
}
func assertFalseBool(t *testing.T, b Bool, from string) {
if b.Bool != false {
t.Errorf("bad %s bool: %v ≠ %v\n", from, b.Bool, false)
} }
if !b.Valid { if !b.Valid {
t.Error(from, "is invalid, but should be valid") t.Error(from, "is invalid, but should be valid")

View file

@ -6,7 +6,9 @@ import (
"strconv" "strconv"
) )
// Float is a nullable float64. // Float is an even nuller nullable float64.
// It does not consider zero values to be null.
// It will decode to null, not zero, if null.
type Float struct { type Float struct {
sql.NullFloat64 sql.NullFloat64
} }
@ -21,12 +23,12 @@ func NewFloat(f float64, valid bool) Float {
} }
} }
// FloatFrom creates a new Float that will be null if zero. // FloatFrom creates a new Float that will always be valid.
func FloatFrom(f float64) Float { func FloatFrom(f float64) Float {
return NewFloat(f, f != 0) return NewFloat(f, true)
} }
// FloatFromPtr creates a new Float that be null if f is nil. // FloatFromPtr creates a new String that be null if f is nil.
func FloatFromPtr(f *float64) Float { func FloatFromPtr(f *float64) Float {
if f == nil { if f == nil {
return NewFloat(0, false) return NewFloat(0, false)
@ -36,7 +38,7 @@ func FloatFromPtr(f *float64) Float {
// UnmarshalJSON implements json.Unmarshaler. // UnmarshalJSON implements json.Unmarshaler.
// It supports number and null input. // It supports number and null input.
// 0 will be considered a null Float. // 0 will not be considered a null Float.
// It also supports unmarshalling a sql.NullFloat64. // It also supports unmarshalling a sql.NullFloat64.
func (f *Float) UnmarshalJSON(data []byte) error { func (f *Float) UnmarshalJSON(data []byte) error {
var err error var err error
@ -44,20 +46,20 @@ func (f *Float) UnmarshalJSON(data []byte) error {
json.Unmarshal(data, &v) json.Unmarshal(data, &v)
switch x := v.(type) { switch x := v.(type) {
case float64: case float64:
f.Float64 = x f.Float64 = float64(x)
case map[string]interface{}: case map[string]interface{}:
err = json.Unmarshal(data, &f.NullFloat64) err = json.Unmarshal(data, &f.NullFloat64)
case nil: case nil:
f.Valid = false f.Valid = false
return nil return nil
} }
f.Valid = (err == nil) && (f.Float64 != 0) f.Valid = err == nil
return err return err
} }
// UnmarshalText implements encoding.TextUnmarshaler. // UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null Float if the input is a blank, zero, or not a float. // It will unmarshal to a null Float if the input is a blank or not an integer.
// It will return an error if the input is not a float, blank, or "null". // It will return an error if the input is not an integer, blank, or "null".
func (f *Float) UnmarshalText(text []byte) error { func (f *Float) UnmarshalText(text []byte) error {
str := string(text) str := string(text)
if str == "" || str == "null" { if str == "" || str == "null" {
@ -66,37 +68,35 @@ func (f *Float) UnmarshalText(text []byte) error {
} }
var err error var err error
f.Float64, err = strconv.ParseFloat(string(text), 64) f.Float64, err = strconv.ParseFloat(string(text), 64)
f.Valid = (err == nil) && (f.Float64 != 0) f.Valid = err == nil
return err return err
} }
// MarshalJSON implements json.Marshaler. // MarshalJSON implements json.Marshaler.
// It will encode null if this Float is null. // It will encode null if this Float is null.
func (f Float) MarshalJSON() ([]byte, error) { func (f Float) MarshalJSON() ([]byte, error) {
n := f.Float64
if !f.Valid { if !f.Valid {
n = 0 return []byte("null"), nil
} }
return []byte(strconv.FormatFloat(n, 'f', -1, 64)), nil return []byte(strconv.FormatFloat(f.Float64, 'f', -1, 64)), nil
} }
// MarshalText implements encoding.TextMarshaler. // MarshalText implements encoding.TextMarshaler.
// It will encode a zero if this Float is null. // It will encode a blank string if this Float is null.
func (f Float) MarshalText() ([]byte, error) { func (f Float) MarshalText() ([]byte, error) {
n := f.Float64
if !f.Valid { if !f.Valid {
n = 0 return []byte{}, nil
} }
return []byte(strconv.FormatFloat(n, 'f', -1, 64)), nil return []byte(strconv.FormatFloat(f.Float64, 'f', -1, 64)), nil
} }
// SetValid changes this Float's value and also sets it to be non-null. // SetValid changes this Float's value and also sets it to be non-null.
func (f *Float) SetValid(v float64) { func (f *Float) SetValid(n float64) {
f.Float64 = v f.Float64 = n
f.Valid = true f.Valid = true
} }
// Ptr returns a poFloater to this Float's value, or a nil poFloater if this Float is null. // Ptr returns a pointer to this Float's value, or a nil pointer if this Float is null.
func (f Float) Ptr() *float64 { func (f Float) Ptr() *float64 {
if !f.Valid { if !f.Valid {
return nil return nil
@ -104,7 +104,8 @@ func (f Float) Ptr() *float64 {
return &f.Float64 return &f.Float64
} }
// IsZero returns true for null or zero Floats, for future omitempty support (Go 1.4?) // IsZero returns true for invalid Floats, for future omitempty support (Go 1.4?)
// A non-null Float with a 0 value will not be considered zero.
func (f Float) IsZero() bool { func (f Float) IsZero() bool {
return !f.Valid || f.Float64 == 0 return !f.Valid
} }

View file

@ -15,8 +15,8 @@ func TestFloatFrom(t *testing.T) {
assertFloat(t, f, "FloatFrom()") assertFloat(t, f, "FloatFrom()")
zero := FloatFrom(0) zero := FloatFrom(0)
if zero.Valid { if !zero.Valid {
t.Error("FloatFrom(0)", "is valid, but should be invalid") t.Error("FloatFrom(0)", "is invalid, but should be valid")
} }
} }
@ -39,12 +39,7 @@ func TestUnmarshalFloat(t *testing.T) {
var nf Float var nf Float
err = json.Unmarshal(nullFloatJSON, &nf) err = json.Unmarshal(nullFloatJSON, &nf)
maybePanic(err) maybePanic(err)
assertFloat(t, nf, "sql.NullFloat64 json") assertFloat(t, nf, "sq.NullFloat64 json")
var zero Float
err = json.Unmarshal(zeroJSON, &zero)
maybePanic(err)
assertNullFloat(t, zero, "zero json")
var null Float var null Float
err = json.Unmarshal(nullJSON, &null) err = json.Unmarshal(nullJSON, &null)
@ -58,11 +53,6 @@ func TestTextUnmarshalFloat(t *testing.T) {
maybePanic(err) maybePanic(err)
assertFloat(t, f, "UnmarshalText() float") assertFloat(t, f, "UnmarshalText() float")
var zero Float
err = zero.UnmarshalText([]byte("0"))
maybePanic(err)
assertNullFloat(t, zero, "UnmarshalText() zero float")
var blank Float var blank Float
err = blank.UnmarshalText([]byte("")) err = blank.UnmarshalText([]byte(""))
maybePanic(err) maybePanic(err)
@ -80,11 +70,11 @@ func TestMarshalFloat(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "1.2345", "non-empty json marshal") assertJSONEquals(t, data, "1.2345", "non-empty json marshal")
// invalid values should be encoded as 0 // invalid values should be encoded as null
null := NewFloat(0, false) null := NewFloat(0, false)
data, err = json.Marshal(null) data, err = json.Marshal(null)
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "0", "null json marshal") assertJSONEquals(t, data, "null", "null json marshal")
} }
func TestMarshalFloatText(t *testing.T) { func TestMarshalFloatText(t *testing.T) {
@ -93,24 +83,24 @@ func TestMarshalFloatText(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "1.2345", "non-empty text marshal") assertJSONEquals(t, data, "1.2345", "non-empty text marshal")
// invalid values should be encoded as zero // invalid values should be encoded as null
null := NewFloat(0, false) null := NewFloat(0, false)
data, err = null.MarshalText() data, err = null.MarshalText()
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "0", "null text marshal") assertJSONEquals(t, data, "", "null text marshal")
} }
func TestFloatPointer(t *testing.T) { func TestFloatPointer(t *testing.T) {
f := FloatFrom(1.2345) f := FloatFrom(1.2345)
ptr := f.Ptr() ptr := f.Ptr()
if *ptr != 1.2345 { if *ptr != 1.2345 {
t.Errorf("bad %s Float: %#v ≠ %s\n", "pointer", ptr, 1.2345) t.Errorf("bad %s float: %#v ≠ %s\n", "pointer", ptr, 1.2345)
} }
null := NewFloat(0, false) null := NewFloat(0, false)
ptr = null.Ptr() ptr = null.Ptr()
if ptr != nil { if ptr != nil {
t.Errorf("bad %s Float: %#v ≠ %s\n", "nil pointer", ptr, "nil") t.Errorf("bad %s float: %#v ≠ %s\n", "nil pointer", ptr, "nil")
} }
} }
@ -126,8 +116,8 @@ func TestFloatIsZero(t *testing.T) {
} }
zero := NewFloat(0, true) zero := NewFloat(0, true)
if !zero.IsZero() { if zero.IsZero() {
t.Errorf("IsZero() should be true") t.Errorf("IsZero() should be false")
} }
} }

38
int.go
View file

@ -6,7 +6,9 @@ import (
"strconv" "strconv"
) )
// Int is a nullable int64. // Int is an even nuller nullable int64.
// It does not consider zero values to be null.
// It will decode to null, not zero, if null.
type Int struct { type Int struct {
sql.NullInt64 sql.NullInt64
} }
@ -21,9 +23,9 @@ func NewInt(i int64, valid bool) Int {
} }
} }
// IntFrom creates a new Int that will be null if zero. // IntFrom creates a new Int that will always be valid.
func IntFrom(i int64) Int { func IntFrom(i int64) Int {
return NewInt(i, i != 0) return NewInt(i, true)
} }
// IntFromPtr creates a new String that be null if i is nil. // IntFromPtr creates a new String that be null if i is nil.
@ -31,13 +33,12 @@ func IntFromPtr(i *int64) Int {
if i == nil { if i == nil {
return NewInt(0, false) return NewInt(0, false)
} }
n := NewInt(*i, true) return NewInt(*i, true)
return n
} }
// UnmarshalJSON implements json.Unmarshaler. // UnmarshalJSON implements json.Unmarshaler.
// It supports number and null input. // It supports number and null input.
// 0 will be considered a null Int. // 0 will not be considered a null Int.
// It also supports unmarshalling a sql.NullInt64. // It also supports unmarshalling a sql.NullInt64.
func (i *Int) UnmarshalJSON(data []byte) error { func (i *Int) UnmarshalJSON(data []byte) error {
var err error var err error
@ -52,12 +53,12 @@ func (i *Int) UnmarshalJSON(data []byte) error {
i.Valid = false i.Valid = false
return nil return nil
} }
i.Valid = (err == nil) && (i.Int64 != 0) i.Valid = err == nil
return err return err
} }
// UnmarshalText implements encoding.TextUnmarshaler. // UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null Int if the input is a blank, zero, or not an integer. // It will unmarshal to a null Int if the input is a blank or not an integer.
// It will return an error if the input is not an integer, blank, or "null". // It will return an error if the input is not an integer, blank, or "null".
func (i *Int) UnmarshalText(text []byte) error { func (i *Int) UnmarshalText(text []byte) error {
str := string(text) str := string(text)
@ -67,28 +68,26 @@ func (i *Int) UnmarshalText(text []byte) error {
} }
var err error var err error
i.Int64, err = strconv.ParseInt(string(text), 10, 64) i.Int64, err = strconv.ParseInt(string(text), 10, 64)
i.Valid = (err == nil) && (i.Int64 != 0) i.Valid = err == nil
return err return err
} }
// MarshalJSON implements json.Marshaler. // MarshalJSON implements json.Marshaler.
// It will encode 0 if this Int is null. // It will encode null if this Int is null.
func (i Int) MarshalJSON() ([]byte, error) { func (i Int) MarshalJSON() ([]byte, error) {
n := i.Int64
if !i.Valid { if !i.Valid {
n = 0 return []byte("null"), nil
} }
return []byte(strconv.FormatInt(n, 10)), nil return []byte(strconv.FormatInt(i.Int64, 10)), nil
} }
// MarshalText implements encoding.TextMarshaler. // MarshalText implements encoding.TextMarshaler.
// It will encode a zero if this Int is null. // It will encode a blank string if this Int is null.
func (i Int) MarshalText() ([]byte, error) { func (i Int) MarshalText() ([]byte, error) {
n := i.Int64
if !i.Valid { if !i.Valid {
n = 0 return []byte{}, nil
} }
return []byte(strconv.FormatInt(n, 10)), nil return []byte(strconv.FormatInt(i.Int64, 10)), nil
} }
// SetValid changes this Int's value and also sets it to be non-null. // SetValid changes this Int's value and also sets it to be non-null.
@ -105,7 +104,8 @@ func (i Int) Ptr() *int64 {
return &i.Int64 return &i.Int64
} }
// IsZero returns true for null or zero Ints, for future omitempty support (Go 1.4?) // IsZero returns true for invalid Ints, for future omitempty support (Go 1.4?)
// A non-null Int with a 0 value will not be considered zero.
func (i Int) IsZero() bool { func (i Int) IsZero() bool {
return !i.Valid || i.Int64 == 0 return !i.Valid
} }

View file

@ -8,7 +8,6 @@ import (
var ( var (
intJSON = []byte(`12345`) intJSON = []byte(`12345`)
nullIntJSON = []byte(`{"Int64":12345,"Valid":true}`) nullIntJSON = []byte(`{"Int64":12345,"Valid":true}`)
zeroJSON = []byte(`0`)
) )
func TestIntFrom(t *testing.T) { func TestIntFrom(t *testing.T) {
@ -16,8 +15,8 @@ func TestIntFrom(t *testing.T) {
assertInt(t, i, "IntFrom()") assertInt(t, i, "IntFrom()")
zero := IntFrom(0) zero := IntFrom(0)
if zero.Valid { if !zero.Valid {
t.Error("IntFrom(0)", "is valid, but should be invalid") t.Error("IntFrom(0)", "is invalid, but should be valid")
} }
} }
@ -40,12 +39,7 @@ func TestUnmarshalInt(t *testing.T) {
var ni Int var ni Int
err = json.Unmarshal(nullIntJSON, &ni) err = json.Unmarshal(nullIntJSON, &ni)
maybePanic(err) maybePanic(err)
assertInt(t, ni, "sql.NullInt64 json") assertInt(t, ni, "sq.NullInt64 json")
var zero Int
err = json.Unmarshal(zeroJSON, &zero)
maybePanic(err)
assertNullInt(t, zero, "zero json")
var null Int var null Int
err = json.Unmarshal(nullJSON, &null) err = json.Unmarshal(nullJSON, &null)
@ -59,11 +53,6 @@ func TestTextUnmarshalInt(t *testing.T) {
maybePanic(err) maybePanic(err)
assertInt(t, i, "UnmarshalText() int") assertInt(t, i, "UnmarshalText() int")
var zero Int
err = zero.UnmarshalText([]byte("0"))
maybePanic(err)
assertNullInt(t, zero, "UnmarshalText() zero int")
var blank Int var blank Int
err = blank.UnmarshalText([]byte("")) err = blank.UnmarshalText([]byte(""))
maybePanic(err) maybePanic(err)
@ -81,11 +70,11 @@ func TestMarshalInt(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "12345", "non-empty json marshal") assertJSONEquals(t, data, "12345", "non-empty json marshal")
// invalid values should be encoded as 0 // invalid values should be encoded as null
null := NewInt(0, false) null := NewInt(0, false)
data, err = json.Marshal(null) data, err = json.Marshal(null)
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "0", "null json marshal") assertJSONEquals(t, data, "null", "null json marshal")
} }
func TestMarshalIntText(t *testing.T) { func TestMarshalIntText(t *testing.T) {
@ -94,11 +83,11 @@ func TestMarshalIntText(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "12345", "non-empty text marshal") assertJSONEquals(t, data, "12345", "non-empty text marshal")
// invalid values should be encoded as zero // invalid values should be encoded as null
null := NewInt(0, false) null := NewInt(0, false)
data, err = null.MarshalText() data, err = null.MarshalText()
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, "0", "null text marshal") assertJSONEquals(t, data, "", "null text marshal")
} }
func TestIntPointer(t *testing.T) { func TestIntPointer(t *testing.T) {
@ -127,11 +116,18 @@ func TestIntIsZero(t *testing.T) {
} }
zero := NewInt(0, true) zero := NewInt(0, true)
if !zero.IsZero() { if zero.IsZero() {
t.Errorf("IsZero() should be true") t.Errorf("IsZero() should be false")
} }
} }
func TestIntSetValid(t *testing.T) {
change := NewInt(0, false)
assertNullInt(t, change, "SetValid()")
change.SetValid(12345)
assertInt(t, change, "SetValid()")
}
func TestIntScan(t *testing.T) { func TestIntScan(t *testing.T) {
var i Int var i Int
err := i.Scan(12345) err := i.Scan(12345)
@ -144,13 +140,6 @@ func TestIntScan(t *testing.T) {
assertNullInt(t, null, "scanned null") assertNullInt(t, null, "scanned null")
} }
func TestIntSetValid(t *testing.T) {
change := NewInt(0, false)
assertNullInt(t, change, "SetValid()")
change.SetValid(12345)
assertInt(t, change, "SetValid()")
}
func assertInt(t *testing.T, i Int, from string) { func assertInt(t *testing.T, i Int, from string) {
if i.Int64 != 12345 { if i.Int64 != 12345 {
t.Errorf("bad %s int: %d ≠ %d\n", from, i.Int64, 12345) t.Errorf("bad %s int: %d ≠ %d\n", from, i.Int64, 12345)

View file

@ -1,7 +1,6 @@
// Package null provides a convenient way of handling null values. // Package null contains types that consider zero input and null input as separate values.
// Types in this package consider empty or zero input the same as null input. // Types in this package will always encode to their null value if null.
// Types in this package will encode to their zero value, even if null. // Use the zero subpackage if you want empty and null to be treated the same.
// Use the nuller subpackage if you don't want this.
package null package null
import ( import (
@ -9,11 +8,24 @@ import (
"encoding/json" "encoding/json"
) )
// String is a nullable string. // String is an even nuller nullable string.
type String struct { type String struct {
sql.NullString sql.NullString
} }
// StringFrom creates a new String that will never be blank.
func StringFrom(s string) String {
return NewString(s, true)
}
// StringFromPtr creates a new String that be null if s is nil.
func StringFromPtr(s *string) String {
if s == nil {
return NewString("", false)
}
return NewString(*s, true)
}
// NewString creates a new String // NewString creates a new String
func NewString(s string, valid bool) String { func NewString(s string, valid bool) String {
return String{ return String{
@ -24,20 +36,6 @@ func NewString(s string, valid bool) String {
} }
} }
// StringFrom creates a new String that will be null if s is blank.
func StringFrom(s string) String {
return NewString(s, s != "")
}
// StringFromPtr creates a new String that be null if s is nil or blank.
// It will make s point to the String's value.
func StringFromPtr(s *string) String {
if s == nil {
return NewString("", false)
}
return NewString(*s, *s != "")
}
// UnmarshalJSON implements json.Unmarshaler. // UnmarshalJSON implements json.Unmarshaler.
// It supports string and null input. Blank string input produces a null String. // It supports string and null input. Blank string input produces a null String.
// It also supports unmarshalling a sql.NullString. // It also supports unmarshalling a sql.NullString.
@ -58,13 +56,13 @@ func (s *String) UnmarshalJSON(data []byte) error {
return err return err
} }
// MarshalText implements encoding.TextMarshaler. // MarshalJSON implements json.Marshaler.
// It will encode a blank string when this String is null. // It will encode null if this String is null.
func (s String) MarshalText() ([]byte, error) { func (s String) MarshalJSON() ([]byte, error) {
if !s.Valid { if !s.Valid {
return []byte{}, nil return []byte("null"), nil
} }
return []byte(s.String), nil return json.Marshal(s.String)
} }
// UnmarshalText implements encoding.TextUnmarshaler. // UnmarshalText implements encoding.TextUnmarshaler.
@ -90,6 +88,7 @@ func (s String) Ptr() *string {
} }
// IsZero returns true for null or empty strings, for future omitempty support. (Go 1.4?) // IsZero returns true for null or empty strings, for future omitempty support. (Go 1.4?)
// Will return false s if blank but non-null.
func (s String) IsZero() bool { func (s String) IsZero() bool {
return !s.Valid || s.String == "" return !s.Valid
} }

View file

@ -20,8 +20,20 @@ func TestStringFrom(t *testing.T) {
str := StringFrom("test") str := StringFrom("test")
assertStr(t, str, "StringFrom() string") assertStr(t, str, "StringFrom() string")
null := StringFrom("") zero := StringFrom("")
assertNullStr(t, null, "StringFrom() empty string") if !zero.Valid {
t.Error("StringFrom(0)", "is invalid, but should be valid")
}
}
func TestStringFromPtr(t *testing.T) {
s := "test"
sptr := &s
str := StringFromPtr(sptr)
assertStr(t, str, "StringFromPtr() string")
null := StringFromPtr(nil)
assertNullStr(t, null, "StringFromPtr(nil)")
} }
func TestUnmarshalString(t *testing.T) { func TestUnmarshalString(t *testing.T) {
@ -64,11 +76,16 @@ func TestMarshalString(t *testing.T) {
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, `"test"`, "non-empty json marshal") assertJSONEquals(t, data, `"test"`, "non-empty json marshal")
// invalid values should be encoded as an empty string // empty values should be encoded as an empty string
null := StringFrom("") zero := StringFrom("")
data, err = json.Marshal(null) data, err = json.Marshal(zero)
maybePanic(err) maybePanic(err)
assertJSONEquals(t, data, `""`, "empty json marshal") assertJSONEquals(t, data, `""`, "empty json marshal")
null := StringFromPtr(nil)
data, err = json.Marshal(null)
maybePanic(err)
assertJSONEquals(t, data, `null`, "null json marshal")
} }
// Tests omitempty... broken until Go 1.4 // Tests omitempty... broken until Go 1.4
@ -86,46 +103,42 @@ func TestStringPointer(t *testing.T) {
t.Errorf("bad %s string: %#v ≠ %s\n", "pointer", ptr, "test") t.Errorf("bad %s string: %#v ≠ %s\n", "pointer", ptr, "test")
} }
null := StringFrom("") null := NewString("", false)
ptr = null.Ptr() ptr = null.Ptr()
if ptr != nil { if ptr != nil {
t.Errorf("bad %s string: %#v ≠ %s\n", "nil pointer", ptr, "nil") t.Errorf("bad %s string: %#v ≠ %s\n", "nil pointer", ptr, "nil")
} }
} }
func TestStringFromPointer(t *testing.T) {
test := "test"
testptr := &test
str := StringFromPtr(testptr)
assertStr(t, str, "StringFromPtr()")
testptr = nil
null := StringFromPtr(testptr)
assertNullStr(t, null, "StringFromPtr()")
ptr := null.Ptr()
if ptr != nil {
t.Errorf("bad %s string: %#v ≠ %s\n", "nil pointer", ptr, "nil")
}
}
func TestStringIsZero(t *testing.T) { func TestStringIsZero(t *testing.T) {
str := StringFrom("test") str := StringFrom("test")
if str.IsZero() { if str.IsZero() {
t.Errorf("IsZero() should be false") t.Errorf("IsZero() should be false")
} }
null := StringFrom("") blank := StringFrom("")
if !null.IsZero() { if blank.IsZero() {
t.Errorf("IsZero() should be true") t.Errorf("IsZero() should be false")
} }
empty := NewString("", true) empty := NewString("", true)
if !empty.IsZero() { if empty.IsZero() {
t.Errorf("IsZero() should be false")
}
null := StringFromPtr(nil)
if !null.IsZero() {
t.Errorf("IsZero() should be true") t.Errorf("IsZero() should be true")
} }
} }
func TestStringSetValid(t *testing.T) {
change := NewString("", false)
assertNullStr(t, change, "SetValid()")
change.SetValid("test")
assertStr(t, change, "SetValid()")
}
func TestStringScan(t *testing.T) { func TestStringScan(t *testing.T) {
var str String var str String
err := str.Scan("test") err := str.Scan("test")
@ -138,13 +151,6 @@ func TestStringScan(t *testing.T) {
assertNullStr(t, null, "scanned null") assertNullStr(t, null, "scanned null")
} }
func TestStringSetValid(t *testing.T) {
change := NewString("", false)
assertNullStr(t, change, "SetValid()")
change.SetValid("test")
assertStr(t, change, "SetValid()")
}
func maybePanic(err error) { func maybePanic(err error) {
if err != nil { if err != nil {
panic(err) panic(err)

113
zero/bool.go Normal file
View file

@ -0,0 +1,113 @@
package zero
import (
"database/sql"
"encoding/json"
"errors"
)
// Bool is a nullable bool.
type Bool struct {
sql.NullBool
}
// NewBool creates a new Bool
func NewBool(b bool, valid bool) Bool {
return Bool{
NullBool: sql.NullBool{
Bool: b,
Valid: valid,
},
}
}
// BoolFrom creates a new Bool that will be null if false.
func BoolFrom(b bool) Bool {
return NewBool(b, b)
}
// BoolFromPtr creates a new Bool that be null if b is nil.
func BoolFromPtr(b *bool) Bool {
if b == nil {
return NewBool(false, false)
}
return NewBool(*b, true)
}
// UnmarshalJSON implements json.Unmarshaler.
// "false" will be considered a null Bool.
// It also supports unmarshalling a sql.NullBool.
func (b *Bool) UnmarshalJSON(data []byte) error {
var err error
var v interface{}
json.Unmarshal(data, &v)
switch x := v.(type) {
case bool:
b.Bool = x
case map[string]interface{}:
err = json.Unmarshal(data, &b.NullBool)
case nil:
b.Valid = false
return nil
}
b.Valid = (err == nil) && b.Bool
return err
}
// UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null Bool if the input is a false or not a bool.
// It will return an error if the input is not a float, blank, or "null".
func (b *Bool) UnmarshalText(text []byte) error {
str := string(text)
switch str {
case "", "null":
b.Valid = false
return nil
case "true":
b.Bool = true
case "false":
b.Bool = false
default:
b.Valid = false
return errors.New("invalid input:" + str)
}
b.Valid = b.Bool
return nil
}
// MarshalJSON implements json.Marshaler.
// It will encode null if this Bool is null.
func (b Bool) MarshalJSON() ([]byte, error) {
if !b.Valid || !b.Bool {
return []byte("false"), nil
}
return []byte("true"), nil
}
// MarshalText implements encoding.TextMarshaler.
// It will encode a zero if this Bool is null.
func (b Bool) MarshalText() ([]byte, error) {
if !b.Valid || !b.Bool {
return []byte("false"), nil
}
return []byte("true"), nil
}
// SetValid changes this Bool's value and also sets it to be non-null.
func (b *Bool) SetValid(v bool) {
b.Bool = v
b.Valid = true
}
// Ptr returns a poBooler to this Bool's value, or a nil poBooler if this Bool is null.
func (b Bool) Ptr() *bool {
if !b.Valid {
return nil
}
return &b.Bool
}
// IsZero returns true for null or zero Bools, for future omitempty support (Go 1.4?)
func (b Bool) IsZero() bool {
return !b.Valid || !b.Bool
}

175
zero/bool_test.go Normal file
View file

@ -0,0 +1,175 @@
package zero
import (
"encoding/json"
"testing"
)
var (
boolJSON = []byte(`true`)
falseJSON = []byte(`false`)
nullBoolJSON = []byte(`{"Bool":true,"Valid":true}`)
invalidJSON = []byte(`:)`)
)
func TestBoolFrom(t *testing.T) {
b := BoolFrom(true)
assertBool(t, b, "BoolFrom()")
zero := BoolFrom(false)
if zero.Valid {
t.Error("BoolFrom(false)", "is valid, but should be invalid")
}
}
func TestBoolFromPtr(t *testing.T) {
v := true
bptr := &v
b := BoolFromPtr(bptr)
assertBool(t, b, "BoolFromPtr()")
null := BoolFromPtr(nil)
assertNullBool(t, null, "BoolFromPtr(nil)")
}
func TestUnmarshalBool(t *testing.T) {
var b Bool
err := json.Unmarshal(boolJSON, &b)
maybePanic(err)
assertBool(t, b, "float json")
var nb Bool
err = json.Unmarshal(nullBoolJSON, &nb)
maybePanic(err)
assertBool(t, nb, "sql.NullBool json")
var zero Bool
err = json.Unmarshal(falseJSON, &zero)
maybePanic(err)
assertNullBool(t, zero, "zero json")
var null Bool
err = json.Unmarshal(nullJSON, &null)
maybePanic(err)
assertNullBool(t, null, "null json")
var invalid Bool
err = invalid.UnmarshalText(invalidJSON)
if err == nil {
panic("err should not be nil")
}
assertNullBool(t, invalid, "invalid json")
}
func TestTextUnmarshalBool(t *testing.T) {
var b Bool
err := b.UnmarshalText(boolJSON)
maybePanic(err)
assertBool(t, b, "UnmarshalText() bool")
var zero Bool
err = zero.UnmarshalText(falseJSON)
maybePanic(err)
assertNullBool(t, zero, "UnmarshalText() zero bool")
var blank Bool
err = blank.UnmarshalText([]byte(""))
maybePanic(err)
assertNullBool(t, blank, "UnmarshalText() empty bool")
var null Bool
err = null.UnmarshalText(nullJSON)
maybePanic(err)
assertNullBool(t, null, `UnmarshalText() "null"`)
}
func TestMarshalBool(t *testing.T) {
b := BoolFrom(true)
data, err := json.Marshal(b)
maybePanic(err)
assertJSONEquals(t, data, "true", "non-empty json marshal")
// invalid values should be encoded as false
null := NewBool(false, false)
data, err = json.Marshal(null)
maybePanic(err)
assertJSONEquals(t, data, "false", "null json marshal")
}
func TestMarshalBoolText(t *testing.T) {
b := BoolFrom(true)
data, err := b.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "true", "non-empty text marshal")
// invalid values should be encoded as zero
null := NewBool(false, false)
data, err = null.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "false", "null text marshal")
}
func TestBoolPointer(t *testing.T) {
b := BoolFrom(true)
ptr := b.Ptr()
if *ptr != true {
t.Errorf("bad %s bool: %#v ≠ %s\n", "pointer", ptr, true)
}
null := NewBool(false, false)
ptr = null.Ptr()
if ptr != nil {
t.Errorf("bad %s bool: %#v ≠ %s\n", "nil pointer", ptr, "nil")
}
}
func TestBoolIsZero(t *testing.T) {
b := BoolFrom(true)
if b.IsZero() {
t.Errorf("IsZero() should be false")
}
null := NewBool(false, false)
if !null.IsZero() {
t.Errorf("IsZero() should be true")
}
zero := NewBool(false, true)
if !zero.IsZero() {
t.Errorf("IsZero() should be true")
}
}
func TestBoolSetValid(t *testing.T) {
change := NewBool(false, false)
assertNullBool(t, change, "SetValid()")
change.SetValid(true)
assertBool(t, change, "SetValid()")
}
func TestBoolScan(t *testing.T) {
var b Bool
err := b.Scan(true)
maybePanic(err)
assertBool(t, b, "scanned bool")
var null Bool
err = null.Scan(nil)
maybePanic(err)
assertNullBool(t, null, "scanned null")
}
func assertBool(t *testing.T, b Bool, from string) {
if b.Bool != true {
t.Errorf("bad %s bool: %d ≠ %d\n", from, b.Bool, true)
}
if !b.Valid {
t.Error(from, "is invalid, but should be valid")
}
}
func assertNullBool(t *testing.T, b Bool, from string) {
if b.Valid {
t.Error(from, "is valid, but should be invalid")
}
}

110
zero/float.go Normal file
View file

@ -0,0 +1,110 @@
package zero
import (
"database/sql"
"encoding/json"
"strconv"
)
// Float is a nullable float64.
type Float struct {
sql.NullFloat64
}
// NewFloat creates a new Float
func NewFloat(f float64, valid bool) Float {
return Float{
NullFloat64: sql.NullFloat64{
Float64: f,
Valid: valid,
},
}
}
// FloatFrom creates a new Float that will be null if zero.
func FloatFrom(f float64) Float {
return NewFloat(f, f != 0)
}
// FloatFromPtr creates a new Float that be null if f is nil.
func FloatFromPtr(f *float64) Float {
if f == nil {
return NewFloat(0, false)
}
return NewFloat(*f, true)
}
// UnmarshalJSON implements json.Unmarshaler.
// It supports number and null input.
// 0 will be considered a null Float.
// It also supports unmarshalling a sql.NullFloat64.
func (f *Float) UnmarshalJSON(data []byte) error {
var err error
var v interface{}
json.Unmarshal(data, &v)
switch x := v.(type) {
case float64:
f.Float64 = x
case map[string]interface{}:
err = json.Unmarshal(data, &f.NullFloat64)
case nil:
f.Valid = false
return nil
}
f.Valid = (err == nil) && (f.Float64 != 0)
return err
}
// UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null Float if the input is a blank, zero, or not a float.
// It will return an error if the input is not a float, blank, or "null".
func (f *Float) UnmarshalText(text []byte) error {
str := string(text)
if str == "" || str == "null" {
f.Valid = false
return nil
}
var err error
f.Float64, err = strconv.ParseFloat(string(text), 64)
f.Valid = (err == nil) && (f.Float64 != 0)
return err
}
// MarshalJSON implements json.Marshaler.
// It will encode null if this Float is null.
func (f Float) MarshalJSON() ([]byte, error) {
n := f.Float64
if !f.Valid {
n = 0
}
return []byte(strconv.FormatFloat(n, 'f', -1, 64)), nil
}
// MarshalText implements encoding.TextMarshaler.
// It will encode a zero if this Float is null.
func (f Float) MarshalText() ([]byte, error) {
n := f.Float64
if !f.Valid {
n = 0
}
return []byte(strconv.FormatFloat(n, 'f', -1, 64)), nil
}
// SetValid changes this Float's value and also sets it to be non-null.
func (f *Float) SetValid(v float64) {
f.Float64 = v
f.Valid = true
}
// Ptr returns a poFloater to this Float's value, or a nil poFloater if this Float is null.
func (f Float) Ptr() *float64 {
if !f.Valid {
return nil
}
return &f.Float64
}
// IsZero returns true for null or zero Floats, for future omitempty support (Go 1.4?)
func (f Float) IsZero() bool {
return !f.Valid || f.Float64 == 0
}

166
zero/float_test.go Normal file
View file

@ -0,0 +1,166 @@
package zero
import (
"encoding/json"
"testing"
)
var (
floatJSON = []byte(`1.2345`)
nullFloatJSON = []byte(`{"Float64":1.2345,"Valid":true}`)
)
func TestFloatFrom(t *testing.T) {
f := FloatFrom(1.2345)
assertFloat(t, f, "FloatFrom()")
zero := FloatFrom(0)
if zero.Valid {
t.Error("FloatFrom(0)", "is valid, but should be invalid")
}
}
func TestFloatFromPtr(t *testing.T) {
n := float64(1.2345)
iptr := &n
f := FloatFromPtr(iptr)
assertFloat(t, f, "FloatFromPtr()")
null := FloatFromPtr(nil)
assertNullFloat(t, null, "FloatFromPtr(nil)")
}
func TestUnmarshalFloat(t *testing.T) {
var f Float
err := json.Unmarshal(floatJSON, &f)
maybePanic(err)
assertFloat(t, f, "float json")
var nf Float
err = json.Unmarshal(nullFloatJSON, &nf)
maybePanic(err)
assertFloat(t, nf, "sql.NullFloat64 json")
var zero Float
err = json.Unmarshal(zeroJSON, &zero)
maybePanic(err)
assertNullFloat(t, zero, "zero json")
var null Float
err = json.Unmarshal(nullJSON, &null)
maybePanic(err)
assertNullFloat(t, null, "null json")
}
func TestTextUnmarshalFloat(t *testing.T) {
var f Float
err := f.UnmarshalText([]byte("1.2345"))
maybePanic(err)
assertFloat(t, f, "UnmarshalText() float")
var zero Float
err = zero.UnmarshalText([]byte("0"))
maybePanic(err)
assertNullFloat(t, zero, "UnmarshalText() zero float")
var blank Float
err = blank.UnmarshalText([]byte(""))
maybePanic(err)
assertNullFloat(t, blank, "UnmarshalText() empty float")
var null Float
err = null.UnmarshalText([]byte("null"))
maybePanic(err)
assertNullFloat(t, null, `UnmarshalText() "null"`)
}
func TestMarshalFloat(t *testing.T) {
f := FloatFrom(1.2345)
data, err := json.Marshal(f)
maybePanic(err)
assertJSONEquals(t, data, "1.2345", "non-empty json marshal")
// invalid values should be encoded as 0
null := NewFloat(0, false)
data, err = json.Marshal(null)
maybePanic(err)
assertJSONEquals(t, data, "0", "null json marshal")
}
func TestMarshalFloatText(t *testing.T) {
f := FloatFrom(1.2345)
data, err := f.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "1.2345", "non-empty text marshal")
// invalid values should be encoded as zero
null := NewFloat(0, false)
data, err = null.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "0", "null text marshal")
}
func TestFloatPointer(t *testing.T) {
f := FloatFrom(1.2345)
ptr := f.Ptr()
if *ptr != 1.2345 {
t.Errorf("bad %s Float: %#v ≠ %s\n", "pointer", ptr, 1.2345)
}
null := NewFloat(0, false)
ptr = null.Ptr()
if ptr != nil {
t.Errorf("bad %s Float: %#v ≠ %s\n", "nil pointer", ptr, "nil")
}
}
func TestFloatIsZero(t *testing.T) {
f := FloatFrom(1.2345)
if f.IsZero() {
t.Errorf("IsZero() should be false")
}
null := NewFloat(0, false)
if !null.IsZero() {
t.Errorf("IsZero() should be true")
}
zero := NewFloat(0, true)
if !zero.IsZero() {
t.Errorf("IsZero() should be true")
}
}
func TestFloatSetValid(t *testing.T) {
change := NewFloat(0, false)
assertNullFloat(t, change, "SetValid()")
change.SetValid(1.2345)
assertFloat(t, change, "SetValid()")
}
func TestFloatScan(t *testing.T) {
var f Float
err := f.Scan(1.2345)
maybePanic(err)
assertFloat(t, f, "scanned float")
var null Float
err = null.Scan(nil)
maybePanic(err)
assertNullFloat(t, null, "scanned null")
}
func assertFloat(t *testing.T, f Float, from string) {
if f.Float64 != 1.2345 {
t.Errorf("bad %s float: %f ≠ %f\n", from, f.Float64, 1.2345)
}
if !f.Valid {
t.Error(from, "is invalid, but should be valid")
}
}
func assertNullFloat(t *testing.T, f Float, from string) {
if f.Valid {
t.Error(from, "is valid, but should be invalid")
}
}

111
zero/int.go Normal file
View file

@ -0,0 +1,111 @@
package zero
import (
"database/sql"
"encoding/json"
"strconv"
)
// Int is a nullable int64.
type Int struct {
sql.NullInt64
}
// NewInt creates a new Int
func NewInt(i int64, valid bool) Int {
return Int{
NullInt64: sql.NullInt64{
Int64: i,
Valid: valid,
},
}
}
// IntFrom creates a new Int that will be null if zero.
func IntFrom(i int64) Int {
return NewInt(i, i != 0)
}
// IntFromPtr creates a new String that be null if i is nil.
func IntFromPtr(i *int64) Int {
if i == nil {
return NewInt(0, false)
}
n := NewInt(*i, true)
return n
}
// UnmarshalJSON implements json.Unmarshaler.
// It supports number and null input.
// 0 will be considered a null Int.
// It also supports unmarshalling a sql.NullInt64.
func (i *Int) UnmarshalJSON(data []byte) error {
var err error
var v interface{}
json.Unmarshal(data, &v)
switch x := v.(type) {
case float64:
i.Int64 = int64(x)
case map[string]interface{}:
err = json.Unmarshal(data, &i.NullInt64)
case nil:
i.Valid = false
return nil
}
i.Valid = (err == nil) && (i.Int64 != 0)
return err
}
// UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null Int if the input is a blank, zero, or not an integer.
// It will return an error if the input is not an integer, blank, or "null".
func (i *Int) UnmarshalText(text []byte) error {
str := string(text)
if str == "" || str == "null" {
i.Valid = false
return nil
}
var err error
i.Int64, err = strconv.ParseInt(string(text), 10, 64)
i.Valid = (err == nil) && (i.Int64 != 0)
return err
}
// MarshalJSON implements json.Marshaler.
// It will encode 0 if this Int is null.
func (i Int) MarshalJSON() ([]byte, error) {
n := i.Int64
if !i.Valid {
n = 0
}
return []byte(strconv.FormatInt(n, 10)), nil
}
// MarshalText implements encoding.TextMarshaler.
// It will encode a zero if this Int is null.
func (i Int) MarshalText() ([]byte, error) {
n := i.Int64
if !i.Valid {
n = 0
}
return []byte(strconv.FormatInt(n, 10)), nil
}
// SetValid changes this Int's value and also sets it to be non-null.
func (i *Int) SetValid(n int64) {
i.Int64 = n
i.Valid = true
}
// Ptr returns a pointer to this Int's value, or a nil pointer if this Int is null.
func (i Int) Ptr() *int64 {
if !i.Valid {
return nil
}
return &i.Int64
}
// IsZero returns true for null or zero Ints, for future omitempty support (Go 1.4?)
func (i Int) IsZero() bool {
return !i.Valid || i.Int64 == 0
}

167
zero/int_test.go Normal file
View file

@ -0,0 +1,167 @@
package zero
import (
"encoding/json"
"testing"
)
var (
intJSON = []byte(`12345`)
nullIntJSON = []byte(`{"Int64":12345,"Valid":true}`)
zeroJSON = []byte(`0`)
)
func TestIntFrom(t *testing.T) {
i := IntFrom(12345)
assertInt(t, i, "IntFrom()")
zero := IntFrom(0)
if zero.Valid {
t.Error("IntFrom(0)", "is valid, but should be invalid")
}
}
func TestIntFromPtr(t *testing.T) {
n := int64(12345)
iptr := &n
i := IntFromPtr(iptr)
assertInt(t, i, "IntFromPtr()")
null := IntFromPtr(nil)
assertNullInt(t, null, "IntFromPtr(nil)")
}
func TestUnmarshalInt(t *testing.T) {
var i Int
err := json.Unmarshal(intJSON, &i)
maybePanic(err)
assertInt(t, i, "int json")
var ni Int
err = json.Unmarshal(nullIntJSON, &ni)
maybePanic(err)
assertInt(t, ni, "sql.NullInt64 json")
var zero Int
err = json.Unmarshal(zeroJSON, &zero)
maybePanic(err)
assertNullInt(t, zero, "zero json")
var null Int
err = json.Unmarshal(nullJSON, &null)
maybePanic(err)
assertNullInt(t, null, "null json")
}
func TestTextUnmarshalInt(t *testing.T) {
var i Int
err := i.UnmarshalText([]byte("12345"))
maybePanic(err)
assertInt(t, i, "UnmarshalText() int")
var zero Int
err = zero.UnmarshalText([]byte("0"))
maybePanic(err)
assertNullInt(t, zero, "UnmarshalText() zero int")
var blank Int
err = blank.UnmarshalText([]byte(""))
maybePanic(err)
assertNullInt(t, blank, "UnmarshalText() empty int")
var null Int
err = null.UnmarshalText([]byte("null"))
maybePanic(err)
assertNullInt(t, null, `UnmarshalText() "null"`)
}
func TestMarshalInt(t *testing.T) {
i := IntFrom(12345)
data, err := json.Marshal(i)
maybePanic(err)
assertJSONEquals(t, data, "12345", "non-empty json marshal")
// invalid values should be encoded as 0
null := NewInt(0, false)
data, err = json.Marshal(null)
maybePanic(err)
assertJSONEquals(t, data, "0", "null json marshal")
}
func TestMarshalIntText(t *testing.T) {
i := IntFrom(12345)
data, err := i.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "12345", "non-empty text marshal")
// invalid values should be encoded as zero
null := NewInt(0, false)
data, err = null.MarshalText()
maybePanic(err)
assertJSONEquals(t, data, "0", "null text marshal")
}
func TestIntPointer(t *testing.T) {
i := IntFrom(12345)
ptr := i.Ptr()
if *ptr != 12345 {
t.Errorf("bad %s int: %#v ≠ %s\n", "pointer", ptr, 12345)
}
null := NewInt(0, false)
ptr = null.Ptr()
if ptr != nil {
t.Errorf("bad %s int: %#v ≠ %s\n", "nil pointer", ptr, "nil")
}
}
func TestIntIsZero(t *testing.T) {
i := IntFrom(12345)
if i.IsZero() {
t.Errorf("IsZero() should be false")
}
null := NewInt(0, false)
if !null.IsZero() {
t.Errorf("IsZero() should be true")
}
zero := NewInt(0, true)
if !zero.IsZero() {
t.Errorf("IsZero() should be true")
}
}
func TestIntScan(t *testing.T) {
var i Int
err := i.Scan(12345)
maybePanic(err)
assertInt(t, i, "scanned int")
var null Int
err = null.Scan(nil)
maybePanic(err)
assertNullInt(t, null, "scanned null")
}
func TestIntSetValid(t *testing.T) {
change := NewInt(0, false)
assertNullInt(t, change, "SetValid()")
change.SetValid(12345)
assertInt(t, change, "SetValid()")
}
func assertInt(t *testing.T, i Int, from string) {
if i.Int64 != 12345 {
t.Errorf("bad %s int: %d ≠ %d\n", from, i.Int64, 12345)
}
if !i.Valid {
t.Error(from, "is invalid, but should be valid")
}
}
func assertNullInt(t *testing.T, i Int, from string) {
if i.Valid {
t.Error(from, "is valid, but should be invalid")
}
}

95
zero/string.go Normal file
View file

@ -0,0 +1,95 @@
// Package zero provides a convenient way of handling null values.
// Types in this package consider empty or zero input the same as null input.
// Types in this package will encode to their zero value, even if null.
// Use the nuller subpackage if you don't want this.
package zero
import (
"database/sql"
"encoding/json"
)
// String is a nullable string.
type String struct {
sql.NullString
}
// NewString creates a new String
func NewString(s string, valid bool) String {
return String{
NullString: sql.NullString{
String: s,
Valid: valid,
},
}
}
// StringFrom creates a new String that will be null if s is blank.
func StringFrom(s string) String {
return NewString(s, s != "")
}
// StringFromPtr creates a new String that be null if s is nil or blank.
// It will make s point to the String's value.
func StringFromPtr(s *string) String {
if s == nil {
return NewString("", false)
}
return NewString(*s, *s != "")
}
// UnmarshalJSON implements json.Unmarshaler.
// It supports string and null input. Blank string input produces a null String.
// It also supports unmarshalling a sql.NullString.
func (s *String) UnmarshalJSON(data []byte) error {
var err error
var v interface{}
json.Unmarshal(data, &v)
switch x := v.(type) {
case string:
s.String = x
case map[string]interface{}:
err = json.Unmarshal(data, &s.NullString)
case nil:
s.Valid = false
return nil
}
s.Valid = (err == nil) && (s.String != "")
return err
}
// MarshalText implements encoding.TextMarshaler.
// It will encode a blank string when this String is null.
func (s String) MarshalText() ([]byte, error) {
if !s.Valid {
return []byte{}, nil
}
return []byte(s.String), nil
}
// UnmarshalText implements encoding.TextUnmarshaler.
// It will unmarshal to a null String if the input is a blank string.
func (s *String) UnmarshalText(text []byte) error {
s.String = string(text)
s.Valid = s.String != ""
return nil
}
// SetValid changes this String's value and also sets it to be non-null.
func (s *String) SetValid(v string) {
s.String = v
s.Valid = true
}
// Ptr returns a pointer to this String's value, or a nil pointer if this String is null.
func (s String) Ptr() *string {
if !s.Valid {
return nil
}
return &s.String
}
// IsZero returns true for null or empty strings, for future omitempty support. (Go 1.4?)
func (s String) IsZero() bool {
return !s.Valid || s.String == ""
}

173
zero/string_test.go Normal file
View file

@ -0,0 +1,173 @@
package zero
import (
"encoding/json"
"testing"
)
var (
stringJSON = []byte(`"test"`)
blankStringJSON = []byte(`""`)
nullStringJSON = []byte(`{"String":"test","Valid":true}`)
nullJSON = []byte(`null`)
)
type stringInStruct struct {
Test String `json:"test,omitempty"`
}
func TestStringFrom(t *testing.T) {
str := StringFrom("test")
assertStr(t, str, "StringFrom() string")
null := StringFrom("")
assertNullStr(t, null, "StringFrom() empty string")
}
func TestUnmarshalString(t *testing.T) {
var str String
err := json.Unmarshal(stringJSON, &str)
maybePanic(err)
assertStr(t, str, "string json")
var ns String
err = json.Unmarshal(nullStringJSON, &ns)
maybePanic(err)
assertStr(t, ns, "sql.NullString json")
var blank String
err = json.Unmarshal(blankStringJSON, &blank)
maybePanic(err)
assertNullStr(t, blank, "blank string json")
var null String
err = json.Unmarshal(nullJSON, &null)
maybePanic(err)
assertNullStr(t, null, "null json")
}
func TestTextUnmarshalString(t *testing.T) {
var str String
err := str.UnmarshalText([]byte("test"))
maybePanic(err)
assertStr(t, str, "UnmarshalText() string")
var null String
err = null.UnmarshalText([]byte(""))
maybePanic(err)
assertNullStr(t, null, "UnmarshalText() empty string")
}
func TestMarshalString(t *testing.T) {
str := StringFrom("test")
data, err := json.Marshal(str)
maybePanic(err)
assertJSONEquals(t, data, `"test"`, "non-empty json marshal")
// invalid values should be encoded as an empty string
null := StringFrom("")
data, err = json.Marshal(null)
maybePanic(err)
assertJSONEquals(t, data, `""`, "empty json marshal")
}
// Tests omitempty... broken until Go 1.4
// func TestMarshalStringInStruct(t *testing.T) {
// obj := stringInStruct{Test: StringFrom("")}
// data, err := json.Marshal(obj)
// maybePanic(err)
// assertJSONEquals(t, data, `{}`, "null string in struct")
// }
func TestStringPointer(t *testing.T) {
str := StringFrom("test")
ptr := str.Ptr()
if *ptr != "test" {
t.Errorf("bad %s string: %#v ≠ %s\n", "pointer", ptr, "test")
}
null := StringFrom("")
ptr = null.Ptr()
if ptr != nil {
t.Errorf("bad %s string: %#v ≠ %s\n", "nil pointer", ptr, "nil")
}
}
func TestStringFromPointer(t *testing.T) {
test := "test"
testptr := &test
str := StringFromPtr(testptr)
assertStr(t, str, "StringFromPtr()")
testptr = nil
null := StringFromPtr(testptr)
assertNullStr(t, null, "StringFromPtr()")
ptr := null.Ptr()
if ptr != nil {
t.Errorf("bad %s string: %#v ≠ %s\n", "nil pointer", ptr, "nil")
}
}
func TestStringIsZero(t *testing.T) {
str := StringFrom("test")
if str.IsZero() {
t.Errorf("IsZero() should be false")
}
null := StringFrom("")
if !null.IsZero() {
t.Errorf("IsZero() should be true")
}
empty := NewString("", true)
if !empty.IsZero() {
t.Errorf("IsZero() should be true")
}
}
func TestStringScan(t *testing.T) {
var str String
err := str.Scan("test")
maybePanic(err)
assertStr(t, str, "scanned string")
var null String
err = null.Scan(nil)
maybePanic(err)
assertNullStr(t, null, "scanned null")
}
func TestStringSetValid(t *testing.T) {
change := NewString("", false)
assertNullStr(t, change, "SetValid()")
change.SetValid("test")
assertStr(t, change, "SetValid()")
}
func maybePanic(err error) {
if err != nil {
panic(err)
}
}
func assertStr(t *testing.T, s String, from string) {
if s.String != "test" {
t.Errorf("bad %s string: %s ≠ %s\n", from, s.String, "test")
}
if !s.Valid {
t.Error(from, "is invalid, but should be valid")
}
}
func assertNullStr(t *testing.T, s String, from string) {
if s.Valid {
t.Error(from, "is valid, but should be invalid")
}
}
func assertJSONEquals(t *testing.T, data []byte, cmp string, from string) {
if string(data) != cmp {
t.Errorf("bad %s data: %s ≠ %s\n", from, data, cmp)
}
}