go-ini · andeya · Jul 15, 2017 · Jul 15, 2017 · Jul 15, 2017 · Aug 5, 2017
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@ ini.sublime-project
 ini.sublime-workspace
 testdata/conf_reflect.ini
 .idea
+*.zip
+*.rar
diff --git a/README.md b/README.md
@@ -573,18 +573,18 @@ Why not?
 
 ```go
 type Embeded struct {
-	Dates  []time.Time `delim:"|"`
+	Dates  []time.Time `delim:"|" comment:"time data"`
 	Places []string    `ini:"places,omitempty"`
 	None   []int       `ini:",omitempty"`
 }
 
 type Author struct {
 	Name      string `ini:"NAME"`
 	Male      bool
-	Age       int
+	Age       int `comment:"Author's age"`
 	GPA       float64
 	NeverMind string `ini:"-"`
-	*Embeded
+	*Embeded `comment:"Embeded section"`
 }
 
 func main() {
@@ -605,10 +605,13 @@ So, what do I get?
 ```ini
 NAME = Unknwon
 Male = true
+; Author's age
 Age = 21
 GPA = 2.8
 
+; Embeded section
 [Embeded]
+; time data
 Dates = 2015-08-07T22:14:22+08:00|2015-08-07T22:14:22+08:00
 places = HangZhou,Boston
 ```

diff --git a/README_ZH.md b/README_ZH.md
@@ -564,18 +564,18 @@ p := &Person{
 
 ```go
 type Embeded struct {
-	Dates  []time.Time `delim:"|"`
+	Dates  []time.Time `delim:"|" comment:"time data"`
 	Places []string    `ini:"places,omitempty"`
 	None   []int       `ini:",omitempty"`
 }
 
 type Author struct {
 	Name      string `ini:"NAME"`
 	Male      bool
-	Age       int
+	Age       int `comment:"Author's age"`
 	GPA       float64
 	NeverMind string `ini:"-"`
-	*Embeded
+	*Embeded `comment:"Embeded section"`
 }
 
 func main() {
@@ -596,10 +596,13 @@ func main() {
 ```ini
 NAME = Unknwon
 Male = true
+; Author's age
 Age = 21
 GPA = 2.8
 
+; Embeded section
 [Embeded]
+; time data
 Dates = 2015-08-07T22:14:22+08:00|2015-08-07T22:14:22+08:00
 places = HangZhou,Boston
 ```

diff --git a/helper.go b/helper.go
@@ -0,0 +1,79 @@
+package ini
+
+import (
+	"os"
+	"path/filepath"
+	"reflect"
+	"strings"
+	"sync"
+
+	"github.com/henrylee2cn/goutil"
+	"github.com/henrylee2cn/goutil/errors"
+)
+
+// SyncINI quickly create your own configuration files.
+// Struct tags reference `https://github.com/henrylee2cn/ini`
+func SyncINI(structPtr interface{}, f func(onecUpdateFunc func() error) error, filename ...string) error {
+	t := reflect.TypeOf(structPtr)
+	if t.Kind() != reflect.Ptr {
+		return errors.New("SyncINI's param must be struct pointer type.")
+	}
+	t = t.Elem()
+	if t.Kind() != reflect.Struct {
+		return errors.New("SyncINI's param must be struct pointer type.")
+	}
+
+	var fname string
+	if len(filename) > 0 {
+		fname = filename[0]
+	} else {
+		fname = strings.TrimSuffix(t.Name(), "Config")
+		fname = strings.TrimSuffix(fname, "INI")
+		fname = goutil.SnakeString(fname) + ".ini"
+	}
+	var cfg *File
+	var err error
+	var existed bool
+	cfg, err = Load(fname)
+	if err != nil {
+		os.MkdirAll(filepath.Dir(fname), 0777)
+		cfg, err = LooseLoad(fname)
+		if err != nil {
+			return err
+		}
+	} else {
+		existed = true
+	}
+
+	err = cfg.MapTo(structPtr)
+	if err != nil {
+		return err
+	}
+
+	var once sync.Once
+	var onecUpdateFunc = func() error {
+		var err error
+		once.Do(func() {
+			err = cfg.ReflectFrom(structPtr)
+			if err != nil {
+				return
+			}
+			err = cfg.SaveTo(fname)
+			if err != nil {
+				return
+			}
+		})
+		return err
+	}
+
+	if f != nil {
+		if err = f(onecUpdateFunc); err != nil {
+			return err
+		}
+	}
+
+	if !existed {
+		return onecUpdateFunc()
+	}
+	return nil
+}
diff --git a/ini.go b/ini.go
@@ -414,6 +414,8 @@ func (f *File) WriteToIndent(w io.Writer, indent string) (n int64, err error) {
 		if len(sec.Comment) > 0 {
 			if sec.Comment[0] != '#' && sec.Comment[0] != ';' {
 				sec.Comment = "; " + sec.Comment
+			} else {
+				sec.Comment = sec.Comment[:1] + " " + strings.TrimSpace(sec.Comment[1:])
 			}
 			if _, err = buf.WriteString(sec.Comment + LineBreak); err != nil {
 				return 0, err
@@ -468,6 +470,8 @@ func (f *File) WriteToIndent(w io.Writer, indent string) (n int64, err error) {
 				}
 				if key.Comment[0] != '#' && key.Comment[0] != ';' {
 					key.Comment = "; " + key.Comment
+				} else {
+					key.Comment = key.Comment[:1] + " " + strings.TrimSpace(key.Comment[1:])
 				}
 				if _, err = buf.WriteString(key.Comment + LineBreak); err != nil {
 					return 0, err

diff --git a/struct.go b/struct.go
@@ -379,7 +379,11 @@ func reflectWithProperType(t reflect.Type, key *Key, field reflect.Value, delim
 	case reflect.Bool:
 		key.SetValue(fmt.Sprint(field.Bool()))
 	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
-		key.SetValue(fmt.Sprint(field.Int()))
+		if t.String() == "time.Duration" {
+			key.SetValue(field.Interface().(time.Duration).String())
+		} else {
+			key.SetValue(fmt.Sprint(field.Int()))
+		}
 	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
 		key.SetValue(fmt.Sprint(field.Uint()))
 	case reflect.Float32, reflect.Float64:
@@ -450,6 +454,12 @@ func (s *Section) reflectFrom(val reflect.Value) error {
 				// Note: fieldName can never be empty here, ignore error.
 				sec, _ = s.f.NewSection(fieldName)
 			}
+
+			// add comment from comment tag
+			if len(sec.Comment) == 0 {
+				sec.Comment = tpField.Tag.Get("comment")
+			}
+
 			if err = sec.reflectFrom(field); err != nil {
 				return fmt.Errorf("error reflecting field (%s): %v", fieldName, err)
 			}
@@ -461,6 +471,12 @@ func (s *Section) reflectFrom(val reflect.Value) error {
 		if err != nil {
 			key, _ = s.NewKey(fieldName, "")
 		}
+
+		// add comment from comment tag
+		if len(key.Comment) == 0 {
+			key.Comment = tpField.Tag.Get("comment")
+		}
+
 		if err = reflectWithProperType(tpField.Type, key, field, parseDelim(tpField.Tag.Get("delim"))); err != nil {
 			return fmt.Errorf("error reflecting field (%s): %v", fieldName, err)
 		}
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,5 @@ ini.sublime-project @@
     ini.sublime-workspace
     testdata/conf_reflect.ini
     .idea
+    *.zip
+    *.rar