# Returns the mentity name with short signature.
#
- # * MProject: `foo`
+ # * MPackage: `foo`
# * MGroup: `foo`
# * MModule: `foo`
# * MClass: `Foo[E]`
# Returns the complete MEntity declaration (modifiers + name + signature).
#
- # * MProject: `project foo`
+ # * MPackage: `package foo`
# * MGroup: `group foo`
# * MModule: `module foo`
# * MClass: `private abstract class Foo[E: Object]`
# Returns `self` namespace formatted for console.
#
- # * MProject: `mproject`
- # * MGroup: `mproject(::group)`
+ # * MPackage: `mpackage`
+ # * MGroup: `mpackage(::group)`
# * MModule: `mgroup::mmodule`
- # * MClass: `mproject::mclass`
+ # * MClass: `mpackage::mclass`
# * MClassDef: `mmodule::mclassdef`
# * MProperty: `mclass::mprop`
# * MPropdef: `mclassdef:mpropdef`
end
end
-redef class MProject
- redef var cs_modifiers = ["project"]
+redef class MPackage
+ redef var cs_modifiers = ["package"]
redef fun cs_namespace do return cs_name
redef fun cs_icon do return "P"
redef fun cs_location do return root.mmodules.first.location.to_s
# Depends if `self` is root or not.
#
- # * If root `mproject`.
- # * Else `mproject::self`.
+ # * If root `mpackage`.
+ # * Else `mpackage::self`.
redef fun cs_namespace do
var tpl = new FlatBuffer
- tpl.append mproject.cs_namespace
- if mproject.root != self then
+ tpl.append mpackage.cs_namespace
+ if mpackage.root != self then
tpl.append "::"
tpl.append cs_name
end
redef fun cs_modifiers do return intro.cs_modifiers
redef fun cs_declaration do return intro.cs_declaration
- # Returns `mproject::self`.
+ # Returns `mpackage::self`.
redef fun cs_namespace do
var tpl = new FlatBuffer
- tpl.append intro_mmodule.mgroup.mproject.cs_namespace
+ tpl.append intro_mmodule.mgroup.mpackage.cs_namespace
tpl.append "::"
tpl.append cs_name
return tpl.write_to_string
redef fun rendering do
var mentity = self.mentity
- if mentity isa MGroup and mentity.mproject.root == mentity then
+ if mentity isa MGroup and mentity.mpackage.root == mentity then
render_body
else
super
doc.populate(self)
end
- # Should we exclude this `mproject` from the documentation?
+ # Should we exclude this `mpackage` from the documentation?
fun ignore_mentity(mentity: MEntity): Bool do
if mentity isa MModule then
return mentity.is_fictive or mentity.is_test_suite
# TODO Should I rebuild a new Model from filtered data?
redef class DocModel
- # MProjects that will be documented.
- var mprojects = new HashSet[MProject]
+ # MPackages that will be documented.
+ var mpackages = new HashSet[MPackage]
# MGroups that will be documented.
var mgroups = new HashSet[MGroup]
# Populate `self` from internal `model`.
fun populate(v: ExtractionPhase) do
- populate_mprojects(v)
+ populate_mpackages(v)
populate_mclasses(v)
populate_mproperties(v)
end
- # Populates the `mprojects` set.
- private fun populate_mprojects(v: ExtractionPhase) do
- for mproject in model.mprojects do
- if v.ignore_mentity(mproject) then continue
- self.mprojects.add mproject
- for mgroup in mproject.mgroups do
+ # Populates the `mpackages` set.
+ private fun populate_mpackages(v: ExtractionPhase) do
+ for mpackage in model.mpackages do
+ if v.ignore_mentity(mpackage) then continue
+ self.mpackages.add mpackage
+ for mgroup in mpackage.mgroups do
if v.ignore_mentity(mgroup) then continue
self.mgroups.add mgroup
for mmodule in mgroup.mmodules do
# FIXME invalidate cache if `self` is modified.
var mentities: Collection[MEntity] is lazy do
var res = new HashSet[MEntity]
- res.add_all mprojects
+ res.add_all mpackages
res.add_all mgroups
res.add_all mmodules
res.add_all mclasses
#
# Path can be the shortest possible to disambiguise like `Class::property`.
# In case of larger conflicts, a more complex namespace can be given like
- # `project::module::Class::prop`.
+ # `package::module::Class::prop`.
fun mentities_by_namespace(namespace: String): Array[MEntity] do
var res = new Array[MEntity]
for mentity in mentities do
end
end
-redef class MProject
+redef class MPackage
redef fun mentities_by_namespace(namespace, res) do lookup_in(mgroups, namespace, res)
end
# Display a custom brand or logo in the documentation top menu.
var opt_custom_brand = new OptionString("custom link to external site", "--custom-brand")
- # Display a custom introduction text before the projects overview.
+ # Display a custom introduction text before the packages overview.
var opt_custom_intro = new OptionString("custom intro text for homepage", "--custom-overview-text")
# Display a custom footer on each documentation page.
#
# FIXME redo the plugin
var opt_github_base_sha1 = new OptionString("Git sha1 of base commit used to create pull request", "--github-base-sha1")
# FIXME redo the plugin
- var opt_github_gitdir = new OptionString("Git working directory used to resolve path name (ex: /home/me/myproject/)", "--github-gitdir")
+ var opt_github_gitdir = new OptionString("Git working directory used to resolve path name (ex: /home/me/mypackage/)", "--github-gitdir")
redef init do
super
redef fun init_topmenu(v, doc) do
super
- var mproject = mentity.mproject
+ var mpackage = mentity.mpackage
if not mentity.is_root then
- topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+ topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
end
- topmenu.add_li new ListItem(new Link(html_url, mproject.html_name))
+ topmenu.add_li new ListItem(new Link(html_url, mpackage.html_name))
topmenu.active_item = topmenu.items.last
end
redef class MGroupPage
redef fun init_topmenu(v, doc) do
super
- var mproject = mentity.mproject
+ var mpackage = mentity.mpackage
if not mentity.is_root then
- topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+ topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
end
- topmenu.add_li new ListItem(new Link(html_url, mproject.html_name))
+ topmenu.add_li new ListItem(new Link(html_url, mpackage.html_name))
topmenu.active_item = topmenu.items.last
end
redef class MModulePage
redef fun init_topmenu(v, doc) do
super
- var mproject = mentity.mproject
- topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+ var mpackage = mentity.mpackage
+ topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
topmenu.add_li new ListItem(new Link(mentity.nitdoc_url, mentity.html_name))
topmenu.active_item = topmenu.items.last
end
redef fun init_topmenu(v, doc) do
super
- var mproject = mentity.intro_mmodule.mgroup.mproject
- topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+ var mpackage = mentity.intro_mmodule.mgroup.mpackage
+ topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
topmenu.add_li new ListItem(new Link(html_url, mentity.html_name))
topmenu.active_item = topmenu.items.last
end
redef fun init_topmenu(v, doc) do
super
var mmodule = mentity.intro_mclassdef.mmodule
- var mproject = mmodule.mgroup.mproject
+ var mpackage = mmodule.mgroup.mpackage
var mclass = mentity.intro_mclassdef.mclass
- topmenu.add_li new ListItem(new Link(mproject.nitdoc_url, mproject.html_name))
+ topmenu.add_li new ListItem(new Link(mpackage.nitdoc_url, mpackage.html_name))
topmenu.add_li new ListItem(new Link(mclass.nitdoc_url, mclass.html_name))
topmenu.add_li new ListItem(new Link(html_url, mentity.html_name))
topmenu.active_item = topmenu.items.last
if not page isa MEntityPage then return
var mentity = self.mentity
if mentity isa MGroup and mentity.is_root then
- html_title = mentity.mproject.html_name
- html_subtitle = mentity.mproject.html_declaration
+ html_title = mentity.mpackage.html_name
+ html_subtitle = mentity.mpackage.html_declaration
else if mentity isa MProperty then
var title = new Template
title.add mentity.html_name
redef class DefinitionArticle
redef fun init_html_render(v, doc, page) do
var mentity = self.mentity
- if mentity isa MProject or mentity isa MModule then
+ if mentity isa MPackage or mentity isa MModule then
var title = new Template
title.add mentity.html_icon
title.add mentity.html_namespace
private fun filter_results(res: Array[MEntity]): Array[MEntity] do
var out = new Array[MEntity]
for e in res do
- if e isa MProject then continue
+ if e isa MPackage then continue
if e isa MGroup then continue
out.add e
end
redef fun apply_structure(v, doc) do
var article = new HomeArticle("home.article", "Home")
root.add_child article
- # Projects list
- var mprojects = doc.model.mprojects.to_a
+ # Packages list
+ var mpackages = doc.model.mpackages.to_a
var sorter = new MConcernRankSorter
- sorter.sort mprojects
- var section = new DocSection("projects.section", "Projects")
- for mproject in mprojects do
- section.add_child new DefinitionArticle("{mproject.nitdoc_id}.definition", null, mproject)
+ sorter.sort mpackages
+ var section = new DocSection("packages.section", "Packages")
+ for mpackage in mpackages do
+ section.add_child new DefinitionArticle("{mpackage.nitdoc_id}.definition", null, mpackage)
end
article.add_child section
end
var section = new MEntitySection("{mentity.nitdoc_name}.section", null, mentity)
root.add_child section
if mentity.is_root then
- section.add_child new IntroArticle("{mentity.mproject.nitdoc_id}.intro", null, mentity.mproject)
+ section.add_child new IntroArticle("{mentity.mpackage.nitdoc_id}.intro", null, mentity.mpackage)
else
section.add_child new IntroArticle("{mentity.nitdoc_id}.intro", null, mentity)
end
var concerns = self.concerns
if concerns == null or concerns.is_empty then return
# FIXME avoid diff
- mentity.mproject.booster_rank = -1000
+ mentity.mpackage.booster_rank = -1000
mentity.booster_rank = -1000
concerns.sort_with(v.concerns_sorter)
- mentity.mproject.booster_rank = 0
+ mentity.mpackage.booster_rank = 0
mentity.booster_rank = 0
section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
for mentity in concerns do
var concerns = self.concerns
if concerns == null or concerns.is_empty then return
# FIXME avoid diff
- mentity.mgroup.mproject.booster_rank = -1000
+ mentity.mgroup.mpackage.booster_rank = -1000
mentity.mgroup.booster_rank = -1000
mentity.booster_rank = -1000
concerns.sort_with(v.concerns_sorter)
- mentity.mgroup.mproject.booster_rank = 0
+ mentity.mgroup.mpackage.booster_rank = 0
mentity.mgroup.booster_rank = 0
mentity.booster_rank = 0
section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
var concerns = self.concerns
if concerns == null or concerns.is_empty then return
# FIXME diff hack
- mentity.intro_mmodule.mgroup.mproject.booster_rank = -1000
+ mentity.intro_mmodule.mgroup.mpackage.booster_rank = -1000
mentity.intro_mmodule.mgroup.booster_rank = -1000
mentity.intro_mmodule.booster_rank = -1000
concerns.sort_with(v.concerns_sorter)
- mentity.intro_mmodule.mgroup.mproject.booster_rank = 0
+ mentity.intro_mmodule.mgroup.mpackage.booster_rank = 0
mentity.intro_mmodule.mgroup.booster_rank = 0
mentity.intro_mmodule.booster_rank = 0
var constructors = new DocSection("{mentity.nitdoc_id}.constructors", "Constructors")
var concerns = self.concerns
if concerns == null or concerns.is_empty then return
# FIXME diff hack
- mentity.intro.mclassdef.mmodule.mgroup.mproject.booster_rank = -1000
+ mentity.intro.mclassdef.mmodule.mgroup.mpackage.booster_rank = -1000
mentity.intro.mclassdef.mmodule.mgroup.booster_rank = -1000
mentity.intro.mclassdef.mmodule.booster_rank = -1000
concerns.sort_with(v.concerns_sorter)
- mentity.intro.mclassdef.mmodule.mgroup.mproject.booster_rank = 0
+ mentity.intro.mclassdef.mmodule.mgroup.mpackage.booster_rank = 0
mentity.intro.mclassdef.mmodule.mgroup.booster_rank = 0
mentity.intro.mclassdef.mmodule.booster_rank = 0
section.add_child new ConcernsArticle("{mentity.nitdoc_id}.concerns", null, mentity, concerns)
redef var is_hidden = false
end
-# The main project article.
+# The main package article.
class HomeArticle
super DocArticle
end
fun concern_rank: Int is abstract
end
-redef class MProject
+redef class MPackage
redef var concern_rank is lazy do
var max = 0
for mgroup in mgroups do
# Returns the mentity name without short signature.
#
- # * MProject: `foo`
+ # * MPackage: `foo`
# * MGroup: `foo`
# * MModule: `foo`
# * MClass: `Foo[E]`
# Returns the complete MEntity declaration decorated with HTML.
#
- # * MProject: `project foo`
+ # * MPackage: `package foo`
# * MGroup: `group foo`
# * MModule: `module foo`
# * MClass: `private abstract class Foo[E: Object]`
# Returns `self` namespace decorated with HTML links.
#
- # * MProject: `mproject`
- # * MGroup: `mproject(::group)`
+ # * MPackage: `mpackage`
+ # * MGroup: `mpackage(::group)`
# * MModule: `mgroup::mmodule`
- # * MClass: `mproject::mclass`
+ # * MClass: `mpackage::mclass`
# * MClassDef: `mmodule::mclassdef`
# * MProperty: `mclass::mprop`
# * MPropdef: `mclassdef:mpropdef`
end
end
-redef class MProject
+redef class MPackage
redef var nitdoc_id = name.to_cmangle is lazy
redef fun nitdoc_url do return root.nitdoc_url
- redef var html_modifiers = ["project"]
+ redef var html_modifiers = ["package"]
redef fun html_namespace do return html_link
redef var css_classes = ["public"]
end
# Depends if `self` is root or not.
#
- # * If root `mproject`.
- # * Else `mproject::self`.
+ # * If root `mpackage`.
+ # * Else `mpackage::self`.
redef fun html_namespace do
var tpl = new Template
- tpl.add mproject.html_namespace
- if mproject.root != self then
+ tpl.add mpackage.html_namespace
+ if mpackage.root != self then
tpl.add "::"
tpl.add html_link
end
redef fun html_modifiers do return intro.html_modifiers
redef fun html_declaration do return intro.html_declaration
- # Returns `mproject::self`.
+ # Returns `mpackage::self`.
redef fun html_namespace do
var tpl = new Template
- tpl.add intro_mmodule.mgroup.mproject.html_namespace
+ tpl.add intro_mmodule.mgroup.mpackage.html_namespace
tpl.add "::<span>"
tpl.add html_link
tpl.add "</span>"
redef fun render_body do
var tabs = new DocTabs("{html_id}.tabs", "")
var comment = mentity.html_documentation
- if mentity isa MProject then
+ if mentity isa MPackage then
comment = mentity.html_synopsis
end
if comment != null then
var tabs = new DocTabs("{html_id}.tabs", "")
if not is_no_body then
var comment
- if is_short_comment or mentity isa MProject then
+ if is_short_comment or mentity isa MPackage then
comment = mentity.html_synopsis
else
comment = mentity.html_documentation
end
redef class MModule
- # Extra Java files to compile with the project
+ # Extra Java files to compile with the module
private var extra_java_files: nullable Array[JavaFile] = null
end
#
# Each name can be:
#
- # * a path to a module, a group or a directory of projects.
+ # * a path to a module, a group or a directory of packages.
# * a short name of a module or a group that are looked in the `paths` (-I)
#
# Then, for each entry, if it is:
#
# * a module, then is it parser and returned.
# * a group then recursively all its modules are parsed.
- # * a directory of projects then all the modules of all projects are parsed.
+ # * a directory of packages then all the modules of all packages are parsed.
# * else an error is displayed.
#
# See `parse` for details.
# First, look in groups
var c = mgroup
if c != null then
- var r = c.mproject.root
+ var r = c.mpackage.root
assert r != null
scan_group(r)
var res = r.mmodule_paths_by_name(name)
# Look at some known directories
var lookpaths = self.paths
- # Look in the directory of the group project also (even if not explicitly in the path)
+ # Look in the directory of the group package also (even if not explicitly in the path)
if mgroup != null then
# path of the root group
- var dirname = mgroup.mproject.root.filepath
+ var dirname = mgroup.mpackage.root.filepath
if dirname != null then
dirname = dirname.join_path("..").simplify_path
if not lookpaths.has(dirname) and dirname.file_exists then
# See `identify_file`.
var identified_files = new Array[ModulePath]
- # Identify a source file and load the associated project and groups if required.
+ # Identify a source file and load the associated package and groups if required.
#
# This method does what the user expects when giving an argument to a Nit tool.
#
# * If `path` is a directory (with a `/`),
# then the ModulePath of its default module is returned (if any)
# * If `path` is a simple identifier (eg. `digraph`),
- # then the main module of the project `digraph` is searched in `paths` and returned.
+ # then the main module of the package `digraph` is searched in `paths` and returned.
#
# Silently return `null` if `path` does not exists or cannot be identified.
fun identify_file(path: String): nullable ModulePath
var mgroup = get_mgroup(mgrouppath)
if mgroup == null then
- # singleton project
- var mproject = new MProject(pn, model)
- mgroup = new MGroup(pn, mproject, null) # same name for the root group
+ # singleton package
+ var mpackage = new MPackage(pn, model)
+ mgroup = new MGroup(pn, mpackage, null) # same name for the root group
mgroup.filepath = path
- mproject.root = mgroup
- toolcontext.info("found singleton project `{pn}` at {path}", 2)
+ mpackage.root = mgroup
+ toolcontext.info("found singleton package `{pn}` at {path}", 2)
- # Attach homonymous `ini` file to the project
+ # Attach homonymous `ini` file to the package
var inipath = path.dirname / "{pn}.ini"
if inipath.file_exists then
var ini = new ConfigTree(inipath)
- mproject.ini = ini
+ mpackage.ini = ini
end
end
return null
end
- # By default, the name of the project or group is the base_name of the directory
+ # By default, the name of the package or group is the base_name of the directory
var pn = rdp.basename(".nit")
- # Check `project.ini` that indicate a project
+ # Check `package.ini` that indicate a package
var ini = null
var parent = null
- var inipath = dirpath / "project.ini"
+ var inipath = dirpath / "package.ini"
if inipath.file_exists then
ini = new ConfigTree(inipath)
end
return null
end
- # Special stopper `projects.ini`
- if (dirpath/"projects.ini").file_exists then
- # dirpath cannot be a project since it is a project directory
+ # Special stopper `packages.ini`
+ if (dirpath/"packages.ini").file_exists then
+ # dirpath cannot be a package since it is a package directory
mgroups[rdp] = null
return null
end
# check the parent directory (if it does not contain the stopper file)
var parentpath = dirpath.join_path("..").simplify_path
- var stopper = parentpath / "projects.ini"
+ var stopper = parentpath / "packages.ini"
if not stopper.file_exists then
# Recursively get the parent group
parent = get_mgroup(parentpath)
var mgroup
if parent == null then
- # no parent, thus new project
- if ini != null then pn = ini["project.name"] or else pn
- var mproject = new MProject(pn, model)
- mgroup = new MGroup(pn, mproject, null) # same name for the root group
- mproject.root = mgroup
- toolcontext.info("found project `{mproject}` at {dirpath}", 2)
- mproject.ini = ini
+ # no parent, thus new package
+ if ini != null then pn = ini["package.name"] or else pn
+ var mpackage = new MPackage(pn, model)
+ mgroup = new MGroup(pn, mpackage, null) # same name for the root group
+ mpackage.root = mgroup
+ toolcontext.info("found package `{mpackage}` at {dirpath}", 2)
+ mpackage.ini = ini
else
- mgroup = new MGroup(pn, parent.mproject, parent)
+ mgroup = new MGroup(pn, parent.mpackage, parent)
toolcontext.info("found sub group `{mgroup.full_name}` at {dirpath}", 2)
end
# search documentation
- # in src first so the documentation of the project code can be distinct for the documentation of the project usage
+ # in src first so the documentation of the package code can be distinct for the documentation of the package usage
var readme = dirpath.join_path("README.md")
if not readme.file_exists then readme = dirpath.join_path("README")
if readme.file_exists then
for f in p.files do
var fp = p/f
var g = get_mgroup(fp)
- # Recursively scan for groups of the same project
- if g != null and g.mproject == mgroup.mproject then
+ # Recursively scan for groups of the same package
+ if g != null and g.mpackage == mgroup.mpackage then
scan_group(g)
end
identify_file(fp)
end
end
- # Check for conflicting module names in the project
+ # Check for conflicting module names in the package
if mgroup != null then
var others = model.get_mmodules_by_name(mod_name)
if others != null then for other in others do
- if other.mgroup!= null and other.mgroup.mproject == mgroup.mproject then
+ if other.mgroup!= null and other.mgroup.mpackage == mgroup.mpackage then
var node: ANode
if decl == null then node = nmodule else node = decl.n_name
error(node, "Error: a module named `{other.full_name}` already exists at {other.location}.")
# If qualified and in a group
if mgroup != null then
- # First search in the project
- var r = mgroup.mproject.root
+ # First search in the package
+ var r = mgroup.mpackage.root
assert r != null
scan_group(r)
# Get all modules with the final name
# The human path of the module
var filepath: String
- # The group (and the project) of the possible module
+ # The group (and the package) of the possible module
var mgroup: MGroup
# The loaded module (if any)
redef fun to_s do return filepath
end
-redef class MProject
+redef class MPackage
# The associated `.ini` file, if any
#
# The `ini` file is given as is and might contain invalid or missing information.
#
- # Some projects, like stand-alone projects or virtual projects have no `ini` file associated.
+ # Some packages, like stand-alone packages or virtual packages have no `ini` file associated.
var ini: nullable ConfigTree = null
end
# Is the group interesting for a final user?
#
- # Groups are mandatory in the model but for simple projects they are not
+ # Groups are mandatory in the model but for simple packages they are not
# always interesting.
#
# A interesting group has, at least, one of the following true:
## ONLY covariance remains here
- cpt_modules.inc(mmodule.mgroup.mproject.name)
+ cpt_modules.inc(mmodule.mgroup.mpackage.name)
cpt_classes.inc(sub.mclass)
# Track if `cpt_explanations` is already decided (used to fallback on unknown)
fun generate_module_hierarchy(toolcontext: ToolContext, given_mmodules: Collection[MModule])
do
var model = given_mmodules.first.model
- var dot = new MProjectDot(model)
+ var dot = new MPackageDot(model)
- # Collect requested projects
+ # Collect requested packages
for m in given_mmodules do
var g = m.mgroup
if g == null then continue
- dot.mprojects.add(g.mproject)
+ dot.mpackages.add(g.mpackage)
end
- var projectpath = toolcontext.output_dir.join_path("project_hierarchy.dot")
- print "generating project_hierarchy.dot"
- dot.write_to_file(projectpath)
+ var packagepath = toolcontext.output_dir.join_path("package_hierarchy.dot")
+ print "generating package_hierarchy.dot"
+ dot.write_to_file(packagepath)
var modulepath = toolcontext.output_dir.join_path("module_hierarchy.dot")
- dot.mprojects.add_all(model.mprojects)
+ dot.mpackages.add_all(model.mpackages)
print "generating module_hierarchy.dot"
dot.write_to_file(modulepath)
end
var model = toolcontext.modelbuilder.model
var mmodules = new HashSet[MModule]
var mclasses = new HashSet[MClass]
- for mproject in model.mprojects do
+ for mpackage in model.mpackages do
- print toolcontext.format_h2("\n ## project {mproject}")
+ print toolcontext.format_h2("\n ## package {mpackage}")
- for mgroup in mproject.mgroups do
+ for mgroup in mpackage.mgroups do
if mgroup.mmodules.is_empty then continue
# Scalar metrics
var model = toolcontext.modelbuilder.model
var mclasses = new HashSet[MClass]
- for mproject in model.mprojects do
+ for mpackage in model.mpackages do
- print toolcontext.format_h2("\n ## project {mproject}")
+ print toolcontext.format_h2("\n ## package {mpackage}")
- for mgroup in mproject.mgroups do
+ for mgroup in mpackage.mgroups do
if mgroup.mmodules.is_empty then continue
metrics.clear
var model = toolcontext.modelbuilder.model
var mmodules = new HashSet[MModule]
- for mproject in model.mprojects do
+ for mpackage in model.mpackages do
- print toolcontext.format_h2("\n ## project {mproject}")
- for mgroup in mproject.mgroups do
+ print toolcontext.format_h2("\n ## package {mpackage}")
+ for mgroup in mpackage.mgroups do
if mgroup.mmodules.is_empty then continue
# Scalar metrics
buf.append("<html>\n<body>\n")
buf.append("<h1>Model</h1>\n")
- buf.append("<h2>Projects</h2>\n")
- for mproject in model.mprojects do
- buf.append("<h3 id='project-{mproject}'>Project {mproject}</h3>\n")
+ buf.append("<h2>Packages</h2>\n")
+ for mpackage in model.mpackages do
+ buf.append("<h3 id='package-{mpackage}'>Package {mpackage}</h3>\n")
buf.append("<dl>\n")
buf.append("<dt>groups</dt>\n")
- for x in mproject.mgroups do
+ for x in mpackage.mgroups do
buf.append("<dd>{linkto(x)}</dd>\n")
end
buf.append("</dl>\n")
end
buf.append("<h2>Groups</h2>\n")
- for mproject in model.mprojects do
- for mgroup in mproject.mgroups do
+ for mpackage in model.mpackages do
+ for mgroup in mpackage.mgroups do
buf.append("<h3 id='group-{mgroup}'>Group {mgroup}</h3>\n")
buf.append("<dl>\n")
- buf.append("<dt>project</dt>\n")
- buf.append("<dd>{linkto(mproject)}</dd>\n")
+ buf.append("<dt>package</dt>\n")
+ buf.append("<dd>{linkto(mpackage)}</dd>\n")
buf.append("<dt>filepath</dt>\n")
buf.append("<dd>{mgroup.filepath.to_s}</dd>\n")
var p = mgroup.parent
private fun linkto(o: Object): String
do
- if o isa MProject then
- return "<a href='#project-{o}'>{o}</a>"
+ if o isa MPackage then
+ return "<a href='#package-{o}'>{o}</a>"
else if o isa MGroup then
return "<a href='#group-{o}'>{o}</a>"
else if o isa MModule then
var model = toolcontext.modelbuilder.model
var mclasses = new HashSet[MClass]
- for mproject in model.mprojects do
+ for mpackage in model.mpackages do
- print toolcontext.format_h2("\n ## project {mproject}")
+ print toolcontext.format_h2("\n ## package {mpackage}")
- for mgroup in mproject.mgroups do
+ for mgroup in mpackage.mgroups do
if mgroup.mmodules.is_empty then continue
metrics.clear
# The documentation associated to the entity or their main nested entity.
#
- # MProject fall-back to their root MGroup
+ # MPackage fall-back to their root MGroup
# MGroup fall-back to their default_mmodule
# Other entities do not fall-back
#
module mmodule
import location
-import mproject
+import mpackage
private import more_collections
# The container class of a Nit object-oriented model.
# The model considered
redef var model: Model
- # The group of module in the project if any
+ # The group of module in the package if any
var mgroup: nullable MGroup
- # The project of the module if any
- # Safe alias for `mgroup.mproject`
- fun mproject: nullable MProject
+ # The package of the module if any
+ # Safe alias for `mgroup.mpackage`
+ fun mpackage: nullable MPackage
do
var g = mgroup
- if g == null then return null else return g.mproject
+ if g == null then return null else return g.mpackage
end
# The short name of the module
# The canonical name of the module.
#
- # It is usually the `name` prefixed by the project's name.
- # Example: `"project::name"`
+ # It is usually the `name` prefixed by the package's name.
+ # Example: `"package::name"`
#
- # If both names are the same (of if the module is project-less), then
+ # If both names are the same (of if the module is package-less), then
# the short-name is used alone.
redef var full_name is lazy do
var mgroup = self.mgroup
- if mgroup == null or mgroup.mproject.name == self.name then
+ if mgroup == null or mgroup.mpackage.name == self.name then
return self.name
else
- return "{mgroup.mproject.name}::{self.name}"
+ return "{mgroup.mpackage.name}::{self.name}"
end
end
# The namespace used for entities according to their visibility `v`.
#
- # Public entities use only the project as a namespace.
- # Private entities use the `full_name` (i.e. "project::module")
+ # Public entities use only the package as a namespace.
+ # Private entities use the `full_name` (i.e. "package::module")
#
# This method is used by entities to implement their `full_name`.
fun namespace_for(v: MVisibility): String do
if mgroup == null then
return full_name
else
- return mgroup.mproject.full_name
+ return mgroup.mpackage.full_name
end
end
redef var c_name: String is lazy do
var g = mgroup
var res
- if g != null and g.mproject.name != name then
- res = g.mproject.name.to_cmangle + "__" + name.to_cmangle
+ if g != null and g.mpackage.name != name then
+ res = g.mpackage.name.to_cmangle + "__" + name.to_cmangle
else
res = name.to_cmangle
end
if mgroup == null then
return c_name
else
- return mgroup.mproject.c_name
+ return mgroup.mpackage.c_name
end
end
# public gives 'p#A'
# private gives 'p::m#A'
return "{mmodule.namespace_for(mclass.visibility)}#{mclass.name}"
- else if mclass.intro_mmodule.mproject != mmodule.mproject then
+ else if mclass.intro_mmodule.mpackage != mmodule.mpackage then
# public gives 'q::n#p::A'
# private gives 'q::n#p::m::A'
return "{mmodule.full_name}#{mclass.full_name}"
redef var c_name is lazy do
if is_intro then
return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
- else if mclass.intro_mmodule.mproject == mmodule.mproject and mclass.visibility > private_visibility then
+ else if mclass.intro_mmodule.mpackage == mmodule.mpackage and mclass.visibility > private_visibility then
return "{mmodule.c_name}___{mclass.name.to_cmangle}"
else
return "{mmodule.c_name}___{mclass.c_name}"
# The canonical name of the property.
#
# It is the short-`name` prefixed by the short-name of the class and the full-name of the module.
- # Example: "my_project::my_module::MyClass::my_method"
+ # Example: "my_package::my_module::MyClass::my_method"
redef var full_name is lazy do
return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
end
res.append name
else
# Just try to simplify each part
- if mclassdef.mmodule.mproject != mproperty.intro_mclassdef.mmodule.mproject then
+ if mclassdef.mmodule.mpackage != mproperty.intro_mclassdef.mmodule.mpackage then
# precise "p::m" only if "p" != "r"
res.append mproperty.intro_mclassdef.mmodule.full_name
res.append "::"
else if mproperty.visibility <= private_visibility then
- # Same project ("p"=="q"), but private visibility,
+ # Same package ("p"=="q"), but private visibility,
# does the module part ("::m") need to be displayed
- if mclassdef.mmodule.namespace_for(mclassdef.mclass.visibility) != mproperty.intro_mclassdef.mmodule.mproject then
+ if mclassdef.mmodule.namespace_for(mclassdef.mclass.visibility) != mproperty.intro_mclassdef.mmodule.mpackage then
res.append "::"
res.append mproperty.intro_mclassdef.mmodule.name
res.append "::"
import model
import ordered_tree
-# A simple specialisation of OrderedTree to display projects, groups and modules
+# A simple specialisation of OrderedTree to display packages, groups and modules
# FIXME do not use Object, but a better common interface of MModule and MGroup
-class MProjectTree
+class MPackageTree
super OrderedTree[Object]
# The model where to look for information
redef fun display(a) do
if a isa MGroup then
- if a.parent == null then return "{a.mproject.name} ({a.filepath.to_s})"
+ if a.parent == null then return "{a.mpackage.name} ({a.filepath.to_s})"
return a.name + " (group)"
else if a isa MModule then
return a.name
end
redef class Model
- # Generate a MProjectTree based on the projects, groups and modules known in the model
- fun to_mproject_tree: MProjectTree
+ # Generate a MPackageTree based on the packages, groups and modules known in the model
+ fun to_mpackage_tree: MPackageTree
do
- var res = new MProjectTree(self)
- for p in mprojects do
+ var res = new MPackageTree(self)
+ for p in mpackages do
for g in p.mgroups do
res.add(g.parent, g)
for m in g.mmodules do
end
end
-# Generate graphiz files based on projects, groups and modules
+# Generate graphiz files based on packages, groups and modules
#
# Interesting elements must be selected. See `mmodules`, ``
-# Display configuration can be set. See `cluster_group`, `project_group`
-class MProjectDot
+# Display configuration can be set. See `cluster_group`, `package_group`
+class MPackageDot
super Writable
# The model where to look for information
var model: Model
- # Set of projects to expand fully (ie all groups and modules are displayed)
- # Initially empty, projects can be added
- var mprojects = new HashSet[MProject]
+ # Set of packages to expand fully (ie all groups and modules are displayed)
+ # Initially empty, packages can be added
+ var mpackages = new HashSet[MPackage]
# Set of modules to display
# Initially empty, modules can be added
# Should groups be shown as clusters?
var cluster_group = true is writable
- # Should projects be shown as clusters?
- var project_group = true is writable
+ # Should packages be shown as clusters?
+ var package_group = true is writable
# Recursively generate node and clusters for a mgroup
private fun dot_cluster(o: Writer, mgroup: MGroup)
do
# Open the cluster, if required
if mgroup.parent == null then
- # is is a root group, so display the project
- if project_group then
- o.write("subgraph cluster_{mgroup.object_id} \{\nlabel=\"{mgroup.mproject.name}\\n({mgroup.filepath.to_s})\"\ncolor=black\nstyle=dotted\n")
+ # is is a root group, so display the package
+ if package_group then
+ o.write("subgraph cluster_{mgroup.object_id} \{\nlabel=\"{mgroup.mpackage.name}\\n({mgroup.filepath.to_s})\"\ncolor=black\nstyle=dotted\n")
end
else
if cluster_group then
# close the cluster if required
if mgroup.parent == null then
- if project_group then o.write("\}\n")
+ if package_group then o.write("\}\n")
else
if cluster_group then o.write("\}\n")
end
end
- # Extends the set of `mmodules` by recursively adding the most specific imported modules of foreign projects
+ # Extends the set of `mmodules` by recursively adding the most specific imported modules of foreign packages
fun collect_important_importation
do
var todo = new List[MModule]
var m = todo.pop
for psm in m.in_importation.greaters do
- if m.mgroup.mproject != psm.mgroup.mproject then continue
+ if m.mgroup.mpackage != psm.mgroup.mpackage then continue
for ssm in psm.in_importation.direct_greaters do
- if psm.mgroup.mproject == ssm.mgroup.mproject then continue
+ if psm.mgroup.mpackage == ssm.mgroup.mpackage then continue
mmodules.add(ssm)
todo.add(ssm)
end
do
# Collect interesting nodes
for m in model.mmodules do
- # filter out modules outside wanted projects
+ # filter out modules outside wanted packages
if m.mgroup == null then continue
- if not mprojects.has(m.mgroup.mproject) then continue
+ if not mpackages.has(m.mgroup.mpackage) then continue
mmodules.add(m)
end
stream.write("digraph g \{\n")
stream.write("rankdir=BT;node[shape=box];\n")
# Generate the nodes
- for p in model.mprojects do
+ for p in model.mpackages do
dot_cluster(stream, p.root.as(not null))
end
# Generate the edges
# See the License for the specific language governing permissions and
# limitations under the License.
-# Modelisation of a Nit project
-module mproject
+# Modelisation of a Nit package
+module mpackage
import model_base
private import more_collections
import poset
import mdoc
-# A Nit project, that encompass a product
-class MProject
+# A Nit package, that encompass a product
+class MPackage
super MConcern
- # The name of the project
+ # The name of the package
redef var name: String
redef fun full_name do return name
redef var c_name = name.to_cmangle is lazy
- # The model of the project
+ # The model of the package
redef var model: Model
# The root of the group tree
init
do
- model.mprojects.add(self)
- model.mproject_by_name.add_one(name, self)
+ model.mpackages.add(self)
+ model.mpackage_by_name.add_one(name, self)
end
- # MProject are always roots of the concerns hierarchy
+ # MPackage are always roots of the concerns hierarchy
redef fun parent_concern do return null
redef fun mdoc_or_fallback
end
end
-# A group of modules in a project
+# A group of modules in a package
class MGroup
super MConcern
# The name of the group
- # empty name for a default group in a single-module project
+ # empty name for a default group in a single-module package
redef var name: String
- # The enclosing project
- var mproject: MProject
+ # The enclosing package
+ var mpackage: MPackage
# The parent group if any
# see `in_nesting` for more
return "{p.full_name}/{name}"
end
- # The group is the group tree on the project (`mproject.mgroups`)
+ # The group is the group tree on the package (`mpackage.mgroups`)
# nested groups (children) are smaller
# nesting group (see `parent`) is bigger
var in_nesting: POSetElement[MGroup] is noinit
- # Is `self` the root of its project?
- fun is_root: Bool do return mproject.root == self
+ # Is `self` the root of its package?
+ fun is_root: Bool do return mpackage.root == self
# The filepath (usually a directory) of the group, if any
var filepath: nullable String = null is writable
init
do
- var tree = mproject.mgroups
+ var tree = mpackage.mgroups
self.in_nesting = tree.add_node(self)
var parent = self.parent
if parent != null then
end
end
- redef fun model do return mproject.model
+ redef fun model do return mpackage.model
redef fun parent_concern do
if not is_root then return parent
- return mproject
+ return mpackage
end
redef fun to_s do return name
end
redef class Model
- # projects of the model
- var mprojects = new Array[MProject]
+ # packages of the model
+ var mpackages = new Array[MPackage]
- # Collections of project grouped by their names
- private var mproject_by_name = new MultiHashMap[String, MProject]
+ # Collections of package grouped by their names
+ private var mpackage_by_name = new MultiHashMap[String, MPackage]
- # Return all project named `name`
- # If such a project is not yet loaded, null is returned (instead of an empty array)
- fun get_mprojects_by_name(name: String): nullable Array[MProject]
+ # Return all package named `name`
+ # If such a package is not yet loaded, null is returned (instead of an empty array)
+ fun get_mpackages_by_name(name: String): nullable Array[MPackage]
do
- if mproject_by_name.has_key(name) then
- return mproject_by_name[name]
+ if mpackage_by_name.has_key(name) then
+ return mpackage_by_name[name]
else
return null
end
return
end
- # Check for conflicting class full-names in the project
+ # Check for conflicting class full-names in the package
if mmodule.mgroup != null and mvisibility >= protected_visibility then
var mclasses = model.get_mclasses_by_name(name)
if mclasses != null then for other in mclasses do
- if other.intro_mmodule.mgroup != null and other.intro_mmodule.mgroup.mproject == mmodule.mgroup.mproject then
+ if other.intro_mmodule.mgroup != null and other.intro_mmodule.mgroup.mpackage == mmodule.mgroup.mpackage then
# Skip classes that are buggy
if other.try_intro == null then continue
warning(nclassdef, "full-name-conflict", "Error: a class named `{other.full_name}` is already defined in module `{other.intro_mmodule}` at {other.intro.location}.")
return false
end
- # Check for full-name conflicts in the project.
- # A public property should have a unique qualified name `project::class::prop`.
+ # Check for full-name conflicts in the package.
+ # A public property should have a unique qualified name `package::class::prop`.
if mprop.intro_mclassdef.mmodule.mgroup != null and mprop.visibility >= protected_visibility then
var others = modelbuilder.model.get_mproperties_by_name(mprop.name)
if others != null then for other in others do
- if other != mprop and other.intro_mclassdef.mmodule.mgroup != null and other.intro_mclassdef.mmodule.mgroup.mproject == mprop.intro_mclassdef.mmodule.mgroup.mproject and other.intro_mclassdef.mclass.name == mprop.intro_mclassdef.mclass.name and other.visibility >= protected_visibility then
+ if other != mprop and other.intro_mclassdef.mmodule.mgroup != null and other.intro_mclassdef.mmodule.mgroup.mpackage == mprop.intro_mclassdef.mmodule.mgroup.mpackage and other.intro_mclassdef.mclass.name == mprop.intro_mclassdef.mclass.name and other.visibility >= protected_visibility then
modelbuilder.advice(self, "full-name-conflict", "Warning: A property named `{other.full_name}` is already defined in module `{other.intro_mclassdef.mmodule}` for the class `{other.intro_mclassdef.mclass.name}`.")
break
end
#
# Note : All nodes described here are MEntities.
#
-# `MProject`
+# `MPackage`
#
-# * labels: `MProject`, `model_name` and `MEntity`.
-# * `(:MProject)-[:ROOT]->(:MGroup)`: root of the group tree.
+# * labels: `MPackage`, `model_name` and `MEntity`.
+# * `(:MPackage)-[:ROOT]->(:MGroup)`: root of the group tree.
#
# `MGroup`
#
# * labels: `MGroup`, `model_name` and `MEntity`.
-# * `(:MGroup)-[:PROJECT]->(:MProject)`: associated project.
+# * `(:MGroup)-[:PROJECT]->(:MPackage)`: associated package.
# * `(:MGroup)-[:PARENT]->(:MGroup)`: parent group. Does not exist for the root
# group.
# * `(:MGroup)-[:DECLARES]->(:MModule)`: modules that are direct children of
fun load(model: Model): Model do
var nodes: Array[NeoNode]
- toolcontext.info("Loading project node...", 1)
- nodes = client.nodes_with_labels([model_name, "MProject"])
- for node in nodes do to_mproject(model, node)
+ toolcontext.info("Loading package node...", 1)
+ nodes = client.nodes_with_labels([model_name, "MPackage"])
+ for node in nodes do to_mpackage(model, node)
toolcontext.info("Loading groups...", 1)
nodes = client.nodes_with_labels([model_name, "MGroup"])
for node in nodes do to_mgroup(model, node)
# Collect all nodes from the current `model`.
private fun collect_model_nodes(model: Model): Collection[NeoNode] do
- for mproject in model.mprojects do
- to_node(mproject)
- for mgroup in mproject.mgroups do to_node(mgroup)
+ for mpackage in model.mpackages do
+ to_node(mpackage)
+ for mgroup in mpackage.mgroups do to_node(mgroup)
end
return nodes.values
end
# `mentities` are stored locally to avoid duplication.
fun to_node(mentity: MEntity): NeoNode do
if nodes.has_key(mentity) then return nodes[mentity]
- if mentity isa MProject then return mproject_node(mentity)
+ if mentity isa MPackage then return mpackage_node(mentity)
if mentity isa MGroup then return mgroup_node(mentity)
if mentity isa MModule then return mmodule_node(mentity)
if mentity isa MClass then return mclass_node(mentity)
# Get the `MEntity` associated with `node`.
fun to_mentity(model: Model, node: NeoNode): MEntity do
- if node.labels.has("MProject") then return to_mproject(model, node)
+ if node.labels.has("MPackage") then return to_mpackage(model, node)
if node.labels.has("MGroup") then return to_mgroup(model, node)
if node.labels.has("MModule") then return to_mmodule(model, node)
if node.labels.has("MClass") then return to_mclass(model, node)
return node
end
- # Build a `NeoNode` representing `mproject`.
- private fun mproject_node(mproject: MProject): NeoNode do
- var node = make_node(mproject)
- node.labels.add "MProject"
- var root = mproject.root
+ # Build a `NeoNode` representing `mpackage`.
+ private fun mpackage_node(mpackage: MPackage): NeoNode do
+ var node = make_node(mpackage)
+ node.labels.add "MPackage"
+ var root = mpackage.root
if root != null then
node.out_edges.add(new NeoEdge(node, "ROOT", to_node(root)))
end
return node
end
- # Build a new `MProject` from a `node`.
+ # Build a new `MPackage` from a `node`.
#
- # REQUIRE `node.labels.has("MProject")`
- private fun to_mproject(model: Model, node: NeoNode): MProject do
+ # REQUIRE `node.labels.has("MPackage")`
+ private fun to_mpackage(model: Model, node: NeoNode): MPackage do
var m = mentities.get_or_null(node.id.as(Int))
- if m isa MProject then return m
+ if m isa MPackage then return m
- assert node.labels.has("MProject")
- var mproject = new MProject(node["name"].to_s, model)
- mentities[node.id.as(Int)] = mproject
- set_doc(node, mproject)
- mproject.root = to_mgroup(model, node.out_nodes("ROOT").first)
- return mproject
+ assert node.labels.has("MPackage")
+ var mpackage = new MPackage(node["name"].to_s, model)
+ mentities[node.id.as(Int)] = mpackage
+ set_doc(node, mpackage)
+ mpackage.root = to_mgroup(model, node.out_nodes("ROOT").first)
+ return mpackage
end
# Build a `NeoNode` representing `mgroup`.
var node = make_node(mgroup)
node.labels.add "MGroup"
var parent = mgroup.parent
- node.out_edges.add(new NeoEdge(node, "PROJECT", to_node(mgroup.mproject)))
+ node.out_edges.add(new NeoEdge(node, "PROJECT", to_node(mgroup.mpackage)))
if parent != null then
node.out_edges.add(new NeoEdge(node, "PARENT", to_node(parent)))
end
if m isa MGroup then return m
assert node.labels.has("MGroup")
- var mproject = to_mproject(model, node.out_nodes("PROJECT").first)
+ var mpackage = to_mpackage(model, node.out_nodes("PROJECT").first)
var parent: nullable MGroup = null
var out = node.out_nodes("PARENT")
if not out.is_empty then
parent = to_mgroup(model, out.first)
end
- var mgroup = new MGroup(node["name"].to_s, mproject, parent)
+ var mgroup = new MGroup(node["name"].to_s, mpackage, parent)
mentities[node.id.as(Int)] = mgroup
set_doc(node, mgroup)
return mgroup
# See the License for the specific language governing permissions and
# limitations under the License.
-# Basic catalog generator for Nit projects
+# Basic catalog generator for Nit packages
#
# See: <http://nitlanguage.org/catalog/>
#
-# The tool scans projects and generates the HTML files of a catalog.
+# The tool scans packages and generates the HTML files of a catalog.
#
# ## Features
#
-# * [X] scan projects and their `.ini`
-# * [X] generate lists of projects
-# * [X] generate a page per project with the readme and most metadata
+# * [X] scan packages and their `.ini`
+# * [X] generate lists of packages
+# * [X] generate a page per package with the readme and most metadata
# * [ ] link/include/be included in the documentation
-# * [ ] propose `related projects`
+# * [ ] propose `related packages`
# * [ ] show directory content (a la nitls)
# * [X] gather git information from the working directory
# * [ ] gather git information from the repository
-# * [ ] gather project information from github
+# * [ ] gather package information from github
# * [ ] gather people information from github
# * [ ] reify people
# * [ ] separate information gathering from rendering
# How to use the tool as the basis of a Nit code archive on the web usable with a package manager is not clear.
module nitcatalog
-import loader # Scan&load projects, groups and modules
+import loader # Scan&load packages, groups and modules
import doc::doc_down # Display mdoc
import md5 # To get gravatar images
import counter # For statistics
import modelize # To process and count classes and methods
-redef class MProject
+redef class MPackage
# Return the associated metadata from the `ini`, if any
fun metadata(key: String): nullable String
do
end
redef class Int
- # Returns `log(self+1)`. Used to compute score of projects
+ # Returns `log(self+1)`. Used to compute score of packages
fun score: Float do return (self+1).to_f.log
end
# used to access the files and count source lines of code
var modelbuilder: ModelBuilder
- # Projects by tag
- var tag2proj = new MultiHashMap[String, MProject]
+ # Packages by tag
+ var tag2proj = new MultiHashMap[String, MPackage]
- # Projects by category
- var cat2proj = new MultiHashMap[String, MProject]
+ # Packages by category
+ var cat2proj = new MultiHashMap[String, MPackage]
- # Projects by maintainer
- var maint2proj = new MultiHashMap[String, MProject]
+ # Packages by maintainer
+ var maint2proj = new MultiHashMap[String, MPackage]
- # Projects by contributors
- var contrib2proj = new MultiHashMap[String, MProject]
+ # Packages by contributors
+ var contrib2proj = new MultiHashMap[String, MPackage]
- # Dependency between projects
- var deps = new POSet[MProject]
+ # Dependency between packages
+ var deps = new POSet[MPackage]
- # Number of modules by project
- var mmodules = new Counter[MProject]
+ # Number of modules by package
+ var mmodules = new Counter[MPackage]
- # Number of classes by project
- var mclasses = new Counter[MProject]
+ # Number of classes by package
+ var mclasses = new Counter[MPackage]
- # Number of methods by project
- var mmethods = new Counter[MProject]
+ # Number of methods by package
+ var mmethods = new Counter[MPackage]
- # Number of line of code by project
- var loc = new Counter[MProject]
+ # Number of line of code by package
+ var loc = new Counter[MPackage]
- # Number of commits by project
- var commits = new Counter[MProject]
+ # Number of commits by package
+ var commits = new Counter[MPackage]
- # Score by project
+ # Score by package
#
# The score is loosely computed using other metrics
- var score = new Counter[MProject]
+ var score = new Counter[MPackage]
- # Scan, register and add a contributor to a project
- fun add_contrib(person: String, mproject: MProject, res: Template)
+ # Scan, register and add a contributor to a package
+ fun add_contrib(person: String, mpackage: MPackage, res: Template)
do
var projs = contrib2proj[person]
- if not projs.has(mproject) then projs.add mproject
+ if not projs.has(mpackage) then projs.add mpackage
var name = person
var email = null
var page = null
end
- # Compute information and generate a full HTML page for a project
- fun project_page(mproject: MProject): Writable
+ # Compute information and generate a full HTML page for a package
+ fun package_page(mpackage: MPackage): Writable
do
var res = new CatalogPage
- var score = score[mproject].to_f
- var name = mproject.name.html_escape
+ var score = score[mpackage].to_f
+ var name = mpackage.name.html_escape
res.more_head.add """<title>{{{name}}}</title>"""
res.add """
<div class="content">
<h1 class="package-name">{{{name}}}</h1>
"""
- var mdoc = mproject.mdoc_or_fallback
+ var mdoc = mpackage.mdoc_or_fallback
if mdoc != null then
score += 100.0
res.add mdoc.html_documentation
<div class="sidebar">
<ul class="box">
"""
- var homepage = mproject.metadata("upstream.homepage")
+ var homepage = mpackage.metadata("upstream.homepage")
if homepage != null then
score += 5.0
var e = homepage.html_escape
res.add "<li><a href=\"{e}\">{e}</a></li>\n"
end
- var maintainer = mproject.metadata("project.maintainer")
+ var maintainer = mpackage.metadata("package.maintainer")
if maintainer != null then
score += 5.0
- add_contrib(maintainer, mproject, res)
- mproject.maintainers.add maintainer
+ add_contrib(maintainer, mpackage, res)
+ mpackage.maintainers.add maintainer
var projs = maint2proj[maintainer]
- if not projs.has(mproject) then projs.add mproject
+ if not projs.has(mpackage) then projs.add mpackage
end
- var license = mproject.metadata("project.license")
+ var license = mpackage.metadata("package.license")
if license != null then
score += 5.0
var e = license.html_escape
res.add "</ul>\n"
res.add "<h3>Source Code</h3>\n<ul class=\"box\">\n"
- var browse = mproject.metadata("upstream.browse")
+ var browse = mpackage.metadata("upstream.browse")
if browse != null then
score += 5.0
var e = browse.html_escape
res.add "<li><a href=\"{e}\">{e}</a></li>\n"
end
- var git = mproject.metadata("upstream.git")
+ var git = mpackage.metadata("upstream.git")
if git != null then
var e = git.html_escape
res.add "<li><tt>{e}</tt></li>\n"
end
- var last_date = mproject.last_date
+ var last_date = mpackage.last_date
if last_date != null then
var e = last_date.html_escape
res.add "<li>most recent commit: {e}</li>\n"
end
- var first_date = mproject.first_date
+ var first_date = mpackage.first_date
if first_date != null then
var e = first_date.html_escape
res.add "<li>oldest commit: {e}</li>\n"
end
- var commits = commits[mproject]
+ var commits = commits[mpackage]
if commits != 0 then
res.add "<li>{commits} commits</li>\n"
end
res.add "</ul>\n"
res.add "<h3>Tags</h3>\n"
- var tags = mproject.metadata("project.tags")
+ var tags = mpackage.metadata("package.tags")
var ts2 = new Array[String]
var cat = null
if tags != null then
t = t.trim
if t == "" then continue
if cat == null then cat = t
- tag2proj[t].add mproject
+ tag2proj[t].add mpackage
t = t.html_escape
ts2.add "<a href=\"index.html#tag_{t}\">{t}</a>"
end
if ts2.is_empty then
var t = "none"
cat = t
- tag2proj[t].add mproject
+ tag2proj[t].add mpackage
res.add "<a href=\"index.html#tag_{t}\">{t}</a>"
end
- if cat != null then cat2proj[cat].add mproject
+ if cat != null then cat2proj[cat].add mpackage
score += ts2.length.score
- var reqs = deps[mproject].greaters.to_a
- reqs.remove(mproject)
+ var reqs = deps[mpackage].greaters.to_a
+ reqs.remove(mpackage)
alpha_comparator.sort(reqs)
res.add "<h3>Requirements</h3>\n"
if reqs.is_empty then
else
var list = new Array[String]
for r in reqs do
- var direct = deps.has_direct_edge(mproject, r)
+ var direct = deps.has_direct_edge(mpackage, r)
var s = "<a href=\"{r}.html\">"
if direct then s += "<strong>"
s += r.to_s
res.add_list(list, ", ", " and ")
end
- reqs = deps[mproject].smallers.to_a
- reqs.remove(mproject)
+ reqs = deps[mpackage].smallers.to_a
+ reqs.remove(mpackage)
alpha_comparator.sort(reqs)
res.add "<h3>Clients</h3>\n"
if reqs.is_empty then
else
var list = new Array[String]
for r in reqs do
- var direct = deps.has_direct_edge(r, mproject)
+ var direct = deps.has_direct_edge(r, mpackage)
var s = "<a href=\"{r}.html\">"
if direct then s += "<strong>"
s += r.to_s
res.add_list(list, ", ", " and ")
end
- score += deps[mproject].greaters.length.score
- score += deps[mproject].direct_greaters.length.score
- score += deps[mproject].smallers.length.score
- score += deps[mproject].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
- var contributors = mproject.contributors
+ var contributors = mpackage.contributors
if not contributors.is_empty then
res.add "<h3>Contributors</h3>\n<ul class=\"box\">"
for c in contributors do
- add_contrib(c, mproject, res)
+ add_contrib(c, mpackage, res)
end
res.add "</ul>"
end
var mclasses = 0
var mmethods = 0
var loc = 0
- for g in mproject.mgroups do
+ for g in mpackage.mgroups do
mmodules += g.module_paths.length
for m in g.mmodules do
var am = modelbuilder.mmodule2node(m)
end
end
end
- self.mmodules[mproject] = mmodules
- self.mclasses[mproject] = mclasses
- self.mmethods[mproject] = mmethods
- self.loc[mproject] = loc
+ self.mmodules[mpackage] = mmodules
+ self.mclasses[mpackage] = mclasses
+ self.mmethods[mpackage] = mmethods
+ self.loc[mpackage] = loc
#score += mmodules.score
score += mclasses.score
res.add """
</div>
"""
- self.score[mproject] = score.to_i
+ self.score[mpackage] = score.to_i
return res
end
- # Return a short HTML sequence for a project
+ # Return a short HTML sequence for a package
#
# Intended to use in lists.
- fun li_project(p: MProject): String
+ fun li_package(p: MPackage): String
do
var res = ""
var f = "{p.name}.html"
return res
end
- # List projects by group.
+ # List packages by group.
#
# For each key of the `map` a `<h3>` is generated.
- # Each project is then listed.
+ # Each package is then listed.
#
# The list of keys is generated first to allow fast access to the correct `<h3>`.
# `id_prefix` is used to give an id to the `<h3>` element.
- fun list_by(map: MultiHashMap[String, MProject], id_prefix: String): Template
+ fun list_by(map: MultiHashMap[String, MPackage], id_prefix: String): Template
do
var res = new Template
var keys = map.keys.to_a
res.add "<h3 id=\"{id_prefix}{e}\">{e} ({projs.length})</h3>\n<ul>\n"
for p in projs do
res.add "<li>"
- res.add li_project(p)
+ res.add li_package(p)
res.add "</li>"
end
res.add "</ul>"
return res
end
- # List the 10 best projects from `cpt`
- fun list_best(cpt: Counter[MProject]): Template
+ # List the 10 best packages from `cpt`
+ fun list_best(cpt: Counter[MPackage]): Template
do
var res = new Template
res.add "<ul>"
if i > best.length then break
var p = best[best.length-i]
res.add "<li>"
- res.add li_project(p)
+ res.add li_package(p)
# res.add " ({cpt[p]})"
res.add "</li>"
end
return res
end
- # Collect more information on a project using the `git` tool.
- fun git_info(mproject: MProject)
+ # Collect more information on a package using the `git` tool.
+ fun git_info(mpackage: MPackage)
do
- var ini = mproject.ini
+ var ini = mpackage.ini
if ini == null then return
# TODO use real git info
#var branch = ini.get_or_null("upstream.git.branch")
#var directory = ini.get_or_null("upstream.git.directory")
- var dirpath = mproject.root.filepath
+ var dirpath = mpackage.root.filepath
if dirpath == null then return
# Collect commits info
var contributors = new Counter[String]
var commits = res.split("\n")
if commits.not_empty and commits.last == "" then commits.pop
- self.commits[mproject] = commits.length
+ self.commits[mpackage] = commits.length
for l in commits do
var s = l.split_once_on(';')
if s.length != 2 or s.last == "" then continue
# Collect date of last and first commit
- if mproject.last_date == null then mproject.last_date = s.first
- mproject.first_date = s.first
+ if mpackage.last_date == null then mpackage.last_date = s.first
+ mpackage.first_date = s.first
# Count contributors
contributors.inc(s.last)
end
for c in contributors.sort.reverse_iterator do
- mproject.contributors.add c
+ mpackage.contributors.add c
end
end
- # Produce a HTML table containig information on the projects
+ # Produce a HTML table containig information on the packages
#
- # `project_page` must have been called before so that information is computed.
- fun table_projects(mprojects: Array[MProject]): Template
+ # `package_page` must have been called before so that information is computed.
+ fun table_packages(mpackages: Array[MPackage]): Template
do
- alpha_comparator.sort(mprojects)
+ alpha_comparator.sort(mpackages)
var res = new Template
res.add "<table data-toggle=\"table\" data-sort-name=\"name\" data-sort-order=\"desc\" width=\"100%\">\n"
res.add "<thead><tr>\n"
res.add "<th data-field=\"loc\" data-sortable=\"true\">lines</th>\n"
res.add "<th data-field=\"score\" data-sortable=\"true\">score</th>\n"
res.add "</tr></thead>"
- for p in mprojects do
+ for p in mpackages do
res.add "<tr>"
res.add "<td><a href=\"{p.name}.html\">{p.name}</a></td>"
var maint = "?"
modelbuilder.identify_file(a)
end
-# Scan projects and compute information
-for p in model.mprojects do
+# Scan packages and compute information
+for p in model.mpackages do
var g = p.root
assert g != null
modelbuilder.scan_group(g)
catalog.deps.add_node(p)
for gg in p.mgroups do for m in gg.mmodules do
for im in m.in_importation.direct_greaters do
- var ip = im.mproject
+ var ip = im.mpackage
if ip == null or ip == p then continue
catalog.deps.add_edge(p, ip)
end
# PAGES
-for p in model.mprojects do
+for p in model.mpackages do
# print p
var f = "{p.name}.html"
- catalog.project_page(p).write_to_file(out/f)
+ catalog.package_page(p).write_to_file(out/f)
end
# INDEX
var index = new CatalogPage
-index.more_head.add "<title>Projects in Nit</title>"
+index.more_head.add "<title>Packages in Nit</title>"
index.add """
<div class="content">
-<h1>Projects in Nit</h1>
+<h1>Packages in Nit</h1>
"""
-index.add "<h2>Highlighted Projects</h2>\n"
+index.add "<h2>Highlighted Packages</h2>\n"
index.add catalog.list_best(catalog.score)
index.add "<h2>Most Required</h2>\n"
-var reqs = new Counter[MProject]
-for p in model.mprojects do
+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)
<div class="sidebar">
<h3>Stats</h3>
<ul class="box">
-<li>{{{model.mprojects.length}}} projects</li>
+<li>{{{model.mpackages.length}}} packages</li>
<li>{{{catalog.maint2proj.length}}} maintainers</li>
<li>{{{catalog.contrib2proj.length}}} contributors</li>
<li>{{{catalog.tag2proj.length}}} tags</li>
page.more_head.add "<title>Projets of Nit</title>"
page.add """<div class="content">\n<h1>People of Nit</h1>\n"""
page.add "<h2>Table of Projets</h2>\n"
-page.add catalog.table_projects(model.mprojects)
+page.add catalog.table_packages(model.mpackages)
page.add "</div>\n"
page.write_to_file(out/"table.html")
if o.mmodule != null and not o.mmodule.in_importation.direct_greaters.is_empty then
var ms = new Array[String]
for m in o.mmodule.in_importation.direct_greaters do
- if m.mgroup.mproject == o.mmodule.mgroup.mproject then
+ if m.mgroup.mpackage == o.mmodule.mgroup.mpackage then
ms.add m.name
else
ms.add m.full_name
var opt_keep = new OptionBool("Ignore errors and files that are not a Nit source file", "-k", "--keep")
var opt_recursive = new OptionBool("Process directories recussively", "-r", "--recursive")
-var opt_tree = new OptionBool("List source files in their groups and projects", "-t", "--tree")
+var opt_tree = new OptionBool("List source files in their groups and packages", "-t", "--tree")
var opt_source = new OptionBool("List source files", "-s", "--source")
-var opt_project = new OptionBool("List projects paths (default)", "-P", "--project")
+var opt_package = new OptionBool("List packages paths (default)", "-P", "--package")
var opt_depends = new OptionBool("List dependencies of given modules", "-d", "--depends")
var opt_make = new OptionBool("List dependencies suitable for a rule in a Makefile. Alias for -d, -p and -s", "-M")
var opt_paths = new OptionBool("List only path (instead of name + path)", "-p", "--path")
-tc.option_context.add_option(opt_keep, opt_recursive, opt_tree, opt_source, opt_project, opt_depends, opt_paths, opt_make)
-tc.tooldescription = "Usage: nitls [OPTION]... <file.nit|directory>...\nLists the projects and/or paths of Nit sources files."
+tc.option_context.add_option(opt_keep, opt_recursive, opt_tree, opt_source, opt_package, opt_depends, opt_paths, opt_make)
+tc.tooldescription = "Usage: nitls [OPTION]... <file.nit|directory>...\nLists the packages and/or paths of Nit sources files."
tc.accept_no_arguments = true
tc.process_options(args)
opt_source.value = true
end
-var sum = opt_tree.value.to_i + opt_source.value.to_i + opt_project.value.to_i
+var sum = opt_tree.value.to_i + opt_source.value.to_i + opt_package.value.to_i
if sum > 1 then
- print "Error: options --tree, --source, and --project are exclusive."
+ print "Error: options --tree, --source, and --package are exclusive."
print tc.tooldescription
exit 1
end
-if sum == 0 then opt_project.value = true
+if sum == 0 then opt_package.value = true
tc.keep_going = opt_keep.value
var model = new Model
end
if sum == 0 then
- # If one of the file is a group, default is `opt_tree` instead of `opt_project`
+ # If one of the file is a group, default is `opt_tree` instead of `opt_package`
for a in files do
var g = mb.get_mgroup(a)
if g != null then
opt_tree.value = true
- opt_project.value = false
+ opt_package.value = false
break
end
end
for a in files do
var g = mb.get_mgroup(a)
var mp = mb.identify_file(a)
- if g != null and not opt_project.value then
+ if g != null and not opt_package.value then
mb.scan_group(g)
end
if g == null and mp == null then
var fs = a.files
for f in fs do
g = mb.get_mgroup(a/f)
- if g != null and not opt_project.value then
+ if g != null and not opt_package.value then
mb.scan_group(g)
end
mp = mb.identify_file(a/f)
var sorter = new AlphaEntityComparator
if opt_tree.value then
ot.opt_paths = opt_paths.value
- for p in model.mprojects do
+ for p in model.mpackages do
for g in p.mgroups do
var pa = g.parent
if g.is_interesting then
if opt_source.value then
var list = new Array[ModulePath]
- for p in model.mprojects do
+ for p in model.mpackages do
for g in p.mgroups do
for mp in g.module_paths do
list.add mp
end
end
-if opt_project.value then
+if opt_package.value then
var list = new Array[MGroup]
- for p in model.mprojects do
+ for p in model.mpackages do
list.add p.root.as(not null)
end
sorter.sort(list)
var opt_dir: OptionString = new OptionString("Output directory", "--dir")
# Depth of the visit and generation
- var opt_depth = new OptionEnum(["module", "group", "project"],
+ var opt_depth = new OptionEnum(["module", "group", "package"],
"Depth of the visit and generation", 0, "-d", "--depth")
redef init
modelbuilder.scan_group mgroup
target_modules = mgroup.mmodules
else if toolcontext.opt_depth.value == 2 then
- # project
+ # package
target_modules = new Array[MModule]
importations = new Array[MModule]
if mgroup != null then
- for g in mgroup.mproject.mgroups do
+ for g in mgroup.mpackage.mgroups do
target_modules.add_all g.mmodules
end
# The starting quad (`::`)
var n_quad: nullable TQuad = null is writable
- # The list of quad-separated project/group identifiers
+ # The list of quad-separated package/group identifiers
var n_path = new ANodes[TId](self)
# The final module identifier
# The starting quad (`::`)
var n_quad: nullable TQuad = null is writable
- # The list of quad-separated project/group/module identifiers
+ # The list of quad-separated package/group/module identifiers
var n_id = new ANodes[TId](self)
# A class identifier
# Copy assets, resources and libs where expected by the SDK
var project_root = "."
- var mproject = compiler.mainmodule.first_real_mmodule.mproject
- if mproject != null then
- var root = mproject.root
+ var mpackage = compiler.mainmodule.first_real_mmodule.mpackage
+ if mpackage != null then
+ var root = mpackage.root
if root != null then
var filepath = root.filepath
if filepath != null then
# Compare model
var sorter = new MEntityNameSorter
-print "# mprojects:"
-var org_mprojects = org_model.mprojects.to_a
-sorter.sort org_mprojects
-print org_mprojects.join(" ")
+print "# mpackages:"
+var org_mpackages = org_model.mpackages.to_a
+sorter.sort org_mpackages
+print org_mpackages.join(" ")
print "------------------------------------"
-var neo_mprojects = neo_model.mprojects.to_a
-sorter.sort neo_mprojects
-print neo_mprojects.join(" ")
+var neo_mpackages = neo_model.mpackages.to_a
+sorter.sort neo_mpackages
+print neo_mpackages.join(" ")
print "\n# mmodules:"
var org_mmodules = org_model.mmodules.to_a
do
print "It works"
var model = modelbuilder.model
- print "I have {model.mprojects.length} projects"
+ print "I have {model.mpackages.length} packages"
print "I have {model.mmodules.length} modules"
var mclasses = mainmodule.flatten_mclass_hierarchy
print "I have {mclasses.length} classes"
# usualy, only the original module must be imported in the unit test.
var o = mmodule
var g = o.mgroup
- if g != null and g.mproject.name == "core" then
+ if g != null and g.mpackage.name == "core" then
# except for a unit test in a module of `core`
# in this case, the whole `core` must be imported
- o = get_mmodule_by_name(nmodule, g, g.mproject.name).as(not null)
+ o = get_mmodule_by_name(nmodule, g, g.mpackage.name).as(not null)
end
ts.attr("package", mmodule.full_name)
return sys.program_name.basename
end
- # The identified root directory of the Nit project
+ # The identified root directory of the Nit package
var nit_dir: String is noinit
private fun compute_nit_dir: String
#
# $ nitls --[TAB][TAB]
# --bash-toolname --keep --path --tree
-# --depends --log --project --verbose
+# --depends --log --package --verbose
# --disable-phase --log-dir --quiet --version
# --gen-bash-completion --no-color --recursive --warn
# --help --only-metamodel --source
nitlanguage / nit.git / commitdiff