X-Git-Url: http://nitlanguage.org
diff --git a/src/nitcatalog.nit b/src/nitcatalog.nit
index c843b51..21847ee 100644
--- a/src/nitcatalog.nit
+++ b/src/nitcatalog.nit
@@ -25,7 +25,7 @@
# * [X] generate a page per package with the readme and most metadata
# * [ ] link/include/be included in the documentation
# * [ ] propose `related packages`
-# * [ ] show directory content (a la nitls)
+# * [X] show directory content (a la nitls)
# * [X] gather git information from the working directory
# * [ ] gather git information from the repository
# * [ ] gather package information from github
@@ -33,7 +33,7 @@
# * [ ] reify people
# * [ ] separate information gathering from rendering
# * [ ] move up information gathering in (existing or new) service modules
-# * [ ] add command line options
+# * [X] add command line options
# * [ ] harden HTML (escaping, path injection, etc)
# * [ ] nitcorn server with RESTful API
#
@@ -86,6 +86,12 @@ class CatalogPage
# Placeholder to include additional things before the ``.
var more_head = new Template
+ # Relative path to the root directory (with the index file).
+ #
+ # Use "" for pages in the root directory
+ # Use ".." for pages in a subdirectory
+ var rootpath: String
+
redef init
do
add """
@@ -94,7 +100,7 @@ class CatalogPage
-
+
"""
add more_head
@@ -116,7 +122,7 @@ class CatalogPage
@@ -238,11 +244,36 @@ class Catalog
res.add ""
end
+ # Recursively generate a level in the file tree of the *content* section
+ private fun gen_content_level(ot: OrderedTree[MConcern], os: Array[Object], res: Template)
+ do
+ res.add "
\n"
+ for o in os do
+ res.add "
"
+ if o isa MGroup then
+ var d = ""
+ var mdoc = o.mdoc
+ if mdoc != null then d = ": {mdoc.html_synopsis.write_to_string}"
+ res.add "{o.name}{d} ({o.filepath.to_s})"
+ else if o isa MModule then
+ var d = ""
+ var mdoc = o.mdoc
+ if mdoc != null then d = ": {mdoc.html_synopsis.write_to_string}"
+ res.add "{o.name}{d} ({o.filepath.to_s})"
+ else
+ abort
+ end
+ var subs = ot.sub.get_or_null(o)
+ if subs != null then gen_content_level(ot, subs, res)
+ res.add "
\n"
+ end
+ res.add "
\n"
+ end
# Compute information and generate a full HTML page for a package
fun package_page(mpackage: MPackage): Writable
do
- var res = new CatalogPage
+ var res = new CatalogPage("..")
var score = score[mpackage].to_f
var name = mpackage.name.html_escape
res.more_head.add """{{{name}}}"""
@@ -257,11 +288,43 @@ class Catalog
res.add mdoc.html_documentation
score += mdoc.content.length.score
end
+
+ res.add "
Content
"
+ var ot = new OrderedTree[MConcern]
+ for g in mpackage.mgroups do
+ var pa = g.parent
+ if g.is_interesting then
+ ot.add(pa, g)
+ pa = g
+ end
+ for mp in g.mmodules do
+ ot.add(pa, mp)
+ end
+ end
+ ot.sort_with(alpha_comparator)
+ gen_content_level(ot, ot.roots, res)
+
+
res.add """
"""
+ var tryit = mpackage.metadata("upstream.tryit")
+ if tryit != null then
+ score += 1.0
+ var e = tryit.html_escape
+ res.add "
\n"""
+
var homepage = mpackage.metadata("upstream.homepage")
if homepage != null then
score += 5.0
@@ -314,73 +377,74 @@ class Catalog
res.add "
Tags
\n"
var tags = mpackage.metadata("package.tags")
- var ts2 = new Array[String]
- var cat = null
+ var ts = new Array[String]
if tags != null then
- var ts = tags.split(",")
- for t in ts do
+ for t in tags.split(",") do
t = t.trim
if t == "" then continue
- if cat == null then cat = t
- tag2proj[t].add mpackage
- t = t.html_escape
- ts2.add "{t}"
+ ts.add t
end
- res.add_list(ts2, ", ", ", ")
end
- if ts2.is_empty then
- var t = "none"
- cat = t
+ if ts.is_empty then ts.add "none"
+ if tryit != null then ts.add "tryit"
+ if apk != null then ts.add "apk"
+ var ts2 = new Array[String]
+ for t in ts do
tag2proj[t].add mpackage
- res.add "{t}"
+ t = t.html_escape
+ ts2.add "{t}"
end
- if cat != null then cat2proj[cat].add mpackage
- score += ts2.length.score
-
- var reqs = deps[mpackage].greaters.to_a
- reqs.remove(mpackage)
- alpha_comparator.sort(reqs)
- res.add "
Requirements
\n"
- if reqs.is_empty then
- res.add "none"
- else
- var list = new Array[String]
- for r in reqs do
- var direct = deps.has_direct_edge(mpackage, r)
- var s = ""
- if direct then s += ""
- s += r.to_s
- if direct then s += ""
- s += ""
- list.add s
+ res.add_list(ts2, ", ", ", ")
+ var cat = ts.first
+ cat2proj[cat].add mpackage
+ score += ts.length.score
+
+ if deps.has(mpackage) then
+ var reqs = deps[mpackage].greaters.to_a
+ reqs.remove(mpackage)
+ alpha_comparator.sort(reqs)
+ res.add "
Requirements
\n"
+ if reqs.is_empty then
+ res.add "none"
+ else
+ var list = new Array[String]
+ for r in reqs do
+ var direct = deps.has_direct_edge(mpackage, r)
+ var s = ""
+ if direct then s += ""
+ s += r.to_s
+ if direct then s += ""
+ s += ""
+ list.add s
+ end
+ res.add_list(list, ", ", " and ")
end
- res.add_list(list, ", ", " and ")
- end
- reqs = deps[mpackage].smallers.to_a
- reqs.remove(mpackage)
- alpha_comparator.sort(reqs)
- res.add "
Clients
\n"
- if reqs.is_empty then
- res.add "none"
- else
- var list = new Array[String]
- for r in reqs do
- var direct = deps.has_direct_edge(r, mpackage)
- var s = ""
- if direct then s += ""
- s += r.to_s
- if direct then s += ""
- s += ""
- list.add s
+ reqs = deps[mpackage].smallers.to_a
+ reqs.remove(mpackage)
+ alpha_comparator.sort(reqs)
+ res.add "
Clients
\n"
+ if reqs.is_empty then
+ res.add "none"
+ else
+ var list = new Array[String]
+ for r in reqs do
+ var direct = deps.has_direct_edge(r, mpackage)
+ var s = ""
+ if direct then s += ""
+ s += r.to_s
+ if direct then s += ""
+ s += ""
+ list.add s
+ end
+ res.add_list(list, ", ", " and ")
end
- res.add_list(list, ", ", " and ")
- end
- score += deps[mpackage].greaters.length.score
- score += deps[mpackage].direct_greaters.length.score
- score += deps[mpackage].smallers.length.score
- score += deps[mpackage].direct_smallers.length.score
+ score += deps[mpackage].greaters.length.score
+ score += deps[mpackage].direct_greaters.length.score
+ score += deps[mpackage].smallers.length.score
+ score += deps[mpackage].direct_smallers.length.score
+ end
var contributors = mpackage.contributors
if not contributors.is_empty then
@@ -397,7 +461,7 @@ class Catalog
var mmethods = 0
var loc = 0
for g in mpackage.mgroups do
- mmodules += g.module_paths.length
+ mmodules += g.mmodules.length
for m in g.mmodules do
var am = modelbuilder.mmodule2node(m)
if am != null then
@@ -449,7 +513,7 @@ class Catalog
fun li_package(p: MPackage): String
do
var res = ""
- var f = "{p.name}.html"
+ var f = "p/{p.name}.html"
res += "{p}"
var d = p.mdoc_or_fallback
if d != null then res += " - {d.html_synopsis.write_to_string}"
@@ -553,10 +617,12 @@ class Catalog
res.add "
name
\n"
res.add "
maint
\n"
res.add "
contrib
\n"
- res.add "
reqs
\n"
- res.add "
direct reqs
\n"
- res.add "
clients
\n"
- res.add "
direct clients
\n"
+ if deps.not_empty then
+ res.add "
reqs
\n"
+ res.add "
direct reqs
\n"
+ res.add "
clients
\n"
+ res.add "
direct clients
\n"
+ end
res.add "
modules
\n"
res.add "
classes
\n"
res.add "
methods
\n"
@@ -565,15 +631,17 @@ class Catalog
res.add ""
for p in mpackages do
res.add "
"
var maint = "?"
if p.maintainers.not_empty then maint = p.maintainers.first
res.add "
{maint}
"
res.add "
{p.contributors.length}
"
- res.add "
{deps[p].greaters.length-1}
"
- res.add "
{deps[p].direct_greaters.length}
"
- res.add "
{deps[p].smallers.length-1}
"
- res.add "
{deps[p].direct_smallers.length}
"
+ if deps.not_empty then
+ res.add "
{deps[p].greaters.length-1}
"
+ res.add "
{deps[p].direct_greaters.length}
"
+ res.add "
{deps[p].smallers.length-1}
"
+ res.add "
{deps[p].direct_smallers.length}
"
+ end
res.add "
{mmodules[p]}
"
res.add "
{mclasses[p]}
"
res.add "
{mmethods[p]}
"
@@ -600,6 +668,13 @@ end
var model = new Model
var tc = new ToolContext
+var opt_dir = new OptionString("Directory where the HTML files are generated", "-d", "--dir")
+var opt_no_git = new OptionBool("Do not gather git information from the working directory", "--no-git")
+var opt_no_parse = new OptionBool("Do not parse nit files (no importation information)", "--no-parse")
+var opt_no_model = new OptionBool("Do not analyse nit files (no class/method information)", "--no-model")
+
+tc.option_context.add_option(opt_dir, opt_no_git, opt_no_parse, opt_no_model)
+
tc.process_options(sys.args)
tc.keep_going = true
@@ -607,9 +682,11 @@ var modelbuilder = new ModelBuilder(model, tc)
var catalog = new Catalog(modelbuilder)
# Get files or groups
-for a in tc.option_context.rest do
- modelbuilder.get_mgroup(a)
- modelbuilder.identify_file(a)
+var args = tc.option_context.rest
+if opt_no_parse.value then
+ modelbuilder.scan_full(args)
+else
+ modelbuilder.parse_full(args)
end
# Scan packages and compute information
@@ -619,7 +696,7 @@ for p in model.mpackages do
modelbuilder.scan_group(g)
# Load the module to process importation information
- modelbuilder.parse_group(g)
+ if opt_no_parse.value then continue
catalog.deps.add_node(p)
for gg in p.mgroups do for m in gg.mmodules do
@@ -629,15 +706,19 @@ for p in model.mpackages do
catalog.deps.add_edge(p, ip)
end
end
+end
+if not opt_no_git.value then for p in model.mpackages do
catalog.git_info(p)
end
# Run phases to modelize classes and properties (so we can count them)
-#modelbuilder.run_phases
+if not opt_no_model.value then
+ modelbuilder.run_phases
+end
-var out = "out"
-out.mkdir
+var out = opt_dir.value or else "catalog.out"
+(out/"p").mkdir
# Generate the css (hard coded)
var css = """
@@ -743,13 +824,13 @@ css.write_to_file(out/"style.css")
for p in model.mpackages do
# print p
- var f = "{p.name}.html"
+ var f = "p/{p.name}.html"
catalog.package_page(p).write_to_file(out/f)
end
# INDEX
-var index = new CatalogPage
+var index = new CatalogPage("")
index.more_head.add "Packages in Nit"
index.add """
@@ -760,12 +841,14 @@ index.add """
index.add "
\n"
-var reqs = new Counter[MPackage]
-for p in model.mpackages do
- reqs[p] = catalog.deps[p].smallers.length - 1
+if catalog.deps.not_empty then
+ index.add "
Most Required
\n"
+ var reqs = new Counter[MPackage]
+ for p in model.mpackages do
+ reqs[p] = catalog.deps[p].smallers.length - 1
+ end
+ index.add catalog.list_best(reqs)
end
-index.add catalog.list_best(reqs)
index.add "
By First Tag
\n"
index.add catalog.list_by(catalog.cat2proj, "cat_")
@@ -794,7 +877,7 @@ index.write_to_file(out/"index.html")
# PEOPLE
-var page = new CatalogPage
+var page = new CatalogPage("")
page.more_head.add "People of Nit"
page.add """
\n
People of Nit
\n"""
page.add "
By Maintainer
\n"
@@ -806,7 +889,7 @@ page.write_to_file(out/"people.html")
# TABLE
-page = new CatalogPage
+page = new CatalogPage("")
page.more_head.add "Projets of Nit"
page.add """