ronin-core 0.1.0.beta1 → 0.1.1

data/lib/ronin/core/cli/generator/options/description.rb

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

data/lib/ronin/core/cli/generator/options/reference.rb

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

data/lib/ronin/core/cli/generator/options/summary.rb

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

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -31,17 +31,17 @@ module Ronin
       # ## Example
       #
       #   class Gen < Command
-      #   
+      #
       #     include Core::Generator
-      #   
+      #
       #     template_dir File.join(ROOT,'data','templates')
-      #   
+      #
       #     argument :path, desc: 'The path of the script to genereate'
-      #   
+      #
       #     def run(path)
       #       erb 'script.rb.erb', path
       #     end
-      #   
+      #
       #   end
       #
       module Generator
@@ -59,6 +59,9 @@ module Ronin
           command.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the template directory.

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -21,6 +21,9 @@ require 'command_kit/colors'
 module Ronin
   module Core
     module CLI
+      #
+      # Helper methods for printing log messages.
+      #
       module Logging
         include CommandKit::Colors
 

data/lib/ronin/core/cli/options/param.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-core.
 #
@@ -8,12 +8,12 @@
 # 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/>.
 #
@@ -35,8 +35,8 @@ module Ronin
           def self.included(command)
             command.option :param, short: '-p',
                                    value: {
-                                     type: /\A[^=]+=.+\z/,
-                                     usage: 'NAME=VALUE',
+                                     type:  /\A[^=]+=.+\z/,
+                                     usage: 'NAME=VALUE'
                                    },
                                    desc: 'Sets a param' do |str|
                                      name, value = str.split('=',2)

data/lib/ronin/core/cli/options/values/arches.rb

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

data/lib/ronin/core/cli/options/values/oses.rb

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

data/lib/ronin/core/cli/printing/arch.rb

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

data/lib/ronin/core/cli/printing/metadata.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -32,7 +32,7 @@ module Ronin
           include CommandKit::Printing::Lists
 
           #
-          # Addss a `-v,--verbose` option to the command class.
+          # Adds a `-v,--verbose` option to the command class.
           #
           # @param [Class<Command>] command
           #   The command class including {Metadata}.

data/lib/ronin/core/cli/printing/os.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -20,6 +20,9 @@ module Ronin
   module Core
     module CLI
       module Printing
+        #
+        # Helper methods for printing Operating System (OS) names.
+        #
         module OS
           # Mapping of Operating System (OS) IDs to printable names.
           OS_NAMES = {

data/lib/ronin/core/cli/printing/params.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -45,10 +45,10 @@ module Ronin
             rows = []
 
             klass.params.each do |name,param|
-              param_type = param.type.class.name.split('::').last
-              required   = if param.required? then 'Yes'
-                           else                    'No'
-                           end
+              param_type  = param.type.class.name.split('::').last
+              required    = if param.required? then 'Yes'
+                            else                    'No'
+                            end
               default     = param.default_value
               description = param.desc
 

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -121,6 +121,7 @@ module Ronin
               PROMPT_C: "#{prompt_prefix}* ",
               RETURN:   "=> %s#{$/}"
             }
+
             IRB.conf[:PROMPT_MODE] = :RONIN
           end
         end

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -23,6 +23,9 @@ require 'reline'
 module Ronin
   module Core
     module CLI
+      #
+      # Base class for all interactive CLI shells.
+      #
       class Shell
 
         include CommandKit::Printing
@@ -61,7 +64,7 @@ module Ronin
             @prompt_sigil = new_sigil
           else
             @prompt_sigil ||= if superclass <= Shell
-                              superclass.prompt_sigil
+                                superclass.prompt_sigil
                               end
           end
         end
@@ -83,12 +86,12 @@ module Ronin
         def self.start(*arguments,**kwargs)
           shell = new(*arguments,**kwargs)
 
+          prev_completion_proc   = Reline.completion_proc
           Reline.completion_proc = shell.method(:complete)
-          use_history = true
 
           begin
             loop do
-              line = Reline.readline("#{shell.prompt} ", use_history)
+              line = Reline.readline("#{shell.prompt} ", true)
 
               if line.nil? # Ctrl^D
                 puts
@@ -100,6 +103,8 @@ module Ronin
               unless line.empty?
                 begin
                   shell.exec(line)
+                rescue Interrupt
+                  # catch Ctrl^C but keep reading input
                 rescue SystemExit
                   break
                 rescue => error
@@ -107,7 +112,10 @@ module Ronin
                 end
               end
             end
-          rescue Interrupt # catch Ctrl^C
+          rescue Interrupt
+            # catch Ctrl^C and return
+          ensure
+            Reline.completion_proc = prev_completion_proc
           end
         end
 
@@ -118,7 +126,7 @@ module Ronin
         #   The partial input being tab completed.
         #
         # @param [String] preposing
-        #   The optional command name that preceeds the argument that's being
+        #   The optional command name that precedes the argument that's being
         #   tab completed.
         #
         # @return [Array<String>, nil]

data/lib/ronin/core/git.rb

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

data/lib/ronin/core/home.rb

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

data/lib/ronin/core/metadata/authors/author.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -20,6 +20,9 @@ module Ronin
   module Core
     module Metadata
       module Authors
+        #
+        # Represents author metadata.
+        #
         class Author
 
           # The author's name.

data/lib/ronin/core/metadata/authors.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -28,12 +28,12 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::Authors
-      #     
+      #
       #       author 'John Doe'
       #       author 'John Smith', email: 'john.smith@example.com'
-      #     
+      #
       #     end
       #
       #     puts MyModule.authors
@@ -53,6 +53,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # The authors associated with the class.

data/lib/ronin/core/metadata/description.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2023 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/>.
 #
@@ -26,9 +26,9 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::Description
-      #     
+      #
       #       description <<~DESC
       #         Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
       #         eiusmod tempor incididunt ut labore et dolore magna aliqua.
@@ -41,7 +41,7 @@ module Ronin
       #         proident, sunt in culpa qui officia deserunt mollit anim id est
       #         laborum.
       #       DESC
-      #     
+      #
       #     end
       #
       module Description
@@ -57,6 +57,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the description.