R/browse.R

Defines functions remote_repo parse_remote_url parse_ssh_url strip_git_ext remote_url parse_lines.list parse_lines.character parse_lines add_lines_to_url add_file_path_to_url relative_path absolute_path rstudio_selection split_path_lines remote_url_to_file link browse

Documented in browse link

#' Navigate and Link to Remote Git Files
#'
#' @description
#' \code{link} creates a permalink to the remote file and copies it to your
#' clipboard for easy sharing. This permalink is based on the HEAD commit
#' of the local git repo.
#'
#' \code{browse} does the same thing, but also opens the website in your default
#' web browser.
#'
#' Works with Github, Gitlab, and Bitbucket repos.
#'
#' @details
#' In the \code{path} argument, you can optionally include line numbers after
#' the path to the file. See the examples section below. Formatting varies
#' between Github, Gitlab, and Bitbucket.
#'
#' @param path path to the file. The path may be relative to the current
#' working directory, or an absolute path.
#' The default, \code{path = NULL} works on a RStudio editor selection.
#'
#' @param remote Name of the remote to link to.
#' Optionally, you can change by setting
#' \code{options(browse.remote.default = "remote_name")}.
#'
#' @examples
#' \dontrun{
#' # works on an RStudio selection in the editor
#' browse()
#' link()
#'
#' # working directory is the top level of repo
#' browse("R/browse.R")
#' link("R/browse.R#L6-L9")
#'
#' # working directory is the R/ folder of repo
#' link("../README.md")
#'
#' # relative or absolute paths to other repos
#' browse("~/rpackages/dplyr/DESCRIPTION")
#' }
#'
#' @export
browse <- function(path = NULL, remote = "origin") {
  url <- link(path, remote = remote) %>%
    utils::browseURL()

  invisible(url)
}

#' @rdname browse
#' @export
link <- function(path = NULL, remote = "origin") {

  path_lines <- split_path_lines(path)

  url <- remote_url_to_file(path_lines$path, remote) %>%
    add_lines_to_url(path_lines$lines)

  add_to_clipboard(url)

  invisible(url)
}

remote_url_to_file <- function(path, remote = "origin") {
  absolute_file_path <- absolute_path(path)
  absolute_repo_path <- absolute_file_path %>%
    git2r::workdir()

  relative_repo_file_path <- absolute_repo_path %>%
    relative_path(absolute_file_path)

  remote_repo_url <- absolute_repo_path %>%
    remote_repo(remote) %>%
    remote_url()

  remote_repo_url %>%
    add_file_path_to_url(relative_repo_file_path)
}

split_path_lines <- function(path) {
  if (is.null(path)) {
    return(rstudio_selection())
  }

  split <- stringr::str_split(path, "#")[[1]]
  list(path = split[1], lines = split[2])
}

rstudio_selection <- function() {
  doc <- rstudioapi::getSourceEditorContext()
  range <- rstudioapi::primary_selection(doc$selection)$range %>%
    rstudioapi::as.document_range()

  list(
    path = doc$path,
    lines = list(start = range$start[[1]], end = range$end[[1]])
  )
}

absolute_path <- function(path) {
  path.expand(path) %>%
    tools::file_path_as_absolute()
}

relative_path <- function(outer_path, inner_path) {
  outer_path <- paste0(outer_path, .Platform$file.sep)
  stringr::str_remove(inner_path, outer_path)
}

add_file_path_to_url <- function(url, path) {
  paste0(url, path)
}

add_lines_to_url <- function(url, lines) {
  paste0(url, parse_lines(lines, domain = urltools::domain(url)))
}

parse_lines <- function(lines, ...) {
  UseMethod("parse_lines")
}

parse_lines.character <- function(lines, ...) {
  if (!is.na(lines)) {
    return(paste0("#", lines))
  }

  ""
}

parse_lines.list <- function(lines, ...) {
  switch(
    list(...)[["domain"]],
    github.com = paste0("#L", lines$start, "-L", lines$end),
    gitlab.com = paste0("#L", lines$start),
    bitbucket.org = paste0("#lines-", lines$start)
  )
}

remote_url <- function(repo) {
  web_ext <- list(
    github = ".com",
    gitlab = ".com",
    bitbucket = ".org"
  )

  web_src <- list(
    github = "blob",
    gitlab = "blob",
    bitbucket = "src"
  )

  stopifnot(repo$domain %in% names(web_ext))

  paste0(
    "https://", repo$domain, web_ext[[repo$domain]],  "/",
    repo$owner, "/", repo$name, "/", web_src[[repo$domain]], "/", repo$sha, "/"
  )
}

strip_git_ext <- function(url) {
  stringr::str_sub(url, end = -5)
}

parse_ssh_url <- function(url) {
  components <- url %>%
    stringr::str_split(":")

  shh_components <- components[[1]][1] %>%
    stringr::str_split("@")

  domain <- shh_components[[1]][2] %>%
    urltools::suffix_extract() %>%
    .$domain

  repo <- components[[1]][2] %>%
    stringr::str_split("/")

  list(
    domain = domain,
    owner = repo[[1]][1],
    name = repo[[1]][2]
  )
}

parse_remote_url <- function(url) {
  url <- strip_git_ext(url)
  if (stringr::str_detect(url, "@")) {
    return(parse_ssh_url(url))
  }

  url_components <- urltools::url_parse(url)

  domain <- url_components$domain %>%
    urltools::suffix_extract() %>%
    .$domain

  repo <- url_components$path %>%
    stringr::str_split("/")

  list(
    domain = domain,
    owner = repo[[1]][1],
    name = repo[[1]][2]
  )
}

remote_repo <- function(repo, remote) {
  if (!is.null(getOption("browse.remote.default"))) {
    remote <- getOption("browse.remote.default")
  }

  remote_data <- git2r::remote_url(repo, remote) %>%
    parse_remote_url()

  head <- git2r::repository_head(repo)

  commit <- git2r::lookup_commit(head) %>%
    as.data.frame()

  c(remote_data, list(sha = commit$sha))
}
tmastny/browse documentation built on June 5, 2020, 6:55 a.m.