ronin-repos 0.1.1 → 0.2.0.rc1

data/lib/ronin/repos/cli/commands/show.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-repos 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos/cli/command'
+
+require 'command_kit/printing/fields'
+require 'command_kit/printing/lists'
+
+module Ronin
+  module Repos
+    class CLI
+      module Commands
+        #
+        # Prints information about a specific repository in the cache directory.
+        #
+        # ## Usage
+        #
+        #     ronin-repos show [options] REPO
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     REPO                             The repository to display
+        #
+        # @since 0.2.0
+        #
+        class Show < Command
+
+          include CommandKit::Printing::Fields
+          include CommandKit::Printing::Lists
+
+          usage '[options] [REPO]'
+
+          argument :name, required: true,
+                          usage:    'REPO',
+                          desc:     'The repository to display'
+
+          description 'Prints information about a repository in the cache directory'
+
+          man_page 'ronin-repos-show.1'
+
+          #
+          # Runs the `ronin-repos show` command.
+          #
+          # @param [String] name
+          #   The repo name to display.
+          #
+          def run(name=nil)
+            repo = cache_dir[name]
+
+            puts "[ #{repo} ]"
+            puts
+
+            indent do
+              print_fields(
+                'Name'  => repo.name,
+                'URI'   => repo.url,
+                'Files' => nil
+              )
+
+              indent do
+                print_list(repo.list_files)
+              end
+            end
+          rescue RepositoryNotFound => error
+            print_error(error.message)
+            exit(-1)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/commands/update.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -77,7 +77,7 @@ module Ronin
 
                 begin
                   repo.update
-                rescue CommandFailed => error
+                rescue CommandNotInstalled, CommandFailed => error
                   log_error("failed to update repository #{repo}: #{error.message}")
                 end
               end

data/lib/ronin/repos/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -41,9 +41,10 @@ module Ronin
       command_name 'ronin-repos'
       version Ronin::Repos::VERSION
 
-      command_aliases['ls'] = 'list'
-      command_aliases['up'] = 'update'
-      command_aliases['rm'] = 'remove'
+      command_aliases['ls']   = 'list'
+      command_aliases['up']   = 'update'
+      command_aliases['rm']   = 'remove'
+      command_aliases['info'] = 'show'
 
     end
   end

data/lib/ronin/repos/exceptions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/repos/repository.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -19,6 +19,7 @@
 require 'ronin/repos/exceptions'
 
 require 'fileutils'
+require 'time'
 
 module Ronin
   module Repos
@@ -138,6 +139,34 @@ module Ronin
         return repo
       end
 
+      #
+      # The git URL of the repository.
+      #
+      # @return [String]
+      #   The `git:` or `https://` URL for the repository.
+      #
+      # @since 0.2.0
+      #
+      def url
+        Dir.chdir(@path) do
+          `git remote get-url origin`.chomp
+        end
+      end
+
+      #
+      # Determines when the repository was last updated.
+      #
+      # @return [Time]
+      #   The timestamp of the last commit will be returned.
+      #
+      # @since 0.2.0
+      #
+      def last_updated_at
+        Dir.chdir(@path) do
+          Time.parse(`git log --date=iso8601 --pretty="%cd" -1`)
+        end
+      end
+
       #
       # Pulls down new git commits.
       #

data/lib/ronin/repos/root.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/repos/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -19,6 +19,6 @@
 module Ronin
   module Repos
     # ronin-repos version
-    VERSION = '0.1.1'
+    VERSION = '0.2.0.rc1'
   end
 end

data/lib/ronin/repos.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-repos is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -25,7 +25,21 @@ module Ronin
   # @api public
   #
   module Repos
-    @cache_dir = CacheDir.new
+    #
+    # The global repositories cache directory.
+    #
+    # @return [CacheDir]
+    #   The global repositories cache directory (`~/.cache/ronin-repos`).
+    #
+    # @note This method lazy initializes {CacheDir} when first called.
+    #
+    # @api private
+    #
+    # @since 0.2.0
+    #
+    def self.cache_dir
+      @cache_dir ||= CacheDir.new
+    end
 
     #
     # Finds the first matching file.
@@ -42,7 +56,7 @@ module Ronin
     #   # => "/home/user/.cache/ronin-repos/foo-repo/wordlists/wordlist.txt"
     #
     def self.find_file(path)
-      @cache_dir.find_file(path)
+      cache_dir.find_file(path)
     end
 
     #
@@ -62,7 +76,7 @@ module Ronin
     #   #     "/home/user/.cache/ronin-repos/bar-repo/wordlists/beers.txt"]
     #
     def self.glob(pattern,&block)
-      @cache_dir.glob(pattern,&block)
+      cache_dir.glob(pattern,&block)
     end
 
     #
@@ -75,7 +89,7 @@ module Ronin
     #   The matching files within all repositories.
     #
     def self.list_files(pattern='{**/}*.*')
-      @cache_dir.list_files(pattern)
+      cache_dir.list_files(pattern)
     end
   end
 end

data/man/ronin-repos-completion.1

@@ -0,0 +1,76 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-repos-completion 1 "2024-01-01" Ronin Repos "User Manuals"
+.SH NAME
+.PP
+ronin\-repos\-completion \- Manages shell completion rules for \fBronin\-repos\fR
+.SH SYNOPSIS
+.PP
+\fBronin\-repos completion\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-repos completion\fR command can print, install, or uninstall shell
+completion rules for the \fBronin\-repos\fR command\.
+.PP
+Supports installing completion rules for Bash or Zsh shells\.
+Completion rules for the Fish shell is currently not supported\.
+.SS ZSH SUPPORT
+.PP
+Zsh users will have to add the following lines to their \fB\[ti]\[sl]\.zshrc\fR file in
+order to enable Zsh\[cq]s Bash completion compatibility layer:
+.PP
+.RS 4
+.EX
+autoload \-Uz \[pl]X compinit && compinit
+autoload \-Uz \[pl]X bashcompinit && bashcompinit
+.EE
+.RE
+.SH OPTIONS
+.TP
+\fB\-\-print\fR
+Prints the shell completion file\.
+.TP
+\fB\-\-install\fR
+Installs the shell completion file\.
+.TP
+\fB\-\-uninstall\fR
+Uninstalls the shell completion file\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH ENVIRONMENT
+.TP
+\fIPREFIX\fP
+Specifies the root prefix for the file system\.
+.TP
+\fIHOME\fP
+Specifies the home directory of the user\. Ronin will search for the
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Specifies the data directory to use\. Defaults to \fB\[Do]HOME\[sl]\.local\[sl]share\fR\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The user\-local installation directory for Bash completion files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The system\-wide installation directory for Bash completions files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]zsh\[sl]site\-functions\[sl]\fR
+The installation directory for Zsh completion files\.
+.SH EXAMPLES
+.TP
+\fBronin\-repos completion \-\-print\fR
+Prints the shell completion rules instead of installing them\.
+.TP
+\fBronin\-repos completion \-\-install\fR
+Installs the shell completion rules for \fBronin\-repos\fR\.
+.TP
+\fBronin\-repos completion \-\-uninstall\fR
+Uninstalls the shell completion rules for \fBronin\-repos\fR\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-repos-completion.1.md

@@ -0,0 +1,78 @@
+# ronin-repos-completion 1 "2024-01-01" Ronin Repos "User Manuals"
+
+## NAME
+
+ronin-repos-completion - Manages shell completion rules for `ronin-repos`
+
+## SYNOPSIS
+
+`ronin-repos completion` [*options*]
+
+## DESCRIPTION
+
+The `ronin-repos completion` command can print, install, or uninstall shell
+completion rules for the `ronin-repos` command.
+
+Supports installing completion rules for Bash or Zsh shells.
+Completion rules for the Fish shell is currently not supported.
+
+### ZSH SUPPORT
+
+Zsh users will have to add the following lines to their `~/.zshrc` file in
+order to enable Zsh's Bash completion compatibility layer:
+
+    autoload -Uz +X compinit && compinit
+    autoload -Uz +X bashcompinit && bashcompinit
+
+## OPTIONS
+
+`--print`
+: Prints the shell completion file.
+
+`--install`
+: Installs the shell completion file.
+
+`--uninstall`
+: Uninstalls the shell completion file.
+
+`-h`, `--help`
+: Prints help information.
+
+## ENVIRONMENT
+
+*PREFIX*
+: Specifies the root prefix for the file system.
+
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-repos` cache directory within the home directory.
+
+*XDG_DATA_HOME*
+: Specifies the data directory to use. Defaults to `$HOME/.local/share`.
+
+## FILES
+
+`~/.local/share/bash-completion/completions/`
+: The user-local installation directory for Bash completion files.
+
+`/usr/local/share/bash-completion/completions/`
+: The system-wide installation directory for Bash completions files.
+
+`/usr/local/share/zsh/site-functions/`
+: The installation directory for Zsh completion files.
+
+## EXAMPLES
+
+`ronin-repos completion --print`
+: Prints the shell completion rules instead of installing them.
+
+`ronin-repos completion --install`
+: Installs the shell completion rules for `ronin-repos`.
+
+`ronin-repos completion --uninstall`
+: Uninstalls the shell completion rules for `ronin-repos`.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-repos-install.1

@@ -1,68 +1,54 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-repos\-install \- Installs a git repository into the cache directory
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-repos install\fR \[lB]\fIoptions\fP\[rB] \fIURI\fP
-.LP
+.PP
+\fBronin\-repos install\fR \[lB]\fIoptions\fP\[rB] \fIURI\fP
 .SH DESCRIPTION
-.LP
 .PP
 Downloads a repository\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIURI\fP
 The URI to the git repository\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+\fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
 Overrides the default cache directory\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Prints help information\.
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Specifies the home directory of the user\. Ronin will search for the
-\fB~/.cache/ronin-repos\fR cache directory within the home directory\.
-.LP
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
 .TP
 \fIXDG\[ru]CACHE\[ru]HOME\fP
-Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
-.LP
+Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
 .SH FILES
-.LP
 .TP
-\fB~/.cache/ronin-repos/\fR
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
 Installation directory for all repositories\.
-.LP
 .SH EXAMPLES
-.LP
 .TP
-\fBronin-repos install https://github.com/user/repo.git\fR
+\fBronin\-repos install https:\[sl]\[sl]github\.com\[sl]user\[sl]repo\.git\fR
 Installs a public repository over HTTPS\.
-.LP
 .TP
-\fBronin-repos install git@example.com:/home/secret/repo\fR
+\fBronin\-repos install git\[at]example\.com:\[sl]home\[sl]secret\[sl]repo\fR
 Installs a private repository over SSH\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-repos(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
+.BR ronin\-repos (1)
+.BR ronin\-repos\-list (1)
+.BR ronin\-repos\-remove (1)
+.BR ronin\-repos\-update (1)
+.BR ronin\-repos\-purge (1)

data/man/ronin-repos-install.1.md

@@ -1,5 +1,9 @@
 # ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
 
+## NAME
+
+ronin-repos-install - Installs a git repository into the cache directory
+
 ## SYNOPSIS
 
 `ronin-repos install` [*options*] *URI*
@@ -11,37 +15,37 @@ Downloads a repository.
 ## ARGUMENTS
 
 *URI*
-	The URI to the git repository.
+: The URI to the git repository.
 
 ## OPTIONS
 
 `-C`, `--cache-dir` *DIR*
-  Overrides the default cache directory.
+: Overrides the default cache directory.
 
 `-h`, `--help`
-  Prints help information.
+: Prints help information.
 
 ## ENVIRONMENT
 
 *HOME*
-	Specifies the home directory of the user. Ronin will search for the
-	`~/.cache/ronin-repos` cache directory within the home directory.
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-repos` cache directory within the home directory.
 
 *XDG_CACHE_HOME*
-  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+: Specifies the cache directory to use. Defaults to `$HOME/.cache`.
 
 ## FILES
 
 `~/.cache/ronin-repos/`
-	Installation directory for all repositories.
+: Installation directory for all repositories.
 
 ## EXAMPLES
 
 `ronin-repos install https://github.com/user/repo.git`
-	Installs a public repository over HTTPS.
+: Installs a public repository over HTTPS.
 
 `ronin-repos install git@example.com:/home/secret/repo`
-	Installs a private repository over SSH.
+: Installs a private repository over SSH.
 
 ## AUTHOR
 
@@ -49,4 +53,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-repos(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
+[ronin-repos](ronin-repos.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)

data/man/ronin-repos-list.1

@@ -1,58 +1,48 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-repos\-list \- Lists all repositories in the cache directory
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-repos list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
-.LP
+.PP
+\fBronin\-repos list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Lists all downloaded repositories\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
-\fIREPO\fP
+\fINAME\fP
 The optional repository name to only list\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+\fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
 Overrides the default cache directory\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Prints help information\.
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Specifies the home directory of the user\. Ronin will search for the
-\fB~/.cache/ronin-repos\fR cache directory within the home directory\.
-.LP
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
 .TP
 \fIXDG\[ru]CACHE\[ru]HOME\fP
-Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
-.LP
+Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
 .SH FILES
-.LP
 .TP
-\fB~/.cache/ronin-repos\fR
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR
 Installation directory for repositories\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-repos(1) ronin\-repos\-install(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
+.BR ronin\-repos (1)
+.BR ronin\-repos\-install (1)
+.BR ronin\-repos\-remove (1)
+.BR ronin\-repos\-show (1)
+.BR ronin\-repos\-update (1)
+.BR ronin\-repos\-purge (1)