File: index.R

package info (click to toggle)
r-cran-git2r 0.26.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 6,884 kB
  • sloc: ansic: 101,730; sh: 3,364; makefile: 2
file content (246 lines) | stat: -rw-r--r-- 8,266 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
## git2r, R bindings to the libgit2 library.
## Copyright (C) 2013-2019 The git2r contributors
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License, version 2,
## as published by the Free Software Foundation.
##
## git2r is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License along
## with this program; if not, write to the Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

##' Add file(s) to index
##'
##' @template repo-param
##' @param path Character vector with file names or shell glob
##'     patterns that will matched against files in the repository's
##'     working directory. Each file that matches will be added to the
##'     index (either updating an existing entry or adding a new
##'     entry).
##' @param force Add ignored files. Default is FALSE.
##' @return invisible(NULL)
##' @export
##' @examples
##' \dontrun{
##' ## Initialize a repository
##' path <- tempfile(pattern="git2r-")
##' dir.create(path)
##' repo <- init(path)
##'
##' ## Create a user
##' config(repo, user.name="Alice", user.email="alice@@example.org")
##'
##' ## Create a file
##' writeLines("a", file.path(path, "a.txt"))
##'
##' ## Add file to repository and view status
##' add(repo, "a.txt")
##' status(repo)
##'
##' ## Add file with a leading './' when the repository working
##' ## directory is the current working directory
##' setwd(path)
##' writeLines("b", file.path(path, "b.txt"))
##' add(repo, "./b.txt")
##' status(repo)
##'
##' ## Add a file in a sub-folder with sub-folder as the working
##' ## directory. Create a file in the root of the repository
##' ## working directory that will remain untracked.
##' dir.create(file.path(path, "sub_dir"))
##' setwd("./sub_dir")
##' writeLines("c", file.path(path, "c.txt"))
##' writeLines("c", file.path(path, "sub_dir/c.txt"))
##' add(repo, "c.txt")
##' status(repo)
##'
##' ## Add files with glob expansion when the current working
##' ## directory is outside the repository's working directory.
##' setwd(tempdir())
##' dir.create(file.path(path, "glob_dir"))
##' writeLines("d", file.path(path, "glob_dir/d.txt"))
##' writeLines("e", file.path(path, "glob_dir/e.txt"))
##' writeLines("f", file.path(path, "glob_dir/f.txt"))
##' writeLines("g", file.path(path, "glob_dir/g.md"))
##' add(repo, "glob_dir/*txt")
##' status(repo)
##'
##' ## Add file with glob expansion with a relative path when
##' ## the current working directory is inside the repository's
##' ## working directory.
##' setwd(path)
##' add(repo, "./glob_dir/*md")
##' status(repo)
##' }
add <- function(repo = ".", path = NULL, force = FALSE)
{
    ## Documentation for the pathspec argument in the libgit2 function
    ## 'git_index_add_all' that git2r use internally:
    ##
    ## The pathspec is a list of file names or shell glob patterns
    ## that will matched against files in the repository's working
    ## directory. Each file that matches will be added to the index
    ## (either updating an existing entry or adding a new entry).

    if (is.null(path) || !is.character(path))
        stop("'path' must be a character vector")

    repo <- lookup_repository(repo)
    repo_wd <- normalizePath(workdir(repo), winslash = "/")
    if (!length(grep("/$", repo_wd)))
        repo_wd <- paste0(repo_wd, "/")

    path <- vapply(path, sanitize_path, character(1), repo_wd = repo_wd)

    .Call(git2r_index_add_all, repo, path, isTRUE(force))

    invisible(NULL)
}

sanitize_path <- function(p, repo_wd) {
    np <- suppressWarnings(normalizePath(p, winslash = "/"))

    ## Check if the normalized path is a non-file e.g. a glob.
    if (!file.exists(np)) {
        ## Check if the normalized path starts with a leading './'
        if (length(grep("^[.]/", np))) {
            nd <- suppressWarnings(normalizePath(dirname(p), winslash = "/"))
            if (!length(grep("/$", nd)))
                nd <- paste0(nd, "/")
            np <- paste0(nd, basename(np))
        }
    }

    ## Check if the file is in the repository's working directory,
    ## else let libgit2 handle this path unmodified.
    if (!length(grep(paste0("^", repo_wd), np)))
        return(p)

    ## Change the path to be relative to the repository's working
    ## directory. Substitute common prefix with ""
    sub(paste0("^", repo_wd), "", np)
}

##' Remove files from the working tree and from the index
##'
##' @template repo-param
##' @param path character vector with filenames to remove. The path
##'     must be relative to the repository's working folder. Only
##'     files known to Git are removed.
##' @return invisible(NULL)
##' @export
##' @examples
##' \dontrun{
##' ## Initialize a repository
##' path <- tempfile(pattern="git2r-")
##' dir.create(path)
##' repo <- init(path)
##'
##' ## Create a user
##' config(repo, user.name="Alice", user.email="alice@@example.org")
##'
##' ## Create a file
##' writeLines("Hello world!", file.path(path, "file-to-remove.txt"))
##'
##' ## Add file to repository
##' add(repo, "file-to-remove.txt")
##' commit(repo, "First commit message")
##'
##' ## Remove file
##' rm_file(repo, "file-to-remove.txt")
##'
##' ## View status of repository
##' status(repo)
##' }
rm_file <- function(repo = ".", path = NULL) {
    if (is.null(path) || !is.character(path))
        stop("'path' must be a character vector")

    repo <- lookup_repository(repo)

    if (length(path)) {
        wd <- workdir(repo)

        ## Check that files exists and are known to Git
        if (!all(file.exists(file.path(wd, path)))) {
            stop(sprintf("pathspec '%s' did not match any files. ",
                         path[!file.exists(file.path(wd, path))]))
        }

        if (any(file.info(file.path(wd, path))$isdir)) {
            stop(sprintf("pathspec '%s' did not match any files. ",
                         path[exists(file.path(wd, path))]))
        }

        s <- status(repo, staged = TRUE, unstaged = TRUE,
                    untracked = TRUE, ignored = TRUE)
        if (any(path %in% c(s$ignored, s$untracked))) {
            stop(sprintf("pathspec '%s' did not match any files. ",
                         path[path %in% c(s$ignored, s$untracked)]))
        }

        if (any(path %in% s$staged)) {
            stop(sprintf("'%s' has changes staged in the index. ",
                         path[path %in% s$staged]))
        }

        if (any(path %in% s$unstaged)) {
            stop(sprintf("'%s' has local modifications. ",
                         path[path %in% s$unstaged]))
        }

        ## Remove and stage files
        lapply(path, function(x) {
            file.remove(file.path(wd, x))
            .Call(git2r_index_remove_bypath, repo, x)
        })
    }

    invisible(NULL)
}

##' Remove an index entry corresponding to a file on disk
##'
##' @template repo-param
##' @param path character vector with filenames to remove. The path
##'     must be relative to the repository's working folder. It may
##'     exist. If this file currently is the result of a merge
##'     conflict, this file will no longer be marked as
##'     conflicting. The data about the conflict will be moved to the
##'     "resolve undo" (REUC) section.
##' @return invisible(NULL)
##' @export
##' @examples
##' \dontrun{
##' ## Initialize a repository
##' path <- tempfile(pattern="git2r-")
##' dir.create(path)
##' repo <- init(path)
##'
##' ## Create a user
##' config(repo, user.name="Alice", user.email="alice@@example.org")
##'
##' ## Create a file
##' writeLines("Hello world!", file.path(path, "file-to-remove.txt"))
##'
##' ## Add file to repository
##' add(repo, "file-to-remove.txt")
##'
##' ## View status of repository
##' status(repo)
##'
##' ## Remove file
##' index_remove_bypath(repo, "file-to-remove.txt")
##'
##' ## View status of repository
##' status(repo)
##' }
index_remove_bypath <- function(repo = ".", path = NULL) {
    .Call(git2r_index_remove_bypath, lookup_repository(repo), path)
    invisible(NULL)
}