Skip to content

Support Short-circuit load #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
unknwon merged 2 commits into from
Sep 5, 2020
+55 −1
Merged

Support Short-circuit load #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cb3b73
Support Short-circuit load
ygj6 Aug 29, 2020
93f60be
Apply suggestions from code review
unknwon Sep 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,9 @@ func (f *File) Reload() (err error) {
}
return err
}
if f.options.ShortCircuit {
return nil
}
Comment thread
unknwon marked this conversation as resolved.
}
return nil
}
Expand Down
2 changes: 1 addition & 1 deletion file_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 "
Expand Down
2 changes: 2 additions & 0 deletions ini.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
49 changes: 49 additions & 0 deletions ini_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]

`)
})
})
})
}

Expand Down