A card that displays the metadata about a package in the Nit catalog

Introduced properties

private var _clients: Array[MPackage]

nitc :: CardMetadata :: _clients

Package clients
private var _deps: Array[MPackage]

nitc :: CardMetadata :: _deps

Package dependencies
private var _id: String

nitc :: CardMetadata :: _id

private var _metadata: MPackageMetadata

nitc :: CardMetadata :: _metadata

Package metadata to display
private var _stats: MPackageStats

nitc :: CardMetadata :: _stats

Package stats
private var _title: String

nitc :: CardMetadata :: _title

fun clients: Array[MPackage]

nitc :: CardMetadata :: clients

Package clients
fun clients=(clients: Array[MPackage])

nitc :: CardMetadata :: clients=

Package clients
init defaultinit(mentity: MEntity, metadata: MPackageMetadata, stats: MPackageStats, deps: Array[MPackage], clients: Array[MPackage])

nitc :: CardMetadata :: defaultinit

fun deps: Array[MPackage]

nitc :: CardMetadata :: deps

Package dependencies
fun deps=(deps: Array[MPackage])

nitc :: CardMetadata :: deps=

Package dependencies
fun metadata: MPackageMetadata

nitc :: CardMetadata :: metadata

Package metadata to display
fun metadata=(metadata: MPackageMetadata)

nitc :: CardMetadata :: metadata=

Package metadata to display
fun stats: MPackageStats

nitc :: CardMetadata :: stats

Package stats
fun stats=(stats: MPackageStats)

nitc :: CardMetadata :: stats=

Package stats

Redefined properties

redef type SELF: CardMetadata

nitc $ CardMetadata :: SELF

Type of this instance, automatically specialized in every class
redef fun id: String

nitc $ CardMetadata :: id

Card id
redef fun id=(id: String)

nitc $ CardMetadata :: id=

Card id
redef fun rendering

nitc $ CardMetadata :: rendering

Service used to render the content of the template.
redef fun title: String

nitc $ CardMetadata :: title

Card title
redef fun title=(title: String)

nitc $ CardMetadata :: title=

Card title

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
private var _clients: Array[MPackage]

nitc :: CardMetadata :: _clients

Package clients
private var _content: Array[Writable]

template :: Template :: _content

Each sub-elements
private var _deps: Array[MPackage]

nitc :: CardMetadata :: _deps

Package dependencies
private var _full_doc: Bool

nitc :: CardMEntity :: _full_doc

Render the mentity full documentation?
private var _id: String

nitc :: StaticCard :: _id

Card id
private var _id: String

nitc :: CardMetadata :: _id

private var _id: String

nitc :: CardMEntity :: _id

private var _is_frozen: Bool

template :: Template :: _is_frozen

Is the template allowing more modification (add)
private var _is_writing: Bool

template :: Template :: _is_writing

Flag to avoid infinite recursivity if a template contains itself
private var _mentity: MEntity

nitc :: CardMEntity :: _mentity

MEntity displayed in this card
private var _metadata: MPackageMetadata

nitc :: CardMetadata :: _metadata

Package metadata to display
private var _render_done: Bool

template :: Template :: _render_done

Flag to avoid multiple rendering
private var _stats: MPackageStats

nitc :: CardMetadata :: _stats

Package stats
private var _title: String

nitc :: CardMEntity :: _title

private var _title: String

nitc :: StaticCard :: _title

Card title
private var _title: String

nitc :: CardMetadata :: _title

fun add(element: Writable)

template :: Template :: add

Append an element (String, other Template, etc.) at the end of the template.
fun add_all(elements: Collection[Writable])

template :: Template :: add_all

Append a bunch of elements at the end of the template.
fun add_list(elements: Collection[Writable], sep: Writable, last_sep: Writable)

template :: Template :: add_list

Append a bunch of elements at the end of the template with separations.
fun addn(element: Writable)

template :: Template :: addn

Append element and the end of the template then append a "\n".
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun clients: Array[MPackage]

nitc :: CardMetadata :: clients

Package clients
fun clients=(clients: Array[MPackage])

nitc :: CardMetadata :: clients=

Package clients
private fun content: Array[Writable]

template :: Template :: content

Each sub-elements
private fun content=(content: Array[Writable])

template :: Template :: content=

Each sub-elements
init defaultinit(mentity: MEntity, full_doc: nullable Bool)

nitc :: CardMEntity :: defaultinit

init defaultinit(title: String, id: String)

nitc :: StaticCard :: defaultinit

init defaultinit(mentity: MEntity, metadata: MPackageMetadata, stats: MPackageStats, deps: Array[MPackage], clients: Array[MPackage])

nitc :: CardMetadata :: defaultinit

fun deps: Array[MPackage]

nitc :: CardMetadata :: deps

Package dependencies
fun deps=(deps: Array[MPackage])

nitc :: CardMetadata :: deps=

Package dependencies
fun force_render

template :: Template :: force_render

Call rendering, if not already done
fun freeze

template :: Template :: freeze

Disable further modification: no more add is allowed
fun full_doc: Bool

nitc :: CardMEntity :: full_doc

Render the mentity full documentation?
fun full_doc=(full_doc: nullable Bool)

nitc :: CardMEntity :: full_doc=

Render the mentity full documentation?
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun id: String

nitc :: StaticCard :: id

Card id
fun id=(id: String)

nitc :: StaticCard :: id=

Card id
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
fun is_frozen: Bool

template :: Template :: is_frozen

Is the template allowing more modification (add)
protected fun is_frozen=(is_frozen: Bool)

template :: Template :: is_frozen=

Is the template allowing more modification (add)
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
private fun is_writing: Bool

template :: Template :: is_writing

Flag to avoid infinite recursivity if a template contains itself
private fun is_writing=(is_writing: Bool)

template :: Template :: is_writing=

Flag to avoid infinite recursivity if a template contains itself
fun mentity: MEntity

nitc :: CardMEntity :: mentity

MEntity displayed in this card
fun mentity=(mentity: MEntity)

nitc :: CardMEntity :: mentity=

MEntity displayed in this card
fun metadata: MPackageMetadata

nitc :: CardMetadata :: metadata

Package metadata to display
fun metadata=(metadata: MPackageMetadata)

nitc :: CardMetadata :: metadata=

Package metadata to display
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
fun new_sub: Template

template :: Template :: new_sub

Return a new basic template that is automatically added in self (using add)
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
private fun render_done: Bool

template :: Template :: render_done

Flag to avoid multiple rendering
private fun render_done=(render_done: Bool)

template :: Template :: render_done=

Flag to avoid multiple rendering
protected fun rendering

template :: Template :: rendering

Service used to render the content of the template.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun stats: MPackageStats

nitc :: CardMetadata :: stats

Package stats
fun stats=(stats: MPackageStats)

nitc :: CardMetadata :: stats=

Package stats
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun title: String

nitc :: StaticCard :: title

Card title
fun title=(title: String)

nitc :: StaticCard :: title=

Card title
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun write_to(stream: Writer)

core :: Writable :: write_to

Write itself to a stream
fun write_to_bytes: Bytes

core :: Writable :: write_to_bytes

Like write_to but return a new Bytes (may be quite large)
fun write_to_file(filepath: String)

core :: Writable :: write_to_file

Like write_to but take care of creating the file
fun write_to_string: String

core :: Writable :: write_to_string

Like write_to but return a new String (may be quite large).
package_diagram nitc::CardMetadata CardMetadata nitc::CardMEntity CardMEntity nitc::CardMetadata->nitc::CardMEntity nitc::StaticCard StaticCard nitc::CardMEntity->nitc::StaticCard ...nitc::StaticCard ... ...nitc::StaticCard->nitc::StaticCard

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
abstract class StaticCard

nitc :: StaticCard

A card that can be rendered to HTML
class Template

template :: Template

Templates are simple hierarchical pieces of text used for efficient stream writing.
interface Writable

core :: Writable

Things that can be efficienlty written to a Writer

Parents

class CardMEntity

nitc :: CardMEntity

A card about a mentity

Class definitions

nitc $ CardMetadata
# A card that displays the metadata about a package in the Nit catalog
class CardMetadata
	super CardMEntity
	autoinit(mentity, metadata, stats, deps, clients)

	# Package metadata to display
	var metadata: MPackageMetadata is writable

	# Package stats
	var stats: MPackageStats is writable

	# Package dependencies
	var deps: Array[MPackage] is writable

	# Package clients
	var clients: Array[MPackage] is writable

	redef var id = "metadata_{super}" is lazy
	redef var title = "Metadata"

	redef fun rendering do
		for maintainer in metadata.maintainers do
			addn """
				<p class='lead'>
					{{{maintainer.to_html}}}
				</p>"""
		end
		var license = metadata.license
		if license != null then
			addn """
				<span class='text-muted'>
					<a href='http://opensource.org/licenses/{{{license}}}'>{{{license}}}</a>
					license
				</span>"""
		end

		var homepage = metadata.homepage
		var browse = metadata.browse
		var issues = metadata.issues
		if homepage != null or browse != null or issues != null then
			addn """
				<h4>Links</h4>
				<ul class='list-unstyled'>"""
			if homepage != null then addn "<li><a href='{homepage}'>Homepage</a></li>"
			if browse != null then addn "<li><a href='{browse}'>Source Code</a></li>"
			if issues != null then addn "<li><a href='{issues}'>Issues</a></li>"
			addn "</ul>"
		end

		var git = metadata.git
		var last_date = metadata.last_date
		var first_date = metadata.first_date
		if git != null then
			addn """
				<h4>Git</h4>
				<ul class='list-unstyled'>
					<li><a href='{{{git}}}'>{{{git}}}</a></li>
				</ul>
				<span class='text-muted'><b>{{{stats.commits}}}</b> commits</span>
				<br>"""
			if last_date != null then
				addn """<b class=text-muted>Last:</b> {{{last_date}}}<br>"""
			end
			if first_date != null then
				addn """<b class=text-muted>First:</b> {{{first_date}}}"""
			end
		end

		addn """
			<h4>Quality</h4>
			<ul class='list-unstyled'>
				<li>{{{stats.documentation_score}}}% documented</li>
			</ul>"""

		if metadata.tags.not_empty then
			addn "<h4>Tags</h4>"
			for tag in metadata.tags do
				addn " <a href='tag_{tag.to_cmangle}.html'>{tag}</a>"
				if tag != metadata.tags.last then add ", "
			end
		end

		if deps.not_empty then
			addn "<h4>Dependencies</h4>"
			for dep in deps do
				add dep.html_link
				if dep != deps.last then add ", "
			end
		end

		if clients.not_empty then
			addn "<h4>Clients</h4>"
			for client in clients do
				add client.html_link
				if client != clients.last then add ", "
			end
		end

		if metadata.contributors.not_empty then
			addn """
				<h4>Contributors</h4>
				<ul class='list-unstyled'>"""
			for contrib in metadata.contributors do
				addn """<li>{{{contrib.to_html}}}</li>"""
			end
			addn "</ul>"
		end

		addn """
			<h4>Stats</h4>
			<ul class='list-unstyled'>
				<li>{{{stats.mmodules}}} modules</li>
				<li>{{{stats.mclasses}}} classes</li>
				<li>{{{stats.mmethods}}} methods</li>
				<li>{{{stats.loc}}} loc</li>
			</ul>"""
	end
end
src/doc/static/static_cards.nit:558,1--675,3