Skip to content
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

Allow default nil values for optional properties #480

Merged
merged 4 commits into from
Aug 31, 2022
Merged

Allow default nil values for optional properties #480

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
efbd18d
Allow default `nil` values for optional properties
natecook1000 Aug 30, 2022
7425be3
Add a similar init to support `Bool?` flags
natecook1000 Aug 30, 2022
37b8889
Update docs to include `= nil` examples
natecook1000 Aug 30, 2022
ffc1c21
Merge branch 'main' into default-nil-values
natecook1000 Aug 30, 2022
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
Prev Previous commit
Next Next commit
Add a similar init to support Bool? flags
  • Loading branch information
@natecook1000
natecook1000 committed Aug 30, 2022
commit 7425be3b852bf675857073478006be2698d45789
18 changes: 18 additions & 0 deletions Sources/ArgumentParser/Parsable Properties/Flag.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,24 @@ extension Flag where Value == Optional<Bool> {
help: help)
})
}

/// This initializer allows a user to provide a `nil` default value for
/// `@Flag`-marked `Optional<Bool>` property without allowing a non-`nil`
/// default value.
public init(
wrappedValue _value: _OptionalNilComparisonType,
name: NameSpecification = .long,
inversion: FlagInversion,
exclusivity: FlagExclusivity = .chooseLast,
help: ArgumentHelp? = nil
) {
self.init(
name: name,
inversion: inversion,
exclusivity: exclusivity,
help: help)
}

}

extension Flag where Value == Bool {
Expand Down
9 changes: 7 additions & 2 deletions Tests/ArgumentParserEndToEndTests/FlagsEndToEndTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ fileprivate struct Foo: ParsableArguments {
var sandbox: Bool = true
@Flag(inversion: .prefixedEnableDisable)
var requiredElement: Bool
@Flag(inversion: .prefixedEnableDisable)
var optional: Bool? = nil
}

extension FlagsEndToEndTests {
Expand All @@ -104,22 +106,25 @@ extension FlagsEndToEndTests {
XCTAssertEqual(options.index, false)
XCTAssertEqual(options.sandbox, true)
XCTAssertEqual(options.requiredElement, true)
XCTAssertNil(options.optional)
}
}

func testParsingEnableDisable_disableAll() throws {
AssertParse(Foo.self, ["--disable-index", "--disable-sandbox", "--disable-required-element"]) { options in
AssertParse(Foo.self, ["--disable-index", "--disable-sandbox", "--disable-required-element", "--disable-optional"]) { options in
XCTAssertEqual(options.index, false)
XCTAssertEqual(options.sandbox, false)
XCTAssertEqual(options.requiredElement, false)
XCTAssertEqual(options.optional, false)
}
}

func testParsingEnableDisable_enableAll() throws {
AssertParse(Foo.self, ["--enable-index", "--enable-sandbox", "--enable-required-element"]) { options in
AssertParse(Foo.self, ["--enable-index", "--enable-sandbox", "--enable-required-element", "--enable-optional"]) { options in
XCTAssertEqual(options.index, true)
XCTAssertEqual(options.sandbox, true)
XCTAssertEqual(options.requiredElement, true)
XCTAssertEqual(options.optional, true)
}
}

Expand Down