githug: Interface to local and remote Git operations

git-survival.R

jenny Wed Jan 27 14:04:50 2016

library(githug)
suppressPackageStartupMessages(library(dplyr))

git config

see git config currently in effect, based on working directory

git_config()         # local > global, same as git_config(where = "de_facto")

## {
##   "core.excludesfile": "/Users/jenny/.gitignore_global",
##   "credential.helper": "osxkeychain",
##   "difftool.sourcetree.cmd": "opendiff \"$LOCAL\" \"$REMOTE\"",
##   "difftool.sourcetree.path": "",
##   "mergetool.sourcetree.cmd": "/Applications/SourceTree.app/Contents/Resources/opendiff-w.sh \"$LOCAL\" \"$REMOTE\" -ancestor \"$BASE\" -merge \"$MERGED\"",
##   "mergetool.sourcetree.trustexitcode": "true",
##   "user.email": "jenny@stat.ubc.ca",
##   "user.name": "jennybc",
##   "branch.attempt-vignette-fix.merge": "refs/heads/attempt-vignette-fix",
##   "branch.attempt-vignette-fix.remote": "origin",
##   "branch.master.merge": "refs/heads/master",
##   "branch.master.remote": "origin",
##   "branch.rsp-travis-debug.merge": "refs/heads/rsp-travis-debug",
##   "branch.rsp-travis-debug.remote": "origin",
##   "core.bare": "false",
##   "core.filemode": "true",
##   "core.ignorecase": "true",
##   "core.logallrefupdates": "true",
##   "core.precomposeunicode": "true",
##   "core.repositoryformatversion": "0",
##   "githug.user": "jennybc",
##   "remote.origin.fetch": "+refs/heads/*:refs/remotes/origin/*",
##   "remote.origin.url": "https://github.com/jennybc/githug.git",
##   "travis.slug": "jennybc/githug"
## }

git_config_local()   #                 same as git_config(where = "local")

## {
##   "branch.attempt-vignette-fix.merge": "refs/heads/attempt-vignette-fix",
##   "branch.attempt-vignette-fix.remote": "origin",
##   "branch.master.merge": "refs/heads/master",
##   "branch.master.remote": "origin",
##   "branch.rsp-travis-debug.merge": "refs/heads/rsp-travis-debug",
##   "branch.rsp-travis-debug.remote": "origin",
##   "core.bare": "false",
##   "core.filemode": "true",
##   "core.ignorecase": "true",
##   "core.logallrefupdates": "true",
##   "core.precomposeunicode": "true",
##   "core.repositoryformatversion": "0",
##   "githug.user": "jennybc",
##   "remote.origin.fetch": "+refs/heads/*:refs/remotes/origin/*",
##   "remote.origin.url": "https://github.com/jennybc/githug.git",
##   "travis.slug": "jennybc/githug",
##   "user.name": "jennybc"
## }

git_config_global()  #                 same as git-config(where = "global")

## {
##   "core.excludesfile": "/Users/jenny/.gitignore_global",
##   "credential.helper": "osxkeychain",
##   "difftool.sourcetree.cmd": "opendiff \"$LOCAL\" \"$REMOTE\"",
##   "difftool.sourcetree.path": "",
##   "mergetool.sourcetree.cmd": "/Applications/SourceTree.app/Contents/Resources/opendiff-w.sh \"$LOCAL\" \"$REMOTE\" -ancestor \"$BASE\" -merge \"$MERGED\"",
##   "mergetool.sourcetree.trustexitcode": "true",
##   "user.email": "jenny@stat.ubc.ca",
##   "user.name": "jennybc"
## }

set, query, restore global config

(ocfg <-
   git_config_global(user.name = "thelma", user.email = "thelma@example.org"))

## {
##   "user.name": "jennybc",
##   "user.email": "jenny@stat.ubc.ca"
## }

git_config_global("user.name", "user.email")

## {
##   "user.name": "thelma",
##   "user.email": "thelma@example.org"
## }

## complete the round trip
git_config_global(ocfg)
git_config_global("user.name", "user.email")

## {
##   "user.name": "jennybc",
##   "user.email": "jenny@stat.ubc.ca"
## }

a whole bunch of adding, commiting, ADDING, and COMMITTING

## conventional git add, status, commit
repo <- git_init(tempfile("githug-commits-"))

## Creating directory /var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T//RtmpYomHpM/githug-commits-c2a269238705

## Doing `git init` in /var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T//RtmpYomHpM/githug-commits-c2a269238705

owd <- setwd(repo)
writeLines("Are these girls real smart or real real lucky?", "max.txt")
git_add("max.txt")
git_status()

## On branch

## Staged changes:
##  New:        max.txt

git_commit("Brains'll only get you so far and luck always runs out.")

## Committing ...

## [4f9ed24] 2016-01-27: Brains'll only get you so far and luck always runs out.

git_status()

## On branch master

## working directory clean

setwd(owd)

THE SHOUTY COMMANDS

repo <- git_init(tempfile("GITHUG-SHOUTING-"))

## Creating directory /var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T//RtmpYomHpM/GITHUG-SHOUTING-c2a2430ba665

## Doing `git init` in /var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T//RtmpYomHpM/GITHUG-SHOUTING-c2a2430ba665

owd <- setwd(repo)
writeLines("Change me", "change-me")
writeLines("Delete me", "delete-me")
git_status()

## On branch

## Untracked files:
##  Untracked:  change-me
##  Untracked:  delete-me

git_add(c("change-me", "delete-me"))
git_status()

## On branch

## Staged changes:
##  New:        change-me
##  New:        delete-me

git_commit("initial")

## Committing ...

## [7db28c9] 2016-01-27: initial

write("OK", "change-me", append = TRUE)
file.remove("delete-me")

## [1] TRUE

writeLines("Add me", "add-me")
git_status()

## On branch master

## Untracked files:
##  Untracked:  add-me
## 
## Unstaged changes:
##  Modified:   change-me
##  Deleted:    delete-me

git_ADD()

## Adding files:
## change-me
## delete-me
## add-me

git_status()

## On branch master

## Staged changes:
##  New:        add-me
##  Modified:   change-me
##  Deleted:    delete-me

## TO DO: return here when commits and reset are wrapped
ccc <- git2r::commits()[[1]]
git2r::reset(ccc, "mixed")
git_status()

## On branch master

## Untracked files:
##  Untracked:  add-me
## 
## Unstaged changes:
##  Modified:   change-me
##  Deleted:    delete-me

git_COMMIT("JUST DO IT.")

## Adding files:
## change-me
## delete-me
## add-me

## Committing ...

## [aacdb22] 2016-01-27: JUST DO IT.

git_status()

## On branch master

## working directory clean

setwd(owd)

all the branch things -----------------------

repo <- git_init(tempfile("githug-branches-"))

## Creating directory /var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T//RtmpYomHpM/githug-branches-c2a232ea323b

## Doing `git init` in /var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T//RtmpYomHpM/githug-branches-c2a232ea323b

repo

## [1] "/private/var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T/RtmpYomHpM/githug-branches-c2a232ea323b"

owd <- setwd(repo)
getwd()

## [1] "/private/var/folders/vt/4sdxy0rd1b3b65nqssx4sx_h0000gn/T/RtmpYomHpM/githug-branches-c2a232ea323b"

## **NOTE TO SELF:** I have no idea why this setwd() does not take effect. WTF?
## Temporary workaround: specify repo everywhere below.

no commits --> no branches

git_branch_list(repo = repo)

## No branches to list.

commit and ... now we have master

writeLines("Well, we're not in the middle of nowhere...",
           file.path(repo, "nowhere.txt"))
git_COMMIT('1: not in the middle of nowhere', repo = repo)

## Adding files:
## nowhere.txt

## Committing ...

## [03593fb] 2016-01-27: 1: not in the middle of nowhere

git_branch_list(repo = repo)

## Source: local data frame [1 x 4]
## 
##     name  curr  type      git_branch
##    (chr) (chr) (chr)          (list)
## 1 master  <--  local <S4:git_branch>

git_branch_list(tips = TRUE, repo = repo)

## Joining by: "sha"

## Source: local data frame [1 x 11]
## 
##     name  curr  type     sha                  message             when
##    (chr) (chr) (chr)   (chr)                    (chr)            (chr)
## 1 master  <--  local 03593fb 1: not in the middle of… 2016-01-27 14:04
## Variables not shown: author (chr), email (chr), summary (chr), commit
##   (list), git_branch (list).

create new branch that points at HEAD

git_branch_create("earlybranch", repo = repo)

## Basing new branch on:
##   [03593f] (Local) (HEAD) master

## Creating branch earlybranch

git_branch_list(repo = repo)

## Source: local data frame [2 x 4]
## 
##          name  curr  type      git_branch
##         (chr) (chr) (chr)          (list)
## 1 earlybranch       local <S4:git_branch>
## 2      master  <--  local <S4:git_branch>

another commit

write("but we can see it from here.",
      file.path(repo, "nowhere.txt"), append = TRUE)
git_COMMIT('2: but we can see it from here', repo = repo)

## Adding files:
## nowhere.txt

## Committing ...

## [4a7b7ab] 2016-01-27: 2: but we can see it from here

create new branch that points at first commit, not HEAD

(gl <- git_log(repo = repo))

## Source: local data frame [2 x 7]
## 
##                    message             when  author     sha
##                      (chr)            (chr)   (chr)   (chr)
## 1 2: but we can see it fr… 2016-01-27 14:04 jennybc 4a7b7ab
## 2 1: not in the middle of… 2016-01-27 14:04 jennybc 03593fb
## Variables not shown: email (chr), summary (chr), commit (list).

git_branch_create("hindsight", commit  = gl$commit[[2]], repo = repo)

## Basing new branch on:
##   [03593fb] 2016-01-27: 1: not in the middle of nowhere

## Creating branch hindsight

git_branch_list(repo = repo)

## Source: local data frame [3 x 4]
## 
##          name  curr  type      git_branch
##         (chr) (chr) (chr)          (list)
## 1 earlybranch       local <S4:git_branch>
## 2   hindsight       local <S4:git_branch>
## 3      master  <--  local <S4:git_branch>

git_branch_list(tips = TRUE, repo = repo)

## Joining by: "sha"

## Source: local data frame [3 x 11]
## 
##          name  curr  type     sha                  message
##         (chr) (chr) (chr)   (chr)                    (chr)
## 1 earlybranch       local 03593fb 1: not in the middle of…
## 2   hindsight       local 03593fb 1: not in the middle of…
## 3      master  <--  local 4a7b7ab 2: but we can see it fr…
## Variables not shown: when (chr), author (chr), email (chr), summary (chr),
##   commit (list), git_branch (list).

try to re-create an existing branch and fail

git_branch_create("hindsight", repo = repo)

## Basing new branch on:
##   [4a7b7a] (Local) (HEAD) master

## Error in (structure(function (commit, name, force = FALSE) : Error in 'git2r_branch_create': Failed to write reference 'refs/heads/hindsight': a reference with that name already exists.

try try again ... and use the force = TRUE

git_branch_create("hindsight", force = TRUE, repo = repo)

## Basing new branch on:
##   [4a7b7a] (Local) (HEAD) master

## Creating branch hindsight

git_branch_list(tips = TRUE, repo = repo)

## Joining by: "sha"

## Source: local data frame [3 x 11]
## 
##          name  curr  type     sha                  message
##         (chr) (chr) (chr)   (chr)                    (chr)
## 1 earlybranch       local 03593fb 1: not in the middle of…
## 2   hindsight       local 4a7b7ab 2: but we can see it fr…
## 3      master  <--  local 4a7b7ab 2: but we can see it fr…
## Variables not shown: when (chr), author (chr), email (chr), summary (chr),
##   commit (list), git_branch (list).

checkout an existing branch

git_checkout("earlybranch", repo = repo)

## Switched to branch 'earlybranch'

git_branch(repo = repo)

## [1] "earlybranch"

git_HEAD(repo = repo)

## On branch earlybranch.
## Most recent commit:
## [03593fb] 2016-01-27: 1: not in the middle of nowhere

checkout master

git_checkout(repo = repo)

## Switched to branch 'master'

git_HEAD(repo = repo)

## On branch master.
## Most recent commit:
## [4a7b7ab] 2016-01-27: 2: but we can see it from here

checkout AND CREATE all at once

git_CHECKOUT("IMMEDIATE-GRATIFICATION", repo = repo)

## Switched to branch 'IMMEDIATE-GRATIFICATION'

git_HEAD(repo = repo)

## On branch IMMEDIATE-GRATIFICATION.
## Most recent commit:
## [4a7b7ab] 2016-01-27: 2: but we can see it from here

delete a branch

git_branch_delete("earlybranch", repo = repo)

## Deleted branch 'earlybranch'

git_branch_list(repo = repo)

## Source: local data frame [3 x 4]
## 
##                      name  curr  type      git_branch
##                     (chr) (chr) (chr)          (list)
## 1               hindsight       local <S4:git_branch>
## 2 IMMEDIATE-GRATIFICATION  <--  local <S4:git_branch>
## 3                  master       local <S4:git_branch>