hubstats 0.3.17 → 0.4.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjU2MmI0YWVkMjVlYWRlMDVmNTVhNGQ4M2NjODIxZWNkMDM1YWRiMw==
-  data.tar.gz: !binary |-
-    Yzc2Njc2YWU4MzU4NjIxMGJkODM5MTJhZGE1MDUyZGI2MGFmYzUwNg==
+SHA1:
+  metadata.gz: 1d42a5ea9c74a42127466bba8c74ef9a8effec2b
+  data.tar.gz: 32f44d7a496f560c48bcbd44469d4ab7f2b07ec4
 SHA512:
-  metadata.gz: !binary |-
-    ZDZmMTc0NTU5M2FjY2NlNWQ0OTc4NjM3Zjg2YTI4YzM3MjhjODZjNWM4ZjQ1
-    MTQ5ZWZmNzc4NWY2MDcyZjUwNjdjNzgyYjU5NzdlYmE4YzM5YzBjNGZhM2Rm
-    MmQ4NWM4MmU4YWQ5ZTU5YTRiM2VjODQwMTkwNzJlODAzMmIyN2I=
-  data.tar.gz: !binary |-
-    OGEyYmUzMjJlM2VkMDQ5NGEwZTllODg0NDE1OWJmYThlMDZkOTI2NGFhNjc2
-    Y2UzMDdhMTM2MjFkNzU2YzZiNWM0MzZhMjNhMmZlOWFlMWEzNmEzOGUwY2Nm
-    ZjgwOTc0NWRkMmMzYWExOWNkNzljZmRkNDhlNzI3NTkzZDJlNDQ=
+  metadata.gz: 4688a3e72183f7108fb153953ea9902feb1195ff8f7e903a81a6c2197a1ac203b6a498d404519711686f7882b9b4a4aca3fb45430d12c0973233215aa62b2103
+  data.tar.gz: a57941f00689be010919731bd4ef7c4c3f744b3776be4c8a0887eb0d4e5c1d5e6d07d2efde44c75894bbb78b54c136cb52970868c4fd6b5e60a050c92d2ea45a

data/.gitignore

@@ -11,4 +11,3 @@ test/dummy/db/migrate/*
 .gitkeep
 Gemfile.lock
 .idea
-db/seeds.rb

data/CHANGELOG.markdown

@@ -1,3 +1,13 @@
+#### v0.4.1
+#### v0.4.0
+* Cleaning up code; fixing bug with repo filter; adding pretty footer
+
+  > Emma Sax: Luke Ludwig, Nick LaMuro: https://github.com/sportngin/hubstats/pull/70
+
+* Cleaning up code; fixing bug with repo filter; adding pretty footer
+
+  > Emma Sax: Luke Ludwig, Nick LaMuro: https://github.com/sportngin/hubstats/pull/70
+
 #### v0.3.17
 * Adding migration to fix datetimes versus strings
 

data/MIT-LICENSE

@@ -1,4 +1,6 @@
-Copyright 2014 YOURNAME
+The MIT License (MIT)
+
+Copyright 2015 Sport Ngin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -30,7 +30,7 @@ Hubstats can also use OAUTH access tokens stored in ENV["GITHUB_API_TOKEN"] or f
 
 ### Webhooks
 
-Hubstats uses GitHub webhooks to keep itself update. It requires you to set a secret as well as an endpoint to push to.
+Hubstats uses GitHub webhooks to keep itself updated. It requires you to set a secret as well as an endpoint to push to.
 
 To generate a secret run:
 
@@ -48,7 +48,7 @@ Hubstats needs to know what repos for it to watch. You can set it to watch eithe
 
 ## Testing
 
-All of the automated tests are written in RSpec. Since hubstats is a plugin, not an application, we need to install the plugin into a Rails application to run. The `test` directory is a dummy rails application for manually testing the UI by serving hubstats locally. When developing and using the `test/dummy` locally, then the test will automatically sync with any updated code, so it doesn't need to be re-served when changes are made with the normal Rails application. When in the development process, one just needs to run `rails s` once from the command line (while in `test/dummy`) to serve the plugin. http://guides.rubyonrails.org/plugins.html will give more information on the implementation of a Rails plugin. 
+All of the automated tests are written in RSpec. Since hubstats is a plugin, not an application, we need to install the plugin into a Rails application to run. The `test` directory is a dummy rails application for manually testing the UI by serving hubstats locally. When developing and using the `test/dummy` locally, then the test will automatically sync with any updated code, so it doesn't need to be re-served when changes are made with the normal Rails application. When in the development process, one just needs to run `bundle exec rails s` once from the command line (while in `test/dummy`) to serve the plugin. http://guides.rubyonrails.org/plugins.html will give more information on the implementation of a Rails plugin. 
 
 ## TL:DR
 

data/app/assets/javascripts/hubstats/application.js

@@ -14,45 +14,101 @@
 //= require jquery_ujs
 //= require select2
 //= require hubstats/bootstrap
+//= require bootstrap-datepicker
 //= require_tree .
 
-$(document).ready( function() {
-  setDateRange()
+/* Below function will run automatically upon refresh. It will do two things:
+ *  - format the datepicker settings
+ *  - call setDateRange on the datepicker
+ */
+$(document).ready(function() {
+  $('.input-daterange').datepicker({
+    "todayHighlight": true,
+    "endDate": "Today",
+    "todayBtn": true
+  });
+  setDateRange();
 });
 
+/* setDateRange
+ * Reads the current cookie (which is currently set as a string with two dates),
+ * and sets the dates in the corresponding datepicker.
+ */
 function setDateRange() {
-  var index = readCookie("hubstats_index") || 2;
-  var timer = document.getElementById("time-select");
+  var dates;
+  var cookie = readCookie("hubstats_dates");
 
-  timer.selectedIndex = index;
+  if (cookie === null || cookie.indexOf("null") > -1) {
+    dates = getDefaultDateRange();
+  } else {
+    dates = readCookie("hubstats_dates");
+  }
+  var submitButton = document.getElementById("submitDateRange");
+  var datesArray = dates.split("~~");
 
-  timer.onchange = function() {
-    createCookie("hubstats_index",this.selectedIndex,1);
+  var start_input = $('.input-daterange').find('[name="start"]');
+  var end_input = $('.input-daterange').find('[name="end"]');
+
+  start_input.datepicker('update', new Date(datesArray[0]));
+  end_input.datepicker('update', new Date(datesArray[1]));
+
+  /* When the 'Apply' button is pressed for the datepicker, this function will
+   * read the datepicker values, assign them to the cookie, and reload the page.
+   */
+  submitButton.onclick = function() {
+    var start_date = start_input.datepicker('getDate');
+    var end_date = end_input.datepicker('getDate');
+    createCookie("hubstats_dates", start_date + "~~" + end_date, 1);
     window.location.reload();
   };
 };
 
-function createCookie(name,value,days) {
-    if (days) {
-        var date = new Date();
-        date.setTime(date.getTime()+(days*24*60*60*1000));
-        var expires = "; expires="+date.toGMTString();
-    }
-    else var expires = "";
-    document.cookie = name+"="+value+expires+"; path=/";
+/* createCookie
+ * @params - name, value, days
+ * Takes a name, value, and number of days and will make a cookie out of those parameters.
+ */
+function createCookie(name, value, days) {
+  if (days) {
+    var date = new Date();
+    date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
+    var expires = "; expires=" + date.toGMTString();
+  }
+  else var expires = "";
+  document.cookie = name + "=" + value + expires + "; path=/";
 };
 
+/* readCookie
+ * @params - name
+ * Takes in the name of a cookie, and will read that cookie, returning either the data
+ * from the cookie or null if there is no cookie with that name.
+ */
 function readCookie(name) {
-    var nameEQ = name + "=";
-    var ca = document.cookie.split(';');
-    for(var i=0;i < ca.length;i++) {
-        var c = ca[i];
-        while (c.charAt(0)==' ') c = c.substring(1,c.length);
-        if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length);
-    }
-    return null;
+  var cookieName = name + "=";
+  var cookieData = document.cookie.split(';');
+  for(var i = 0; i < cookieData.length ; i++) {
+    var c = cookieData[i];
+    while (c.charAt(0) == ' ') c = c.substring(1, c.length);
+    if (c.indexOf(cookieName) == 0) return c.substring(cookieName.length, c.length);
+  }
+  return null;
 };
 
+/* eraseCookie
+ * @params - name
+ * Creates a new blank cookie.
+ */
 function eraseCookie(name) {
-    createCookie(name,"",-1);
+  createCookie(name, "" , -1);
+};
+
+/* getDefaultDateRange
+ * Returns a string that is the date two weeks ago, '~~', and today's date with all hours
+ * set at midnight.
+ */
+function getDefaultDateRange() {
+  var today = new Date();
+  today.setHours(0,0,0,0);
+  var twoWeeksAgo = new Date(today);
+  twoWeeksAgo.setDate(twoWeeksAgo.getDate() - 14);
+  return twoWeeksAgo + '~~' + today;
 };

data/app/assets/javascripts/hubstats/pull_requests.js

@@ -1,6 +1,12 @@
 // Place all the behaviors and hooks related to the matching controller here.
 // All this logic will automatically be available in application.js.
 
+/* This will be run whenever the Pull Requests page or Deploy page (for some functionality)
+ * is opened or refreshed. It will automatically call of the below functions on all of the
+ * variables that are in the URL of the page. The below pieces are all about sorting
+ * the data on the page based on state (open or closed), order (newest first
+ * or oldest first), and the grouping (by repo or user).
+ */
 $(document).ready(function() {
   queryParameters = getUrlVars();
   setDefaults(queryParameters);
@@ -31,7 +37,11 @@ $(document).ready(function() {
   });
 });
 
-
+/**
+ * updateQueryStringParameter
+ * @params - queryParameters, key, value
+ * Updates the string paramters based on the specifications in the URL.
+ */
 function updateQueryStringParameter(queryParameters, key, value) {
   var uri = document.location.pathname;
   if (!queryParameters[key])
@@ -49,6 +59,9 @@ function updateQueryStringParameter(queryParameters, key, value) {
   document.location.href = uri
 }
 
+/* getUrlVars
+ * Gets all of the variables that are in the URL.
+ */
 function getUrlVars() {
   var vars = [], hash;
   if (window.location.href.indexOf('?') > 0) {
@@ -63,6 +76,10 @@ function getUrlVars() {
   return vars;
 }
 
+/* setDefaults
+ * @params - queryParameters
+ * Sets the state, order, and grouping to be 'default', or all, descending, and non-grouped.
+ */
 function setDefaults(queryParameters) {
   if (queryParameters["state"])
     $('#' + queryParameters["state"]).addClass('active');
@@ -78,6 +95,11 @@ function setDefaults(queryParameters) {
     $('#group-by').val(queryParameters["group"]);
 }
 
+/* initLabels
+ * @params - queryParameters
+ * Takes the query parameters and if there are labels as a parameter, then assigns 
+ * the background colors to the labels that are highlighted.
+ */
 function initLabels (queryParameters) {
   if (queryParameters["label"]) {
     var labels = queryParameters["label"].split(',');
@@ -93,6 +115,9 @@ function initLabels (queryParameters) {
   }
 }
 
+/* changeColors
+ * Adds the colors to the labels on the list of labels and when labeling the pull requests.
+ */
 function changeColors () {
   $(".color-label").each( function() {
     var color = '#' + $(this)[0].title;
@@ -104,9 +129,12 @@ function changeColors () {
     var color = '#' + $(this).data("color");
     $(this).children().eq(0).css('background-color',color);
   });
-
 }
 
+/* activeLabels
+ * Shows only the labels that are assigned to a pull request that is currently being shown;
+ * whether a PR is being shown is dependent on what state (closed, open, or all) the data is showing.
+ */
 function activeLabels () {
   $("#labels-container .btn-label").click(function () {
     $(this).toggleClass("active");
@@ -122,7 +150,11 @@ function activeLabels () {
   });
 }
 
-function isDark( color ) {
+/* isDark
+ * @params - color
+ * Edits the color of the text if the label color is dark.
+ */
+function isDark(color) {
     var match = /rgb\((\d+).*?(\d+).*?(\d+)\)/.exec(color);
     return parseFloat(match[1])
          + parseFloat(match[2])

data/app/assets/javascripts/hubstats/select2.js

@@ -1,3 +1,7 @@
+/* This is for the filters in the top left corner of the Deploys and Pull Requests pages.
+ * This allows the user of Hubstats to filter by an entire list of the repos/users, and then
+ * on selection only show data for that choice.
+ */
 $(document).ready(function() { 
   usersIDs = queryParameters["users"] ? queryParameters["users"].replace("%2C", ",") : "";
   reposIDs = queryParameters["repos"] ? queryParameters["repos"].replace("%2C", ",") : "";
@@ -86,7 +90,10 @@ $(document).ready(function() {
   }).select2('val', []);
 });
 
-
+/* getPath
+ * @params - model (string)
+ * Returns the user or repo bath, based on whether the string passed in is 'repo' or 'user'.
+ */
 function getPath (model) {
   if (model == 'user') {
     return $("#brand").attr('data-user-path');}

data/app/assets/javascripts/hubstats/users.js

@@ -1,6 +1,11 @@
 // Place all the behaviors and hooks related to the matching controller here.
 // All this logic will automatically be available in application.js.
 
+/* This function is run whenever the Metrics page or the Users page is opened or refreshed. It will
+ * sort all of the repos/users sorted by count of (or alphabetically by) name, number of deploys,
+ * number of merged pull requests, number of comments, net additions, average additions, or average
+ * deletions.
+ */
 $(document).ready(function() {
   queryParameters = getUrlVars();
   setUserDefaults(queryParameters);
@@ -21,7 +26,6 @@ $(document).ready(function() {
     toggleOrder(queryParameters,$(this).attr('id'));
   });
 
-// No longer using additions and deletions, but instead using net additions
   $("#netadditions").on("click", function(){
     toggleOrder(queryParameters,$(this).attr('id'));
   });
@@ -35,6 +39,10 @@ $(document).ready(function() {
   });
 });
 
+/* toggleOrder
+ * @params - queryParams, sort_by
+ * Will toggle the order that the data is sorted by (highest first or lowest first).
+ */
 function toggleOrder(queryParams, sort_by) {
   if (queryParams["order"] !== undefined) {
     if (queryParams["order"] === sort_by+"-desc" ) {
@@ -47,10 +55,14 @@ function toggleOrder(queryParams, sort_by) {
   }
 }
 
-function setUserDefaults(queryParameters) {
-  if (queryParameters["order"]) {
-    sort_by = queryParameters["order"].split("-")[0];
-    order = queryParameters["order"].split("-")[1];
+/* setUserDefaults
+ * @params - queryParameters
+ * Sets the arrow next to what piece of data is being sorted.
+ */
+function setUserDefaults(queryParams) {
+  if (queryParams["order"]) {
+    sort_by = queryParams["order"].split("-")[0];
+    order = queryParams["order"].split("-")[1];
     if (order === 'asc') {
       $('#'+sort_by+' .octicon').addClass('octicon-arrow-up');
     } else {

data/app/assets/stylesheets/hubstats/application.css

@@ -12,9 +12,42 @@
  *= require hubstats/bootstrap
  *= require select2
  *= require select2-bootstrap
+ *= require bootstrap-datepicker
  *= require_tree .
  */
 
+/*For the 'Apply' button*/
+.apply {
+  float: right;
+  margin-top: 8px;
+}
+
+/*For the active tab on the navigation bar*/
+.navbar-active {
+  font-weight: bold;
+  color: #E0E0E0;
+  background-color: #E0E0E0;
+  border-color: #E0E0E0;
+}
+
+/*For the datepicker*/
+.input-daterange {
+  width: 245px;
+  top: 8px;
+}
+
+.footer-main-text {
+  font-size: 18px;
+  color: #B0B0B0;
+  text-align: center;
+}
+
+.footer-text {
+  font-size: 12px;
+  color: #A0A0A0;
+  line-height: 20px;
+}
+
 .numeric, .title {
   text-align: center;
 }
@@ -50,13 +83,14 @@
   padding: 5px;
 }
 
-
 .user-image > img,
 .repo-image {
   width: 55px;
   height: 55px;
 }
 
+/*For the various images of the repos, octicons, deploys, etc*/
+
 .repo-octicon-small {
   font-size: 36px !important;
 }
@@ -71,6 +105,8 @@
   height: 36px;
 }
 
+/*For the lists of repos, pull requests, deploys, comments, and users*/
+
 .pulls, .comments, .users, .repos, .deploys {
   margin: 15px 0px 15px 0px;
   border: 1px solid #ccc;
@@ -123,6 +159,8 @@
   margin: 0px;
 }
 
+/*Other extraneous bits that format the UI*/
+
 .push-down {
   margin-top: 8px;
 }

data/app/assets/stylesheets/hubstats/bootstrap.css

@@ -3667,12 +3667,6 @@ select[multiple].input-group-sm > .input-group-btn > .btn {
 .navbar-collapse.in {
   overflow-y: auto;
 }
-.navbar-active {
-  font-weight: bold;
-  color: #E0E0E0;
-  background-color: #E0E0E0;
-  border-color: #E0E0E0;
-}
 @media (min-width: 768px) {
   .navbar-collapse {
     width: auto;

data/app/assets/stylesheets/hubstats/deploys.css

@@ -1,7 +1,9 @@
+/*For the filter boxes on the left side of the Deploys page*/
 .select2-container{
   width: 100%;
 }
 
+/*To align the right-side octicon and pull requests numbers on the Deploys index page*/
 .deploy-right {
   float: right !important;
 }