ronin-core 0.1.0 → 0.1.1

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

@@ -6,12 +6,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/>.
 #
@@ -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

@@ -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

@@ -6,12 +6,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/>.
 #

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

@@ -6,12 +6,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/>.
 #

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

@@ -6,12 +6,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/>.
 #

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

@@ -6,12 +6,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/>.
 #

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

@@ -6,12 +6,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/>.
 #
@@ -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

@@ -6,12 +6,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/>.
 #
@@ -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

@@ -6,12 +6,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/>.
 #
@@ -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

@@ -6,12 +6,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/>.
 #
@@ -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
 

data/lib/ronin/core/git.rb

@@ -6,12 +6,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/>.
 #

data/lib/ronin/core/home.rb

@@ -6,12 +6,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/>.
 #

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

@@ -6,12 +6,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/>.
 #
@@ -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

@@ -6,12 +6,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/>.
 #
@@ -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

@@ -6,12 +6,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/>.
 #
@@ -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.

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

@@ -6,12 +6,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/>.
 #
@@ -25,13 +25,13 @@ module Ronin
       # ### Example
       #
       #     class MyClass
-      #     
+      #
       #       include Ronin::Core::Metadata::ID
       #
       #       id 'my_class'
       #
       #     end
-      #     
+      #
       module ID
         #
         # Adds {ClassMethods} to the class.
@@ -45,6 +45,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the class `id`.

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

@@ -6,12 +6,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/>.
 #
@@ -26,14 +26,14 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::References
-      #     
+      #
       #       references [
       #         "https://...",
       #         ...
       #       ]
-      #     
+      #
       #     end
       #
       module References
@@ -49,6 +49,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the reference links.
@@ -71,7 +74,11 @@ module Ronin
           #
           def references(new_references=nil)
             if new_references
-              @references = references() + new_references
+              @references = if superclass.kind_of?(ClassMethods)
+                              superclass.references + new_references
+                            else
+                              new_references
+                            end
             else
               @references || if superclass.kind_of?(ClassMethods)
                                superclass.references

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

@@ -6,12 +6,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/>.
 #
@@ -26,11 +26,11 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::Summary
-      #     
+      #
       #       summary "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
-      #     
+      #
       #     end
       #
       module Summary
@@ -46,6 +46,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the summary.
@@ -57,7 +60,7 @@ module Ronin
           #   The previously set summary text.
           #
           # @example Setting the summary:
-          #   summary "Lorem ipsum dolor sit amet, consectetur adipiscing elit" 
+          #   summary "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
           #
           # @example Getting the summary:
           #   MyModule.summary
@@ -67,7 +70,7 @@ module Ronin
               @summary = new_summary
             else
               @summary || if superclass.kind_of?(ClassMethods)
-                                superclass.summary
+                            superclass.summary
                           end
             end
           end

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

@@ -6,12 +6,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/>.
 #
@@ -26,11 +26,11 @@ module Ronin
       # ### Example
       #
       #     class MyModule
-      #     
+      #
       #       include Ronin::Core::Metadata::Version
-      #     
+      #
       #       version '0.2'
-      #     
+      #
       #     end
       #
       module Version
@@ -46,6 +46,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class methods.
+        #
         module ClassMethods
           #
           # Gets or sets the version number.

data/lib/ronin/core/params/exceptions.rb

@@ -6,12 +6,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/>.
 #