NAME

Git::Code::Review::Utilities - Tools for performing code review using Git as the backend

VERSION

version 0.1

FUNCTIONS

gcr_dir()

Returns the audit directory

gcr_config()

Returns a copy of our configuration as a hash or hash ref.

gcr_is_initialized()

gcr_repo()

Returns the Git::Repository object for audit or source repos

gcr_mkdir(@path)

Takes a directory path as a list and creates the path inside the audit directory.

gcr_origin($type)

Lookup the remote 'origin' for 'audit' or 'source'

gcr_reset()

Reset the audit directory to origin:master, stash weirdness. Most operations call this first.

gcr_push()

Push any modifications upstream.

gcr_commit_info($sha1 | $partial_sha1 | $path)

Retrieves all relevant Git::Code::Review details on the commit that mataches the string passed in.

gcr_open_editor( mode => file )

    Mode can be: readonly, comment

    File is the file to be opened

gcr_view_commit($commit_info)

View the contents of the commit in the $commit_info, stores time spent in editor as review_time in the hash.

gcr_change_state($commit_info,$state,$details)

$commit_info is a hash attained from gcr_commit_info() $state is a string representing the state $details can be either a string, the commit message, or a hash reference including a 'message' item to become the commit message. The rest of the keys will be added to the YAML generated.

gcr_commit_message($commit_info,\%details)

Creates the YAML commit message. If $details{message} exists it will be used as the YAML header text/comment.

gcr_not_resigned($commit)

Returns true unless the author resigned from the commit.

gcr_not_authored($path)

Returns true unless the reviewer authored the commit.

gcr_state_color($state)

Make coloring consistent in this function.

_get_review_path($path)

Figure out the review path from a file path.

_get_commit_date($path)

Figure out the commit date.

_get_author($path)

Figure out the commit author.

_get_sha1($path)

Extract the SHA1 from the file path

_get_state($path)

Figure out the state from the current path.

AUTHOR

Brad Lhotsky <brad@divisionbyzero.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2014 by Brad Lhotsky.

This is free software, licensed under:

  The (three-clause) BSD License

cpanm Git::Code::Review

perl -MCPAN -e shell
install Git::Code::Review