revel#835 Atob and ToBool methods added

jeevatkm · jeevatkm · commit 4816d0666640 · 2016-06-18T13:45:27.000-07:00
diff --git a/binder.go b/binder.go
@@ -140,19 +140,11 @@ var (
 		},
 	}
 
-	// Booleans support a couple different value formats:
-	// "true" and "false"
-	// "on" and "" (a checkbox)
-	// "1" and "0" (why not)
+	// Booleans support a various value formats,
+	// refer `revel.Atob` method.
 	BoolBinder = Binder{
 		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
-			v := strings.TrimSpace(strings.ToLower(val))
-			switch v {
-			case "true", "on", "1":
-				return reflect.ValueOf(true)
-			}
-			// Return false by default.
-			return reflect.ValueOf(false)
+			return reflect.ValueOf(Atob(val))
 		}),
 		Unbind: func(output map[string]string, name string, val interface{}) {
 			output[name] = fmt.Sprintf("%t", val)
diff --git a/binder_test.go b/binder_test.go
@@ -47,7 +47,9 @@ var (
 		"bool-on":         {"on"},
 		"bool-false":      {"false"},
 		"bool-0":          {"0"},
-		"bool-off":        {""},
+		"bool-0.0":        {"0.0"},
+		"bool-off":        {"off"},
+		"bool-f":          {"f"},
 		"date":            {"1982-07-09"},
 		"datetime":        {"1982-07-09 21:30"},
 		"customDate":      {"07/09/1982"},
@@ -112,7 +114,9 @@ var binderTestCases = map[string]interface{}{
 	"bool-on":    true,
 	"bool-false": false,
 	"bool-0":     false,
+	"bool-0.0":   false,
 	"bool-off":   false,
+	"bool-f":     false,
 	"date":       testDate,
 	"datetime":   testDatetime,
 	"customDate": testDate,
@@ -144,7 +148,7 @@ var binderTestCases = map[string]interface{}{
 	// The point of these is to ensure that invalid user input does not cause panics.
 	"invalidInt":     0,
 	"invalidInt2":    0,
-	"invalidBool":    false,
+	"invalidBool":    true,
 	"invalidArr":     []int{},
 	"priv":           A{},
 	"int8-overflow":  int8(0),
diff --git a/libs.go b/libs.go
@@ -9,6 +9,8 @@ import (
 	"crypto/sha1"
 	"encoding/hex"
 	"io"
+	"reflect"
+	"strings"
 )
 
 // Sign a given string with the app-configured secret key.
@@ -31,3 +33,54 @@ func Sign(message string) string {
 func Verify(message, sig string) bool {
 	return hmac.Equal([]byte(sig), []byte(Sign(message)))
 }
+
+// ToBool method converts/assert value into true or false. Default is true.
+// When converting to boolean, the following values are considered FALSE:
+// - The integer value is 0 (zero)
+// - The float value 0.0 (zero)
+// - The complex value 0.0 (zero)
+// - For string value, please refer `revel.Atob` method
+// - An array, map, slice with zero elements
+// - Boolean value returned as-is
+// - "nil" value
+func ToBool(val interface{}) bool {
+	if val == nil {
+		return false
+	}
+
+	v := reflect.ValueOf(val)
+	switch v.Kind() {
+	case reflect.Bool:
+		return v.Bool()
+	case reflect.String:
+		return Atob(v.String())
+	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
+		return v.Int() != 0
+	case reflect.Float32, reflect.Float64:
+		return v.Float() != 0.0
+	case reflect.Complex64, reflect.Complex128:
+		return v.Complex() != 0.0
+	case reflect.Array, reflect.Map, reflect.Slice:
+		return v.Len() != 0
+	}
+
+	// Return true by default
+	return true
+}
+
+// Atob converts string into boolean. It is in-case sensitive
+// When converting to boolean, the following values are considered FALSE:
+// - The "" (empty) string
+// - The "false" string
+// - The "f" string
+// - The "off" string,
+// - The string "0" & "0.0"
+func Atob(v string) bool {
+	switch strings.TrimSpace(strings.ToLower(v)) {
+	case "", "false", "off", "f", "0", "0.0":
+		return false
+	}
+
+	// Return true by default
+	return true
+}
diff --git a/libs_test.go b/libs_test.go
@@ -0,0 +1,38 @@
+// Copyright (c) 2012-2016 The Revel Framework Authors, All rights reserved.
+// Revel Framework source code and usage is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package revel
+
+import "testing"
+
+func TestToBooleanForFalse(t *testing.T) {
+	if ToBool(nil) ||
+		ToBool([]string{}) ||
+		ToBool(map[string]string{}) ||
+		ToBool(0) ||
+		ToBool(0.0) ||
+		ToBool("") ||
+		ToBool("false") ||
+		ToBool("0") ||
+		ToBool("0.0") ||
+		ToBool("off") ||
+		ToBool("f") {
+		t.Error("Expected 'false' got 'true'")
+	}
+}
+
+func TestToBooleanForTrue(t *testing.T) {
+	if !ToBool([]string{"true"}) ||
+		!ToBool(map[string]string{"true": "value"}) ||
+		!ToBool(1) ||
+		!ToBool(0.1) ||
+		!ToBool("not empty") ||
+		!ToBool("true") ||
+		!ToBool("1") ||
+		!ToBool("1.0") ||
+		!ToBool("on") ||
+		!ToBool("t") {
+		t.Error("Expected 'true' got 'false'")
+	}
+}
