Teal: convert luarocks.path

1 files changed, 57 insertions, 66 deletions

diff --git a/src/luarocks/path.lua b/src/luarocks/path.tl
index 19657c83..dae3e318 100644
--- a/src/luarocks/path.lua
+++ b/src/luarocks/path.tl
@@ -2,12 +2,23 @@
 --- LuaRocks-specific path handling functions.
 -- All paths are configured in this module, making it a single
 -- point where the layout of the local installation is defined in LuaRocks.
-local path = {}
 
+local cfg = require("luarocks.core.cfg")
 local core = require("luarocks.core.path")
 local dir = require("luarocks.dir")
-local cfg = require("luarocks.core.cfg")
-local util = require("luarocks.util")
+local util = require("luarocks.core.util")
+
+local type Tree = require("luarocks.core.types.tree").Tree
+
+local record path
+   rocks_dir: function(string | Tree): string
+   versioned_name: function(string, string, string, string): string
+   path_to_module: function(string): string
+   deploy_lua_dir: function(string | Tree): string
+   deploy_lib_dir: function(string | Tree): string
+   map_trees: function(string, function(...: any): any..., ...: string): {any}
+   rocks_tree_to_string: function(string | Tree): string
+end
 
 path.rocks_dir = core.rocks_dir
 path.versioned_name = core.versioned_name
@@ -17,34 +28,31 @@ path.deploy_lib_dir = core.deploy_lib_dir
 path.map_trees = core.map_trees
 path.rocks_tree_to_string = core.rocks_tree_to_string
 
+function path.root_dir(tree: string | Tree): string
+   if tree is string then
+      return tree
+   else
+      return tree.root
+   end
+end
+
 --- Infer rockspec filename from a rock filename.
 -- @param rock_name string: Pathname of a rock file.
 -- @return string: Filename of the rockspec, without path.
-function path.rockspec_name_from_rock(rock_name)
-   assert(type(rock_name) == "string")
+function path.rockspec_name_from_rock(rock_name: string): string
    local base_name = dir.base_name(rock_name)
    return base_name:match("(.*)%.[^.]*.rock") .. ".rockspec"
 end
 
-function path.root_from_rocks_dir(rocks_dir)
-   assert(type(rocks_dir) == "string")
+function path.root_from_rocks_dir(rocks_dir: string): string
    return rocks_dir:match("(.*)" .. util.matchquote(cfg.rocks_subdir) .. ".*$")
 end
 
-function path.root_dir(tree)
-   if type(tree) == "string" then
-      return tree
-   else
-      assert(type(tree) == "table")
-      return tree.root
-   end
-end
-
-function path.deploy_bin_dir(tree)
+function path.deploy_bin_dir(tree: string | Tree): string
    return dir.path(path.root_dir(tree), "bin")
 end
 
-function path.manifest_file(tree)
+function path.manifest_file(tree: string | Tree): string
    return dir.path(path.rocks_dir(tree), "manifest")
 end
 
@@ -53,8 +61,8 @@ end
 -- @return string: The resulting path -- does not guarantee that
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- the package (and by extension, the path) exists.
-function path.versions_dir(name, tree)
-   assert(type(name) == "string" and not name:match("/"))
+function path.versions_dir(name: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name)
 end
 
@@ -64,9 +72,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the path) exists.
-function path.install_dir(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.install_dir(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version)
 end
 
@@ -76,9 +83,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the file) exists.
-function path.rockspec_file(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.rockspec_file(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, name.."-"..version..".rockspec")
 end
 
@@ -88,9 +94,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the file) exists.
-function path.rock_manifest_file(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.rock_manifest_file(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "rock_manifest")
 end
 
@@ -100,9 +105,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the file) exists.
-function path.rock_namespace_file(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.rock_namespace_file(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "rock_namespace")
 end
 
@@ -112,9 +116,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the path) exists.
-function path.lib_dir(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.lib_dir(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "lib")
 end
 
@@ -124,9 +127,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the path) exists.
-function path.lua_dir(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.lua_dir(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "lua")
 end
 
@@ -136,9 +138,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the path) exists.
-function path.doc_dir(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.doc_dir(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "doc")
 end
 
@@ -148,9 +149,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the path) exists.
-function path.conf_dir(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.conf_dir(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "conf")
 end
 
@@ -161,9 +161,8 @@ end
 -- @param tree string or nil: If given, specifies the local tree to use.
 -- @return string: The resulting path -- does not guarantee that
 -- the package (and by extension, the path) exists.
-function path.bin_dir(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
+function path.bin_dir(name: string, version: string, tree?: string | Tree): string
+   assert(not name:match("/"))
    return dir.path(path.rocks_dir(tree), name, version, "bin")
 end
 
@@ -172,8 +171,7 @@ end
 -- @param file_name string: pathname of a rock or rockspec
 -- @return (string, string, string) or nil: name, version and arch
 -- or nil if name could not be parsed
-function path.parse_name(file_name)
-   assert(type(file_name) == "string")
+function path.parse_name(file_name: string): string, string, string
    if file_name:match("%.rock$") then
       return dir.base_name(file_name):match("(.*)-([^-]+-%d+)%.([^.]+)%.rock$")
    else
@@ -187,12 +185,8 @@ end
 -- @param version string: Package version.
 -- @param arch string: Architecture identifier, or "rockspec" or "installed".
 -- @return string: A URL or pathname following LuaRocks naming conventions.
-function path.make_url(pathname, name, version, arch)
-   assert(type(pathname) == "string")
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
-   assert(type(arch) == "string")
-
+function path.make_url(pathname: string, name: string, version: string, arch: string): string
+   assert(not name:match("/"))
    local filename = name.."-"..version
    if arch == "installed" then
       filename = dir.path(name, version, filename..".rockspec")
@@ -208,12 +202,11 @@ end
 -- For example, on Unix, "foo.bar.baz" will return "foo/bar".
 -- @param mod string: A module name in Lua dot-separated format.
 -- @return string: A directory name using the platform's separator.
-function path.module_to_path(mod)
-   assert(type(mod) == "string")
+function path.module_to_path(mod: string): string
    return (mod:gsub("[^.]*$", ""):gsub("%.", "/"))
 end
 
-function path.use_tree(tree)
+function path.use_tree(tree: string | Tree)
    cfg.root_dir = tree
    cfg.rocks_dir = path.rocks_dir(tree)
    cfg.deploy_bin_dir = path.deploy_bin_dir(tree)
@@ -221,7 +214,7 @@ function path.use_tree(tree)
    cfg.deploy_lib_dir = path.deploy_lib_dir(tree)
 end
 
-function path.add_to_package_paths(tree)
+function path.add_to_package_paths(tree: string | Tree)
    package.path = dir.path(path.deploy_lua_dir(tree), "?.lua") .. ";"
                .. dir.path(path.deploy_lua_dir(tree), "?/init.lua") .. ";"
                .. package.path
@@ -234,12 +227,10 @@ end
 -- @param version string: The rock version.
 -- @param tree string: The local tree to use.
 -- @return string?: The namespace if it exists, or nil.
-function path.read_namespace(name, version, tree)
-   assert(type(name) == "string" and not name:match("/"))
-   assert(type(version) == "string")
-   assert(type(tree) == "string")
+function path.read_namespace(name: string, version: string, tree: string | Tree): string
+   assert(not name:match("/"))
 
-   local namespace
+   local namespace: string
    local fd = io.open(path.rock_namespace_file(name, version, tree), "r")
    if fd then
       namespace = fd:read("*a")
@@ -248,10 +239,10 @@ function path.read_namespace(name, version, tree)
    return namespace
 end
 
-function path.package_paths(deps_mode)
+function path.package_paths(deps_mode: string): string, string
    local lpaths = {}
    local lcpaths = {}
-   path.map_trees(deps_mode, function(tree)
+   path.map_trees(deps_mode, function(tree: string | Tree)
       local root = path.root_dir(tree)
       table.insert(lpaths, dir.path(root, cfg.lua_modules_path, "?.lua"))
       table.insert(lpaths, dir.path(root, cfg.lua_modules_path, "?/init.lua"))