ronin-repos 0.1.0.beta1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cdb6ec92ec228ed94c0dffd11a4bf18deed273cc583d2f004a14def0350d1cf
-  data.tar.gz: 654d9319ac2ef706f48ae1b857578869e966a182c2f714123bc860fd2a33c0d8
+  metadata.gz: 5f165cb9c5c8eda828d18f33114a9407ccae14fb6d5a7edc84fbc5159ba26aad
+  data.tar.gz: 6518e8a7dc2b29c778bf82d8ce32efc692e85b0d3ab108f3575724181b689bd4
 SHA512:
-  metadata.gz: a5620e26ab2f1bbcda24a33859191a75217e07c8ff7666597ec0278147f26988cc15c569efd4eec3dabf954821e3d2dc8cf2f06b90a38223683a66e6ac4b2159
-  data.tar.gz: d4660c329f3674884c038bae87529d3e89f39e0c675f6584802cf504d83feb476dc5485e4619123a4bd7c05d9e4ed71a420ba87a1356da7aea0e9678d369bb88
+  metadata.gz: 0a827887a127c7a8165087e71cd3e8098b154f1ecd72dd0136f66ef640562db59a401ded921ac74877a981974ab16570cc431850f12f8d184291b5834c9d998d
+  data.tar.gz: 4c6e43043c8a93b69b0f55a1a8016e6014e4343b338b90b9a85d6cc9477b93f8c413d5e3d98bf71bf39115731a13bdfc4e3a46e2d40aa9302029089edf502b6c

data/.github/workflows/ruby.yml

@@ -21,7 +21,22 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Install dependencies
         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/.yardopts

@@ -1 +1 @@
---markup markdown --title 'Ronin Repos Documentation' --protected
+--markup markdown --title 'Ronin::Repos Documentation' --protected

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/README.md

@@ -2,6 +2,7 @@
 
 [![CI](https://github.com/ronin-rb/ronin-repos/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-repos/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-repos.svg)](https://codeclimate.com/github/ronin-rb/ronin-repos)
+[![Gem Version](https://badge.fury.io/rb/ronin-repos.svg)](https://badge.fury.io/rb/ronin-repos)
 
 * [Website](https://ronin-rb.dev)
 * [Source](https://github.com/ronin-rb/ronin-repos)
@@ -137,7 +138,7 @@ gem 'ronin-repos', '~> 0.1'
 
 ## License
 
-Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+Copyright (c) 2021-2023 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/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,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-repos.
 #
@@ -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/gemspec.yml

@@ -11,7 +11,7 @@ homepage: https://ronin-rb.dev
 has_yard: true
 
 metadata:
-  documentation_uri: https://rubydoc.info/gems/ronin-repos
+  documentation_uri: https://ronin-rb.dev/docs/ronin-repos
   source_code_uri:   https://github.com/ronin-rb/ronin-repos
   bug_tracker_uri:   https://github.com/ronin-rb/ronin-repos/issues
   changelog_uri:     https://github.com/ronin-rb/ronin-repos/blob/main/ChangeLog.md
@@ -30,7 +30,7 @@ required_ruby_version: ">= 3.0.0"
 
 dependencies:
   # Library dependencies:
-  ronin-core: ~> 0.1.0.beta1
+  ronin-core: ~> 0.1
 
 development_dependencies:
   bundler: ~> 2.0

data/lib/ronin/repos/cache_dir.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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/list.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/cli/commands/new.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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/cli/commands/remove.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/cli/commands/update.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -16,8 +16,11 @@
 # along with ronin-repos.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require 'ronin/repos/version'
+
 require 'command_kit/commands'
 require 'command_kit/commands/auto_load'
+require 'command_kit/options/version'
 
 module Ronin
   module Repos
@@ -33,8 +36,10 @@ module Ronin
         dir:       "#{__dir__}/cli/commands",
         namespace: "#{self}::Commands"
       )
+      include CommandKit::Options::Version
 
       command_name 'ronin-repos'
+      version Ronin::Repos::VERSION
 
       command_aliases['ls'] = 'list'
       command_aliases['up'] = 'update'

data/lib/ronin/repos/exceptions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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
@@ -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/root.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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.0.beta1'
+    VERSION = '0.1.1'
   end
 end

data/lib/ronin/repos.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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,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