ronin-repos 0.1.0.beta1 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +15 -0
  3. data/.rubocop.yml +17 -0
  4. data/.yardopts +1 -1
  5. data/ChangeLog.md +13 -1
  6. data/Gemfile +7 -3
  7. data/README.md +2 -1
  8. data/Rakefile +2 -2
  9. data/bin/ronin-repos +7 -8
  10. data/data/templates/repo/README.md.erb +1 -1
  11. data/gemspec.yml +2 -2
  12. data/lib/ronin/repos/cache_dir.rb +6 -7
  13. data/lib/ronin/repos/class_dir.rb +18 -12
  14. data/lib/ronin/repos/cli/command.rb +5 -3
  15. data/lib/ronin/repos/cli/commands/install.rb +6 -2
  16. data/lib/ronin/repos/cli/commands/list.rb +1 -1
  17. data/lib/ronin/repos/cli/commands/new.rb +2 -2
  18. data/lib/ronin/repos/cli/commands/purge.rb +16 -1
  19. data/lib/ronin/repos/cli/commands/remove.rb +1 -1
  20. data/lib/ronin/repos/cli/commands/update.rb +1 -1
  21. data/lib/ronin/repos/cli.rb +6 -1
  22. data/lib/ronin/repos/exceptions.rb +4 -4
  23. data/lib/ronin/repos/repository.rb +4 -4
  24. data/lib/ronin/repos/root.rb +1 -1
  25. data/lib/ronin/repos/version.rb +2 -2
  26. data/lib/ronin/repos.rb +5 -5
  27. data/man/ronin-repos-install.1 +16 -12
  28. data/man/ronin-repos-install.1.md +13 -10
  29. data/man/ronin-repos-list.1 +16 -12
  30. data/man/ronin-repos-list.1.md +13 -10
  31. data/man/ronin-repos-new.1 +5 -1
  32. data/man/ronin-repos-new.1.md +30 -0
  33. data/man/ronin-repos-purge.1 +16 -12
  34. data/man/ronin-repos-purge.1.md +13 -10
  35. data/man/ronin-repos-remove.1 +12 -12
  36. data/man/ronin-repos-remove.1.md +10 -10
  37. data/man/ronin-repos-update.1 +16 -12
  38. data/man/ronin-repos-update.1.md +13 -10
  39. data/man/ronin-repos.1 +36 -10
  40. data/man/ronin-repos.1.md +28 -8
  41. data/ronin-repos.gemspec +6 -4
  42. metadata +8 -26
  43. data/spec/cache_dir_spec.rb +0 -272
  44. data/spec/class_dir_spec.rb +0 -97
  45. data/spec/fixtures/cache/repo1/dir/file1.txt +0 -0
  46. data/spec/fixtures/cache/repo1/file1.txt +0 -0
  47. data/spec/fixtures/cache/repo1/file2.txt +0 -0
  48. data/spec/fixtures/cache/repo2/dir/file1.txt +0 -0
  49. data/spec/fixtures/cache/repo2/dir/file2.txt +0 -0
  50. data/spec/fixtures/cache/repo2/file1.txt +0 -0
  51. data/spec/fixtures/cache/repo2/file2.txt +0 -0
  52. data/spec/fixtures/cache/repo2/only-exists-in-repo2.txt +0 -0
  53. data/spec/fixtures/class_dir/file1.rb +0 -0
  54. data/spec/fixtures/class_dir/file2.rb +0 -0
  55. data/spec/fixtures/class_dir/only_in_class_dir.rb +0 -0
  56. data/spec/repos_spec.rb +0 -67
  57. data/spec/repository_spec.rb +0 -415
  58. data/spec/spec_helper.rb +0 -6
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -21,25 +21,29 @@ The URI to the git repository\.
21
21
  .SH OPTIONS
22
22
  .LP
23
23
  .TP
24
+ \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
25
+ Overrides the default cache directory\.
26
+ .LP
27
+ .TP
24
28
  \fB-h\fR, \fB--help\fR
25
29
  Prints help information\.
26
30
  .LP
27
- .SH FILES
31
+ .SH ENVIRONMENT
28
32
  .LP
29
33
  .TP
30
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
31
- Installation directory for all repositories\.
34
+ \fIHOME\fP
35
+ Specifies the home directory of the user\. Ronin will search for the
36
+ \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
32
37
  .LP
33
- .SH ENVIRONMENT
38
+ .TP
39
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
40
+ Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
34
41
  .LP
35
- .PP
36
- HOME
37
- Specifies the home directory of the user\. Ronin will search for the
38
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
42
+ .SH FILES
39
43
  .LP
40
- .PP
41
- XDG\[ru]CACHE\[ru]HOME
42
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
44
+ .TP
45
+ \fB~/.cache/ronin-repos/\fR
46
+ Installation directory for all repositories\.
43
47
  .LP
44
48
  .SH EXAMPLES
45
49
  .LP
@@ -1,4 +1,4 @@
1
- # ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -15,22 +15,25 @@ Downloads a repository.
15
15
 
16
16
  ## OPTIONS
17
17
 
18
+ `-C`, `--cache-dir` *DIR*
19
+ Overrides the default cache directory.
20
+
18
21
  `-h`, `--help`
19
22
  Prints help information.
20
23
 
21
- ## FILES
22
-
23
- *~/.cache/ronin-repos/*
24
- Installation directory for all repositories.
25
-
26
24
  ## ENVIRONMENT
27
25
 
28
- HOME
26
+ *HOME*
29
27
  Specifies the home directory of the user. Ronin will search for the
30
- *~/.cache/ronin-repos* cache directory within the home directory.
28
+ `~/.cache/ronin-repos` cache directory within the home directory.
31
29
 
32
- XDG_CACHE_HOME
33
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
30
+ *XDG_CACHE_HOME*
31
+ Specifies the cache directory to use. Defaults to `$HOME/.cache`.
32
+
33
+ ## FILES
34
+
35
+ `~/.cache/ronin-repos/`
36
+ Installation directory for all repositories.
34
37
 
35
38
  ## EXAMPLES
36
39
 
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -21,25 +21,29 @@ The optional repository name to only list\.
21
21
  .SH OPTIONS
22
22
  .LP
23
23
  .TP
24
+ \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
25
+ Overrides the default cache directory\.
26
+ .LP
27
+ .TP
24
28
  \fB-h\fR, \fB--help\fR
25
29
  Prints help information\.
26
30
  .LP
27
- .SH FILES
31
+ .SH ENVIRONMENT
28
32
  .LP
29
33
  .TP
30
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
31
- Installation directory for repositories\.
34
+ \fIHOME\fP
35
+ Specifies the home directory of the user\. Ronin will search for the
36
+ \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
32
37
  .LP
33
- .SH ENVIRONMENT
38
+ .TP
39
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
40
+ Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
34
41
  .LP
35
- .PP
36
- HOME
37
- Specifies the home directory of the user\. Ronin will search for the
38
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
42
+ .SH FILES
39
43
  .LP
40
- .PP
41
- XDG\[ru]CACHE\[ru]HOME
42
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
44
+ .TP
45
+ \fB~/.cache/ronin-repos\fR
46
+ Installation directory for repositories\.
43
47
  .LP
44
48
  .SH AUTHOR
45
49
  .LP
@@ -1,4 +1,4 @@
1
- # ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -15,22 +15,25 @@ Lists all downloaded repositories.
15
15
 
16
16
  ## OPTIONS
17
17
 
18
+ `-C`, `--cache-dir` *DIR*
19
+ Overrides the default cache directory.
20
+
18
21
  `-h`, `--help`
19
22
  Prints help information.
20
23
 
21
- ## FILES
22
-
23
- *~/.cache/ronin-repos*
24
- Installation directory for repositories.
25
-
26
24
  ## ENVIRONMENT
27
25
 
28
- HOME
26
+ *HOME*
29
27
  Specifies the home directory of the user. Ronin will search for the
30
- *~/.cache/ronin-repos* cache directory within the home directory.
28
+ `~/.cache/ronin-repos` cache directory within the home directory.
31
29
 
32
- XDG_CACHE_HOME
33
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
30
+ *XDG_CACHE_HOME*
31
+ Specifies the cache directory to use. Defaults to `$HOME/.cache`.
32
+
33
+ ## FILES
34
+
35
+ `~/.cache/ronin-repos`
36
+ Installation directory for repositories.
34
37
 
35
38
  ## AUTHOR
36
39
 
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos-new 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -21,6 +21,10 @@ The path to the new git repository directory\.
21
21
  .SH OPTIONS
22
22
  .LP
23
23
  .TP
24
+ \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
25
+ Overrides the default cache directory\.
26
+ .LP
27
+ .TP
24
28
  \fB-h\fR, \fB--help\fR
25
29
  Prints help information\.
26
30
  .LP
@@ -0,0 +1,30 @@
1
+ # ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-repos new` [*options*] *PATH*
6
+
7
+ ## DESCRIPTION
8
+
9
+ Generates a new git repository.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *PATH*
14
+ The path to the new git repository directory.
15
+
16
+ ## OPTIONS
17
+
18
+ `-C`, `--cache-dir` *DIR*
19
+ Overrides the default cache directory.
20
+
21
+ `-h`, `--help`
22
+ Prints help information.
23
+
24
+ ## AUTHOR
25
+
26
+ Postmodern <postmodern.mod3@gmail.com>
27
+
28
+ ## SEE ALSO
29
+
30
+ ronin-repos(1) ronin-repos-list(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -15,6 +15,10 @@ Removes all installed repositories\.
15
15
  .SH OPTIONS
16
16
  .LP
17
17
  .TP
18
+ \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
19
+ Overrides the default cache directory\.
20
+ .LP
21
+ .TP
18
22
  \fB-h\fR, \fB--help\fR
19
23
  Prints help information\.
20
24
  .LP
@@ -24,22 +28,22 @@ Prints help information\.
24
28
  \fBronin-repo purge\fR
25
29
  Removes all installed repositories\.
26
30
  .LP
27
- .SH FILES
31
+ .SH ENVIRONMENT
28
32
  .LP
29
33
  .TP
30
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
31
- Installation directory for all repositories\.
34
+ \fIHOME\fP
35
+ Specifies the home directory of the user\. Ronin will search for the
36
+ \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
32
37
  .LP
33
- .SH ENVIRONMENT
38
+ .TP
39
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
40
+ Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
34
41
  .LP
35
- .PP
36
- HOME
37
- Specifies the home directory of the user\. Ronin will search for the
38
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
42
+ .SH FILES
39
43
  .LP
40
- .PP
41
- XDG\[ru]CACHE\[ru]HOME
42
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
44
+ .TP
45
+ \fB~/.cache/ronin-repos/\fR
46
+ Installation directory for all repositories\.
43
47
  .LP
44
48
  .SH AUTHOR
45
49
  .LP
@@ -1,4 +1,4 @@
1
- # ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -10,6 +10,9 @@ Removes all installed repositories.
10
10
 
11
11
  ## OPTIONS
12
12
 
13
+ `-C`, `--cache-dir` *DIR*
14
+ Overrides the default cache directory.
15
+
13
16
  `-h`, `--help`
14
17
  Prints help information.
15
18
 
@@ -18,19 +21,19 @@ Removes all installed repositories.
18
21
  `ronin-repo purge`
19
22
  Removes all installed repositories.
20
23
 
21
- ## FILES
22
-
23
- *~/.cache/ronin-repos/*
24
- Installation directory for all repositories.
25
-
26
24
  ## ENVIRONMENT
27
25
 
28
- HOME
26
+ *HOME*
29
27
  Specifies the home directory of the user. Ronin will search for the
30
- *~/.cache/ronin-repos* cache directory within the home directory.
28
+ `~/.cache/ronin-repos` cache directory within the home directory.
31
29
 
32
- XDG_CACHE_HOME
33
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
30
+ *XDG_CACHE_HOME*
31
+ Specifies the cache directory to use. Defaults to `$HOME/.cache`.
32
+
33
+ ## FILES
34
+
35
+ `~/.cache/ronin-repos/`
36
+ Installation directory for all repositories.
34
37
 
35
38
  ## AUTHOR
36
39
 
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -30,22 +30,22 @@ Prints help information\.
30
30
  \fBronin-repo remove repo\fR
31
31
  Removes the repository with with the name \fBrepo\fR\.
32
32
  .LP
33
- .SH FILES
33
+ .SH ENVIRONMENT
34
34
  .LP
35
35
  .TP
36
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
37
- Installation directory for all repositories\.
36
+ \fIHOME\fP
37
+ Specifies the home directory of the user\. Ronin will search for the
38
+ \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
38
39
  .LP
39
- .SH ENVIRONMENT
40
+ .TP
41
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
42
+ Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
40
43
  .LP
41
- .PP
42
- HOME
43
- Specifies the home directory of the user\. Ronin will search for the
44
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
44
+ .SH FILES
45
45
  .LP
46
- .PP
47
- XDG\[ru]CACHE\[ru]HOME
48
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
46
+ .TP
47
+ \fB~/.cache/ronin-repos/\fR
48
+ Installation directory for all repositories\.
49
49
  .LP
50
50
  .SH AUTHOR
51
51
  .LP
@@ -1,4 +1,4 @@
1
- # ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -23,19 +23,19 @@ Removes a repository.
23
23
  `ronin-repo remove repo`
24
24
  Removes the repository with with the name `repo`.
25
25
 
26
- ## FILES
27
-
28
- *~/.cache/ronin-repos/*
29
- Installation directory for all repositories.
30
-
31
26
  ## ENVIRONMENT
32
27
 
33
- HOME
28
+ *HOME*
34
29
  Specifies the home directory of the user. Ronin will search for the
35
- *~/.cache/ronin-repos* cache directory within the home directory.
30
+ `~/.cache/ronin-repos` cache directory within the home directory.
36
31
 
37
- XDG_CACHE_HOME
38
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
32
+ *XDG_CACHE_HOME*
33
+ Specifies the cache directory to use. Defaults to `$HOME/.cache`.
34
+
35
+ ## FILES
36
+
37
+ `~/.cache/ronin-repos/`
38
+ Installation directory for all repositories.
39
39
 
40
40
  ## AUTHOR
41
41
 
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -21,6 +21,10 @@ The optional repository name to only update\.
21
21
  .SH OPTIONS
22
22
  .LP
23
23
  .TP
24
+ \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
25
+ Overrides the default cache directory\.
26
+ .LP
27
+ .TP
24
28
  \fB-h\fR, \fB--help\fR
25
29
  Prints help information\.
26
30
  .LP
@@ -34,22 +38,22 @@ Updates all installed repositories\.
34
38
  \fBronin update repo\fR
35
39
  Updates the specific repository named \fBrepo\fR\.
36
40
  .LP
37
- .SH FILES
41
+ .SH ENVIRONMENT
38
42
  .LP
39
43
  .TP
40
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
41
- Installation directory for all repositories\.
44
+ \fIHOME\fP
45
+ Specifies the home directory of the user\. Ronin will search for the
46
+ \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
42
47
  .LP
43
- .SH ENVIRONMENT
48
+ .TP
49
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
50
+ Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
44
51
  .LP
45
- .PP
46
- HOME
47
- Specifies the home directory of the user\. Ronin will search for the
48
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
52
+ .SH FILES
49
53
  .LP
50
- .PP
51
- XDG\[ru]CACHE\[ru]HOME
52
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
54
+ .TP
55
+ \fB~/.cache/ronin-repos/\fR
56
+ Installation directory for all repositories\.
53
57
  .LP
54
58
  .SH AUTHOR
55
59
  .LP
@@ -1,4 +1,4 @@
1
- # ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -15,6 +15,9 @@ Updates all repositories or just one.
15
15
 
16
16
  ## OPTIONS
17
17
 
18
+ `-C`, `--cache-dir` *DIR*
19
+ Overrides the default cache directory.
20
+
18
21
  `-h`, `--help`
19
22
  Prints help information.
20
23
 
@@ -26,19 +29,19 @@ Updates all repositories or just one.
26
29
  `ronin update repo`
27
30
  Updates the specific repository named `repo`.
28
31
 
29
- ## FILES
30
-
31
- *~/.cache/ronin-repos/*
32
- Installation directory for all repositories.
33
-
34
32
  ## ENVIRONMENT
35
33
 
36
- HOME
34
+ *HOME*
37
35
  Specifies the home directory of the user. Ronin will search for the
38
- *~/.cache/ronin-repos* cache directory within the home directory.
36
+ `~/.cache/ronin-repos` cache directory within the home directory.
39
37
 
40
- XDG_CACHE_HOME
41
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
38
+ *XDG_CACHE_HOME*
39
+ Specifies the cache directory to use. Defaults to `$HOME/.cache`.
40
+
41
+ ## FILES
42
+
43
+ `~/.cache/ronin-repos/`
44
+ Installation directory for all repositories.
42
45
 
43
46
  ## AUTHOR
44
47
 
data/man/ronin-repos.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
3
+ .TH ronin-repos 1 "2023-02-01" Ronin Repos "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -19,22 +19,48 @@ and use any git repository containing Ruby code or other data\.
19
19
  \fB-h\fR, \fB--help\fR
20
20
  Prints help information\.
21
21
  .LP
22
- .SH FILES
22
+ .SH COMMANDS
23
23
  .LP
24
24
  .TP
25
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
26
- Installation directory for repositories\.
25
+ \fBinstall\fR
26
+ Installs a 3rd\-party git repository\.
27
+ .LP
28
+ .TP
29
+ \fBlist\fR, \fBls\fR
30
+ Lists installed git repositories\.
31
+ .LP
32
+ .TP
33
+ \fBnew\fR
34
+ Generates a new git repository\.
35
+ .LP
36
+ .TP
37
+ \fBpurge\fR
38
+ Deletes all installed git repositories\.
39
+ .LP
40
+ .TP
41
+ \fBremove\fR, \fBrm\fR
42
+ Removes a previously installed git repository\.
43
+ .LP
44
+ .TP
45
+ \fBupdate\fR, \fBup\fR
46
+ Updates a previously installed git repository\.
27
47
  .LP
28
48
  .SH ENVIRONMENT
29
49
  .LP
30
- .PP
31
- HOME
50
+ .TP
51
+ \fIHOME\fP
32
52
  Specifies the home directory of the user\. Ronin will search for the
33
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
53
+ \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
34
54
  .LP
35
- .PP
36
- XDG\[ru]CACHE\[ru]HOME
37
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
55
+ .TP
56
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
57
+ Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
58
+ .LP
59
+ .SH FILES
60
+ .LP
61
+ .TP
62
+ \fB~/.cache/ronin-repos\fR
63
+ Installation directory for repositories\.
38
64
  .LP
39
65
  .SH AUTHOR
40
66
  .LP
data/man/ronin-repos.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -14,19 +14,39 @@ and use any git repository containing Ruby code or other data.
14
14
  `-h`, `--help`
15
15
  Prints help information.
16
16
 
17
- ## FILES
17
+ ## COMMANDS
18
18
 
19
- *~/.cache/ronin-repos*
20
- Installation directory for repositories.
19
+ `install`
20
+ Installs a 3rd-party git repository.
21
+
22
+ `list`, `ls`
23
+ Lists installed git repositories.
24
+
25
+ `new`
26
+ Generates a new git repository.
27
+
28
+ `purge`
29
+ Deletes all installed git repositories.
30
+
31
+ `remove`, `rm`
32
+ Removes a previously installed git repository.
33
+
34
+ `update`, `up`
35
+ Updates a previously installed git repository.
21
36
 
22
37
  ## ENVIRONMENT
23
38
 
24
- HOME
39
+ *HOME*
25
40
  Specifies the home directory of the user. Ronin will search for the
26
- *~/.cache/ronin-repos* cache directory within the home directory.
41
+ `~/.cache/ronin-repos` cache directory within the home directory.
42
+
43
+ *XDG_CACHE_HOME*
44
+ Specifies the cache directory to use. Defaults to `$HOME/.cache`.
27
45
 
28
- XDG_CACHE_HOME
29
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
46
+ ## FILES
47
+
48
+ `~/.cache/ronin-repos`
49
+ Installation directory for repositories.
30
50
 
31
51
  ## AUTHOR
32
52
 
data/ronin-repos.gemspec CHANGED
@@ -1,4 +1,4 @@
1
- # encoding: utf-8
1
+ # frozen_string_literal: true
2
2
 
3
3
  require 'yaml'
4
4
 
@@ -22,19 +22,21 @@ Gem::Specification.new do |gem|
22
22
  gem.homepage = gemspec['homepage']
23
23
  gem.metadata = gemspec['metadata'] if gemspec['metadata']
24
24
 
25
- glob = lambda { |patterns| gem.files & Dir[*patterns] }
25
+ glob = ->(patterns) { gem.files & Dir[*patterns] }
26
26
 
27
27
  gem.files = `git ls-files`.split($/)
28
28
  gem.files = glob[gemspec['files']] if gemspec['files']
29
29
  gem.files += Array(gemspec['generated_files'])
30
+ # exclude test files from the packages gem
31
+ gem.files -= glob[gemspec['test_files'] || 'spec/{**/}*']
30
32
 
31
33
  gem.executables = gemspec.fetch('executables') do
32
34
  glob['bin/*'].map { |path| File.basename(path) }
33
35
  end
36
+
34
37
  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
35
38
 
36
39
  gem.extensions = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
37
- gem.test_files = glob[gemspec['test_files'] || 'spec/{**/}*_spec.rb']
38
40
  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
39
41
 
40
42
  gem.require_paths = Array(gemspec.fetch('require_paths') {
@@ -46,7 +48,7 @@ Gem::Specification.new do |gem|
46
48
  gem.required_rubygems_version = gemspec['required_rubygems_version']
47
49
  gem.post_install_message = gemspec['post_install_message']
48
50
 
49
- split = lambda { |string| string.split(/,\s*/) }
51
+ split = ->(string) { string.split(/,\s*/) }
50
52
 
51
53
  if gemspec['dependencies']
52
54
  gemspec['dependencies'].each do |name,versions|