functions.js

// Using jQuery is ok because it is needed by and bundled with sphinx

// Quirk to note: the jQuery.getJSON function fails if you open this locally
// with Chrome, because Chrome thinks local JSON files are unsafe for some
// reason.  Use basically any other modern browser, or it works fine if its
// actually on the web server even with chrome.

function url_translator(urltext) {
    if (urltext === undefined) {
        return 'None';
    } else {
        return '<a href="' + urltext + '">' + 'Website' + '</a>';
    }
}


function repo_translator(urltext) {
    if (urltext === undefined) {
        return 'None';
    } else {
        return '<a href="' + urltext + '">' + 'Repository' + '</a>';
    }
}


function pypi_translator(pypiname) {
    if (pypiname === undefined) {
        return 'None';
    } else {
        var urltext = 'https://pypi.python.org/pypi/' + pypiname;
        return '<a href="' + urltext + '">' + 'PyPI' + '</a>';
    }
}


function bool_translator(stable) {
    if (stable) {
        return 'Yes';
    } else {
        return 'No';
    }
}


function ghuser_translator(fullname, ghname) {
    if (fullname === undefined || ghname === undefined) {
        return 'None';
    } else {
        var urltext = 'https://github.com/' + ghname;
        if (fullname === null) {
            fullname = ghname;
        }
        return '<a href="' + urltext + '">' + fullname + '</a>';
    }
}


var _email_regex_str = '[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}';
var _email_regex  = new RegExp(_email_regex_str, 'i');
var _email_with_name_regex  = new RegExp('(.+)<(' + _email_regex_str + ')>', 'i');


function maintainer_translator(maint, pkgnm) {
    var url, match;
    if (_email_with_name_regex.test(maint)) {
        match = _email_with_name_regex.exec(maint);
        url = 'mailto:' + match[2] + '?subject=Astropy%20affiliated%20package%20' + pkgnm;
        return '<a href="' + url + '">' + match[1] + '</a>';
    } else if (_email_regex.test(maint)) {
        url = 'mailto:' + maint + '?subject=Astropy%20affiliated%20package%20' + pkgnm;
        return '<a href="' + url + '">' + maint + '</a>';
    } else {
        return maint;
    }
}


function createRolesTable(roles) {
    var tab = document.getElementById("roles-table");
    tab.deleteRow(1);
    //roles is an array of objects called "role"
    var rows = '';
    roles.forEach(function (role) {
        //role is an object containing information about each team role
        //index marks current people
        var index = 0;

        // for roles where there are no sub-roles, the people are defined
        // at the top-level of the JSON role dict - for convenience below we create
        // a virtual sub-role with no heading
        if (!('sub-roles' in role)) {
            role['sub-roles'] = [{'role': '',
                                  'people': role['people']}];
        }

        //creating each row by iterating over each person in a role
        role["sub-roles"].forEach(function (subrole) {
            //rowRole is displayed once for each role
            rowRole = index == 0 ? '<a href="#' + role["url"] + '">' + role["role"] + '</a>' : "";

            var rowSubRole = subrole['role'];

            if (subrole['people'][0] == "Unfilled") {
                rowPeople = '<a href="mailto:coordinators@astropy.org"><span style="font-style: italic;">Unfilled</span></a>';
            } else {
                rowPeople = subrole['people'].join(', ');
            }

            //generating rows
            if (index == 0) {
                rows += '<tr class="border-top">';
            } else {
                rows += '<tr>';
            }

            rows +=   '<td>' + rowRole + '</td>' +
                      '<td>' + rowSubRole + '</td>' +
                      '<td>' + rowPeople + '</td>' +
                    '</tr>';
            index++;
        });
    });

    $("#roles-table").append(rows);
}


function createRolesDescription(roles) {
    //roles is an array of objects called "role"
    var blocks = "";
    roles.forEach(function (role) {
        //role is an object containing information about each team role
        var list = "";
        //checking if role["description"] array isn't empty
        if (role["responsibilities"] != null) {

            // If responsibilities is a dict, wrap inside a list so that all entries have a list
            // dicts
            if (role['responsibilities'].constructor == Object) {
                role['responsibilities'] = [role['responsibilities']];
            }

            //console.log(role['responsibilities']);

            blocks += '<h4 id="' + role["url"] + '">' + role["role-head"] + '</h4>';

            index = 0;

            role['responsibilities'].forEach(function (resp) {

                //console.log(resp);

                detail_list = '';
                resp["details"].forEach(function (detail) {
                    detail_list += '<li>' + detail + '</li>';
                });

                if ('subrole-head' in resp) {
                    if (index > 0) {
                        blocks += '<br>';
                    }
                    blocks += '<em>' + resp["subrole-head"] + '</em>';
                }
                blocks += '<p>' + resp["description"] + '</p>' +
                          '<ul>' + detail_list + '</ul>';

                index += 1;

            })

        }
    });
    $("#roles-description").append(blocks);
}


function populateRoles(data, tstat, xhr) {
    //creating roles table from json data
    createRolesTable(data);
    //creating roles lists from json data
    createRolesDescription(data);
}


function populateTables(data, tstat, xhr) {
    populatePackageTable('coordinated', filter_pkg_data(data, "coordinated", true));
    populatePackageTable('affiliated', filter_pkg_data(data, "coordinated", false));
}


function filter_pkg_data(data, field, value) {
    if (data === null) {
      return null;
    }
    var pkgs = data.packages;
    var filtered_data = [];

    for (i=0; i<pkgs.length; i++) {
        if (pkgs[i][field] == value) {
            filtered_data.push(pkgs[i]);
        }
    }
    return {'packages': filtered_data};
}


function populatePackageTable(tableid, data) {
    // Now we get the table and prepare it
    var tab = document.getElementById(tableid + "-package-table");
    var ncols = tab.rows[0].cells.length;

    //we have to delete the "Loading..." row
    tab.deleteRow(1);

    if (data === null) {
        var row = tab.insertRow(1);
        row.insertCell(0).innerHTML = 'Could not load registry file!';
        for (i=0;i<(ncols - 1);i++) { row.insertCell(i + 1).innerHTML = ' '; }
    } else {
        var pkgs = data.packages;
        //inserting total number of affiliated packages at top of table
        $("#total-" + tableid + "-pkgs").text(pkgs.length);
        //First figure out the correct order if we sort on the name
        var nmarr = new Array(pkgs.length);
        var sortorder = new Array(pkgs.length);
        for (i=0; i<pkgs.length; i++) {
            pkgi = pkgs[i];
            nmarr[i] = pkgi.name.toLowerCase();
            sortorder[i] = i;
        }
        // This "sorts" the indicies using a compare function that actually sorts nmarr
        sortorder.sort(function (a, b) { return nmarr[a] < nmarr[b] ? -1 : nmarr[a] > nmarr[b] ? 1 : 0; });

        var pkgi;
        var namerow, descrow, shieldrow, maintrow;
        var nmcell, pypicell, urlcell, repocell;
        var desccell, maintcell, shieldcell;

        for (i=0; i<sortorder.length; i++) {
            pkgi = pkgs[sortorder[i]];
            namerow = tab.insertRow(i*4 + 1);

            nmcell = namerow.insertCell(0);
            urlcell = namerow.insertCell(1);
            repocell = namerow.insertCell(2);
            pypicell = namerow.insertCell(3);

            nmcell.innerHTML = pkgi.name;
            nmcell.className = 'first-package-row'
            nmcell.setAttribute('width', 100)
            urlcell.innerHTML = url_translator(pkgi.home_url);
            repocell.innerHTML = repo_translator(pkgi.repo_url);
            pypicell.innerHTML = pypi_translator(pkgi.pypi_name);


            descrow = tab.insertRow(i*4 + 2);
            descrow.insertCell(0).innerHTML = "";
            desccell = descrow.insertCell(1);
            desccell.colSpan = "3";
            desccell.innerHTML = pkgi.description;

            maintrow = tab.insertRow(i*4 + 3);
            maintrow.insertCell(0).innerHTML = "";
            maintcell = maintrow.insertCell(1);
            maintcell.colSpan = "3";
            maintcell.innerHTML = "Maintainer(s): " + maintainer_translator(pkgi.maintainer, pkgi.name);

            shieldrow = tab.insertRow(i*4 + 4);
            shieldrow.insertCell(0).innerHTML = "";
            shieldcell = shieldrow.insertCell(1);
            shieldcell.colSpan = "3";
            shieldcell.innerHTML = makeShields(pkgi)

        }
      tab.deleteRow(0);
    }
}

var review_name_map = {"functionality": "Functionality",
    "ecointegration": "Astropy%20integration",
    "documentation": "Docs",
    "testing": "Tests",
    "devstatus": "Development",
    "python3": "Python 3"
};

var review_default_color = "brightgreen";
var review_color_map = {'Unmaintained': "red",
    "Functional but low activity": "orange",
    "Good": "brightgreen",
    "Partial": "orange",
    "No": "orange",
    "Needs work": "red"
};


function makeShields(pkg) {
  var shield_string = "";

  var key, shield_name, pkgvalue, color, url;

  for (key in review_name_map) {
    //console.log("K"+key);
    if (review_name_map.hasOwnProperty(key)) {
      shield_name = review_name_map[key];
      if ("review" in pkg && key in pkg.review ) {
        pkgvalue = pkg.review[key];

        color = review_color_map[pkgvalue];
        if (typeof color == 'undefined') {
          color = review_default_color;
        }

        url = "https://img.shields.io/badge/" + shield_name + "-" + pkgvalue + "-" + color + ".svg";
        shield_string += "<img src=\"" + url + "\">" + " "
      }
    }
  }
  return shield_string
}


function guess_os() {
    var OSName="source";
    if (navigator.appVersion.indexOf("Win")!=-1) OSName="windows";
    if (navigator.appVersion.indexOf("Mac")!=-1) OSName="osx";
    if (navigator.appVersion.indexOf("Linux")!=-1) OSName="linux";
    return OSName;
}