mirrors/argparse
1
0
Fork 0
mirror of https://github.com/TangentFoxy/argparse.git synced 2025-07-28 02:52:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow using multiple constructor arguments for configuring elements

Browse Source 
Disable undocumented ability to specify aliases as arguments
for constructors, e.g. parser:option("-f", "--foo"), and instead
order properties and pass constructor arguments to them.
E.g. parser:argument("foo", "A foo that bars") sets argument
name to foo and description to "A foo that bars".

TODO: remove "aliases" property, instead allow setting several
names in one string by separating them using space.
TODO: reorder properties so that most useful ones could be used
as constructor arguments.
This commit is contained in:
mpeterv
2015-06-09 21:54:18 +03:00
parent 476ad19de8
commit ff9abac990
5 changed files with 303 additions and 305 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
spec/options_spec.lua
View File

@@ -5,21 +5,21 @@ describe("tests related to options", function()
describe("passing correct options", function()
it("handles no options passed correctly", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
local args = parser:parse({})
assert.same({}, args)
end)
it("handles one option correctly", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
local args = parser:parse({"--server", "foo"})
assert.same({server = "foo"}, args)
end)
it("normalizes default target", function()
local parser = Parser()
parser:option("--from-server")
parser:option "--from-server"
local args = parser:parse({"--from-server", "foo"})
assert.same({from_server = "foo"}, args)
end)
@@ -34,39 +34,39 @@ describe("tests related to options", function()
it("handles GNU-style long options", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
local args = parser:parse({"--server=foo"})
assert.same({server = "foo"}, args)
end)
it("handles GNU-style long options even when it could take more arguments", function()
local parser = Parser()
parser:option("-s", "--server", {
parser:option "-s" "--server" {
args = "*"
})
}
local args = parser:parse({"--server=foo"})
assert.same({server = {"foo"}}, args)
end)
it("handles GNU-style long options for multi-argument options", function()
local parser = Parser()
parser:option("-s", "--server", {
parser:option "-s" "--server" {
args = "1-2"
})
}
local args = parser:parse({"--server=foo", "bar"})
assert.same({server = {"foo", "bar"}}, args)
end)
it("handles short option correclty", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
local args = parser:parse({"-s", "foo"})
assert.same({server = "foo"}, args)
end)
it("handles flag correclty", function()
local parser = Parser()
parser:flag("-q", "--quiet")
parser:flag "-q" "--quiet"
local args = parser:parse({"--quiet"})
assert.same({quiet = true}, args)
args = parser:parse({})
@@ -75,23 +75,23 @@ describe("tests related to options", function()
it("handles combined flags correclty", function()
local parser = Parser()
parser:flag("-q", "--quiet")
parser:flag("-f", "--fast")
parser:flag "-q" "--quiet"
parser:flag "-f" "--fast"
local args = parser:parse({"-qf"})
assert.same({quiet = true, fast = true}, args)
end)
it("handles short options without space between option and argument", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
local args = parser:parse({"-sfoo"})
assert.same({server = "foo"}, args)
end)
it("handles flags combined with short option correclty", function()
local parser = Parser()
parser:flag("-q", "--quiet")
parser:option("-s", "--server")
parser:flag "-q" "--quiet"
parser:option "-s" "--server"
local args = parser:parse({"-qsfoo"})
assert.same({quiet = true, server = "foo"}, args)
end)
@@ -152,27 +152,27 @@ describe("tests related to options", function()
describe("Options with optional argument", function()
it("handles emptiness correctly", function()
local parser = Parser()
parser:option("-p", "--password", {
parser:option "-p" "--password" {
args = "?"
})
}
local args = parser:parse({})
assert.same({}, args)
end)
it("handles option without argument correctly", function()
local parser = Parser()
parser:option("-p", "--password", {
parser:option "-p" "--password" {
args = "?"
})
}
local args = parser:parse({"-p"})
assert.same({password = {}}, args)
end)
it("handles option with argument correctly", function()
local parser = Parser()
parser:option("-p", "--password", {
parser:option "-p" "--password" {
args = "?"
})
}
local args = parser:parse({"-p", "password"})
assert.same({password = {"password"}}, args)
end)
@@ -180,9 +180,9 @@ describe("tests related to options", function()
it("handles multi-argument options correctly", function()
local parser = Parser()
parser:option("--pair", {
parser:option "--pair" {
args = 2
})
}
local args = parser:parse({"--pair", "Alice", "Bob"})
assert.same({pair = {"Alice", "Bob"}}, args)
end)
@@ -190,55 +190,55 @@ describe("tests related to options", function()
describe("Multi-count options", function()
it("handles multi-count option correctly", function()
local parser = Parser()
parser:option("-e", "--exclude", {
parser:option "-e" "--exclude" {
count = "*"
})
}
local args = parser:parse({"-efoo", "--exclude=bar", "-e", "baz"})
assert.same({exclude = {"foo", "bar", "baz"}}, args)
end)
it("handles not used multi-count option correctly", function()
local parser = Parser()
parser:option("-e", "--exclude", {
parser:option "-e" "--exclude" {
count = "*"
})
}
local args = parser:parse({})
assert.same({exclude = {}}, args)
end)
it("handles multi-count multi-argument option correctly", function()
local parser = Parser()
parser:option("-e", "--exclude", {
parser:option "-e" "--exclude" {
count = "*",
args = 2
})
}
local args = parser:parse({"-e", "Alice", "Bob", "-e", "Emma", "Jacob"})
assert.same({exclude = {{"Alice", "Bob"}, {"Emma", "Jacob"}}}, args)
end)
it("handles multi-count flag correctly", function()
local parser = Parser()
parser:flag("-q", "--quiet", {
parser:flag "-q" "--quiet" {
count = "*"
})
}
local args = parser:parse({"-qq", "--quiet"})
assert.same({quiet = 3}, args)
end)
it("overwrites old invocations", function()
local parser = Parser()
parser:option("-u", "--user", {
parser:option "-u" "--user" {
count = "0-2"
})
}
local args = parser:parse({"-uAlice", "--user=Bob", "--user", "John"})
assert.same({user = {"Bob", "John"}}, args)
end)
it("handles not used multi-count flag correctly", function()
local parser = Parser()
parser:flag("-q", "--quiet", {
parser:flag "-q" "--quiet" {
count = "*"
})
}
local args = parser:parse({})
assert.same({quiet = 0}, args)
end)
@@ -248,7 +248,7 @@ describe("tests related to options", function()
describe("passing incorrect options", function()
it("handles lack of required argument correctly", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
assert.has_error(function() parser:parse{"--server"} end, "too few arguments")
end)
@@ -264,30 +264,30 @@ describe("tests related to options", function()
it("handles too many arguments correctly", function()
local parser = Parser()
parser:option("-s", "--server")
parser:option "-s" "--server"
assert.has_error(function() parser:parse{"-sfoo", "bar"} end, "too many arguments")
end)
it("doesn't accept GNU-like long options when it doesn't need arguments", function()
local parser = Parser()
parser:flag("-q", "--quiet")
parser:flag "-q" "--quiet"
assert.has_error(function() parser:parse{"--quiet=very_quiet"} end, "option '--quiet' does not take arguments")
end)
it("handles too many invocations correctly", function()
local parser = Parser()
parser:flag("-q", "--quiet", {
parser:flag "-q" "--quiet" {
count = 1,
overwrite = false
})
}
assert.has_error(function() parser:parse{"-qq"} end, "option '-q' must be used at most 1 time")
end)
it("handles too few invocations correctly", function()
local parser = Parser()
parser:option("-f", "--foo", {
parser:option "-f" "--foo" {
count = "3-4"
})
}
assert.has_error(function() parser:parse{"-fFOO", "-fBAR"} end, "option '-f' must be used at least 3 times")
end)
end)