Class GitReview::Local
In: lib/git-review/local.rb
Parent: Object

The local repository is where the git-review command is being called by default. It is (supposedly) able to handle systems other than Github. TODO: remove Github-dependency

Methods

all_branches   branch_exists?   clean_all   clean_remotes   clean_single   config_list   create_title_and_body   delete_branch   delete_local_branch   delete_remote_branch   edit_title_and_body   head   instance   load_config   merged?   new   new_commits?   on_feature_branch?   protected_branches   prune_remotes   remote_exists?   remote_for_branch   remote_for_request   remotes   remotes_for_branches   remotes_for_url   remotes_with_urls   review_branches   sanitize_branch_name   server   source   source_branch   source_repo   target   target_branch   target_repo   uncommitted_changes?   unmerged_commits?  

Included Modules

::GitReview::Helpers

Attributes

config  [RW] 

Public Class methods

instance()

acts like a singleton class but it‘s actually not use ::GitReview::Local.instance everywhere except in tests

Public Instance methods

all_branches()

@return [Array<String>] all existing branches

branch_exists?(location, branch_name)

@param location [Symbol] location of the branch, `:remote` or `:local` @param branch_name [String] name of the branch @return [Boolean] whether a branch exists in a specified location

clean_all()

clean all obsolete branches

clean_remotes()

Remove obsolete remotes with review prefix.

clean_single(number, force = false)

clean a single request‘s obsolete branch

create_title_and_body(target_branch)

@return [Array(String, String)] the title and the body of pull request

delete_branch(branch_name)

delete local and remote branches that match a given name @param branch_name [String] name of the branch to delete

delete_local_branch(branch_name)

delete local branch if it exists. @param (see delete_branch)

delete_remote_branch(branch_name)

delete remote branch if it exists. @param (see delete_branch)

head()

@return [String] the head string used for pull requests

merged?(sha)

@return [Boolean] whether a specified commit has already been merged.

new_commits?(upstream = false)

@return [Boolean] whether there are commits not in target branch yet

on_feature_branch?()

@return [Boolean] whether already on a feature branch

protected_branches()

@return [Array<String>] all open requests’ branches shouldn‘t be deleted

prune_remotes()

Prune all configured remotes.

remote_exists?(name)

Determine whether a remote with a given name exists?

remote_for_branch(branch_name)

Finds the correct remote for a given branch name.

remote_for_request(request)

Find or create the correct remote for a fork with a given owner name.

remotes()

List all available remotes.

remotes_for_branches()

Find all remotes which are currently referenced by local branches.

remotes_for_url(remote_url)

Collect all remotes for a given url.

remotes_with_urls()

Create a Hash with all remotes as keys and their urls as values.

review_branches()

@return [Array<String>] all review branches with ‘review_’ prefix

sanitize_branch_name(name)

Remove all non word characters and turn them into underscores.

source()

@return [String] combine source repo and branch

source_branch()

@return [String] the current source branch

source_repo()

@return [String] the source repo

target()

@return [String] combine target repo and branch

target_branch()

@return [String] the name of the target branch

target_repo(upstream=false)

if to send a pull request to upstream repo, get the parent as target @return [String] the name of the target repo

uncommitted_changes?()

@return [Boolean] whether there are local changes not committed

unmerged_commits?(branch_name, verbose=true)

@param branch_name [String] name of the branch @param verbose [Boolean] if verbose output @return [Boolean] whether there are unmerged commits on the local or 

  remote branch.

[Validate]