Teal: convert luarocks.queries

1 files changed, 34 insertions, 40 deletions

diff --git a/src/luarocks/queries.lua b/src/luarocks/queries.tl
index 0c8790fa..303d9250 100644
--- a/src/luarocks/queries.lua
+++ b/src/luarocks/queries.tl
@@ -1,20 +1,23 @@
 
-local queries = {}
+local record queries
+end
 
 local vers = require("luarocks.core.vers")
 local util = require("luarocks.util")
 local cfg = require("luarocks.core.cfg")
 
-local query_mt = {}
+local query = require("luarocks.core.types.query")
+local type Query = query.Query
 
-query_mt.__index = query_mt
+local type Version = require("luarocks.core.types.version").Version
+local type Constraint = require("luarocks.core.types.version").Constraint
 
-function query_mt.type()
-   return "query"
-end
+local query_mt: metatable<Query> = {}
+
+query_mt.__index = query.Query
 
 -- Fallback default value for the `arch` field, if not explicitly set.
-query_mt.arch = {
+query.Query.arch = {
    src = true,
    all = true,
    rockspec = true,
@@ -23,14 +26,14 @@ query_mt.arch = {
 }
 
 -- Fallback default value for the `substring` field, if not explicitly set.
-query_mt.substring = false
+query.Query.substring = false
 
 --- Convert the arch field of a query table to table format.
 -- @param input string, table or nil
-local function arch_to_table(input)
-   if type(input) == "table" then
+local function arch_to_table(input: string | {string: boolean}): {string: boolean}
+   if input is {string: boolean} then
       return input
-   elseif type(input) == "string" then
+   elseif input is string then
       local arch = {}
       for a in input:gmatch("[%w_-]+") do
          arch[a] = true
@@ -48,17 +51,11 @@ end
 -- @param arch string?: a string with pipe-separated accepted arch values
 -- @param operator string?: operator for version matching (default is "==")
 -- @return table: A query in table format
-function queries.new(name, namespace, version, substring, arch, operator)
-   assert(type(name) == "string")
-   assert(type(namespace) == "string" or not namespace)
-   assert(type(version) == "string" or not version)
-   assert(type(substring) == "boolean" or not substring)
-   assert(type(arch) == "string" or not arch)
-   assert(type(operator) == "string" or not operator)
+function queries.new(name: string, namespace?: string, version?: string, substring?: boolean, arch?: string, operator?: string): Query
 
    operator = operator or "=="
 
-   local self = {
+   local self: Query = {
       name = name,
       namespace = namespace,
       constraints = {},
@@ -69,24 +66,23 @@ function queries.new(name, namespace, version, substring, arch, operator)
       table.insert(self.constraints, { op = operator, version = vers.parse_version(version)})
    end
 
-   query_mt.arch[cfg.arch] = true
+   query.Query.arch[cfg.arch] = true
    return setmetatable(self, query_mt)
 end
 
 -- Query for all packages
 -- @param arch string (optional)
-function queries.all(arch)
-   assert(type(arch) == "string" or not arch)
+function queries.all(arch?: string): Query
 
    return queries.new("", nil, nil, true, arch)
 end
 
 do
-   local parse_constraints
+   local parse_constraints: function(string): {Constraint}, string
    do
-      local parse_constraint
+      local parse_constraint: function(string): Constraint, string
       do
-         local operators = {
+         local operators: {string: string} = {
             ["=="] = "==",
             ["~="] = "~=",
             [">"] = ">",
@@ -108,19 +104,18 @@ do
          -- @return (table, string) or nil: A table representing the same
          -- constraints and the string with the unused input, or nil if the
          -- input string is invalid.
-         parse_constraint = function(input)
-            assert(type(input) == "string")
+         parse_constraint = function(input: string): {string: any}, string
 
-            local no_upgrade, op, version, rest = input:match("^(@?)([<>=~!]*)%s*([%w%.%_%-]+)[%s,]*(.*)")
+            local no_upgrade, op, versionstr, rest = input:match("^(@?)([<>=~!]*)%s*([%w%.%_%-]+)[%s,]*(.*)")
             local _op = operators[op]
-            version = vers.parse_version(version)
+            local version = vers.parse_version(versionstr)
             if not _op then
                return nil, "Encountered bad constraint operator: '"..tostring(op).."' in '"..input.."'"
             end
             if not version then
                return nil, "Could not parse version from constraint: '"..input.."'"
             end
-            return { op = _op, version = version, no_upgrade = no_upgrade=="@" and true or nil }, rest
+            return { op = _op, version = version, no_upgrade = no_upgrade=="@" and true or nil }, rest --? false instead of nil
          end
       end
 
@@ -132,10 +127,10 @@ do
       -- @param input string: A list of constraints in string format.
       -- @return table or nil: A table representing the same constraints,
       -- or nil if the input string is invalid.
-      parse_constraints = function(input)
-         assert(type(input) == "string")
+      parse_constraints = function(input: string): {Constraint}, string
 
-         local constraints, oinput, constraint = {}, input
+         local constraints, oinput = {}, input
+         local constraint: Constraint
          while #input > 0 do
             constraint, input = parse_constraint(input)
             if constraint then
@@ -152,8 +147,7 @@ do
    -- @param depstr string: A dependency in string format
    -- as entered in rockspec files.
    -- @return table: A query in table format, or nil and an error message in case of errors.
-   function queries.from_dep_string(depstr)
-      assert(type(depstr) == "string")
+   function queries.from_dep_string(depstr: string): Query, string
 
       local ns_name, rest = depstr:match("^%s*([a-zA-Z0-9%.%-%_]*/?[a-zA-Z0-9][a-zA-Z0-9%.%-%_]*)%s*([^/]*)")
       if not ns_name then
@@ -175,13 +169,13 @@ do
          constraints = constraints,
       }
 
-      query_mt.arch[cfg.arch] = true
+      query.Query.arch[cfg.arch] = true
       return setmetatable(self, query_mt)
    end
 end
 
-function queries.from_persisted_table(tbl)
-   query_mt.arch[cfg.arch] = true
+function queries.from_persisted_table(tbl: Query): Query
+   query.Query.arch[cfg.arch] = true
    return setmetatable(tbl, query_mt)
 end
 
@@ -189,7 +183,7 @@ end
 -- Includes namespace, name and version, but not arch or constraints.
 -- @param query table: a query table
 -- @return string: a result such as `my_user/my_rock 1.0` or `my_rock`.
-function query_mt:__tostring()
+function query_mt.__tostring(self: Query): string
    local out = {}
    if self.namespace then
       table.insert(out, self.namespace)
@@ -200,7 +194,7 @@ function query_mt:__tostring()
    if #self.constraints > 0 then
       local pretty = {}
       for _, c in ipairs(self.constraints) do
-         local v = c.version.string
+         local v = tostring(c.version)
          if c.op == "==" then
             table.insert(pretty, v)
          else