78700d0ecce310831a920ff79d577d8af4270203
1 # This file is part of NIT ( http://www.nitlanguage.org ).
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 # Basic catalog generator for Nit packages
17 # See: <http://nitlanguage.org/catalog/>
19 # The tool scans packages and generates the HTML files of a catalog.
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
34 # * [X] 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
40 # ## Issues and limitations
42 # The tool works likee the other tools and expects to find valid Nit source code in the directories
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)
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.
51 import md5
# To get gravatar images
52 import counter
# For statistics
53 import modelize
# To process and count classes and methods
57 # Metadata related to this package
58 var metadata
= new MPackageMetadata(self)
61 # The metadata extracted from a MPackage
62 class MPackageMetadata
64 # The mpacakge this metadata belongs to
65 var mpackage
: MPackage
67 # Return the associated metadata from the `ini`, if any
68 fun metadata
(key
: String): nullable String do
69 var ini
= mpackage
.ini
70 if ini
== null then return null
74 # The consolidated list of tags
75 var tags
: Array[String] is lazy
do
76 var tags
= new Array[String]
77 var string
= metadata
("package.tags")
78 if string
== null then return tags
79 for tag
in string
.split
(",") do
81 if tag
.is_empty
then continue
84 if tryit
!= null then tags
.add
"tryit"
85 if apk
!= null then tags
.add
"apk"
86 if tags
.is_empty
then tags
.add
"none"
90 # The list of all maintainers
91 var maintainers
= new Array[Person]
93 # The list of contributors
94 var contributors
= new Array[Person]
96 # The date of the most recent commit
97 var last_date
: nullable String = null
99 # The date of the oldest commit
100 var first_date
: nullable String = null
102 # Key: package.maintainer`
103 var maintainer
: nullable String is lazy
do return metadata
("package.maintainer")
105 # Key: `package.more_contributors`
106 var more_contributors
: Array[String] is lazy
do
107 var res
= new Array[String]
108 var string
= metadata
("package.more_contributors")
109 if string
== null then return res
110 for c
in string
.split
(",") do
112 if c
.is_empty
then continue
118 # Key: `package.license`
119 var license
: nullable String is lazy
do return metadata
("package.license")
121 # Key: `upstream.tryit`
122 var tryit
: nullable String is lazy
do return metadata
("upstream.tryit")
124 # Key: `upstream.apk`
125 var apk
: nullable String is lazy
do return metadata
("upstream.apk")
127 # Key: `upstream.homepage`
128 var homepage
: nullable String is lazy
do return metadata
("upstream.homepage")
130 # Key: `upstream.browse`
131 var browse
: nullable String is lazy
do return metadata
("upstream.browse")
133 # Package git clone address
134 var git
: nullable String is lazy
do return metadata
("upstream.git")
136 # Package issue tracker
137 var issues
: nullable String is lazy
do return metadata
("upstream.issues")
141 # Returns `log(self+1)`. Used to compute score of packages
142 fun score
: Float do return (self+1).to_f
.log
145 # A contributor/author/etc.
147 # It comes from git or the metadata
149 # TODO get more things from github by using the email as a key
150 # "https://api.github.com/search/users?q={email}+in:email"
152 # The name. Eg "John Doe"
153 var name
: String is writable
155 # The email, Eg "john.doe@example.com"
156 var email
: nullable String is writable
158 # Some homepage. Eg "http://example.com/~jdoe"
159 var page
: nullable String is writable
161 # Return a full-featured link to a person
165 var e
= name
.html_escape
168 res
+= "<a href=\"{page.html_escape}\
">"
170 var email
= self.email
171 if email
!= null then
172 var md5
= email
.md5
.to_lower
173 res
+= "<img src=\"https
://secure
.gravatar
.com
/avatar
/{md5}?size
=20&
;default
=retro\
"> "
176 if page
!= null then res
+= "</a>"
180 # The standard representation of a person.
183 # var jd = new Person("John Doe", "john.doe@example.com", "http://example.com/~jdoe")
184 # assert jd.to_s == "John Doe <john.doe@example.com> (http://example.com/~jdoe)"
187 # It can be used as the input of `parse`.
190 # var jd2 = new Person.parse(jd.to_s)
191 # assert jd2.to_s == jd.to_s
196 var email
= self.email
197 if email
!= null then res
+= " <{email}>"
199 if page
!= null then res
+= " ({page})"
203 # Crete a new person from its standard textual representation.
206 # var jd = new Person.parse("John Doe <john.doe@example.com> (http://example.com/~jdoe)")
207 # assert jd.name == "John Doe"
208 # assert jd.email == "john.doe@example.com"
209 # assert jd.page == "http://example.com/~jdoe"
212 # Emails and page are optional.
215 # var jd2 = new Person.parse("John Doe")
216 # assert jd2.name == "John Doe"
217 # assert jd2.email == null
218 # assert jd2.page == null
220 init parse
(person
: String)
225 # Regular expressions are broken, need to investigate.
228 #var re = "([^<(]*?)(<([^>]*?)>)?(\\((.*)\\))?".to_re
229 #var m = (person+" ").search(re)
230 #print "{person}: `{m or else "?"}` `{m[1] or else "?"}` `{m[3] or else "?"}` `{m[5] or else "?"}`"
232 var sp1
= person
.split_once_on
("<")
233 if sp1
.length
< 2 then
236 var sp2
= sp1
.last
.split_once_on
(">")
237 if sp2
.length
< 2 then
240 name
= sp1
.first
.trim
241 email
= sp2
.first
.trim
242 var sp3
= sp2
.last
.split_once_on
("(")
243 if sp3
.length
< 2 then
246 var sp4
= sp3
.last
.split_once_on
(")")
247 if sp4
.length
< 2 then
250 page
= sp4
.first
.trim
253 init(name
, email
, page
)
258 # The main class of the calatog generator that has the knowledge
262 # used to access the files and count source lines of code
263 var modelbuilder
: ModelBuilder
266 var tag2proj
= new MultiHashMap[String, MPackage]
268 # Packages by category
269 var cat2proj
= new MultiHashMap[String, MPackage]
271 # Packages by maintainer
272 var maint2proj
= new MultiHashMap[Person, MPackage]
274 # Packages by contributors
275 var contrib2proj
= new MultiHashMap[Person, MPackage]
277 # Dependency between packages
278 var deps
= new POSet[MPackage]
280 # Number of modules by package
281 var mmodules
= new Counter[MPackage]
283 # Number of classes by package
284 var mclasses
= new Counter[MPackage]
286 # Number of methods by package
287 var mmethods
= new Counter[MPackage]
289 # Number of line of code by package
290 var loc
= new Counter[MPackage]
293 var errors
= new Counter[MPackage]
295 # Number of warnings and advices
296 var warnings
= new Counter[MPackage]
298 # Number of warnings per 1000 lines of code (w/kloc)
299 var warnings_per_kloc
= new Counter[MPackage]
301 # Documentation score (between 0 and 100)
302 var documentation_score
= new Counter[MPackage]
304 # Number of commits by package
305 var commits
= new Counter[MPackage]
309 # The score is loosely computed using other metrics
310 var score
= new Counter[MPackage]
312 # List of known people
313 var persons
= new HashMap[String, Person]
315 # Scan, register and add a contributor to a package
316 fun register_contrib
(person
: String, mpackage
: MPackage): Person
318 var p
= persons
.get_or_null
(person
)
320 var new_p
= new Person.parse
(person
)
321 # Maybe, we already have this person in fact?
322 p
= persons
.get_or_null
(new_p
.to_s
)
328 var projs
= contrib2proj
[p
]
329 if not projs
.has
(mpackage
) then
331 mpackage
.metadata
.contributors
.add p
336 # Compute information for a package
337 fun package_page
(mpackage
: MPackage)
339 var score
= score
[mpackage
].to_f
341 var mdoc
= mpackage
.mdoc_or_fallback
344 score
+= mdoc
.content
.length
.score
347 var metadata
= mpackage
.metadata
349 var tryit
= metadata
.tryit
350 if tryit
!= null then
353 var apk
= metadata
.apk
357 var homepage
= metadata
.homepage
358 if homepage
!= null then
361 var maintainer
= metadata
.maintainer
362 if maintainer
!= null then
364 var person
= register_contrib
(maintainer
, mpackage
)
365 mpackage
.metadata
.maintainers
.add person
366 var projs
= maint2proj
[person
]
367 if not projs
.has
(mpackage
) then projs
.add mpackage
369 var license
= metadata
.license
370 if license
!= null then
373 var browse
= metadata
.browse
374 if browse
!= null then
377 var tags
= metadata
.tags
379 tag2proj
[tag
].add mpackage
381 if tags
.not_empty
then
383 cat2proj
[cat
].add mpackage
384 score
+= tags
.length
.score
386 if deps
.has
(mpackage
) then
387 score
+= deps
[mpackage
].greaters
.length
.score
388 score
+= deps
[mpackage
].direct_greaters
.length
.score
389 score
+= deps
[mpackage
].smallers
.length
.score
390 score
+= deps
[mpackage
].direct_smallers
.length
.score
393 var contributors
= mpackage
.metadata
.contributors
394 var more_contributors
= metadata
.more_contributors
395 for c
in more_contributors
do
396 register_contrib
(c
, mpackage
)
398 score
+= contributors
.length
.to_f
405 # The documentation value of each entity is ad hoc.
406 var entity_score
= 0.0
408 for g
in mpackage
.mgroups
do
409 mmodules
+= g
.mmodules
.length
412 if g
.mdoc
!= null then doc_score
+= gs
413 for m
in g
.mmodules
do
414 var source
= m
.location
.file
415 if source
!= null then
416 for msg
in source
.messages
do
417 if msg
.level
== 2 then
424 var am
= modelbuilder
.mmodule2node
(m
)
426 var file
= am
.location
.file
428 loc
+= file
.line_starts
.length
- 1
432 if m
.is_test
then ms
/= 100.0
434 if m
.mdoc
!= null then doc_score
+= ms
else ms
/= 10.0
435 for cd
in m
.mclassdefs
do
437 if not cd
.is_intro
then cs
/= 100.0
438 if not cd
.mclass
.visibility
<= private_visibility
then cs
/= 100.0
440 if cd
.mdoc
!= null then doc_score
+= cs
442 for pd
in cd
.mpropdefs
do
444 if not pd
.is_intro
then ps
/= 100.0
445 if not pd
.mproperty
.visibility
<= private_visibility
then ps
/= 100.0
447 if pd
.mdoc
!= null then doc_score
+= ps
448 if not pd
isa MMethodDef then continue
454 self.mmodules
[mpackage
] = mmodules
455 self.mclasses
[mpackage
] = mclasses
456 self.mmethods
[mpackage
] = mmethods
457 self.loc
[mpackage
] = loc
458 self.errors
[mpackage
] = errors
459 self.warnings
[mpackage
] = warnings
461 self.warnings_per_kloc
[mpackage
] = warnings
* 1000 / loc
463 var documentation_score
= (100.0 * doc_score
/ entity_score
).to_i
464 self.documentation_score
[mpackage
] = documentation_score
465 #score += mmodules.score
466 score
+= mclasses
.score
467 score
+= mmethods
.score
469 score
+= documentation_score
.score
471 self.score
[mpackage
] = score
.to_i
474 # Collect more information on a package using the `git` tool.
475 fun git_info
(mpackage
: MPackage)
477 var ini
= mpackage
.ini
478 if ini
== null then return
480 var root
= mpackage
.root
481 if root
== null then return
483 # TODO use real git info
484 #var repo = ini.get_or_null("upstream.git")
485 #var branch = ini.get_or_null("upstream.git.branch")
486 #var directory = ini.get_or_null("upstream.git.directory")
488 var dirpath
= root
.filepath
489 if dirpath
== null then return
491 # Collect commits info
492 var res
= git_run
("log", "--no-merges", "--follow", "--pretty=tformat:%ad;%aN <%aE>", "--", dirpath
)
493 var contributors
= new Counter[String]
494 var commits
= res
.split
("\n")
495 if commits
.not_empty
and commits
.last
== "" then commits
.pop
496 self.commits
[mpackage
] = commits
.length
498 var s
= l
.split_once_on
(';')
499 if s
.length
!= 2 or s
.last
== "" then continue
501 # Collect date of last and first commit
502 if mpackage
.metadata
.last_date
== null then mpackage
.metadata
.last_date
= s
.first
503 mpackage
.metadata
.first_date
= s
.first
506 contributors
.inc
(s
.last
)
508 for c
in contributors
.sort
.reverse_iterator
do
509 register_contrib
(c
, mpackage
)
515 # Execute a git command and return the result
516 fun git_run
(command
: String...): String
518 # print "git {command.join(" ")}"
519 var p
= new ProcessReader("git", command
...)