ronin-repos 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c76d7743b473b4df8d834209051aa7643aafade9edcc3e3f12e8b344741e7f
-  data.tar.gz: a4c58c0869e1b44a4c5da6589760f86cf261af3dcfe6478a8cff01efe1bab9c1
+  metadata.gz: 5f165cb9c5c8eda828d18f33114a9407ccae14fb6d5a7edc84fbc5159ba26aad
+  data.tar.gz: 6518e8a7dc2b29c778bf82d8ce32efc692e85b0d3ab108f3575724181b689bd4
 SHA512:
-  metadata.gz: 92a8b69b652f962de02fd63b9fbc8e71636c669126e0ab96e769e4aa9894aa70689bc275001e6ddfe214606977618b003daf3de8dfb7966c1feff4e96a910221
-  data.tar.gz: fa460921d3bf47e09714d3fdfeb01d392739ef96366df19f2f6262df1c8df4d37f8eef05bc6f7ac56f0815b76fc8e0c6efd37e23111b788c29db4c3fdc5aa651
+  metadata.gz: 0a827887a127c7a8165087e71cd3e8098b154f1ecd72dd0136f66ef640562db59a401ded921ac74877a981974ab16570cc431850f12f8d184291b5834c9d998d
+  data.tar.gz: 4c6e43043c8a93b69b0f55a1a8016e6014e4343b338b90b9a85d6cc9477b93f8c413d5e3d98bf71bf39115731a13bdfc4e3a46e2d40aa9302029089edf502b6c

data/.github/workflows/ruby.yml

@@ -26,3 +26,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-repos specific exceptions
+#
+
+Lint/EmptyFile:
+  Exclude:
+    - 'spec/fixtures/class_dir/file1.rb'
+    - 'spec/fixtures/class_dir/file2.rb'
+    - 'spec/fixtures/class_dir/only_in_class_dir.rb'

data/ChangeLog.md

@@ -1,4 +1,16 @@
-### 0.1.0 / 2023-XX-XX
+### 0.1.1 / 2023-06-09
+
+* Fixed a bug in {Ronin::Repos::ClassDir::ClassMethods#list_files} where the
+  {Ronin::Repos::ClassDir::ClassMethods#repo_class_dir repo_class_dir} was not
+  being removed from paths.
+* Documentation fixes and improvements.
+
+#### CLI
+
+* Multiple bug fixes to the `ronin-repos install` command.
+* Add missing man-page for the `ronin-repos new` command.
+
+### 0.1.0 / 2023-02-01
 
 * Initial release:
   * Supports installing any [Git][git] repository.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -7,7 +9,7 @@ platform :jruby do
 end
 
 # Ronin dependencies:
-# gem 'ronin-core', '~> 0.1', github: "ronin-rb/ronin-core",
+# gem 'ronin-core', '~> 0.1', github: 'ronin-rb/ronin-core',
 #                             branch: 'main'
 
 # gem 'command_kit', '~> 0.4', github: 'postmodern/command_kit.rb',
@@ -27,6 +29,8 @@ group :development do
   gem 'yard-spellcheck', require: false
 
   gem 'dead_end',        require: false
-  gem 'sord',            require: false, platforms: :mri
-  gem 'stackprof',       require: false, platforms: :mri
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
 end

data/Rakefile

@@ -1,11 +1,11 @@
-require 'rubygems'
+# frozen_string_literal: true
 
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
   warn "Run `gem install bundler` to install Bundler"
-  exit -1
+  exit(-1)
 end
 
 begin

data/bin/ronin-repos

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -21,13 +22,11 @@
 root = File.expand_path(File.join(__dir__,'..'))
 if File.file?(File.join(root,'Gemfile.lock'))
   Dir.chdir(root) do
-    begin
-      require 'bundler/setup'
-    rescue LoadError => e
-      warn e.message
-      warn "Run `gem install bundler` to install Bundler"
-      exit -1
-    end
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
   end
 end
 

data/data/templates/repo/README.md.erb

@@ -5,7 +5,7 @@
 This git repository can be installed by the [ronin-repos] command:
 
 ```shell
-ronin-repos download https://github.com/<%= @github_user %>/<%= @name %>.git
+ronin-repos install https://github.com/<%= @github_user %>/<%= @name %>.git
 ```
 
 [ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme

data/lib/ronin/repos/cache_dir.rb

@@ -34,7 +34,7 @@ module Ronin
 
       include Enumerable
 
-      # The ~/.cache/ronin-repos/ directory where all repos are stored.
+      # The `~/.cache/ronin-repos/` directory where all repos are stored.
       PATH = Core::Home.cache_dir('ronin-repos')
 
       # The path to the cache directory.
@@ -52,7 +52,7 @@ module Ronin
         @path = path
       end
 
-      # 
+      #
       # Accesses a repository from the cache directory.
       #
       # @param [String] name
@@ -129,10 +129,9 @@ module Ronin
       #
       def update
         each do |repo|
-          begin
-            repo.update
-          rescue CommandFailed
-          end
+          repo.update
+        rescue CommandFailed
+          # ignore any `git` errors when updating
         end
       end
 

data/lib/ronin/repos/class_dir.rb

@@ -33,12 +33,12 @@ module Ronin
     #
     #     require 'ronin/core/module_registry'
     #     require 'ronin/repos/class_dir'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         include Ronin::Core::ClassRegistry
     #         include Ronin::Repos::ClassDir
-    #     
+    #
     #         class_dir "#{__dir__}/classes"
     #         repo_class_dir "exploits"
     #       end
@@ -49,11 +49,11 @@ module Ronin
     #     module Ronin
     #       module Exploits
     #         class Exploit
-    #     
+    #
     #           def self.register(name)
     #             Exploits.register(name,self)
     #           end
-    #     
+    #
     #         end
     #       end
     #     end
@@ -61,13 +61,13 @@ module Ronin
     # `~/.cache/ronin-repos/repo1/exploits/my_exploit.rb`:
     #
     #     require 'ronin/exploits/exploit'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         class MyExploit < Exploit
-    #     
+    #
     #           register 'my_exploit'
-    #     
+    #
     #         end
     #       end
     #     end
@@ -88,6 +88,9 @@ module Ronin
         namespace.extend ClassMethods
       end
 
+      #
+      # Class-methods.
+      #
       module ClassMethods
         #
         # Gets or sets the repository module directory name.
@@ -97,7 +100,7 @@ module Ronin
         #
         # @return [String]
         #   The repository module directory name.
-        # 
+        #
         # @raise [NotImplementedError]
         #   The `repo_class_dir` method was not defined in the module.
         #
@@ -117,13 +120,16 @@ module Ronin
         # {#repo_class_dir} across all installed repositories.
         #
         # @return [Array<String>]
-        # 
+        #
         def list_files
           modules = Set.new(super)
-          pattern = File.join(repo_class_dir,"{**/}*.rb") 
+          pattern = File.join(repo_class_dir,"{**/}*.rb")
+
+          # the String#slice range to remove the repo_class_dir/ and .rb ext
+          slice_range = (repo_class_dir.length + 1)...-3
 
           Repos.list_files(pattern).each do |path|
-            modules << path.chomp('.rb')
+            modules << path.slice(slice_range)
           end
 
           return modules.to_a

data/lib/ronin/repos/cli/command.rb

@@ -24,6 +24,9 @@ require 'ronin/core/cli/command'
 module Ronin
   module Repos
     class CLI
+      #
+      # Base command for all `ronin-repos` commands.
+      #
       class Command < Core::CLI::Command
 
         man_dir File.join(ROOT,'man')
@@ -39,8 +42,7 @@ module Ronin
                              @cache_dir = CacheDir.new(dir)
                            end
 
-
-        # The ronin-repos cache directory.
+        # The `ronin-repos` cache directory.
         #
         # @return [CacheDir]
         attr_reader :cache_dir

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

@@ -18,6 +18,8 @@
 
 require 'ronin/repos/cli/command'
 
+require 'ronin/core/cli/logging'
+
 module Ronin
   module Repos
     class CLI
@@ -40,6 +42,8 @@ module Ronin
         #
         class Install < Command
 
+          include Core::CLI::Logging
+
           usage '[options] URI'
 
           argument :uri, required: true,
@@ -58,7 +62,7 @@ module Ronin
           #
           def run(uri)
             log_info "Installing repository from #{uri} ..."
-            cache_dir.download(uri)
+            cache_dir.install(uri)
           rescue CommandFailed => error
             print_error(error.message)
             exit(-1)

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

@@ -63,7 +63,7 @@ module Ronin
           #   The path to the new repo directory to create.
           #
           def run(path)
-            @name = File.basename(path)
+            @name        = File.basename(path)
             @github_user = Core::Git.github_user || ENV['USER']
 
             mkdir path

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

@@ -22,12 +22,27 @@ module Ronin
   module Repos
     class CLI
       module Commands
+        #
+        # The `ronin-repos purge` command.
+        #
+        # ## Usage
+        #
+        #     ronin-repos purge [options]
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
         class Purge < Command
 
           description 'Removes all git repository from the cache directory'
 
           man_page 'ronin-repos-download.1'
 
+          #
+          # Runs the `ronin-repos purge` command.
+          #
           def run
             cache_dir.purge
           end

data/lib/ronin/repos/exceptions.rb

@@ -21,13 +21,13 @@ module Ronin
     class Exception < RuntimeError
     end
 
-    class RepositoryNotFound < Exception
+    class RepositoryNotFound < Repos::Exception
     end
 
-    class CommandNotInstalled < Exception
+    class CommandNotInstalled < Repos::Exception
     end
 
-    class CommandFailed < Exception
+    class CommandFailed < Repos::Exception
     end
   end
 end

data/lib/ronin/repos/repository.rb

@@ -66,7 +66,7 @@ module Ronin
       # Clones a repository.
       #
       # @param [String, URI::HTTPS] uri
-      #   The `https://` or `git@HOST:PATH` SSH URI 
+      #   The `https://` or `git@HOST:PATH` SSH URI
       #
       # @param [String] path
       #   The path to where the repository will be cloned to.
@@ -109,7 +109,7 @@ module Ronin
       # path.
       #
       # @param [String, URI::HTTPS] uri
-      #   The `https://` or `git@HOST:PATH` SSH URI 
+      #   The `https://` or `git@HOST:PATH` SSH URI
       #
       # @param [String] path
       #   The path to where the repository will be cloned to.
@@ -304,7 +304,7 @@ module Ronin
       #
       def glob(pattern,&block)
         path    = join(pattern)
-        matches = Dir.glob(path).sort
+        matches = Dir.glob(path)
 
         if block then matches.each(&block)
         else          matches

data/lib/ronin/repos/version.rb

@@ -19,6 +19,6 @@
 module Ronin
   module Repos
     # ronin-repos version
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/ronin/repos.rb

@@ -25,7 +25,7 @@ module Ronin
   # @api public
   #
   module Repos
-    @@cache_dir = CacheDir.new
+    @cache_dir = CacheDir.new
 
     #
     # Finds the first matching file.
@@ -42,7 +42,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 +62,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 +75,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-install.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -21,25 +21,29 @@ The URI to the git repository\.
 .SH OPTIONS
 .LP
 .TP
+\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.LP
+.TP
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
-Installation directory for all repositories\.
+\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
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
 .LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
+.SH FILES
 .LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
+.TP
+\fB~/.cache/ronin-repos/\fR
+Installation directory for all repositories\.
 .LP
 .SH EXAMPLES
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
 
 ## SYNOPSIS
 
@@ -15,22 +15,25 @@ Downloads a repository.
 
 ## OPTIONS
 
+`-C`, `--cache-dir` *DIR*
+  Overrides the default cache directory.
+
 `-h`, `--help`
   Prints help information.
 
-## FILES
-
-*~/.cache/ronin-repos/*
-	Installation directory for all repositories.
-
 ## ENVIRONMENT
 
-HOME
+*HOME*
 	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+	`~/.cache/ronin-repos` cache directory within the home directory.
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+*XDG_CACHE_HOME*
+  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+
+## FILES
+
+`~/.cache/ronin-repos/`
+	Installation directory for all repositories.
 
 ## EXAMPLES
 

data/man/ronin-repos-list.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -21,25 +21,29 @@ The optional repository name to only list\.
 .SH OPTIONS
 .LP
 .TP
+\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.LP
+.TP
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
-Installation directory for repositories\.
+\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
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
 .LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
+.SH FILES
 .LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
+.TP
+\fB~/.cache/ronin-repos\fR
+Installation directory for repositories\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
 
 ## SYNOPSIS
 
@@ -15,22 +15,25 @@ Lists all downloaded repositories.
 
 ## OPTIONS
 
+`-C`, `--cache-dir` *DIR*
+  Overrides the default cache directory.
+
 `-h`, `--help`
   Prints help information.
 
-## FILES
-
-*~/.cache/ronin-repos*
-	Installation directory for repositories.
-
 ## ENVIRONMENT
 
-HOME
+*HOME*
 	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+	`~/.cache/ronin-repos` cache directory within the home directory.
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+*XDG_CACHE_HOME*
+  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+
+## FILES
+
+`~/.cache/ronin-repos`
+	Installation directory for repositories.
 
 ## AUTHOR
 

data/man/ronin-repos-new.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-new 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -21,6 +21,10 @@ The path to the new git repository directory\.
 .SH OPTIONS
 .LP
 .TP
+\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.LP
+.TP
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP

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

@@ -0,0 +1,30 @@
+# ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
+
+## SYNOPSIS
+
+`ronin-repos new` [*options*] *PATH*
+
+## DESCRIPTION
+
+Generates a new git repository.
+
+## ARGUMENTS
+
+*PATH*
+  The path to the new git repository directory.
+
+## OPTIONS
+
+`-C`, `--cache-dir` *DIR*
+  Overrides the default cache directory.
+
+`-h`, `--help`
+  Prints help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-repos(1) ronin-repos-list(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)

data/man/ronin-repos-purge.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -15,6 +15,10 @@ Removes all installed repositories\.
 .SH OPTIONS
 .LP
 .TP
+\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.LP
+.TP
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP
@@ -24,22 +28,22 @@ Prints help information\.
 \fBronin-repo purge\fR
 Removes all installed repositories\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
-Installation directory for all repositories\.
+\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
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
 .LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
+.SH FILES
 .LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
+.TP
+\fB~/.cache/ronin-repos/\fR
+Installation directory for all repositories\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
 
 ## SYNOPSIS
 
@@ -10,6 +10,9 @@ Removes all installed repositories.
 
 ## OPTIONS
 
+`-C`, `--cache-dir` *DIR*
+  Overrides the default cache directory.
+
 `-h`, `--help`
   Prints help information.
 
@@ -18,19 +21,19 @@ Removes all installed repositories.
 `ronin-repo purge`
 	Removes all installed repositories.
 
-## FILES
-
-*~/.cache/ronin-repos/*
-	Installation directory for all repositories.
-
 ## ENVIRONMENT
 
-HOME
+*HOME*
 	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+	`~/.cache/ronin-repos` cache directory within the home directory.
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+*XDG_CACHE_HOME*
+  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+
+## FILES
+
+`~/.cache/ronin-repos/`
+	Installation directory for all repositories.
 
 ## AUTHOR
 

data/man/ronin-repos-remove.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -30,22 +30,22 @@ Prints help information\.
 \fBronin-repo remove repo\fR
 Removes the repository with with the name \fBrepo\fR\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
-Installation directory for all repositories\.
+\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
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
 .LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
+.SH FILES
 .LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
+.TP
+\fB~/.cache/ronin-repos/\fR
+Installation directory for all repositories\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
 
 ## SYNOPSIS
 
@@ -23,19 +23,19 @@ Removes a repository.
 `ronin-repo remove repo`
 	Removes the repository with with the name `repo`.
 
-## FILES
-
-*~/.cache/ronin-repos/*
-	Installation directory for all repositories.
-
 ## ENVIRONMENT
 
-HOME
+*HOME*
 	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+	`~/.cache/ronin-repos` cache directory within the home directory.
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+*XDG_CACHE_HOME*
+  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+
+## FILES
+
+`~/.cache/ronin-repos/`
+	Installation directory for all repositories.
 
 ## AUTHOR
 

data/man/ronin-repos-update.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -21,6 +21,10 @@ The optional repository name to only update\.
 .SH OPTIONS
 .LP
 .TP
+\fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
+Overrides the default cache directory\.
+.LP
+.TP
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP
@@ -34,22 +38,22 @@ Updates all installed repositories\.
 \fBronin update repo\fR
 Updates the specific repository named \fBrepo\fR\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
-Installation directory for all repositories\.
+\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
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
 .LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
+.SH FILES
 .LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
+.TP
+\fB~/.cache/ronin-repos/\fR
+Installation directory for all repositories\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
 
 ## SYNOPSIS
 
@@ -15,6 +15,9 @@ Updates all repositories or just one.
 
 ## OPTIONS
 
+`-C`, `--cache-dir` *DIR*
+  Overrides the default cache directory.
+
 `-h`, `--help`
   Prints help information.
 
@@ -26,19 +29,19 @@ Updates all repositories or just one.
 `ronin update repo`
 	Updates the specific repository named `repo`.
 
-## FILES
-
-*~/.cache/ronin-repos/*
-	Installation directory for all repositories.
-
 ## ENVIRONMENT
 
-HOME
+*HOME*
 	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+	`~/.cache/ronin-repos` cache directory within the home directory.
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+*XDG_CACHE_HOME*
+  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+
+## FILES
+
+`~/.cache/ronin-repos/`
+	Installation directory for all repositories.
 
 ## AUTHOR
 

data/man/ronin-repos.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
+.TH ronin-repos 1 "2023-02-01" Ronin Repos "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -19,22 +19,48 @@ and use any git repository containing Ruby code or other data\.
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP
-.SH FILES
+.SH COMMANDS
 .LP
 .TP
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
-Installation directory for repositories\.
+\fBinstall\fR
+Installs a 3rd\-party git repository\.
+.LP
+.TP
+\fBlist\fR, \fBls\fR
+Lists installed git repositories\.
+.LP
+.TP
+\fBnew\fR
+Generates a new git repository\.
+.LP
+.TP
+\fBpurge\fR
+Deletes all installed git repositories\.
+.LP
+.TP
+\fBremove\fR, \fBrm\fR
+Removes a previously installed git repository\.
+.LP
+.TP
+\fBupdate\fR, \fBup\fR
+Updates a previously installed git repository\.
 .LP
 .SH ENVIRONMENT
 .LP
-.PP
-HOME
+.TP
+\fIHOME\fP
 Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
+\fB~/.cache/ronin-repos\fR cache directory within the home directory\.
 .LP
-.PP
-XDG\[ru]CACHE\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
+.TP
+\fIXDG\[ru]CACHE\[ru]HOME\fP
+Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
+.LP
+.SH FILES
+.LP
+.TP
+\fB~/.cache/ronin-repos\fR
+Installation directory for repositories\.
 .LP
 .SH AUTHOR
 .LP

data/man/ronin-repos.1.md

@@ -1,4 +1,4 @@
-# ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
+# ronin-repos 1 "2023-02-01" Ronin Repos "User Manuals"
 
 ## SYNOPSIS
 
@@ -14,19 +14,39 @@ and use any git repository containing Ruby code or other data.
 `-h`, `--help`
   Prints help information.
 
-## FILES
+## COMMANDS
 
-*~/.cache/ronin-repos*
-	Installation directory for repositories.
+`install`
+  Installs a 3rd-party git repository.
+
+`list`, `ls`
+  Lists installed git repositories.
+
+`new`
+  Generates a new git repository.
+
+`purge`
+  Deletes all installed git repositories.
+
+`remove`, `rm`
+  Removes a previously installed git repository.
+
+`update`, `up`
+  Updates a previously installed git repository.
 
 ## ENVIRONMENT
 
-HOME
+*HOME*
 	Specifies the home directory of the user. Ronin will search for the
-	*~/.cache/ronin-repos* cache directory within the home directory.
+	`~/.cache/ronin-repos` cache directory within the home directory.
+
+*XDG_CACHE_HOME*
+  Specifies the cache directory to use. Defaults to `$HOME/.cache`.
 
-XDG_CACHE_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.cache*.
+## FILES
+
+`~/.cache/ronin-repos`
+	Installation directory for repositories.
 
 ## AUTHOR
 

data/ronin-repos.gemspec

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
 
@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.homepage    = gemspec['homepage']
   gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
-  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+  glob = ->(patterns) { gem.files & Dir[*patterns] }
 
   gem.files  = `git ls-files`.split($/)
   gem.files  = glob[gemspec['files']] if gemspec['files']
@@ -33,6 +33,7 @@ Gem::Specification.new do |gem|
   gem.executables = gemspec.fetch('executables') do
     glob['bin/*'].map { |path| File.basename(path) }
   end
+
   gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
   gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
@@ -47,7 +48,7 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = gemspec['required_rubygems_version']
   gem.post_install_message      = gemspec['post_install_message']
 
-  split = lambda { |string| string.split(/,\s*/) }
+  split = ->(string) { string.split(/,\s*/) }
 
   if gemspec['dependencies']
     gemspec['dependencies'].each do |name,versions|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-repos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ronin-core
@@ -53,6 +53,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".yardopts"
 - COPYING.txt
@@ -83,6 +84,7 @@ files:
 - man/ronin-repos-list.1
 - man/ronin-repos-list.1.md
 - man/ronin-repos-new.1
+- man/ronin-repos-new.1.md
 - man/ronin-repos-purge.1
 - man/ronin-repos-purge.1.md
 - man/ronin-repos-remove.1