Refactor and add doc level comments

This commit is contained in:
Ian Minoso 2016-11-29 15:57:53 -05:00
parent 0d915eccc4
commit daa759a066
4 changed files with 35 additions and 17 deletions

View file

@ -1,14 +1,22 @@
import * as React from "react";
interface IMain {
interface IBody {
description: string
}
class body extends React.Component<IMain, {}> {
/**
* The Component for the main body of the repo page
* @param {string} description - The description of the repository
*/
class body extends React.Component<IBody, {}> {
static propTypes = {
description: React.PropTypes.string.isRequired,
}
render () {
let description: string = this.props.description;
if (description === "") {
description = "No Description";
}
return(
<div>
<ul className="nav nav-tabs rp-tabs">
@ -18,7 +26,7 @@ class body extends React.Component<IMain, {}> {
<div className="panel-body rp-panelBody">
<div className="tab-content">
<div className="tab-pane in active" id="tab1">
<div className="rp-description">{this.props.description}</div>
<div className="rp-description">{description}</div>
</div>
<div className="tab-pane" id="tab2">
TODO (IAN): Convert the build directives to angular components

View file

@ -5,6 +5,11 @@ interface IHeader {
namespace: string
}
/**
* The Component for the header of the repo page
* @param {string} name - The name of the repository
* @param {string} namespace - The namespace of the repository
*/
class repoHeader extends React.Component<IHeader, {}> {
static propTypes = {
name: React.PropTypes.string.isRequired,

View file

@ -14,6 +14,12 @@ interface ISidebar {
repository: Object
}
/**
* The Component for the sidebar of the repo page
* @param {string} isPublic - A string that states whether the repository is private or public
* @param {tag} tags - The list of tags for the repository
* @param {object} repository - The list of properties for the repository
*/
class repoSidebar extends React.Component<ISidebar, {}> {
static propTypes = {
isPublic: React.PropTypes.string.isRequired,
@ -27,16 +33,18 @@ class repoSidebar extends React.Component<ISidebar, {}> {
let badgeIcon: string = (this.props.isPublic) ? "rp-badge__icon--public" : "rp-badge__icon--private";
let repository: any = this.props.repository;
let sharing: string = repository.company || repository.namespace;
for (let t in this.props.tags){
sortedTags.push(
{
name: this.props.tags[t].name,
lastModified: Date.parse(this.props.tags[t].last_modified)
}
);
for (let tagObject in this.props.tags) {
sortedTags.push({
name: this.props.tags[tagObject].name,
lastModified: Date.parse(this.props.tags[tagObject].last_modified)
});
}
sortedTags = sortedTags.sort(function(a,b){return a.lastModified - b.lastModified});
sortedTags = sortedTags.sort(function(a, b) {
return a.lastModified - b.lastModified;
});
sortedTags.forEach(function(el, i){
tagRows.push(
<tr>

View file

@ -61,9 +61,6 @@
$scope.repository = repo;
$scope.viewScope.repository = repo;
$scope.publicRepoExperiment = CookieService.get('quay.public-repo-exp') == 'true';
if (!$scope.repository.description){
$scope.repository.description = "No Description";
}
// Flag for new repo page experiment
$scope.newRepoExperiment = $scope.repository.is_public && $scope.user.username != $scope.repository.namespace && $scope.publicRepoExperiment;