hubstats 0.3.17 → 0.4.1

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

@@ -1,3 +1,5 @@
+/*For various label appearances throughout Hubstats*/
+
 .btn-label {
   font-weight: bold;
   color: #333333;

data/app/assets/stylesheets/hubstats/octicons.css.erb

@@ -1,3 +1,5 @@
+/*Octicons!*/
+
 @font-face {
   font-family: 'octicons';
   src: url('<%= asset_path("hubstats/octicons.eot") + "?#iefix" %>') format('embedded-opentype'),

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

@@ -2,6 +2,8 @@
   Place all the styles related to the matching controller here.
   They will automatically be included in application.css.
 */
+
+/*For the filter boxes on the left side of the Pull Requests page*/
 .select2-container{
   width: 100%;
 }

data/app/controllers/hubstats/application_controller.rb

@@ -1,13 +1,21 @@
 module Hubstats
   class ApplicationController < ApplicationController
-
     before_filter :set_time
 
+    # Private - Reads the cookie, and then either sets @start_date and @end_date to be the cookie's values
+    # or sets them to be today + 1 and two weeks ago.
+    # 
+    # Returns -  nothing 
     private
     def set_time
-      cookies[:hubstats_index] ||= 2
-      @start_date = DATE_RANGE_ARRAY[cookies[:hubstats_index].to_i][:date].ago.to_date
-      @end_date = Date.today + 1
+      cookie = cookies[:hubstats_dates]
+      if cookie == nil || cookie.include?("null")
+        @start_date = Date.today - 14
+        @end_date = Date.today + 1
+      else
+        @start_date = cookies[:hubstats_dates].split("~~").first.to_date
+        @end_date = cookies[:hubstats_dates].split("~~").last.to_date + 1
+      end
     end
   end
 end

data/app/controllers/hubstats/base_controller.rb

@@ -2,6 +2,14 @@ require_dependency "hubstats/application_controller"
 
 module Hubstats
   class BaseController < Hubstats::ApplicationController
+
+    # Public - If the group is being asked to be grouped by user or repo, will make an array and group the data
+    # by either username or repo name.
+    #
+    # group_request - string of what the data should be grouped by
+    # group - the group of data to be grouped
+    #
+    # Returns - nothing
     def grouping (group_request, group)
       if group_request == "user"
         @groups = group.to_a.group_by(&:user_name)

data/app/controllers/hubstats/deploys_controller.rb

@@ -3,8 +3,11 @@ require_dependency "hubstats/application_controller"
 module Hubstats
   class DeploysController < Hubstats::BaseController
 
+    # Public - Will list the deploys that correspond with selected repos, users, orders, and groupings. Only shows
+    # deploys within the @start_date and @end_date.
+    #
+    # Returns - the deploy data
     def index
-      # sets to include user and repo, and sorts data
       @deploys = Hubstats::Deploy.includes(:repo, :pull_requests, :user)
         .belonging_to_users(params[:users]).belonging_to_repos(params[:repos])
         .group_by(params[:group])
@@ -14,7 +17,10 @@ module Hubstats
       grouping(params[:group], @deploys)
     end
 
-    # show basic stats and pull requests from a single deploy
+    # Public - Shows the single deploy and all of the stats and pull requests about that deploy. Stats and PRs only
+    # include info that happened between @start_date and @end_date.
+    #
+    # Returns - the stats and data of the deploy
     def show
       @deploy = Hubstats::Deploy.includes(:repo, :pull_requests).find(params[:id])
       repo = @deploy.repo
@@ -29,7 +35,10 @@ module Hubstats
       }
     end
 
-    # make a new deploy with all of the correct attributes
+    # Public - Creates a new deploy with the git_revision. Passed in the repo name and a string of PR ids
+    # that are then used to find the repo_id, PR id array. The user_id is found through one of the pull requests.
+    #
+    # Returns - nothing, but makes a new deploy
     def create
       if params[:git_revision].nil? || params[:repo_name].nil? || params[:pull_request_ids].nil?
         render text: "Missing a necessary parameter: git revision, pull request ids, or repository name.", :status => 400 and return
@@ -45,11 +54,11 @@ module Hubstats
           @deploy.repo_id = @repo.first.id.to_i
         end
 
-        @pull_request_id_array = params[:pull_request_ids].split(",").map {|i| i.strip.to_i}
-        if !valid_pr_ids
+        pull_request_id_array = params[:pull_request_ids].split(",").map {|i| i.strip.to_i}
+        if !valid_pr_ids(pull_request_id_array)
           render text: "No pull request ids given.", :status => 400 and return
         else
-          @deploy.pull_requests = Hubstats::PullRequest.where(repo_id: @deploy.repo_id).where(number: @pull_request_id_array)
+          @deploy.pull_requests = Hubstats::PullRequest.where(repo_id: @deploy.repo_id).where(number: pull_request_id_array)
         end
 
         if !valid_pulls
@@ -64,14 +73,28 @@ module Hubstats
       end
     end
 
+    # Public - Checks if the repo that's passed in is empty.
+    #
+    # repo - the repository
+    #
+    # Returns - true if the repo is valid 
     def valid_repo(repo)
       return !repo.empty?
     end
 
-    def valid_pr_ids
-      return !@pull_request_id_array.empty? && @pull_request_id_array != [0]
+    # Public - Checks if the array is empty or if the ids in the array are invalid.
+    #
+    # pull_id_array - the array of pull request ids
+    #
+    # Returns - returns true if the array neither is empty nor comes out to [0]
+    def valid_pr_ids(pull_id_array)
+      return !pull_id_array.empty? && pull_id_array != [0]
     end
 
+    # Public - Checks if the first pull assigned to the new deploy is nil, if the merged_by part is nil. If nothing is
+    # nil, it will set the user_id of the deploy to be the merged_by of the pull.
+    #
+    # Returns - true and changes the user_id of deploy, else returns false
     def valid_pulls
       pull = @deploy.pull_requests.first
       return false if pull.nil? || pull.merged_by.nil?

data/app/controllers/hubstats/events_controller.rb

@@ -3,6 +3,12 @@ require_dependency "hubstats/application_controller"
 module Hubstats
   class EventsController < ApplicationController
 
+    # Public - Verifies that the request we're receiving is a new event, and then will handle it and route
+    # it to the correct place.
+    #
+    # request - the request of the new event
+    #
+    # Returns - nothing, but makes a new event
     def handler
       verify_signature(request)
 
@@ -14,6 +20,11 @@ module Hubstats
       render :nothing => true
     end
 
+    # Pulbic - Will check that the request passed is a valid signature.
+    # 
+    # request - the signature to be checked
+    #
+    # Returns - an error if the signatures don't match
     private
     def verify_signature(request)
       request.body.rewind

data/app/controllers/hubstats/pull_requests_controller.rb

@@ -3,6 +3,11 @@ require_dependency "hubstats/application_controller"
 module Hubstats
   class PullRequestsController < Hubstats::BaseController
 
+    # Public - Will correctly add the labels to the side of the page based on which PRs are showing, and will
+    # come up with the list of PRs to show, based on users, repos, grouping, labels, and order. Only shows
+    # PRs within @start_date and @end_date.
+    #
+    # Returns - the pull request data
     def index
       URI.decode(params[:label]) if params[:label]
 
@@ -18,13 +23,16 @@ module Hubstats
       grouping(params[:group], @pull_requests)
     end 
 
+    # Public - Will show the particular pull request selected, including all of the basic stats, deploy (only if 
+    # PR is closed), and comments associated with that PR within the @start_date and @end_date.
+    #
+    # Returns - the specific details of the pull request
     def show
       @repo = Hubstats::Repo.where(name: params[:repo]).first
       @pull_request = Hubstats::PullRequest.belonging_to_repo(@repo.id).where(id: params[:id]).first
       @comments = Hubstats::Comment.belonging_to_pull_request(params[:id]).created_in_date_range(@start_date, @end_date).limit(20)
       comment_count = Hubstats::Comment.belonging_to_pull_request(params[:id]).created_in_date_range(@start_date, @end_date).count(:all)
       @deploys = Hubstats::Deploy.where(id: @pull_request.deploy_id).order("deployed_at DESC")
-
       @stats_basics = {
         comment_count: comment_count,
         net_additions: @pull_request.additions.to_i - @pull_request.deletions.to_i,

data/app/controllers/hubstats/repos_controller.rb

@@ -1,8 +1,12 @@
 require_dependency "hubstats/application_controller"
 
 module Hubstats
-  class ReposController < ApplicationController
+  class ReposController < Hubstats::BaseController
 
+    # Public - Lists all of the repos, either in alphabetical order, by query params, or with activity in between
+    # @start_date and @end_date.
+    #
+    # Returns - the repository data
     def index
       if params[:query] ## For select 2
         @repos = Hubstats::Repo.where("name LIKE ?", "%#{params[:query]}%").order("name ASC")
@@ -17,6 +21,10 @@ module Hubstats
       end
     end
 
+    # Public - Shows the selected repository and all of the basic stats associated with that repository, including
+    # all deploys and merged PRs in that repo within @start_date and @end_date.
+    #
+    # Returns - the specific repository data
     def show
       @repo = Hubstats::Repo.where(name: params[:repo]).first
       @pull_requests = Hubstats::PullRequest.belonging_to_repo(@repo.id).merged_in_date_range(@start_date, @end_date).order("updated_at DESC").limit(20)
@@ -24,7 +32,7 @@ module Hubstats
       @deploys = Hubstats::Deploy.belonging_to_repo(@repo.id).deployed_in_date_range(@start_date, @end_date).order("deployed_at DESC").limit(20)
       @deploy_count = Hubstats::Deploy.belonging_to_repo(@repo.id).deployed_in_date_range(@start_date, @end_date).count(:all)
       @comment_count = Hubstats::Comment.belonging_to_repo(@repo.id).created_in_date_range(@start_date, @end_date).count(:all)
-      @user_count = Hubstats::User.with_pulls_or_comments(@start_date, @end_date, @repo.id).only_active.length
+      @user_count = Hubstats::User.with_pulls_or_comments_or_deploys(@start_date, @end_date, @repo.id).only_active.length
       @net_additions = Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_repo(@repo.id).sum(:additions).to_i -
                        Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_repo(@repo.id).sum(:deletions).to_i
       @additions = Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_repo(@repo.id).average(:additions)
@@ -33,6 +41,10 @@ module Hubstats
       stats
     end
 
+    # Public - Shows all of the repositories with individual stats for each repo. Also shows the stats for all of
+    # the repositories within @start_date and @end_date.
+    #
+    # Returns - the stats for the entirety of Hubstats and all repos
     def dashboard
       if params[:query] ## For select 2
         @repos = Hubstats::Repo.where("name LIKE ?", "%#{params[:query]}%").order("name ASC")
@@ -45,7 +57,7 @@ module Hubstats
           .paginate(:page => params[:page], :per_page => 15)
       end
 
-      @user_count = Hubstats::User.with_pulls_or_comments(@start_date, @end_date).only_active.length
+      @user_count = Hubstats::User.with_pulls_or_comments_or_deploys(@start_date, @end_date).only_active.length
       @deploy_count = Hubstats::Deploy.deployed_in_date_range(@start_date, @end_date).count(:all)
       @pull_count = Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).count(:all)
       @comment_count = Hubstats::Comment.created_in_date_range(@start_date, @end_date).count(:all)
@@ -62,6 +74,8 @@ module Hubstats
       end
     end
 
+    # stats
+    # Will assign all of the stats for both the show page and the dashboard page.
     def stats
       @additions ||= 0
       @deletions ||= 0

data/app/controllers/hubstats/users_controller.rb

@@ -3,11 +3,20 @@ require_dependency "hubstats/application_controller"
 module Hubstats
   class UsersController < ApplicationController
 
+    # Public - Shows all of the users in either alphabetical order, by filter params, or that have done things in
+    # github between the selected @start_date and @end_date.
+    #
+    # Returns - the user data
     def index 
       if params[:query] ## For select 2
         @users = Hubstats::User.where("login LIKE ?", "%#{params[:query]}%").order("login ASC")
       elsif params[:id]
         @users = Hubstats::User.where(id: params[:id].split(",")).order("login ASC")
+      elsif params[:repos]
+        @users = Hubstats::User.only_active.with_contributions(@start_date, @end_date, params[:repos])
+            .with_id(params[:users])
+            .custom_order(params[:order])
+            .paginate(:page => params[:page], :per_page => 15)
       else
         @users = Hubstats::User.only_active.with_all_metrics(@start_date, @end_date)
             .with_id(params[:users])
@@ -21,6 +30,10 @@ module Hubstats
       end
     end
 
+    # Public - Will show the specific user along with the basic stats about that user, including all deploys
+    # and merged PRs they've done within the @start_date and @end_date.
+    #
+    # Returns - the data of the specific user
     def show
       @user = Hubstats::User.where(login: params[:id]).first
       @pull_requests = Hubstats::PullRequest.belonging_to_user(@user.id).merged_in_date_range(@start_date, @end_date).order("updated_at DESC").limit(20)
@@ -36,6 +49,8 @@ module Hubstats
       stats
     end
 
+    # stats
+    # Shows the basic stats for both the user show page.
     def stats
       @additions ||= 0
       @deletions ||= 0

data/app/models/hubstats/comment.rb

@@ -1,5 +1,15 @@
 module Hubstats
   class Comment < ActiveRecord::Base
+
+    # Various checks that can be used to filter and find info about comments.
+    scope :created_in_date_range, lambda {|start_date, end_date| where("hubstats_comments.created_at BETWEEN ? AND ?", start_date, end_date)}
+    scope :belonging_to_pull_request, lambda {|pull_request_id| where(pull_request_id: pull_request_id)}
+    scope :belonging_to_user, lambda {|user_id| where(user_id: user_id)}
+    scope :belonging_to_repo, lambda {|repo_id| where(repo_id: repo_id)}
+
+    # Public - Gets the number of PRs that a user commented on that were not their own PR.
+    #
+    # Returns - the number of PRs that a specific user has reviewed
     scope :pull_reviews_count, lambda {
       select("hubstats_comments.user_id")
       .select("COUNT(DISTINCT hubstats_pull_requests.id) as total")
@@ -8,11 +18,6 @@ module Hubstats
       .group("hubstats_comments.user_id")
     }
 
-    scope :created_in_date_range, lambda {|start_date, end_date| where("hubstats_comments.created_at BETWEEN ? AND ?", start_date, end_date)}
-    scope :belonging_to_pull_request, lambda {|pull_request_id| where(pull_request_id: pull_request_id)}
-    scope :belonging_to_user, lambda {|user_id| where(user_id: user_id)}
-    scope :belonging_to_repo, lambda {|repo_id| where(repo_id: repo_id)}
-
     attr_accessible :id, :html_url, :url, :pull_request_url, :diff_hunk, :path,
       :position, :original_position, :line, :commit_id, :original_commit_id,
       :body, :created_at, :updated_at, :user_id, :pull_request_id, :repo_id,
@@ -22,6 +27,9 @@ module Hubstats
     belongs_to :pull_request
     belongs_to :repo
    
+    # Public - Makes a new comment based on a GitHub webhook occurrence. Assigns the user and the PR.
+    #
+    # github_comment - the information from Github about the comment
     def self.create_or_update(github_comment)
       github_comment = github_comment.to_h.with_indifferent_access if github_comment.respond_to? :to_h
 

data/app/models/hubstats/deploy.rb

@@ -4,10 +4,14 @@ module Hubstats
     before_validation :check_time, on: :create
     validates :git_revision, :deployed_at, :repo_id, presence: true
 
+    # Public - Checks if there is a deployed_at for a new deploy; if there isn't, then assign it the current time.
+    #
+    # Returns - the current time or the actual deployed_at time
     def check_time
         self.deployed_at = Time.now.getutc if deployed_at.nil?
     end
 
+    # Various checks that can be used to filter, sort, and find info about deploys.
     scope :deployed_in_date_range, lambda {|start_date, end_date| where("hubstats_deploys.deployed_at BETWEEN ? AND ?", start_date, end_date)}
     scope :group, lambda {|group| group_by(:repo_id) if group }
     scope :belonging_to_repo, lambda {|repo_id| where(repo_id: repo_id)}
@@ -23,13 +27,23 @@ module Hubstats
     belongs_to :repo
     has_many :pull_requests
 
-    # Order the data in a given date range in a given order
+    # Public - Orders the deploys within the start_date and end_date with by a given order.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # order - the designated order to sort the data 
+    #
+    # Returns - the deploy data ordered
     def self.order_with_date_range(start_date, end_date, order)
       order = ["ASC", "DESC"].detect{|order_type| order_type.to_s == order.to_s.upcase } || "DESC"
       deployed_in_date_range(start_date, end_date).order("hubstats_deploys.deployed_at #{order}")
     end
 
-    # Sorts based on whether data is being grouped by user or repo
+    # Public - Groups the deploys based on the string passed in: 'user' or 'repo'.
+    # 
+    # group - string that is the designated grouping
+    #
+    # Returns - the data grouped
     def self.group_by(group)
        if group == "user"
          with_user_name.order("user_name ASC")
@@ -40,7 +54,12 @@ module Hubstats
        end
     end
 
-    # finds the total number of additions or deletions for all pull requests in this deploy
+    # Public - Gathers all PRs for a deploy, and then either finds all of the additions or all of the 
+    # deletions, depending on the symbol passed in.
+    #
+    # add - symbol that reflects the type of data we want to add up
+    #
+    # Returns - the total amount that has been added; either deletions or additions 
     def total_changes(add)
       pull_requests = self.pull_requests
       total = 0
@@ -54,7 +73,10 @@ module Hubstats
       return total
     end
 
-    # finds all of the additions and deletions in all pull requests and then makes the net additions
+    # Public - Gathers all PRs for a deploy, and then finds all of the additions and all of the deletions,
+    # then subtracts them to find the number of net additions.
+    #
+    # Returns - the total number of deletions subtracted from the total number of additions
     def find_net_additions
       pull_requests = self.pull_requests
       total_additions = 0
@@ -66,7 +88,9 @@ module Hubstats
       return total_additions - total_deletions
     end
 
-    # returns the total amount of comments from all pull requests in a deploy
+    # Public - Gathers all of the PRs and then counts all of the comments that are assigned to each PR.
+    #
+    # Returns - the total amount of comments that all PRs to a deploy has
     def find_comment_count
       pull_requests = self.pull_requests
       total_comments = 0
@@ -75,6 +99,5 @@ module Hubstats
       end
       return total_comments
     end
-
   end
 end

data/app/models/hubstats/label.rb

@@ -1,6 +1,16 @@
 module Hubstats
   class Label < ActiveRecord::Base
 
+    # Various checks that can be used to filter and find info about labels.
+    scope :with_ids, lambda {|pull_ids| (where("hubstats_labels_pull_requests.pull_request_id" => pull_ids))}
+    scope :with_state, lambda {|state| (where(state: state) unless state == 'all') if state}
+
+    # Public - Counts all of the labels that are assigned to one of the PRs that is passed in. This is then 
+    # merged with the list of PRs. It also shows a count of the number of PRs with each specific label.
+    #
+    # pull_requests - the PRs that are shown on the given index page
+    #
+    # Returns - the labels data
     def self.count_by_pull_requests(pull_requests)
       select("hubstats_labels.*")
        .select("COUNT(hubstats_labels_pull_requests.pull_request_id) AS pull_request_count")
@@ -10,14 +20,16 @@ module Hubstats
        .order("pull_request_count DESC")
     end
 
-    scope :with_ids, lambda {|pull_ids| (where("hubstats_labels_pull_requests.pull_request_id" => pull_ids))}
-
-    scope :with_state, lambda {|state| (where(state: state) unless state == 'all') if state}
-
     attr_accessible :url, :name, :color
 
     has_and_belongs_to_many :pull_requests, :join_table => 'hubstats_labels_pull_requests'
 
+    # Public - Checks if the label is currently existing, and if it isn't, then makes a new label with 
+    # the specifications that are passed in.
+    #
+    # label - the info that's passed in about the new label
+    #
+    # Returns - the label 
     def self.first_or_create(label)
       if exists = Hubstats::Label.where(name: label[:name]).first
         return exists