Skip to content

Commit

Permalink
Merge pull request #156 from wafers/wt-githubRanks
Browse files Browse the repository at this point in the history 
Incorporate GitHub data in ranking.
  • Loading branch information
Allen Chang committed Aug 22, 2015
2 parents d34fa61 + 278cc32 commit de4f776
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 20 deletions.
12 changes: 8 additions & 4 deletions client/app/results/results.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ angular.module('app')
}

$scope.bulletGraph = function(module, index) {
var ranks = [['Overall Rank',module.overallRank, 'overallRank'], ['Last Update Rank', module.dateRank, 'lastUpdate'], ['Number of Versions Rank', module.versionNumberRank, 'time'], ['Module Data Completeness', module.completenessRank, 'completenessRank'], ['Monthly Download Rank', module.downloadRank, 'monthlyDownloadSum'], ['Dependents Rank', module.dependentRank, 'dependentsSize'], ['Number of Stars Rank', module.starRank, 'starred']];
var ranks = [['Overall Rank',module.overallRank, 'overallRank'], ['Last Update Rank', module.dateRank, 'lastUpdate'], ['Number of Versions Rank', module.versionNumberRank, 'time'], ['Module Data Completeness', module.completenessRank, 'completenessRank'], ['Monthly Download Rank', module.downloadRank, 'monthlyDownloadSum'], ['Dependents Rank', module.dependentRank, 'dependentsSize'], ['Number of Stars Rank', module.starRank, 'starred'], ['GitHub Repo Rank', module.githubRank, 'github']];
var margin = {top: 5, bottom: 5, left: 200};
var width = document.getElementsByClassName('page-header')[0].offsetWidth - margin.left;
var height = 200 - margin.top - margin.bottom;
Expand Down Expand Up @@ -92,19 +92,23 @@ angular.module('app')
} else if (key === 'lastUpdate') {
displayData = 'Last update on ' + module[key];
} else if (key === 'monthlyDownloadSum') {
displayData = module[key] + ' downloads in past 30 days';
displayData = module[key].toLocaleString() + ' downloads in past 30 days';
} else if (key === 'dependentsSize') {
displayData = module[key] + ' modules depending on ' + module.name;
displayData = module[key].toLocaleString() + ' modules depending on ' + module.name;
} else if (key === 'starred') {
displayData = module[key] + ' stars on NPM';
displayData = module[key].toLocaleString() + ' stars on NPM';
} else if (key === 'overallRank') {
displayData = module[key] + ' overall module score';
} else if (key === 'completenessRank') {
displayData = module[key] + '% module information complete'
if (module[key] < 100) displayData += '. Missing info: ' + module.completenessFailures
} else if (key === 'github' && module.subscribers) {
displayData = 'Watched by ' + module.subscribers.toLocaleString() + ' GitHub users. \n' + module.forks.toLocaleString() + ' forked repos. \n' + module.openIssues.toLocaleString() + ' open issues and pull requests.'
}

return displayData
}

}

$scope.$watch(function() {
Expand Down
69 changes: 53 additions & 16 deletions client/app/results/services.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ angular.module('app')
return this.results;
}

// Calculate quality ranking for given module and attach relevent metrics to module.
this.calculateRank = function(module) {
// Rank by time since last module update. Longer time => lower score.
if (module.lastUpdate === 'Unknown') {
module.dateRank = 0;
} else {
Expand All @@ -27,33 +29,68 @@ angular.module('app')
module.dateRank = Math.floor((100/(recent-year))*(moduleDate - now) + 100 - (100/(recent-year))*(recent-now))
if (module.dateRank < 0 ) module.dateRank = 0;
};

// Rank by total number of published module updates.
module.versionNumberRank = Object.keys(module.time).length < 35 ? 3 * (Object.keys(module.time).length-2) : 100; // versionNumberRank gives 3pts per published update, max 100 pts.


// Rank by number of downloads in past 30 days.
if (!module.monthlyDownloadSum) {
module.downloadRank = 0;
} else { // If there are downloads, min score is 40. Score moves up from there on log10 scale. Max score of 100 reached at 1million monthly downloads.
module.downloadRank = Math.log10(module.monthlyDownloadSum)*10+40 > 100 ? 100 : Math.floor(Math.log10(module.monthlyDownloadSum)*10+40);
} else { // If there are downloads, min score is 10. Score moves up from there on log10 scale. Max score of 100 reached at 1million monthly downloads.
module.downloadRank = Math.log10(module.monthlyDownloadSum)*15+10 > 100 ? 100 : Math.floor(Math.log10(module.monthlyDownloadSum)*15+10);
}

if (!module.starred) {

// Rank by number of NPM stars and Github stars.
if (!module.starred && !module.watchers) {
module.starRank = 0;
} else {
module.starRank = module.starred > 50 ? 100 : 2 * module.starred;
} else { // NPM stars added to GitHub stars, then scaled on log10. Max score of 100 reached at 10,000 combined stars.
module.starRank = Math.floor(Math.log10(module.starred+module.watchers)*25) > 100 ? 100 : Math.floor(Math.log10(module.starred+module.watchers)*25);
}

// Rank by number of modules listing this module as a dependency
if (!module.dependentsSize) {
module.dependentRank = 0;
} else {
module.dependentRank = Math.log10(module.dependentsSize)*25 > 100 ? 100 : Math.floor(Math.log10(module.dependentsSize)*25) ;
}

// Rank by NPM module submission completeness (quality module must have Readme, Keywords, and URL)
// Store lacking pieces for rank explanations
module.completenessRank = 0;
if (module.readme !== 'No readme provided') module.completenessRank += 34;
if (module.url && module.url.length > 0) module.completenessRank += 33;
if (module.keywords && module.keywords.length > 0) module.completenessRank += 33;
if (module.readme !== 'No readme provided') {
module.completenessRank += 34;
} else {
module.completenessFailures = ['Readme'];
}
if (module.url && module.url.length > 0) {
module.completenessRank += 33;
} else {
if (module.completenessFailures) module.completenessFailures.push('URL')
else module.completenessFailures = ['URL'];
}
if (module.keywords && module.keywords.length > 0) {
module.completenessRank += 33;
} else {
if (module.completenessFailures) module.completenessFailures.push('Keywords')
else module.completenessFailures = ['Keywords'];
}

// Rank by GitHub followers, forks, and open issues/pulls
if (!module.subscribers || !module.forks || !module.openIssues) {
module.githubRank = 0;
} else {
// Count users watching repo for 33 of 100 points. Scaled on log10 with max score of 33 reached at 1500 users watching.
var watchersPortion = Math.floor(Math.log10(module.subscribers)*31.5/100*33) > 33 ? 33 : Math.floor(Math.log10(module.subscribers)*31.5/100*33);
// Count forked repos for 34 of 100 points. Scaled on log10 with max score of 34 reached at 1000 forks.
var forkPortion = Math.floor(Math.log10(module.forks)*33/100*34) > 34 ? 34 : Math.floor(Math.log10(module.forks)*33/100*34);
// Count issues+pulls for 33 of 100 points. Scaled on log10 with max score of 33 reached at 150 open issues/pulls.
var issuesPortion = Math.floor(Math.log10(module.openIssues)*46/100*33) > 33 ? 33 : Math.floor(Math.log10(module.openIssues)*46/100*33);
module.githubRank = watchersPortion + forkPortion + issuesPortion;
}

var rankSum = (module.dateRank + module.versionNumberRank + module.downloadRank + module.starRank + module.dependentRank + module.completenessRank)
module.overallRank = Math.floor(rankSum/600 * 100)
// Calculate overall rank as average of individual rankings
var rankSum = (module.dateRank + module.versionNumberRank + module.downloadRank + module.starRank + module.dependentRank + module.completenessRank + module.githubRank)
module.overallRank = Math.floor(rankSum/7)
}

this.getResults = function() {
Expand Down Expand Up @@ -239,7 +276,7 @@ angular.module('app')
var thisTotal = thisVersion[0]+thisVersion[1]+thisVersion[2];
var lastTotal = lastVersion[0]+lastVersion[1]+lastVersion[2];
var versionDiff = thisTotal - lastTotal;

return versionDiff > 0 ? versionDiff : 1;
}
var data = [];
Expand All @@ -257,7 +294,7 @@ angular.module('app')
versionObj['majorVersion'] = key.split('.')[0]
data.push(versionObj);
last = versionObj['versionLabel'];
}
}
}
}

Expand Down Expand Up @@ -301,7 +338,7 @@ angular.module('app')
str += "</br><string>Date:</strong><span class='tip-values'> " + date + "</span>";
return str;
})

// Create main svg for drawing
var svg = d3.select("#graph-container").append("svg")
.attr("width", width + margin.left + margin.right)
Expand Down Expand Up @@ -329,7 +366,7 @@ angular.module('app')
.attr('x', 0)
.attr('dx', 15)
.attr('transform', 'rotate(30)')

// Load in data and create circles for each
svg.selectAll(".circle")
.data(data)
Expand Down

0 comments on commit de4f776

Please sign in to comment.