Support Short-circuit load (#261)

Co-authored-by: ᴜɴᴋɴᴡᴏɴ <[email protected]>

Author: ygj6

file.go

@@ -302,6 +302,9 @@ func (f *File) Reload() (err error) {
 			}
 			return err
 		}
+		if f.options.ShortCircuit {
+			return nil
+		}
 	}
 	return nil
 }

file_test.go

@@ -449,7 +449,7 @@ bar3 = "  val ue3 "
 		var buf bytes.Buffer
 		_, err := f.WriteTo(&buf)
 		So(err, ShouldBeNil)
-		So(buf.String(),ShouldEqual,`[foo]
+		So(buf.String(), ShouldEqual, `[foo]
 bar1 = "  val ue1 "
 bar2 = "  val ue2 "
 bar3 = "  val ue3 "

ini.go

@@ -81,6 +81,8 @@ type LoadOptions struct {
 	IgnoreInlineComment bool
 	// SkipUnrecognizableLines indicates whether to skip unrecognizable lines that do not conform to key/value pairs.
 	SkipUnrecognizableLines bool
+	// ShortCircuit indicates whether to ignore other configuration sources after loaded the first available configuration source.
+	ShortCircuit bool
 	// AllowBooleanKeys indicates whether to allow boolean type keys or treat as value is missing.
 	// This type of keys are mostly used in my.cnf.
 	AllowBooleanKeys bool

ini_test.go

@@ -1367,6 +1367,55 @@ GITHUB = U;n;k;n;w;o;n
 				}
 			})
 		})
+
+		Convey("ShortCircuit", func() {
+			Convey("Load the first available configuration, ignore other configuration", func() {
+				f, err := ini.LoadSources(ini.LoadOptions{ShortCircuit: true}, minimalConf, []byte(`key1 = value1`))
+				So(f, ShouldNotBeNil)
+				So(err, ShouldBeNil)
+				var buf bytes.Buffer
+				_, err = f.WriteTo(&buf)
+				So(err, ShouldBeNil)
+				So(buf.String(), ShouldEqual, `[author]
+E-MAIL = [email protected]
+
+`)
+			})
+
+			Convey("Return an error when fail to load", func() {
+				f, err := ini.LoadSources(ini.LoadOptions{ShortCircuit: true}, notFoundConf, minimalConf)
+				So(f, ShouldBeNil)
+				So(err, ShouldNotBeNil)
+			})
+
+			Convey("Used with Loose to ignore errors that the file does not exist", func() {
+				f, err := ini.LoadSources(ini.LoadOptions{ShortCircuit: true, Loose: true}, notFoundConf, minimalConf)
+				So(f, ShouldNotBeNil)
+				So(err, ShouldBeNil)
+				var buf bytes.Buffer
+				_, err = f.WriteTo(&buf)
+				So(err, ShouldBeNil)
+				So(buf.String(), ShouldEqual, `[author]
+E-MAIL = [email protected]
+
+`)
+			})
+
+			Convey("Ensure all sources are loaded without ShortCircuit", func() {
+				f, err := ini.LoadSources(ini.LoadOptions{ShortCircuit: false}, minimalConf, []byte(`key1 = value1`))
+				So(f, ShouldNotBeNil)
+				So(err, ShouldBeNil)
+				var buf bytes.Buffer
+				_, err = f.WriteTo(&buf)
+				So(err, ShouldBeNil)
+				So(buf.String(), ShouldEqual, `key1 = value1
+
+[author]
+E-MAIL = [email protected]
+
+`)
+			})
+		})
 	})
 }