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

Jump to bottom

Pragmas #750

Merged
merged 2 commits into from
Aug 31, 2024
Merged

Pragmas #750

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
7a6a19f
pragma: introduce --#pragma syntax
hishamhm Jun 16, 2024
1b12d76
pragma: arity on/off
hishamhm Jun 16, 2024
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
4 changes: 2 additions & 2 deletions spec/cli/feat_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ local test_cases = {
status = 1,
match = {
"2 errors:",
":9:22: wrong number of arguments (given 3, expects 2)",
":19:22: wrong number of arguments (given 3, expects at least 1 and at most 2)",
":9:22: wrong number of arguments (given 3, expects at most 2)",
":19:22: wrong number of arguments (given 3, expects at most 2)",
}
}
}
Expand Down
237 changes: 237 additions & 0 deletions spec/pragma/arity_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
local util = require("spec.util")

describe("pragma arity", function()
describe("on", function()
it("rejects function calls with missing arguments", util.check_type_error([[
--#pragma arity on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))
]], {
{ msg = "wrong number of arguments (given 1, expects 2)" }
}))

it("accepts optional arguments", util.check([[
--#pragma arity on

local function f(x: integer, y?: integer)
print(x + (y or 20))
end

print(f(10))
]]))
end)

describe("off", function()
it("accepts function calls with missing arguments", util.check([[
--#pragma arity off

local function f(x: integer, y: integer)
print(x + (y or 20))
end

print(f(10))
]]))

it("ignores optional argument annotations", util.check([[
--#pragma arity off

local function f(x: integer, y?: integer)
print(x + y)
end

print(f(10))
]]))
end)

describe("no propagation from required module upwards:", function()
it("on then off, with error in 'on'", function()
util.mock_io(finally, {
["r.tl"] = [[
--#pragma arity off
local function f(x: integer, y: integer, z: integer)
print(x + (y or 20))
end
print(f(10))
]]
})
util.check_type_error([[
--#pragma arity on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))

local r = require("r")

local function g(x: integer, y: integer, z: integer, w: integer)
print(x + y)
end

print(g(10, 20))
]], {
{ filename = "foo.tl", y = 7, msg = "wrong number of arguments (given 1, expects 2)" },
{ filename = "foo.tl", y = 15, msg = "wrong number of arguments (given 2, expects 4)" },
})()
end)

it("on then on, with errors in both", function()
util.mock_io(finally, {
["r.tl"] = [[
--#pragma arity on
local function f(x: integer, y: integer, z: integer)
print(x + (y or 20))
end
print(f(10))
]]
})
util.check_type_error([[
--#pragma arity on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))

local r = require("r")

local function g(x: integer, y: integer, z: integer, w: integer)
print(x + y)
end

print(g(10, 20))
]], {
{ filename = "r.tl", y = 5, msg = "wrong number of arguments (given 1, expects 3)" },
{ filename = "foo.tl", y = 7, msg = "wrong number of arguments (given 1, expects 2)" },
{ filename = "foo.tl", y = 15, msg = "wrong number of arguments (given 2, expects 4)" },
})()
end)

it("off then on, with error in 'on'", function()
util.mock_io(finally, {
["r.tl"] = [[
--#pragma arity on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))
]]
})
util.check_type_error([[
--#pragma arity off

local r = require("r")

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))
]], {
{ y = 7, filename = "r.tl", msg = "wrong number of arguments (given 1, expects 2)" }
})()
end)
end)

describe("does propagate downwards into required module:", function()
it("can trigger errors in required modules", function()
util.mock_io(finally, {
["r.tl"] = [[
local function f(x: integer, y: integer, z: integer)
print(x + (y or 20))
end
print(f(10))

return {
f = f
}
]]
})
util.check_type_error([[
--#pragma arity on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))

local r = require("r")

local function g(x: integer, y: integer, z: integer, w: integer)
print(x + y)
end

print(g(10, 20))

r.f(10)
]], {
{ filename = "r.tl", y = 4, msg = "wrong number of arguments (given 1, expects 3)" },
{ filename = "foo.tl", y = 7, msg = "wrong number of arguments (given 1, expects 2)" },
{ filename = "foo.tl", y = 15, msg = "wrong number of arguments (given 2, expects 4)" },
{ filename = "foo.tl", y = 17, msg = "wrong number of arguments (given 1, expects 3)" },
})()
end)

it("can be used to load modules with different settings", function()
util.mock_io(finally, {
["r.tl"] = [[
local function f(x: integer, y: integer, z: integer)
print(x + (y or 20))
end
print(f(10))

return {
f = f
}
]]
})
util.check_type_error([[
--#pragma arity on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))

--#pragma arity off
local r = require("r")
--#pragma arity on

local function g(x: integer, y: integer, z: integer, w: integer)
print(x + y)
end

print(g(10, 20))

r.f(10) -- no error here!
]], {
{ filename = "foo.tl", y = 7, msg = "wrong number of arguments (given 1, expects 2)" },
{ filename = "foo.tl", y = 17, msg = "wrong number of arguments (given 2, expects 4)" },
})()
end)
end)

describe("invalid", function()
it("rejects invalid value", util.check_type_error([[
--#pragma arity invalid_value

local function f(x: integer, y?: integer)
print(x + y)
end

print(f(10))
]], {
{ y = 1, msg = "invalid value for pragma 'arity': invalid_value" }
}))
end)
end)
29 changes: 29 additions & 0 deletions spec/pragma/invalid_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
local util = require("spec.util")

describe("invalid pragma", function()
it("rejects invalid pragma", util.check_syntax_error([[
--#invalid_pragma on
]], {
{ y = 1, msg = "invalid token '--#invalid_pragma'" }
}))

it("pragmas currently do not accept punctuation", util.check_syntax_error([[
--#pragma something(other)
]], {
{ y = 1, msg = "invalid token '('" },
{ y = 1, msg = "invalid token ')'" },
}))

it("pragma arguments need to be in a single line", util.check_syntax_error([[
--#pragma arity
on

local function f(x: integer, y: integer)
print(x + y)
end

print(f(10))
]], {
{ msg = "expected pragma value" }
}))
end)
Loading
Loading