nitcatalog: do not crash if the dependency poset is empty (--no-parse)
[nit.git] / src / nitcatalog.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 # Basic catalog generator for Nit packages
16 #
17 # See: <http://nitlanguage.org/catalog/>
18 #
19 # The tool scans packages and generates the HTML files of a catalog.
20 #
21 # ## Features
22 #
23 # * [X] scan packages and their `.ini`
24 # * [X] generate lists of packages
25 # * [X] generate a page per package with the readme and most metadata
26 # * [ ] link/include/be included in the documentation
27 # * [ ] propose `related packages`
28 # * [X] show directory content (a la nitls)
29 # * [X] gather git information from the working directory
30 # * [ ] gather git information from the repository
31 # * [ ] gather package information from github
32 # * [ ] gather people information from github
33 # * [ ] reify people
34 # * [ ] separate information gathering from rendering
35 # * [ ] move up information gathering in (existing or new) service modules
36 # * [X] add command line options
37 # * [ ] harden HTML (escaping, path injection, etc)
38 # * [ ] nitcorn server with RESTful API
39 #
40 # ## Issues and limitations
41 #
42 # The tool works likee the other tools and expects to find valid Nit source code in the directories
43 #
44 # * cruft and temporary files will be collected
45 # * missing source file (e.g. not yet generated by nitcc) will make information
46 # incomplete (e.g. invalid module thus partial dependency and metrics)
47 #
48 # How to use the tool as the basis of a Nit code archive on the web usable with a package manager is not clear.
49 module nitcatalog
50
51 import loader # Scan&load packages, groups and modules
52 import doc::doc_down # Display mdoc
53 import md5 # To get gravatar images
54 import counter # For statistics
55 import modelize # To process and count classes and methods
56
57 redef class MPackage
58 # Return the associated metadata from the `ini`, if any
59 fun metadata(key: String): nullable String
60 do
61 var ini = self.ini
62 if ini == null then return null
63 return ini[key]
64 end
65
66 # The list of maintainers
67 var maintainers = new Array[String]
68
69 # The list of contributors
70 var contributors = new Array[String]
71
72 # The date of the most recent commit
73 var last_date: nullable String = null
74
75 # The date of the oldest commit
76 var first_date: nullable String = null
77 end
78
79 # A HTML page in a catalog
80 #
81 # This is just a template with the header pre-filled and the footer injected at rendering.
82 # Therefore, once instantiated, the content can just be added to it.
83 class CatalogPage
84 super Template
85
86 # Placeholder to include additional things before the `</head>`.
87 var more_head = new Template
88
89 redef init
90 do
91 add """
92 <!DOCTYPE html>
93 <html>
94 <head>
95 <meta charset="utf-8">
96 <link rel="stylesheet" media="all" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
97 <link rel="stylesheet" media="all" href="style.css">
98 """
99 add more_head
100
101 add """
102 </head>
103 <body>
104 <div class='container-fluid'>
105 <div class='row'>
106 <nav id='topmenu' class='navbar navbar-default navbar-fixed-top' role='navigation'>
107 <div class='container-fluid'>
108 <div class='navbar-header'>
109 <button type='button' class='navbar-toggle' data-toggle='collapse' data-target='#topmenu-collapse'>
110 <span class='sr-only'>Toggle menu</span>
111 <span class='icon-bar'></span>
112 <span class='icon-bar'></span>
113 <span class='icon-bar'></span>
114 </button>
115 <span class='navbar-brand'><a href="http://nitlanguage.org/">Nitlanguage.org</a></span>
116 </div>
117 <div class='collapse navbar-collapse' id='topmenu-collapse'>
118 <ul class='nav navbar-nav'>
119 <li><a href="index.html">Catalog</a></li>
120 </ul>
121 </div>
122 </div>
123 </nav>
124 </div>
125 """
126 end
127
128 redef fun rendering
129 do
130 add """
131 </div> <!-- container-fluid -->
132 <script src='https://code.jquery.com/jquery-latest.min.js'></script>
133 <script src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js'></script>
134 <script src='https://cdnjs.cloudflare.com/ajax/libs/bootstrap-table/1.8.1/bootstrap-table-all.min.js'></script>
135 </body>
136 </html>
137 """
138 end
139 end
140
141 redef class Int
142 # Returns `log(self+1)`. Used to compute score of packages
143 fun score: Float do return (self+1).to_f.log
144 end
145
146 # The main class of the calatog generator that has the knowledge
147 class Catalog
148
149 # The modelbuilder
150 # used to access the files and count source lines of code
151 var modelbuilder: ModelBuilder
152
153 # Packages by tag
154 var tag2proj = new MultiHashMap[String, MPackage]
155
156 # Packages by category
157 var cat2proj = new MultiHashMap[String, MPackage]
158
159 # Packages by maintainer
160 var maint2proj = new MultiHashMap[String, MPackage]
161
162 # Packages by contributors
163 var contrib2proj = new MultiHashMap[String, MPackage]
164
165 # Dependency between packages
166 var deps = new POSet[MPackage]
167
168 # Number of modules by package
169 var mmodules = new Counter[MPackage]
170
171 # Number of classes by package
172 var mclasses = new Counter[MPackage]
173
174 # Number of methods by package
175 var mmethods = new Counter[MPackage]
176
177 # Number of line of code by package
178 var loc = new Counter[MPackage]
179
180 # Number of commits by package
181 var commits = new Counter[MPackage]
182
183 # Score by package
184 #
185 # The score is loosely computed using other metrics
186 var score = new Counter[MPackage]
187
188 # Scan, register and add a contributor to a package
189 fun add_contrib(person: String, mpackage: MPackage, res: Template)
190 do
191 var projs = contrib2proj[person]
192 if not projs.has(mpackage) then projs.add mpackage
193 var name = person
194 var email = null
195 var page = null
196
197 # Regular expressions are broken, need to investigate.
198 # So split manually.
199 #
200 #var re = "([^<(]*?)(<([^>]*?)>)?(\\((.*)\\))?".to_re
201 #var m = (person+" ").search(re)
202 #print "{person}: `{m or else "?"}` `{m[1] or else "?"}` `{m[3] or else "?"}` `{m[5] or else "?"}`"
203 do
204 var sp1 = person.split_once_on("<")
205 if sp1.length < 2 then
206 break
207 end
208 var sp2 = sp1.last.split_once_on(">")
209 if sp2.length < 2 then
210 break
211 end
212 name = sp1.first.trim
213 email = sp2.first.trim
214 var sp3 = sp2.last.split_once_on("(")
215 if sp3.length < 2 then
216 break
217 end
218 var sp4 = sp3.last.split_once_on(")")
219 if sp4.length < 2 then
220 break
221 end
222 page = sp4.first.trim
223 end
224
225 var e = name.html_escape
226 res.add "<li>"
227 if page != null then
228 res.add "<a href=\"{page.html_escape}\">"
229 end
230 if email != null then
231 # TODO get more things from github by using the email as a key
232 # "https://api.github.com/search/users?q={email}+in:email"
233 var md5 = email.md5.to_lower
234 res.add "<img src=\"https://secure.gravatar.com/avatar/{md5}?size=20&amp;default=retro\">&nbsp;"
235 end
236 res.add "{e}"
237 if page != null then res.add "</a>"
238 res.add "</li>"
239 end
240
241 # Recursively generate a level in the file tree of the *content* section
242 private fun gen_content_level(ot: OrderedTree[Object], os: Array[Object], res: Template)
243 do
244 res.add "<ul>\n"
245 for o in os do
246 res.add "<li>"
247 if o isa MGroup then
248 var d = ""
249 var mdoc = o.mdoc
250 if mdoc != null then d = ": {mdoc.html_synopsis.write_to_string}"
251 res.add "<strong>{o.name}</strong>{d} ({o.filepath.to_s})"
252 else if o isa ModulePath then
253 var d = ""
254 var m = o.mmodule
255 if m != null then
256 var mdoc = m.mdoc
257 if mdoc != null then d = ": {mdoc.html_synopsis.write_to_string}"
258 end
259 res.add "<strong>{o.name}</strong>{d} ({o.filepath.to_s})"
260 else
261 abort
262 end
263 var subs = ot.sub.get_or_null(o)
264 if subs != null then gen_content_level(ot, subs, res)
265 res.add "</li>\n"
266 end
267 res.add "</ul>\n"
268 end
269
270 # Compute information and generate a full HTML page for a package
271 fun package_page(mpackage: MPackage): Writable
272 do
273 var res = new CatalogPage
274 var score = score[mpackage].to_f
275 var name = mpackage.name.html_escape
276 res.more_head.add """<title>{{{name}}}</title>"""
277
278 res.add """
279 <div class="content">
280 <h1 class="package-name">{{{name}}}</h1>
281 """
282 var mdoc = mpackage.mdoc_or_fallback
283 if mdoc != null then
284 score += 100.0
285 res.add mdoc.html_documentation
286 score += mdoc.content.length.score
287 end
288
289 res.add "<h2>Content</h2>"
290 var ot = new OrderedTree[Object]
291 for g in mpackage.mgroups do
292 var pa = g.parent
293 if g.is_interesting then
294 ot.add(pa, g)
295 pa = g
296 end
297 for mp in g.module_paths do
298 ot.add(pa, mp)
299 end
300 end
301 ot.sort_with(alpha_comparator)
302 gen_content_level(ot, ot.roots, res)
303
304
305 res.add """
306 </div>
307 <div class="sidebar">
308 <ul class="box">
309 """
310 var homepage = mpackage.metadata("upstream.homepage")
311 if homepage != null then
312 score += 5.0
313 var e = homepage.html_escape
314 res.add "<li><a href=\"{e}\">{e}</a></li>\n"
315 end
316 var maintainer = mpackage.metadata("package.maintainer")
317 if maintainer != null then
318 score += 5.0
319 add_contrib(maintainer, mpackage, res)
320 mpackage.maintainers.add maintainer
321 var projs = maint2proj[maintainer]
322 if not projs.has(mpackage) then projs.add mpackage
323 end
324 var license = mpackage.metadata("package.license")
325 if license != null then
326 score += 5.0
327 var e = license.html_escape
328 res.add "<li><a href=\"http://opensource.org/licenses/{e}\">{e}</a> license</li>\n"
329 end
330 res.add "</ul>\n"
331
332 res.add "<h3>Source Code</h3>\n<ul class=\"box\">\n"
333 var browse = mpackage.metadata("upstream.browse")
334 if browse != null then
335 score += 5.0
336 var e = browse.html_escape
337 res.add "<li><a href=\"{e}\">{e}</a></li>\n"
338 end
339 var git = mpackage.metadata("upstream.git")
340 if git != null then
341 var e = git.html_escape
342 res.add "<li><tt>{e}</tt></li>\n"
343 end
344 var last_date = mpackage.last_date
345 if last_date != null then
346 var e = last_date.html_escape
347 res.add "<li>most recent commit: {e}</li>\n"
348 end
349 var first_date = mpackage.first_date
350 if first_date != null then
351 var e = first_date.html_escape
352 res.add "<li>oldest commit: {e}</li>\n"
353 end
354 var commits = commits[mpackage]
355 if commits != 0 then
356 res.add "<li>{commits} commits</li>\n"
357 end
358 res.add "</ul>\n"
359
360 res.add "<h3>Tags</h3>\n"
361 var tags = mpackage.metadata("package.tags")
362 var ts2 = new Array[String]
363 var cat = null
364 if tags != null then
365 var ts = tags.split(",")
366 for t in ts do
367 t = t.trim
368 if t == "" then continue
369 if cat == null then cat = t
370 tag2proj[t].add mpackage
371 t = t.html_escape
372 ts2.add "<a href=\"index.html#tag_{t}\">{t}</a>"
373 end
374 res.add_list(ts2, ", ", ", ")
375 end
376 if ts2.is_empty then
377 var t = "none"
378 cat = t
379 tag2proj[t].add mpackage
380 res.add "<a href=\"index.html#tag_{t}\">{t}</a>"
381 end
382 if cat != null then cat2proj[cat].add mpackage
383 score += ts2.length.score
384
385 if deps.has(mpackage) then
386 var reqs = deps[mpackage].greaters.to_a
387 reqs.remove(mpackage)
388 alpha_comparator.sort(reqs)
389 res.add "<h3>Requirements</h3>\n"
390 if reqs.is_empty then
391 res.add "none"
392 else
393 var list = new Array[String]
394 for r in reqs do
395 var direct = deps.has_direct_edge(mpackage, r)
396 var s = "<a href=\"{r}.html\">"
397 if direct then s += "<strong>"
398 s += r.to_s
399 if direct then s += "</strong>"
400 s += "</a>"
401 list.add s
402 end
403 res.add_list(list, ", ", " and ")
404 end
405
406 reqs = deps[mpackage].smallers.to_a
407 reqs.remove(mpackage)
408 alpha_comparator.sort(reqs)
409 res.add "<h3>Clients</h3>\n"
410 if reqs.is_empty then
411 res.add "none"
412 else
413 var list = new Array[String]
414 for r in reqs do
415 var direct = deps.has_direct_edge(r, mpackage)
416 var s = "<a href=\"{r}.html\">"
417 if direct then s += "<strong>"
418 s += r.to_s
419 if direct then s += "</strong>"
420 s += "</a>"
421 list.add s
422 end
423 res.add_list(list, ", ", " and ")
424 end
425
426 score += deps[mpackage].greaters.length.score
427 score += deps[mpackage].direct_greaters.length.score
428 score += deps[mpackage].smallers.length.score
429 score += deps[mpackage].direct_smallers.length.score
430 end
431
432 var contributors = mpackage.contributors
433 if not contributors.is_empty then
434 res.add "<h3>Contributors</h3>\n<ul class=\"box\">"
435 for c in contributors do
436 add_contrib(c, mpackage, res)
437 end
438 res.add "</ul>"
439 end
440 score += contributors.length.to_f
441
442 var mmodules = 0
443 var mclasses = 0
444 var mmethods = 0
445 var loc = 0
446 for g in mpackage.mgroups do
447 mmodules += g.module_paths.length
448 for m in g.mmodules do
449 var am = modelbuilder.mmodule2node(m)
450 if am != null then
451 var file = am.location.file
452 if file != null then
453 loc += file.line_starts.length - 1
454 end
455 end
456 for cd in m.mclassdefs do
457 mclasses += 1
458 for pd in cd.mpropdefs do
459 if not pd isa MMethodDef then continue
460 mmethods += 1
461 end
462 end
463 end
464 end
465 self.mmodules[mpackage] = mmodules
466 self.mclasses[mpackage] = mclasses
467 self.mmethods[mpackage] = mmethods
468 self.loc[mpackage] = loc
469
470 #score += mmodules.score
471 score += mclasses.score
472 score += mmethods.score
473 score += loc.score
474
475 res.add """
476 <h3>Stats</h3>
477 <ul class="box">
478 <li>{{{mmodules}}} modules</li>
479 <li>{{{mclasses}}} classes</li>
480 <li>{{{mmethods}}} methods</li>
481 <li>{{{loc}}} lines of code</li>
482 </ul>
483 """
484
485 res.add """
486 </div>
487 """
488 self.score[mpackage] = score.to_i
489
490 return res
491 end
492
493 # Return a short HTML sequence for a package
494 #
495 # Intended to use in lists.
496 fun li_package(p: MPackage): String
497 do
498 var res = ""
499 var f = "{p.name}.html"
500 res += "<a href=\"{f}\">{p}</a>"
501 var d = p.mdoc_or_fallback
502 if d != null then res += " - {d.html_synopsis.write_to_string}"
503 return res
504 end
505
506 # List packages by group.
507 #
508 # For each key of the `map` a `<h3>` is generated.
509 # Each package is then listed.
510 #
511 # The list of keys is generated first to allow fast access to the correct `<h3>`.
512 # `id_prefix` is used to give an id to the `<h3>` element.
513 fun list_by(map: MultiHashMap[String, MPackage], id_prefix: String): Template
514 do
515 var res = new Template
516 var keys = map.keys.to_a
517 alpha_comparator.sort(keys)
518 var list = [for x in keys do "<a href=\"#{id_prefix}{x.html_escape}\">{x.html_escape}</a>"]
519 res.add_list(list, ", ", " and ")
520
521 for k in keys do
522 var projs = map[k].to_a
523 alpha_comparator.sort(projs)
524 var e = k.html_escape
525 res.add "<h3 id=\"{id_prefix}{e}\">{e} ({projs.length})</h3>\n<ul>\n"
526 for p in projs do
527 res.add "<li>"
528 res.add li_package(p)
529 res.add "</li>"
530 end
531 res.add "</ul>"
532 end
533 return res
534 end
535
536 # List the 10 best packages from `cpt`
537 fun list_best(cpt: Counter[MPackage]): Template
538 do
539 var res = new Template
540 res.add "<ul>"
541 var best = cpt.sort
542 for i in [1..10] do
543 if i > best.length then break
544 var p = best[best.length-i]
545 res.add "<li>"
546 res.add li_package(p)
547 # res.add " ({cpt[p]})"
548 res.add "</li>"
549 end
550 res.add "</ul>"
551 return res
552 end
553
554 # Collect more information on a package using the `git` tool.
555 fun git_info(mpackage: MPackage)
556 do
557 var ini = mpackage.ini
558 if ini == null then return
559
560 # TODO use real git info
561 #var repo = ini.get_or_null("upstream.git")
562 #var branch = ini.get_or_null("upstream.git.branch")
563 #var directory = ini.get_or_null("upstream.git.directory")
564
565 var dirpath = mpackage.root.filepath
566 if dirpath == null then return
567
568 # Collect commits info
569 var res = git_run("log", "--no-merges", "--follow", "--pretty=tformat:%ad;%aN <%aE>", "--", dirpath)
570 var contributors = new Counter[String]
571 var commits = res.split("\n")
572 if commits.not_empty and commits.last == "" then commits.pop
573 self.commits[mpackage] = commits.length
574 for l in commits do
575 var s = l.split_once_on(';')
576 if s.length != 2 or s.last == "" then continue
577
578 # Collect date of last and first commit
579 if mpackage.last_date == null then mpackage.last_date = s.first
580 mpackage.first_date = s.first
581
582 # Count contributors
583 contributors.inc(s.last)
584 end
585 for c in contributors.sort.reverse_iterator do
586 mpackage.contributors.add c
587 end
588
589 end
590
591 # Produce a HTML table containig information on the packages
592 #
593 # `package_page` must have been called before so that information is computed.
594 fun table_packages(mpackages: Array[MPackage]): Template
595 do
596 alpha_comparator.sort(mpackages)
597 var res = new Template
598 res.add "<table data-toggle=\"table\" data-sort-name=\"name\" data-sort-order=\"desc\" width=\"100%\">\n"
599 res.add "<thead><tr>\n"
600 res.add "<th data-field=\"name\" data-sortable=\"true\">name</th>\n"
601 res.add "<th data-field=\"maint\" data-sortable=\"true\">maint</th>\n"
602 res.add "<th data-field=\"contrib\" data-sortable=\"true\">contrib</th>\n"
603 if deps.not_empty then
604 res.add "<th data-field=\"reqs\" data-sortable=\"true\">reqs</th>\n"
605 res.add "<th data-field=\"dreqs\" data-sortable=\"true\">direct<br>reqs</th>\n"
606 res.add "<th data-field=\"cli\" data-sortable=\"true\">clients</th>\n"
607 res.add "<th data-field=\"dcli\" data-sortable=\"true\">direct<br>clients</th>\n"
608 end
609 res.add "<th data-field=\"mod\" data-sortable=\"true\">modules</th>\n"
610 res.add "<th data-field=\"cla\" data-sortable=\"true\">classes</th>\n"
611 res.add "<th data-field=\"met\" data-sortable=\"true\">methods</th>\n"
612 res.add "<th data-field=\"loc\" data-sortable=\"true\">lines</th>\n"
613 res.add "<th data-field=\"score\" data-sortable=\"true\">score</th>\n"
614 res.add "</tr></thead>"
615 for p in mpackages do
616 res.add "<tr>"
617 res.add "<td><a href=\"{p.name}.html\">{p.name}</a></td>"
618 var maint = "?"
619 if p.maintainers.not_empty then maint = p.maintainers.first
620 res.add "<td>{maint}</td>"
621 res.add "<td>{p.contributors.length}</td>"
622 if deps.not_empty then
623 res.add "<td>{deps[p].greaters.length-1}</td>"
624 res.add "<td>{deps[p].direct_greaters.length}</td>"
625 res.add "<td>{deps[p].smallers.length-1}</td>"
626 res.add "<td>{deps[p].direct_smallers.length}</td>"
627 end
628 res.add "<td>{mmodules[p]}</td>"
629 res.add "<td>{mclasses[p]}</td>"
630 res.add "<td>{mmethods[p]}</td>"
631 res.add "<td>{loc[p]}</td>"
632 res.add "<td>{score[p]}</td>"
633 res.add "</tr>\n"
634 end
635 res.add "</table>\n"
636 return res
637 end
638 end
639
640 # Execute a git command and return the result
641 fun git_run(command: String...): String
642 do
643 # print "git {command.join(" ")}"
644 var p = new ProcessReader("git", command...)
645 var res = p.read_all
646 p.close
647 p.wait
648 return res
649 end
650
651 var model = new Model
652 var tc = new ToolContext
653
654 var opt_dir = new OptionString("Directory where the HTML files are generated", "-d", "--dir")
655 var opt_no_git = new OptionBool("Do not gather git information from the working directory", "--no-git")
656 var opt_no_parse = new OptionBool("Do not parse nit files (no importation information)", "--no-parse")
657 var opt_no_model = new OptionBool("Do not analyse nit files (no class/method information)", "--no-model")
658
659 tc.option_context.add_option(opt_dir, opt_no_git, opt_no_parse, opt_no_model)
660
661 tc.process_options(sys.args)
662 tc.keep_going = true
663
664 var modelbuilder = new ModelBuilder(model, tc)
665 var catalog = new Catalog(modelbuilder)
666
667 # Get files or groups
668 for a in tc.option_context.rest do
669 modelbuilder.get_mgroup(a)
670 modelbuilder.identify_file(a)
671 end
672
673 # Scan packages and compute information
674 for p in model.mpackages do
675 var g = p.root
676 assert g != null
677 modelbuilder.scan_group(g)
678
679 # Load the module to process importation information
680 if opt_no_parse.value then continue
681 modelbuilder.parse_group(g)
682
683 catalog.deps.add_node(p)
684 for gg in p.mgroups do for m in gg.mmodules do
685 for im in m.in_importation.direct_greaters do
686 var ip = im.mpackage
687 if ip == null or ip == p then continue
688 catalog.deps.add_edge(p, ip)
689 end
690 end
691 end
692
693 if not opt_no_git.value then for p in model.mpackages do
694 catalog.git_info(p)
695 end
696
697 # Run phases to modelize classes and properties (so we can count them)
698 if not opt_no_model.value then
699 modelbuilder.run_phases
700 end
701
702 var out = opt_dir.value or else "catalog.out"
703 out.mkdir
704
705 # Generate the css (hard coded)
706 var css = """
707 body {
708 margin-top: 15px;
709 background-color: #f8f8f8;
710 }
711
712 a {
713 color: #0D8921;
714 text-decoration: none;
715 }
716
717 a:hover {
718 color: #333;
719 text-decoration: none;
720 }
721
722 h1 {
723 font-weight: bold;
724 color: #0D8921;
725 font-size: 22px;
726 }
727
728 h2 {
729 color: #6C6C6C;
730 font-size: 18px;
731 border-bottom: solid 3px #CCC;
732 }
733
734 h3 {
735 color: #6C6C6C;
736 font-size: 15px;
737 border-bottom: solid 1px #CCC;
738 }
739
740 ul {
741 list-style-type: square;
742 }
743
744 dd {
745 color: #6C6C6C;
746 margin-top: 1em;
747 margin-bottom: 1em;
748 }
749
750 pre {
751 border: 1px solid #CCC;
752 font-family: Monospace;
753 color: #2d5003;
754 background-color: rgb(250, 250, 250);
755 }
756
757 code {
758 font-family: Monospace;
759 color: #2d5003;
760 }
761
762 footer {
763 margin-top: 20px;
764 }
765
766 .container {
767 margin: 0 auto;
768 padding: 0 20px;
769 }
770
771 .content {
772 float: left;
773 margin-top: 40px;
774 width: 65%;
775 }
776
777 .sidebar {
778 float: right;
779 margin-top: 40px;
780 width: 30%
781 }
782
783 .sidebar h3 {
784 color: #0D8921;
785 font-size: 18px;
786 border-bottom: 0px;
787 }
788
789 .box {
790 margin: 0;
791 padding: 0;
792 }
793
794 .box li {
795 line-height: 2.5;
796 white-space: nowrap;
797 overflow: hidden;
798 text-overflow: ellipsis;
799 padding-right: 10px;
800 border-bottom: 1px solid rgba(0,0,0,0.2);
801 }
802 """
803 css.write_to_file(out/"style.css")
804
805 # PAGES
806
807 for p in model.mpackages do
808 # print p
809 var f = "{p.name}.html"
810 catalog.package_page(p).write_to_file(out/f)
811 end
812
813 # INDEX
814
815 var index = new CatalogPage
816 index.more_head.add "<title>Packages in Nit</title>"
817
818 index.add """
819 <div class="content">
820 <h1>Packages in Nit</h1>
821 """
822
823 index.add "<h2>Highlighted Packages</h2>\n"
824 index.add catalog.list_best(catalog.score)
825
826 if catalog.deps.not_empty then
827 index.add "<h2>Most Required</h2>\n"
828 var reqs = new Counter[MPackage]
829 for p in model.mpackages do
830 reqs[p] = catalog.deps[p].smallers.length - 1
831 end
832 index.add catalog.list_best(reqs)
833 end
834
835 index.add "<h2>By First Tag</h2>\n"
836 index.add catalog.list_by(catalog.cat2proj, "cat_")
837
838 index.add "<h2>By Any Tag</h2>\n"
839 index.add catalog.list_by(catalog.tag2proj, "tag_")
840
841 index.add """
842 </div>
843 <div class="sidebar">
844 <h3>Stats</h3>
845 <ul class="box">
846 <li>{{{model.mpackages.length}}} packages</li>
847 <li>{{{catalog.maint2proj.length}}} maintainers</li>
848 <li>{{{catalog.contrib2proj.length}}} contributors</li>
849 <li>{{{catalog.tag2proj.length}}} tags</li>
850 <li>{{{catalog.mmodules.sum}}} modules</li>
851 <li>{{{catalog.mclasses.sum}}} classes</li>
852 <li>{{{catalog.mmethods.sum}}} methods</li>
853 <li>{{{catalog.loc.sum}}} lines of code</li>
854 </ul>
855 </div>
856 """
857
858 index.write_to_file(out/"index.html")
859
860 # PEOPLE
861
862 var page = new CatalogPage
863 page.more_head.add "<title>People of Nit</title>"
864 page.add """<div class="content">\n<h1>People of Nit</h1>\n"""
865 page.add "<h2>By Maintainer</h2>\n"
866 page.add catalog.list_by(catalog.maint2proj, "maint_")
867 page.add "<h2>By Contributor</h2>\n"
868 page.add catalog.list_by(catalog.contrib2proj, "contrib_")
869 page.add "</div>\n"
870 page.write_to_file(out/"people.html")
871
872 # TABLE
873
874 page = new CatalogPage
875 page.more_head.add "<title>Projets of Nit</title>"
876 page.add """<div class="content">\n<h1>People of Nit</h1>\n"""
877 page.add "<h2>Table of Projets</h2>\n"
878 page.add catalog.table_packages(model.mpackages)
879 page.add "</div>\n"
880 page.write_to_file(out/"table.html")