ls_remote function

[jimhester]

Analogous to git ls-remote, returns all references from a remote
repository.

Fixes #130

I added documentation, tests and a note to NEWS. The libgit2 functions require a repository object to work, but the only information you really need for this is the remote URL. The interface allows you to pass a repository object if you want, otherwise it simply creates a temporary object in tempdir() and uses that.

[stewid]

@jimhester thanks a lot!

I suggest we change the name to remote_ls to be consistent with the other remote methods: remote_add, remote_remove, remote_rename, remote_set_url and remote_url.

I take a closer look at the code later today.

[jimhester]

👍 on remote_ls, the only reason I didn't do that to begin with was to match git ls-remote. I will add a mention of git ls-remote to the roxygen comment so it will show up in any future searches.

[stewid]

git2r_repository_open can return NULL and must be checked before usage, see https://github.com/ropensci/git2r/blob/master/src/git2r_remote.c#L54

if (!repository)
        git2r_error(git2r_err_invalid_repository, __func__, NULL);

[jimhester]

Ok 4a3187d should address all of your suggestions. Thank you for the review! Let me know if you see anything else that needs to be changed.

[jimhester]

cd77539 is passing R CMD check without warnings, let me know if there is anything else you'd like changed, if not it should be ready to merge.

[stewid]

Thank you, I look at the code today.

[stewid]

Do we need to cleanup the temporary repository? One way could be to change the default repo argument to NULL and then something like this in the method:

path <- NULL
if (is.null(repo)) {
    path <- tempdir()
    repo <- git2r::init(path)
}

.Call(git2r_remote_ls, name, repo, credentials)

if (!is.null(path))
   unlink(path, recursive=TRUE)

What do you think?

[jimhester]

The initial repository does not have a large size footprint and the tempdir will be removed when the R session ends, which is why I didn't clean it up explicitly. I added cleanup with jimhester@5b2067d

[stewid]

I like the usage of on.exit for the cleanup and also realize that my suggestion would actually fail to cleanup if .Call(...) fails.

[stewid]

Thanks for this PR 👍
I have added you to the git2r authors https://github.com/ropensci/git2r/blob/master/inst/AUTHORS

[jimhester]

Great thanks, and thank you for the code review!

[sckott]

@stewid any way to do what ls_remote() does with current CRAN version? hoping to push up gistr version, and ideally need to check that a remote exists

[stewid]

@sckott no it only works with the development version. When do plan to push gistr?

[jimhester]

If all you need to do is verify a remote is valid you could just try
fetching from it. That should return an error if it is not (which you can
catch)
On Oct 9, 2015 1:34 PM, "Scott Chamberlain" notifications@github.com
wrote:

@stewid https://github.com/stewid any way to do what ls_remote() does
with current CRAN version? hoping to push up gistr version, and ideally
need to check that a remote exists

—
Reply to this email directly or view it on GitHub
#172 (comment).

[sckott]

I already pushed it to CRAN - I did as @jimhester suggested, used tryCatch on push, then on failure, updated the remote.

[stewid]

Great