ronin-core 0.1.3 → 0.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e61fdc08b8e215624863cd59c443f5b5e41c25d8cf6427df9b903aa2458fcb3
-  data.tar.gz: b2598fe308eeb283bbcfd6ec817bfb3c3c94f34e3d1fb93aac98d345078c1129
+  metadata.gz: 1cf7fd888aed1c83850fa7dcb18a6122de9e192272f111ce2fdc933fd463a4bb
+  data.tar.gz: 5b8cc281734f00f55be809eb46588233356e9209181981d6790fe2d028dfa144
 SHA512:
-  metadata.gz: 73d16460be02608e46d22de62311f45d1fc4b01c40fac304222fc90ae321a7cf57ff5a29663eee49ae0ea84c8106e3fd548db65d3b48b9879f445e7aaf597094
-  data.tar.gz: 8c6f88d8caac5a0f6af9a2838cae33a97a7796b66872c17dde4a225e9e2195451637d553db349a3eab3a16c238621b7c069f5a4f7cd1ce092250490785f2bdc6
+  metadata.gz: fb0eb0cfc052476dae0931b2a0860b6dfd68938a8d2ca7bbe73d62f77fdec3d13322a75f3d59a3fe2723554508e26af779dc3eb6e8c6a39c98adee6f65c78cfa
+  data.tar.gz: 619061f0b74ad0e03352d0d6a4b84081334f01cf100037b2366a7dad1f6d056a353dd4104bc9e2a90adb56b356751bbd7a67a577607f4ab9a70bbd04fdffa185

data/.rubocop.yml

@@ -21,3 +21,5 @@ Style/GlobalStdStream:
     - 'lib/ronin/core/cli/ruby_shell.rb'
     - 'spec/cli/ruby_shell_spec.rb'
 
+Layout/HeredocIndentation: { Exclude: ['lib/ronin/core/cli/banner.rb'] }
+Layout/ClosingHeredocIndentation: { Exclude: ['lib/ronin/core/cli/banner.rb'] }

data/ChangeLog.md

@@ -1,3 +1,27 @@
+### 0.2.0 / 2024-XX-XX
+
+* Require [command_kit] ~> 0.5.
+* Added the `mastodon:` keyword argument to {Ronin::Core::Metadata::Authors::ClassMethods#author}.
+* Added {Ronin::Core::Metadata::Authors::Author#mastodon}.
+* Added {Ronin::Core::Metadata::Authors::Author#mastodon_url}.
+* Added {Ronin::Core::OutputFormats}.
+* Added {Ronin::Core::OutputFormats::OutputFile}.
+* Added {Ronin::Core::OutputFormats::OutputDir}.
+* Added {Ronin::Core::System}.
+* Added {Ronin::Core::CLI::Banner}.
+* Added {Ronin::Core::CLI::Help::Banner}.
+* Added {Ronin::Core::CLI::CompletionCommand}.
+* Added {Ronin::Core::CLI::Printing::Params#param_usage}.
+* Print the new ASCII art banner in {Ronin::Core::CLI::RubyShell#start} and
+  {Ronin::Core::CLI::Shell.start}.
+* Added a default `quit` command to {Ronin::Core::CLI::CommandShell}.
+* Print the author's Mastodon profile URL in
+  {Ronin::Core::CLI::Printing::Metadata}.
+* Change the formatting of {Ronin::Core::CLI::Logging#log_warn} to output
+  ANSI bold-bright-yellow.
+* Change the formatting of {Ronin::Core::CLI::Logging#log_error} to output
+  ANSI bold-bright-red.
+
 ### 0.1.3 / 2024-06-19
 
 * Improved {Ronin::Core::ClassRegistry::ClassMethods#load_class_from_file}
@@ -31,3 +55,4 @@
     shells.
   * Provides a `Params` API for adding user configurable parameters to classes.
 
+[command_kit]: https://github.com/postmodern/command_kit.rb#readme

data/Gemfile

@@ -7,7 +7,7 @@ platform :jruby do
   gem 'jruby-openssl',	'~> 0.7'
 end
 
-# gem 'command_kit', '~> 0.4', github: 'postmodern/command_kit.rb',
+# gem 'command_kit', '~> 0.5', github: 'postmodern/command_kit.rb',
 #                              branch: 'main'
 
 group :development do

data/README.md

@@ -35,7 +35,7 @@ and development.
 
 * [Ruby] >= 3.0.0
 * [reline] ~> 0.1
-* [command_kit] ~> 0.4
+* [command_kit] ~> 0.5
 * [irb] ~> 1.0
 
 ## Install
@@ -274,7 +274,7 @@ http> post /foo var=bar
 
 ## License
 
-Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3@gmail.com)
+Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3@gmail.com)
 
 ronin-core is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published

data/gemspec.yml

@@ -21,7 +21,7 @@ required_ruby_version: ">= 3.0.0"
 
 dependencies:
   reline: ~> 0.1
-  command_kit: ~> 0.4
+  command_kit: ~> 0.5
   irb: ~> 1.0
 
 development_dependencies:

data/lib/ronin/core/class_registry.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-core 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/core/cli/banner.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Core
+    module CLI
+      #
+      # Adds a Ronin ASCII art banner to the `--help` output.
+      #
+      # @since 0.2.0
+      #
+      module Banner
+        # Ronin ASCII art banner.
+        BANNER = <<~ASCII
+                                                                   , Jµ     ▓▓█▓
+                                                  J▌      ▐▓██▌ ████ ██    ▐███D
+                                      ╓▄▓▓█████▌  ██µ     ████ ▄███ÖJ██▌   ███▌
+        ,╓µ▄▄▄▄▄▄▄▄µ;,            ,▄▓██████████  ▐███    ▐███▀ ███▌ ████µ ▄███
+¬∞MÆ▓███████████████████████▓M  ▄██████▀▀╙████▌  ████▌   ████ ▄███ J█████ ███▌
+           `█████▀▀▀▀▀███████  -████▀└    ████  ▐█████n ▄███O ███▌ ██████████
+           ▓████L       ████▀  ▓████     ▓███Ö  ███████ ███▌ ▓███ ▐█████████▀
+          ▄████▀  ,╓▄▄▄█████  J████Ü    ,███▌  ▄███████████ J███▀ ████ █████
+         J█████████████████─  ████▌     ████   ████`██████▌ ████ ▐███Ü ▐███Ü
+         ███████████▀▀▀╙└    ▐████     J███▌  ▓███▌ ²█████ J███Ü ███▌   ▀█▌
+        ▓██████████▌         ████▌     ████  ;████   ▀███▀ ███▌ J▀▀▀-    █
+       ▄█████▀ ▀█████µ      ▐████  ,▄▓████▀  ████▀    ███ J███           `
+      J█████-    ╙▀███▄     ████████████▀╙  J█▀▀▀      █U  ▀█▌
+      ████▀         ▀███   ▄████████▀▀                 ╨    █
+     ▓██▀             ²▀█▄ █▀▀▀╙└
+    ▄██╜                 ╙W
+   J█▀
+   ▌└
+  ┘
+ASCII
+
+        #
+        # Prints the Ronin banner.
+        #
+        def print_banner
+          print "#{BANNER}#{$/}"
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/command.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-core 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/core/cli/command_shell/command.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-core 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/core/cli/command_shell.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-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -246,6 +246,17 @@ module Ronin
           end
         end
 
+        command :quit, summary: 'Exits the shell'
+
+        #
+        # Quits the shell.
+        #
+        # @since 0.2.0
+        #
+        def quit
+          exit
+        end
+
         private
 
         #

data/lib/ronin/core/cli/completion_command.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/cli/command'
+
+require 'command_kit/completion/install'
+
+module Ronin
+  module Core
+    module CLI
+      #
+      # Common base class for all `ronin-* completion` commands.
+      #
+      # ## Example
+      #
+      #     # lib/ronin/foo/cli/commands/completion.rb
+      #     require 'ronin/foo/root'
+      #     require 'ronin/core/cli/completion_command'
+      #
+      #     module Ronin
+      #       module Foo
+      #         class CLI
+      #           class Command < Core::CLI::CompletionCommand
+      #
+      #             man_dir File.join(ROOT,'man')
+      #             man_page 'ronin-foo-completion.1'
+      #
+      #             completion_file File.join(ROOT,'data','completions','ronin-foo')
+      #
+      #           end
+      #         end
+      #       end
+      #     end
+      #
+      # @api semipublic
+      #
+      # @since 0.2.0
+      #
+      class CompletionCommand < Command
+
+        include CommandKit::Completion::Install
+
+        #
+        # Gets or sets the completion file for the `completion` command.
+        #
+        # @param [String, nil] new_completion_file
+        #   The optional path to the completion file.
+        #
+        # @return [String]
+        #   The completion file path.
+        #
+        # @raise [NotImplementedError]
+        #   The command did not set the `completion_file`.
+        #
+        # @example
+        #   completion_file File.join(ROOT,'data','completions','ronin-foo')
+        #
+        def self.completion_file(new_completion_file=nil)
+          if new_completion_file
+            @completion_file = new_completion_file
+          else
+            @completion_file || raise(NotImplementedError,"#{self} did not set completion_file")
+          end
+        end
+
+        command_name 'completion'
+
+        option :print, desc: 'Prints the shell completion file' do
+          @mode = :print
+        end
+
+        option :install, desc: 'Installs the shell completion file' do
+          @mode = :install
+        end
+
+        option :uninstall, desc: 'Uninstalls the shell completion file' do
+          @mode = :uninstall
+        end
+
+        examples [
+          '--print',
+          '--install',
+          '--uninstall'
+        ]
+
+        bug_report_url 'https://github.com/ronin-rb/ronin-core/issues/new'
+
+        # The command mode.
+        #
+        # @return [:print, :install, :uninstall]
+        attr_reader :mode
+
+        #
+        # Initializes the `completion` command.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for the command.
+        #
+        def initialize(**kwargs)
+          super(**kwargs)
+
+          @mode = :print
+        end
+
+        #
+        # The `completion` commands registered completion file.
+        #
+        # @return [String]
+        #   The completion file path.
+        #
+        # @raise [NotImplementedError]
+        #   The command did not set the `completion_file`.
+        #
+        def completion_file
+          self.class.completion_file
+        end
+
+        #
+        # Runs the `completion` command.
+        #
+        def run
+          if shell_type == :fish
+            print_error "shell completions for the fish shell are not currently supported"
+            exit(-1)
+          end
+
+          case @mode
+          when :print
+            print_completion_file
+          when :install
+            install_completion_file
+
+            if shell_type == :zsh
+              puts "Ensure that you have the following lines added to your ~/.zshrc:"
+              puts
+              puts "    autoload -Uz +X compinit && compinit"
+              puts "    autoload -Uz +X bashcompinit && bashcompinit"
+              puts
+            end
+          when :uninstall
+            uninstall_completion_file
+
+            puts "Completion rules successfully uninstalled. Please restart your shell."
+          else
+            raise(NotImplementedError,"mode not implemented: #{@mode.inspect}")
+          end
+        end
+
+        #
+        # Prints the `completion` command's {completion_file} to stdout.
+        #
+        # @param [String] completion_file
+        #   The path to the completion file to print.
+        #
+        # @api private
+        #
+        def print_completion_file(completion_file=self.completion_file)
+          super(completion_file)
+        end
+
+        #
+        # Installs the `completion` command's {completion_file} for the current
+        # `SHELL`.
+        #
+        # @param [String] completion_file
+        #   The path to the completion file to install.
+        #
+        # @api private
+        #
+        def install_completion_file(completion_file=self.completion_file)
+          super(completion_file)
+        end
+
+        #
+        # Uninstalls the `completion` command's {completion_file}.
+        #
+        # @param [String] completion_file
+        #   The path to the completion file to uninstall.
+        #
+        # @api private
+        #
+        def uninstall_completion_file(completion_file=self.completion_file)
+          uninstall_completion_file_for(File.basename(completion_file))
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/generator/options/author.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-core 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/core/cli/generator/options/description.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-core 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/core/cli/generator/options/reference.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-core 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/core/cli/generator/options/summary.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-core 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/core/cli/generator.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-core 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/core/cli/help/banner.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/cli/banner'
+
+module Ronin
+  module Core
+    module CLI
+      module Help
+        #
+        # Adds the Ronin ASCII art banner to the `--help` output.
+        #
+        # @since 0.2.0
+        #
+        module Banner
+          include CLI::Banner
+
+          #
+          # Prints the Ronin ASCII art banner and the `--help` output.
+          #
+          # @note
+          #   If `stdout` is not a TTY, the Ronin ASCII art banner will be
+          #   omitted.
+          #
+          def help
+            print_banner if stdout.tty?
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/logging.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-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -44,7 +44,7 @@ module Ronin
         #   The message to print.
         #
         def log_warn(message)
-          puts("#{colors.bold(colors.bright_yellow('***'))} #{colors.bold(colors.white(message))}")
+          puts("#{colors.bold(colors.bright_red('/!\\'))} #{colors.bold(colors.bright_yellow(message))}")
         end
 
         #
@@ -54,7 +54,7 @@ module Ronin
         #   The message to print.
         #
         def log_error(message)
-          stderr.puts("#{colors(stderr).bold(colors(stderr).bright_red('!!!'))} #{colors(stderr).bold(colors(stderr).white(message))}")
+          stderr.puts("#{colors(stderr).bold(colors(stderr).bright_red('!!!'))} #{colors(stderr).bold(colors(stderr).red(message))}")
         end
       end
     end

data/lib/ronin/core/cli/options/param.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)
 #
 # This file is part of ronin-core.
 #

data/lib/ronin/core/cli/options/values/arches.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-core 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/core/cli/options/values/oses.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-core 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/core/cli/printing/arch.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-core 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/core/cli/printing/metadata.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-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -55,13 +55,38 @@ module Ronin
                 indent do
                   klass.authors.each do |author|
                     puts "* #{author}"
-                    puts "  * PGP: #{author.pgp}"             if author.pgp?
-                    puts "  * Website: #{author.website}"     if author.website?
-                    puts "  * Blog: #{author.blog}"           if author.blog?
-                    puts "  * GitHub: #{author.github_url}"   if author.github?
-                    puts "  * GitLab: #{author.gitlab_url}"   if author.gitlab?
-                    puts "  * Twitter: #{author.twitter_url}" if author.twitter?
-                    puts "  * Discord: #{author.discord}"     if author.discord?
+
+                    if author.pgp?
+                      puts "  * PGP: #{author.pgp}"
+                    end
+
+                    if author.website?
+                      puts "  * Website: #{author.website}"
+                    end
+
+                    if author.blog?
+                      puts "  * Blog: #{author.blog}"
+                    end
+
+                    if author.github?
+                      puts "  * GitHub: #{author.github_url}"
+                    end
+
+                    if author.gitlab?
+                      puts "  * GitLab: #{author.gitlab_url}"
+                    end
+
+                    if author.twitter?
+                      puts "  * Twitter: #{author.twitter_url}"
+                    end
+
+                    if author.mastodon?
+                      puts "  * Mastodon: #{author.mastodon_url}"
+                    end
+
+                    if author.discord?
+                      puts "  * Discord: #{author.discord}"
+                    end
                   end
                 end
               else

data/lib/ronin/core/cli/printing/os.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-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published