LowEndInsight

View Source GitModule (LowEndInsight v0.8.1)

Collections of functions for interacting with the git command to perform queries.

Link to this section Summary

Functions

clone_repo(url, tmp_path)

clone_repo/2: clones the repo

delete_repo(repo)
get_clean_contributions_map(repo)
get_commit_dates(repo)

get_commit_dates/1: returns a list of unix timestamps representing commit times

get_contributions_map(repo)

get_contributions_map/1: returns a map of contributions per git user note: this map is unfiltered, dupes aren't identified

get_contributor_count(repo)

get_contributors_count/1: returns the number of contributors for a given Git repo

get_contributor_distribution(repo)
get_contributors(repo)
get_default_branch(repo)

get_default_branch/1: returns the default branch of the remote repo

get_diff_2_commits(repo, list)

get_last_n_commits/2: returns a list of lines generated from the diff of two commits

get_functional_contributors(repo)
get_hash(repo)

get_current_hash/1: returns the hash of the repo's HEAD

get_last_2_delta(repo)

get_last_2_delta/1: returns the lines changed, files changed, additions and deletions in the last commit

get_last_commit_date(repo)

get_last_commit_date/1: returns the date of the last commit

get_last_contribution_date_by_contributor(repo, contributor)

get_last_contribution_date_by_contributor/1: returns the date of the last author or commit whichever is more recent.

get_last_n_commits(repo, n)

get_last_n_commits/1: returns a list of the short hashes of the last n commits

get_recent_changes(repo)

get_recent_changes/1: returns the percentage of changed lines in the last commit by the total lines in the repo

get_repo(path)

get_repo/1: gets a repo by path, returns Repository struct

get_repo_size(repo)
get_tag_and_commit_dates(repo)

get_tag_and_commit_dates/1: returns a list of lists of unix timestamps representing commit times with each lsit belonging to a different tag

get_top10_contributors_map(repo) 
get_top10_contributors_map/1: Gets the top 10 contributors and returns it
as a list of contributors with the commits list stripped from the map.
get_total_commit_count(repo)

get_total_commit_count/2: returns the count of commits for a provided branch

get_total_lines(repo)

get_total_lines/1: returns the total lines and files contained in a repo as of the latest commit

Link to this section Functions

Link to this function

clone_repo(url, tmp_path)

View Source 
@spec clone_repo(String.t(), String.t()) :: {:ok, String.t()} | {:error, String.t()}

clone_repo/2: clones the repo

Link to this function

delete_repo(repo)

View Source 
@spec delete_repo(
  atom()
  | %{
      :path =>
        binary()
        | maybe_improper_list(
            binary() | maybe_improper_list(any(), binary() | []) | char(),
            binary() | []
          ),
      optional(any()) => any()
    }
) :: [binary()]
Link to this function

get_clean_contributions_map(repo)

View Source 
@spec get_clean_contributions_map(Git.Repository.t()) :: {:ok, list()}
Link to this function

get_commit_dates(repo)

View Source 
@spec get_commit_dates(Git.Repository.t()) :: {:ok, [non_neg_integer()]}

get_commit_dates/1: returns a list of unix timestamps representing commit times

Link to this function

get_contributions_map(repo)

View Source 
@spec get_contributions_map(Git.Repository.t()) ::
  {:ok, [%{contributions: non_neg_integer(), name: String.t()}]}

get_contributions_map/1: returns a map of contributions per git user note: this map is unfiltered, dupes aren't identified

Link to this function

get_contributor_count(repo)

View Source 
@spec get_contributor_count(Git.Repository.t()) :: {:ok, non_neg_integer()}

get_contributors_count/1: returns the number of contributors for a given Git repo

Link to this function

get_contributor_distribution(repo)

View Source 
@spec get_contributor_distribution(Git.Repository.t()) ::
  {:ok, map(), non_neg_integer()}
Link to this function

get_contributors(repo)

View Source 
@spec get_contributors(Git.Repository.t()) :: {:ok, [Contributor.t()]}
Link to this function

get_default_branch(repo)

View Source 
@spec get_default_branch(Git.Repository.t()) :: {:ok, String.t()}

get_default_branch/1: returns the default branch of the remote repo

Link to this function

get_diff_2_commits(repo, list)

View Source 
@spec get_diff_2_commits(Git.Repository.t(), [any()]) :: {:ok, [String.t()]} | []

get_last_n_commits/2: returns a list of lines generated from the diff of two commits

Link to this function

get_functional_contributors(repo)

View Source 
@spec get_functional_contributors(Git.Repository.t()) ::
  {:ok, non_neg_integer(), [any()]}
Link to this function

get_hash(repo)

View Source 
@spec get_hash(Git.Repository.t()) :: {:ok, String.t()}

get_current_hash/1: returns the hash of the repo's HEAD

Link to this function

get_last_2_delta(repo)

View Source 
@spec get_last_2_delta(Git.Repository.t()) ::
  {:ok, non_neg_integer(), non_neg_integer(), non_neg_integer()}

get_last_2_delta/1: returns the lines changed, files changed, additions and deletions in the last commit

Link to this function

get_last_commit_date(repo)

View Source 
@spec get_last_commit_date(Git.Repository.t()) :: {:ok, String.t()}

get_last_commit_date/1: returns the date of the last commit

Link to this function

get_last_contribution_date_by_contributor(repo, contributor)

View Source

get_last_contribution_date_by_contributor/1: returns the date of the last author or commit whichever is more recent.

Link to this function

get_last_n_commits(repo, n)

View Source 
@spec get_last_n_commits(Git.Repository.t(), non_neg_integer()) :: {:ok, [any()]}

get_last_n_commits/1: returns a list of the short hashes of the last n commits

Link to this function

get_recent_changes(repo)

View Source 
@spec get_recent_changes(Git.Repository.t()) :: {:ok, number(), number()}

get_recent_changes/1: returns the percentage of changed lines in the last commit by the total lines in the repo

Link to this function

get_repo(path)

View Source 
@spec get_repo(String.t()) :: {:ok, Git.Repository.t()} | {:error, String.t()}

get_repo/1: gets a repo by path, returns Repository struct

Link to this function

get_repo_size(repo)

View Source 
@spec get_repo_size(Git.Repository.t()) :: {:ok, String.t()}
Link to this function

get_tag_and_commit_dates(repo)

View Source 
@spec get_tag_and_commit_dates(Git.Repository.t()) :: {:ok, [[...]]}

get_tag_and_commit_dates/1: returns a list of lists of unix timestamps representing commit times with each lsit belonging to a different tag

Link to this function

get_top10_contributors_map(repo)

View Source 
@spec get_top10_contributors_map(Git.Repository.t()) :: {:ok, [any()]}
get_top10_contributors_map/1: Gets the top 10 contributors and returns it
as a list of contributors with the commits list stripped from the map.
Link to this function

get_total_commit_count(repo)

View Source

get_total_commit_count/2: returns the count of commits for a provided branch

Link to this function

get_total_lines(repo)

View Source 
@spec get_total_lines(Git.Repository.t()) ::
  {:ok, non_neg_integer(), non_neg_integer()}

get_total_lines/1: returns the total lines and files contained in a repo as of the latest commit