X-Git-Url: http://nitlanguage.org diff --git a/src/nitpackage.nit b/src/nitpackage.nit index 8c1ec62..0e29e89 100644 --- a/src/nitpackage.nit +++ b/src/nitpackage.nit @@ -21,12 +21,22 @@ redef class ToolContext # --expand var opt_expand = new OptionBool("Move singleton packages to their own directory", "--expand") + # --check-ini + var opt_check_ini = new OptionBool("Check package.ini files", "--check-ini") + + # --gen-ini + var opt_gen_ini = new OptionBool("Generate package.ini files", "--gen-ini") + + # --force + var opt_force = new OptionBool("Force update of existing files", "-f", "--force") + # README handling phase var readme_phase: Phase = new ReadmePhase(self, null) redef init do super - option_context.add_option(opt_expand) + option_context.add_option(opt_expand, opt_force) + option_context.add_option(opt_check_ini, opt_gen_ini) end end @@ -35,7 +45,6 @@ private class ReadmePhase redef fun process_mainmodule(mainmodule, mmodules) do var mpackages = extract_mpackages(mmodules) - for mpackage in mpackages do # Fictive and buggy packages are ignored @@ -45,6 +54,12 @@ private class ReadmePhase continue end + # Check package INI files + if toolcontext.opt_check_ini.value then + mpackage.check_ini(toolcontext) + continue + end + # Expand packages if toolcontext.opt_expand.value and not mpackage.is_expanded then var path = mpackage.expand @@ -55,6 +70,14 @@ private class ReadmePhase "Warning: `{mpackage}` has no package directory") continue end + + # Create INI file + if toolcontext.opt_gen_ini.value then + if not mpackage.has_ini or toolcontext.opt_force.value then + var path = mpackage.gen_ini + toolcontext.info("generated INI file `{path}`", 0) + end + end end end @@ -89,6 +112,179 @@ redef class MPackage return new_path end + + private var maintainer: nullable String is lazy do + return git_exec("git shortlog -esn . | head -n 1 | sed 's/\\s*[0-9]*\\s*//'") + end + + private var contributors: Array[String] is lazy do + var contribs = git_exec("git shortlog -esn . | head -n -1 | " + + "sed 's/\\s*[0-9]*\\s*//'") + if contribs == null then return new Array[String] + return contribs.split("\n") + end + + private var git_url: nullable String is lazy do + var git = git_exec("git remote get-url origin") + if git == null then return null + git = git.replace("git@github.com:", "https://github.com/") + git = git.replace("git@gitlab.com:", "https://gitlab.com/") + return git + end + + private var git_dir: nullable String is lazy do + return git_exec("git rev-parse --show-prefix") + end + + private var browse_url: nullable String is lazy do + var git = git_url + if git == null then return null + var browse = git.replace(".git", "") + var dir = git_dir + if dir == null or dir.is_empty then return browse + return "{browse}/tree/master/{dir}" + end + + private var homepage_url: nullable String is lazy do + var git = git_url + if git == null then return null + # Special case for nit files + if git.has_suffix("/nit.git") then + return "http://nitlanguage.org" + end + return git.replace(".git", "") + end + + private var issues_url: nullable String is lazy do + var git = git_url + if git == null then return null + return "{git.replace(".git", "")}/issues" + end + + private var license: nullable String is lazy do + var git = git_url + if git == null then return null + # Special case for nit files + if git.has_suffix("/nit.git") then + return "Apache-2.0" + end + return null + end + + private fun git_exec(cmd: String): nullable String do + var path = package_path + if path == null then return null + if not is_expanded then path = path.dirname + with pr = new ProcessReader("sh", "-c", "cd {path} && {cmd}") do + return pr.read_all.trim + end + end + + private var allowed_ini_keys = [ + "package.name", "package.desc", "package.tags", "package.license", + "package.maintainer", "package.more_contributors", + "upstream.browse", "upstream.git", "upstream.git.directory", + "upstream.homepage", "upstream.issues" + ] + + private fun check_ini(toolcontext: ToolContext) do + if not has_ini then + toolcontext.error(location, "No `package.ini` file for `{name}`") + return + end + + var pkg_path = package_path + if pkg_path == null then return + + var ini_path = ini_path + if ini_path == null then return + + var ini = new ConfigTree(ini_path) + + ini.check_key(toolcontext, self, "package.name", name) + ini.check_key(toolcontext, self, "package.desc") + ini.check_key(toolcontext, self, "package.tags") + + # FIXME since `git reflog --follow` seems bugged + ini.check_key(toolcontext, self, "package.maintainer") + # var maint = mpackage.maintainer + # if maint != null then + # ini.check_key(toolcontext, self, "package.maintainer", maint) + # end + + # FIXME since `git reflog --follow` seems bugged + # var contribs = mpackage.contributors + # if contribs.not_empty then + # ini.check_key(toolcontext, self, "package.more_contributors", contribs.join(", ")) + # end + + ini.check_key(toolcontext, self, "package.license", license) + ini.check_key(toolcontext, self, "upstream.browse", browse_url) + ini.check_key(toolcontext, self, "upstream.git", git_url) + ini.check_key(toolcontext, self, "upstream.git.directory", git_dir) + ini.check_key(toolcontext, self, "upstream.homepage", homepage_url) + ini.check_key(toolcontext, self, "upstream.issues", issues_url) + + for key in ini.to_map.keys do + if not allowed_ini_keys.has(key) then + toolcontext.warning(location, "unknown-ini-key", + "Warning: ignoring unknown `{key}` key in `{ini.ini_file}`") + end + end + end + + private fun gen_ini: String do + var ini_path = self.ini_path.as(not null) + var ini = new ConfigTree(ini_path) + + ini.update_value("package.name", name) + ini.update_value("package.desc", "") + ini.update_value("package.tags", "") + ini.update_value("package.maintainer", maintainer) + ini.update_value("package.more_contributors", contributors.join(",")) + ini.update_value("package.license", license or else "") + + ini.update_value("upstream.browse", browse_url) + ini.update_value("upstream.git", git_url) + ini.update_value("upstream.git.directory", git_dir) + ini.update_value("upstream.homepage", homepage_url) + ini.update_value("upstream.issues", issues_url) + + ini.save + return ini_path + end +end + +redef class ConfigTree + private fun check_key(toolcontext: ToolContext, mpackage: MPackage, key: String, value: nullable String) do + if not has_key(key) then + toolcontext.warning(mpackage.location, "missing-ini-key", + "Warning: missing `{key}` key in `{ini_file}`") + return + end + if self[key].as(not null).is_empty then + toolcontext.warning(mpackage.location, "missing-ini-value", + "Warning: empty `{key}` key in `{ini_file}`") + return + end + if value != null and self[key] != value then + toolcontext.warning(mpackage.location, "wrong-ini-value", + "Warning: wrong value for `{key}` in `{ini_file}`. " + + "Expected `{value}`, got `{self[key] or else ""}`") + end + end + + private fun update_value(key: String, value: nullable String) do + if value == null then return + if not has_key(key) then + self[key] = value + else + var old_value = self[key] + if not value.is_empty and old_value != value then + self[key] = value + end + end + end end # build toolcontext