feat: table scheme implemented on proposal at issue #2

Author: ecoshub

changelog

@@ -12,3 +12,6 @@ v1.0.2:
     example 'ExampleField_Hide()' fixed
     a trailing new line '\n' added to table -> string core function
 
+v1.0.3:
+    new scheme feature added
+

example_test.go

@@ -578,3 +578,97 @@ func ExampleSTable_FieldCount() {
 	fmt.Println(table.FieldCount())
 	// output: 3
 }
+
+func ExampleInjectScheme() {
+	// example struct
+	type Person struct {
+		Age    int     `table:"age"`
+		Height float64 `table:"height"`
+		Name   string  `table:"name"`
+		Male   bool    `table:"male"`
+	}
+
+	// lets create a person named 'ruby'
+	ruby := &Person{
+		Name:   "Ruby Cohen",
+		Age:    31,
+		Height: 1.853,
+		Male:   true,
+	}
+
+	sc := &Scheme{
+		Caption:        "Ruby Cohen Personal Info",
+		GeneralPadding: 2,
+		FieldOptions: map[string]*Options{
+			"male":   {Hide: true},
+			"height": {Format: "%0.2f m"},
+		},
+	}
+
+	t, err := InjectScheme(sc, ruby)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(t)
+	// output:
+	// +---------------------------------+
+	// |     Ruby Cohen Personal Info    |
+	// |---------------------------------|
+	// |  age  |  height  |     name     |
+	// |-------+----------+--------------|
+	// |  31   |  1.85 m  |  Ruby Cohen  |
+	// +-------+----------+--------------+
+}
+
+func ExamplePrintWithScheme() {
+	// example struct
+	type Person struct {
+		Age    int     `table:"age"`
+		Height float64 `table:"height"`
+		Name   string  `table:"name"`
+		Male   bool    `table:"male"`
+	}
+
+	// lets create a person named 'ruby'
+	ruby := &Person{
+		Name:   "Ruby Cohen",
+		Age:    31,
+		Height: 1.853,
+		Male:   true,
+	}
+
+	sc := &Scheme{
+		Caption:        "Ruby Cohen Personal Info",
+		GeneralPadding: 2,
+		FieldOptions: map[string]*Options{
+			"male":   {Hide: true},
+			"height": {Format: "%0.2f m"},
+		},
+	}
+	// print the ruby's info
+	PrintWithScheme(sc, ruby)
+
+	// if anything change
+	ruby.Age = 32
+
+	// we can print with same scheme
+	PrintWithScheme(sc, ruby)
+
+	// output:
+	// +---------------------------------+
+	// |     Ruby Cohen Personal Info    |
+	// |---------------------------------|
+	// |  age  |  height  |     name     |
+	// |-------+----------+--------------|
+	// |  31   |  1.85 m  |  Ruby Cohen  |
+	// +-------+----------+--------------+
+	//
+	// +---------------------------------+
+	// |     Ruby Cohen Personal Info    |
+	// |---------------------------------|
+	// |  age  |  height  |     name     |
+	// |-------+----------+--------------|
+	// |  32   |  1.85 m  |  Ruby Cohen  |
+	// +-------+----------+--------------+
+}

table_scheme.go

@@ -0,0 +1,38 @@
+package stable
+
+import "fmt"
+
+type Scheme struct {
+	Caption         string
+	BorderStyleName borderStyleName
+	GeneralPadding  int
+	FieldOptions    map[string]*Options
+}
+
+func InjectScheme(sc *Scheme, i interface{}) (*STable, error) {
+	t, err := ToTable(i)
+	if err != nil {
+		return nil, err
+	}
+
+	t.caption = processCaption(sc.Caption)
+	style, err := processBorderStyle(sc.BorderStyleName)
+	if err != nil {
+		return nil, err
+	}
+	t.borderStyle = style
+	t.generalPadding = processPadding(sc.GeneralPadding)
+	for name, opts := range sc.FieldOptions {
+		t.GetFieldByName(name).SetOptions(opts)
+	}
+	return t, nil
+}
+
+func PrintWithScheme(sc *Scheme, i interface{}) error {
+	t, err := InjectScheme(sc, i)
+	if err != nil {
+		return err
+	}
+	fmt.Println(t)
+	return nil
+}

table_utils.go

@@ -32,7 +32,21 @@ func processCaption(caption string) string {
 	return caption
 }
 
+func processBorderStyle(bsn borderStyleName) (*BorderStyle, error) {
+	if bsn == 0 {
+		return DefaultLineStyle, nil
+	}
+	bs, err := getStyle(bsn)
+	if err != nil {
+		return nil, err
+	}
+	return bs, nil
+}
+
 func processPadding(padding int) int {
+	if padding == 0 {
+		return DefaultGeneralPadding
+	}
 	if padding > MaxGeneralPadding {
 		return MaxGeneralPadding
 	}

version.go

@@ -2,5 +2,5 @@ package stable
 
 const (
 	// Version current version
-	Version string = "v1.0.2"
+	Version string = "v1.0.3"
 )