hubstats 0.3.17 → 0.4.1

data/app/models/hubstats/pull_request.rb

@@ -1,5 +1,7 @@
 module Hubstats
   class PullRequest < ActiveRecord::Base
+    
+    # Various checks that can be used to filter, sort, and find info about pull requests.
     scope :closed_in_date_range, lambda {|start_date, end_date| where("hubstats_pull_requests.closed_at BETWEEN ? AND ?", start_date, end_date)}
     scope :updated_in_date_range, lambda {|start_date, end_date| where("hubstats_pull_requests.updated_at BETWEEN ? AND ?", start_date, end_date)}
     scope :created_in_date_range, lambda {|start_date, end_date| where("hubstats_pull_requests.created_at BETWEEN ? AND ?", start_date, end_date)}
@@ -16,7 +18,7 @@ module Hubstats
     scope :with_repo_name, select('DISTINCT hubstats_repos.name as repo_name, hubstats_pull_requests.*').joins("LEFT JOIN hubstats_repos ON hubstats_repos.id = hubstats_pull_requests.repo_id")
     scope :with_user_name, select('DISTINCT hubstats_users.login as user_name, hubstats_pull_requests.*').joins("LEFT JOIN hubstats_users ON hubstats_users.id = hubstats_pull_requests.user_id")
 
-     attr_accessible :id, :url, :html_url, :diff_url, :patch_url, :issue_url, :commits_url,
+    attr_accessible :id, :url, :html_url, :diff_url, :patch_url, :issue_url, :commits_url,
       :review_comments_url, :review_comment_url, :comments_url, :statuses_url, :number,
       :state, :title, :body, :created_at, :updated_at, :closed_at, :merged_at, 
       :merge_commit_sha, :merged, :mergeable, :comments, :commits, :additions,
@@ -27,6 +29,12 @@ module Hubstats
     belongs_to :deploy
     has_and_belongs_to_many :labels, :join_table => "hubstats_labels_pull_requests"
 
+    # Public - Makes a new pull request from a GitHub webhook. Finds user_id and repo_id based on users and repos 
+    # that are already in the Hubstats database. Also updates the user_id of a deploy if the pull request has been merged in a deploy.
+    #
+    # github_pull - the info that is from Github about the new or updated pull request
+    #
+    # Returns - the pull request 
     def self.create_or_update(github_pull)
       github_pull = github_pull.to_h.with_indifferent_access if github_pull.respond_to? :to_h
 
@@ -41,7 +49,6 @@ module Hubstats
 
       pull = where(:id => pull_data[:id]).first_or_create(pull_data)
 
-      # Updates the merged_by part of the pull request and the user_id of the deploy
       if github_pull[:merged_by] && github_pull[:merged_by][:id]
         pull_data[:merged_by] = github_pull[:merged_by][:id]
         deploy = Hubstats::Deploy.where(id: pull.deploy_id, user_id: nil).first
@@ -55,21 +62,51 @@ module Hubstats
       Rails.logger.warn pull.errors.inspect
     end
 
+    # Public - Adds any labels to the labels database if the labels passed in aren't already there.
+    #
+    # labels - the labels to be added to the db
+    #
+    # Returns - the new labels
     def add_labels(labels)
       labels.map!{|label| Hubstats::Label.first_or_create(label) }
       self.labels = labels
     end
 
+    # Public - Filters all of the pull requests between start_date and end_date that are the given state
+    # (passed as part of params) that belong to the params' users and repos.
+    #
+    # params - the params that are passed in (likely from the URL)
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    #
+    # Returns - the PRs that fit all of the below sql queries
     def self.all_filtered(params, start_date, end_date)
       filter_based_on_date_range(start_date, end_date, params[:state])
        .belonging_to_users(params[:users])
        .belonging_to_repos(params[:repos])
     end
 
+    # Public - Finds all of the PRs with the current state, and then filters to ones that have been updated in
+    # between the start_date and end_date.
+    #
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # state - the current state (open, closed, or all) of the PRs
+    #
+    # Returns - the PRs that are within the date range and that are the state
     def self.filter_based_on_date_range(start_date, end_date, state)
       with_state(state).updated_in_date_range(start_date, end_date)
     end
 
+    # Public - Finds all of the PRs that have the current state, then filters to PRs that were updated within the
+    # start_date and end_date. Lastly, it orders all of them based on the given order.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # state - the current state (open, closed, or all) of the PRs
+    # order - the order (descending or ascending) that the PRs should be ordered in
+    #
+    # Returns - the PRs that are within the date range and that are the state ordered 
     def self.state_based_order(start_date, end_date, state, order)
       order = ["ASC","DESC"].detect{|order_type| order_type.to_s == order.to_s.upcase } || "DESC"
       if state == "closed"
@@ -79,6 +116,11 @@ module Hubstats
       end
     end
 
+    # Public - Groups the PRs by either username or repo name, based on the string passed in.
+    #
+    # 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")

data/app/models/hubstats/repo.rb

@@ -1,9 +1,16 @@
 module Hubstats
   class Repo < ActiveRecord::Base
 
+    # Various checks that can be used to filter and find info about repos.
     scope :with_recent_activity, lambda {|start_date, end_date| where("hubstats_repos.updated_at BETWEEN ? AND ?", start_date, end_date).order("updated_at DESC")}
     scope :with_id, lambda {|repo_id| where(id: repo_id.split(',')) if repo_id}
 
+    # Public - Counts all of the deploys for selected repo that occurred between the start_date and end_date.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of deploys
     scope :deploys_count, lambda {|start_date, end_date|
       select("hubstats_repos.id as repo_id")
        .select("IFNULL(COUNT(DISTINCT hubstats_deploys.id),0) AS deploy_count")
@@ -11,6 +18,12 @@ module Hubstats
        .group("hubstats_repos.id")
     }
 
+    # Public - Counts all of the comments for selected repo that occurred between the start_date and end_date.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of comments
     scope :comments_count, lambda {|start_date, end_date|
       select("hubstats_repos.id as repo_id")
        .select("IFNULL(COUNT(DISTINCT hubstats_comments.id),0) AS comment_count")
@@ -18,15 +31,26 @@ module Hubstats
        .group("hubstats_repos.id")
     }
  
+    # Public - Counts all of the merged pull requests for selected repo that occurred between the start_date and end_date.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of pull requests
     scope :pull_requests_count, lambda {|start_date, end_date|
       select("hubstats_repos.id as repo_id")
       .select("IFNULL(COUNT(DISTINCT hubstats_pull_requests.id),0) AS pull_request_count")
-      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.repo_id = hubstats_repos.id AND (hubstats_pull_requests.merged_at BETWEEN ? AND ?)", start_date, end_date]))
-      .where("hubstats_pull_requests.merged = '1'")
+      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.repo_id = hubstats_repos.id AND (hubstats_pull_requests.merged_at BETWEEN ? AND ?) AND hubstats_pull_requests.merged = '1'", start_date, end_date]))
       .group("hubstats_repos.id")
     }
 
-    scope :averages, lambda {|start_date, end_date|
+    # Public - Averages all of the additions and deletions of the merged PRs for selected repo.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - the average additions and deletions
+    scope :averages, lambda {
       select("hubstats_repos.id as repo_id")
       .select("ROUND(IFNULL(AVG(hubstats_pull_requests.additions),0)) AS average_additions")
       .select("ROUND(IFNULL(AVG(hubstats_pull_requests.deletions),0)) AS average_deletions")
@@ -34,9 +58,15 @@ module Hubstats
       .group("hubstats_repos.id")
     }
 
+    # Public - Joins all of the metrics together for selected repository: average additions and deletions, comments, pull requests, and deploys.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - all of the stats about the repo
     scope :with_all_metrics, lambda {|start_date, end_date|
       select("hubstats_repos.*, deploy_count, pull_request_count, comment_count, average_additions, average_deletions")
-      .joins("LEFT JOIN (#{averages(start_date, end_date).to_sql}) AS averages ON averages.repo_id = hubstats_repos.id")
+      .joins("LEFT JOIN (#{averages.to_sql}) AS averages ON averages.repo_id = hubstats_repos.id")
       .joins("LEFT JOIN (#{pull_requests_count(start_date, end_date).to_sql}) AS pull_requests ON pull_requests.repo_id = hubstats_repos.id")
       .joins("LEFT JOIN (#{comments_count(start_date, end_date).to_sql}) AS comments ON comments.repo_id = hubstats_repos.id")
       .joins("LEFT JOIN (#{deploys_count(start_date, end_date).to_sql}) AS deploys ON deploys.repo_id = hubstats_repos.id")
@@ -56,6 +86,11 @@ module Hubstats
     has_many :comments
     belongs_to :owner, :class_name => "User", :foreign_key => "id"
 
+    # Public - Makes a new repository based on a GitHub webhook. Sets a user (owner) based on users that are already in the database.
+    #
+    # github_repo - the info about the new or updated repository
+    #
+    # Returns - the repository
     def self.create_or_update(github_repo)
       github_repo = github_repo.to_h.with_indifferent_access if github_repo.respond_to? :to_h
       repo_data = github_repo.slice(*column_names.map(&:to_sym))
@@ -70,6 +105,12 @@ module Hubstats
       Rails.logger.warn repo.errors.inspect
     end
 
+    # Public - Designed so that the list of repositories can be ordered based on deploys, pulls, comments, additions, deletions, or name.
+    # if none of these are selected, then the default is to order by pull request count in descending order.
+    #
+    # order_params - the param of what the repos should be sorted by
+    #
+    # Returns - the repo data ordered
     def self.custom_order(order_params)
       if order_params
         order = order_params.include?('asc') ? "ASC" : "DESC"
@@ -94,6 +135,9 @@ module Hubstats
       end
     end
     
+    # Public - Designed to make a path for the show page when a repository is selected.
+    #
+    # Returns - the show page of self.name
     def to_param
       self.name
     end

data/app/models/hubstats/user.rb

@@ -1,8 +1,17 @@
 module Hubstats
   class User < ActiveRecord::Base
 
+    # Various checks that can be used to filter and find info about users.
     scope :with_id, lambda {|user_id| where(id: user_id.split(',')) if user_id}
-
+    scope :only_active, having("comment_count > 0 OR pull_request_count > 0 OR deploy_count > 0")
+    scope :with_contributions, lambda {|start_date, end_date, repo_id| with_all_metrics_repos(start_date, end_date, repo_id) if repo_id}
+
+    # Public - Counts all of the deploys for selected user that occurred between the start_date and end_date.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of deploys
     scope :deploys_count, lambda {|start_date, end_date|
       select("hubstats_users.id as user_id")
        .select("IFNULL(COUNT(DISTINCT hubstats_deploys.id),0) AS deploy_count")
@@ -10,6 +19,12 @@ module Hubstats
        .group("hubstats_users.id")
     }
 
+    # Public - Counts all of the comments for selected user that occurred between the start_date and end_date.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of comments
     scope :comments_count, lambda {|start_date, end_date|
       select("hubstats_users.id as user_id")
        .select("IFNULL(COUNT(DISTINCT hubstats_comments.id),0) AS comment_count")
@@ -17,39 +32,94 @@ module Hubstats
        .group("hubstats_users.id")
     }
  
+    # Public - Counts all of the merged pull requests for selected user that occurred between the start_date and end_date.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of pull requests
     scope :pull_requests_count, lambda {|start_date, end_date|
       select("hubstats_users.id as user_id")
       .select("IFNULL(COUNT(DISTINCT hubstats_pull_requests.id),0) AS pull_request_count")
-      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.user_id = hubstats_users.id AND (hubstats_pull_requests.merged_at BETWEEN ? AND ?)", start_date, end_date]))
-      .where("hubstats_pull_requests.merged = '1'")
+      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.user_id = hubstats_users.id AND (hubstats_pull_requests.merged_at BETWEEN ? AND ?) AND hubstats_pull_requests.merged = '1'", start_date, end_date]))
       .group("hubstats_users.id")
     }
 
-    scope :pull_requests_count_by_repo, lambda {|start_date, end_date, repo_id|
-      select("hubstats_users.id as user_id")
-      .select("IFNULL(COUNT(DISTINCT hubstats_pull_requests.id),0) AS pull_request_count")
-      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.user_id = hubstats_users.id AND (hubstats_pull_requests.created_at BETWEEN ? AND ?)", start_date, end_date]))
-      .where("hubstats_pull_requests.repo_id = ? AND hubstats_pull_requests.merged = '1'", repo_id)
+    # Public - Counts all of the merged pull requests, deploys, and comments that occurred between the start_date and end_date that belong to a user.
+    #
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    #
+    # Returns - the count of deploys, pull requests, and comments
+    scope :pull_comment_deploy_count, lambda {|start_date, end_date|
+      select("hubstats_users.*, pull_request_count, comment_count, deploy_count")
+      .joins("LEFT JOIN (#{pull_requests_count(start_date, end_date).to_sql}) AS pull_requests ON pull_requests.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{comments_count(start_date, end_date).to_sql}) AS comments ON comments.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{deploys_count(start_date, end_date).to_sql}) AS deploys ON deploys.user_id = hubstats_users.id")
       .group("hubstats_users.id")
     }
 
+    # Public - Counts all of the deploys for selected user that occurred between the start_date and end_date and belong to the repos.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of deploys
+    scope :deploys_count_by_repo, lambda {|start_date, end_date, repo_id|
+      select("hubstats_users.id as user_id")
+       .select("IFNULL(COUNT(DISTINCT hubstats_deploys.id),0) AS deploy_count")
+       .joins(sanitize_sql_array(["LEFT JOIN hubstats_deploys ON hubstats_deploys.user_id = hubstats_users.id AND (hubstats_deploys.deployed_at BETWEEN ? AND ?) AND (hubstats_deploys.repo_id LIKE ?)", start_date, end_date, repo_id]))
+       .group("hubstats_users.id")
+    }
+
+    # Public - Counts all of the comments for selected user that occurred between the start_date and end_date and belong to the repos.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of comments
     scope :comments_count_by_repo, lambda {|start_date, end_date, repo_id|
       select("hubstats_users.id as user_id")
       .select("COUNT(DISTINCT hubstats_comments.id) AS comment_count")
-      .joins(sanitize_sql_array(["LEFT JOIN hubstats_comments ON hubstats_comments.user_id = hubstats_users.id AND (hubstats_comments.created_at BETWEEN ? AND ?)", start_date, end_date]))
-      .where("hubstats_comments.repo_id = ?", repo_id)
+      .joins(sanitize_sql_array(["LEFT JOIN hubstats_comments ON hubstats_comments.user_id = hubstats_users.id AND (hubstats_comments.created_at BETWEEN ? AND ?) AND (hubstats_comments.repo_id LIKE ?)", start_date, end_date, repo_id]))
       .group("hubstats_users.id")
     }
 
-    scope :pulls_reviewed_count, lambda {|start_date, end_date|
+    # Public - Counts all of the pull requests for selected user that occurred between the start_date and end_date and belong to the repos.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - count of pull requests
+    scope :pull_requests_count_by_repo, lambda {|start_date, end_date, repo_id|
       select("hubstats_users.id as user_id")
-      .select("COUNT(DISTINCT hubstats_pull_requests.id) as reviews_count")
-      .joins(sanitize_sql_array(["LEFT JOIN hubstats_comments ON hubstats_comments.user_id = hubstats_users.id AND (hubstats_comments.created_at BETWEEN ? AND ?)", start_date, end_date]))
-      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.id = hubstats_comments.pull_request_id AND (hubstats_pull_requests.closed_at BETWEEN ? AND ?)", start_date, end_date]))
-      .where("hubstats_pull_requests.user_id != hubstats_users.id")
+      .select("IFNULL(COUNT(DISTINCT hubstats_pull_requests.id),0) AS pull_request_count")
+      .joins(sanitize_sql_array(["LEFT JOIN hubstats_pull_requests ON hubstats_pull_requests.user_id = hubstats_users.id AND (hubstats_pull_requests.merged_at BETWEEN ? AND ?) AND (hubstats_pull_requests.repo_id LIKE ?) AND hubstats_pull_requests.merged = '1'", start_date, end_date, repo_id]))
+      .group("hubstats_users.id")
+    }
+
+    # Public - Counts all of the merged pull requests, deploys, and comments that belong to a repository and belong to a user and occurred between 
+    # the start_date and end_date.
+    #
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    #
+    # Returns - the count of deploys, pull requests, and comments
+    scope :pull_comment_deploy_count_by_repo, lambda {|start_date, end_date, repo_id|
+      select("hubstats_users.*, pull_request_count, comment_count, deploy_count")
+      .joins("LEFT JOIN (#{pull_requests_count_by_repo(start_date, end_date, repo_id).to_sql}) AS pull_requests ON pull_requests.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{comments_count_by_repo(start_date, end_date, repo_id).to_sql}) AS comments ON comments.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{deploys_count_by_repo(start_date, end_date, repo_id).to_sql}) AS deploys ON deploys.user_id = hubstats_users.id")
       .group("hubstats_users.id")
     }
     
+    # Public - Counts all of the addtiions and deletions made from PRs by the selected user that have been merged between the start_date
+    # and the end_date.
+    #
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    #
+    # Returns - the additions and deletions
     scope :net_additions_count, lambda {|start_date, end_date|
       select("hubstats_users.id as user_id")
       .select("SUM(IFNULL(hubstats_pull_requests.additions, 0)) AS additions")
@@ -58,20 +128,28 @@ module Hubstats
       .group("hubstats_users.id")
     }
 
-    scope :pull_and_comment_count, lambda {|start_date, end_date|
-      select("hubstats_users.*, pull_request_count, comment_count")
-      .joins("LEFT JOIN (#{pull_requests_count(start_date, end_date).to_sql}) AS pull_requests ON pull_requests.user_id = hubstats_users.id")
-      .joins("LEFT JOIN (#{comments_count(start_date, end_date).to_sql}) AS comments ON comments.user_id = hubstats_users.id")
-      .group("hubstats_users.id")
-    }
-
-    scope :pull_and_comment_count_by_repo, lambda {|start_date, end_date, repo_id|
-      select("hubstats_users.*, pull_request_count, comment_count")
-      .joins("LEFT JOIN (#{pull_requests_count_by_repo(start_date, end_date, repo_id).to_sql}) AS pull_requests ON pull_requests.user_id = hubstats_users.id")
-      .joins("LEFT JOIN (#{comments_count_by_repo(start_date, end_date, repo_id).to_sql}) AS comments ON comments.user_id = hubstats_users.id")
+    # Public - Joins all of the metrics together for selected repository: average additions and deletions, comments, pull requests, and deploys.
+    # However, will only count those that also have something to do with the repos passed in.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - all of the stats about the user
+    scope :with_all_metrics_repos, lambda {|start_date, end_date, repos|
+      select("hubstats_users.*, deploy_count, pull_request_count, comment_count, additions, deletions")
+      .joins("LEFT JOIN (#{net_additions_count(start_date, end_date).to_sql}) AS net_additions ON net_additions.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{pull_requests_count_by_repo(start_date, end_date, repos).to_sql}) AS pull_requests ON pull_requests.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{comments_count_by_repo(start_date, end_date, repos).to_sql}) AS comments ON comments.user_id = hubstats_users.id")
+      .joins("LEFT JOIN (#{deploys_count_by_repo(start_date, end_date, repos).to_sql}) AS deploys ON deploys.user_id = hubstats_users.id")
       .group("hubstats_users.id")
     }
 
+    # Public - Joins all of the metrics together for selected repository: average additions and deletions, comments, pull requests, and deploys.
+    # 
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # 
+    # Returns - all of the stats about the user
     scope :with_all_metrics, lambda {|start_date, end_date|
       select("hubstats_users.*, deploy_count, pull_request_count, comment_count, additions, deletions")
       .joins("LEFT JOIN (#{net_additions_count(start_date, end_date).to_sql}) AS net_additions ON net_additions.user_id = hubstats_users.id")
@@ -81,9 +159,6 @@ module Hubstats
       .group("hubstats_users.id")
     }
 
-    scope :only_active, having("comment_count > 0 OR pull_request_count > 0")
-    scope :weighted_sort, order("(pull_request_count)*2 + (comment_count) DESC")
-
     attr_accessible :login, :id, :avatar_url, :gravatar_id, :url, :html_url, :followers_url,
       :following_url, :gists_url, :starred_url, :subscriptions_url, :organizations_url,
       :repos_url, :events_url, :received_events_url, :role, :site_admin
@@ -95,6 +170,11 @@ module Hubstats
     has_many :pull_requests
     has_many :deploys
 
+    # Public - Creates a new user form a GitHub webhook.
+    #
+    # github_user - the info from Github about the new or updated user
+    #
+    # Returns - the user 
     def self.create_or_update(github_user)
       github_user[:role] = github_user.delete :type  ##changing :type in to :role
       github_user = github_user.to_h.with_indifferent_access unless github_user.is_a? Hash
@@ -106,14 +186,29 @@ module Hubstats
       Rails.logger.warn user.errors.inspect
     end
 
-    def self.with_pulls_or_comments(start_date, end_date, repo_id = nil)
+    # Public - If a repo_id is provided, will sort/filter the users based on the number of comments, deploys, and pull requests
+    # on that repo within the start_date and end_date. If no repo_id is provided, will still sort, just considering all PRs and comments 
+    # within the two dates.
+    #
+    # start_date - the start of the date range
+    # end_date - the end of the data range
+    # repo_id - the id of the repository (optional)
+    #
+    # Returns - the count of data that fulfills the sql queries 
+    def self.with_pulls_or_comments_or_deploys(start_date, end_date, repo_id = nil)
       if repo_id
-        pull_and_comment_count_by_repo(start_date, end_date, repo_id).weighted_sort
+        pull_comment_deploy_count_by_repo(start_date, end_date, repo_id)
       else
-        pull_and_comment_count(start_date, end_date).weighted_sort
+        pull_comment_deploy_count(start_date, end_date)
       end
     end
 
+    # Public - Designed so that the list of users can be ordered based on deploys, pulls, comments, net additions, or name.
+    # if none of these are selected, then the default is to order by pull request count in descending order.
+    #
+    # order_params - the param of what the users should be sorted by
+    #
+    # Returns - the user data ordered
     def self.custom_order(order_params)
       if order_params
         order = order_params.include?('asc') ? "ASC" : "DESC"
@@ -136,6 +231,9 @@ module Hubstats
       end
     end
 
+    # Public - Designed to make a path for the show page when a repository is selected.
+    #
+    # Returns - the show page of self.name
     def to_param
       self.login
     end