ronin-core 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2f5f5f7d2a3a576e4dc446c47092a671360298a4ae31ecfb3d1ccc37b5661b6
-  data.tar.gz: 9006bd12c0be7cd0e9fe26eeefd0518c96810c600eb8a3e4e65915292d641fe1
+  metadata.gz: 632034dea1307157efadc601fa99bfb2b1eaf3cf81506392f2a68733d68645d4
+  data.tar.gz: 32f82f08f6692163e22f55ecc37666e2cc1655e37127bd578009fed61a3b4cbe
 SHA512:
-  metadata.gz: 653896adb82564b360c89a40bbc0ce74563ea8adb9db1d91e806bf7fb48555eafcc5cb807b6753b098e529a663c39ffbdfa01298c99bd49e5254c89f24d3ccf8
-  data.tar.gz: 7c989f9aed0758ce9ddee625ec35337129e283e6e6b6e5403f6f041e1595915283ba572810cf169e9cbf73c13a6b5e38b522406b4f7d825f9ff10dd377079659
+  metadata.gz: cba7b2829ba506c61c028d6961a5040b026640a3f60d46f2cdbf96649b6de4385a07d171835ab19e687837e9936bc757a832cd58ca71217e2d186433fdfcb3ab
+  data.tar.gz: 64684f9aa1a7e46348b1596ed941b2056c0262806c5310a17991f6e2e43de179dd9d9988315f55a03be079f26b3f8452ec3f009ef09a3f58d236f9b4e8a238f0

data/.rubocop.yml

@@ -3,158 +3,21 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 3.1
 
-#
-# our rules
-#
-
-Layout/FirstArrayElementIndentation: { Exclude: ['spec/**/*'] }
-Layout/LineLength: { Enabled: false }
-Layout/SpaceAroundEqualsInParameterDefault: { EnforcedStyle: no_space }
-Lint/ConstantDefinitionInBlock: { Exclude: ['spec/**/*'] }
-Metrics: { Enabled: false }
-Style/SymbolArray: { EnforcedStyle: brackets }
-Style/IfInsideElse: { Enabled: false } # Offense count: 1
-Style/PercentLiteralDelimiters:
-  Enabled: true
-  PreferredDelimiters:
-    default: '{}'
-    '%i': '[]'
-    '%I': '[]'
-    '%w': '[]'
-    '%W': '[]'
-Style/UnlessElse: { Enabled: false }
-Bundler/OrderedGems: { Enabled: false }
-Style/CaseEquality: { Exclude: ['lib/ronin/web/server/conditions.rb'] }
-Style/Next: { Enabled: false }
-Style/HashSyntax: { Enabled: false }
-Naming/BlockForwarding: { Enabled: false }
-Lint/ReturnInVoidContext: { Enabled: false }
-Gemspec/DeprecatedAttributeAssignment: { Enabled: false }
-Style/MixinUsage: { Enabled: false }
-Naming/VariableNumber: { Enabled: false }
-Naming/PredicateName: { Enabled: false }
-Style/FetchEnvVar: { Enabled: false }
-Layout/RescueEnsureAlignment: { Enabled: false }
-Layout/BeginEndAlignment: { Enabled: false }
-Layout/EmptyLineAfterMagicComment: { Enabled: false }
-
-#
-# rules that are in flux
-#
-
-# consider enabling these and autocorrecting?
-# Layout/SpaceAfterComma
-# Layout/SpaceAroundKeyword
-# Layout/SpaceBeforeComma
-# Layout/SpaceInsideHashLiteralBraces
-# Layout/SpaceInsideParens
-# Layout/TrailingWhitespace
-# Lint/UnreachableLoop
-# Lint/UnusedBlockArgument
-# Style/ClassCheck
-# Style/Documentation
-# Style/ExpandPathArguments
-# Style/GlobalStdStream
-# Style/HashSyntax
-# Style/KeywordParametersOrder
-# Style/MethodCallWithoutArgsParentheses
-# Style/MutableConstant
-# Style/QuotedSymbols: { EnforcedStyle: double_quotes }
-# Style/RedundantReturn
-# Style/SafeNavigation
-# Style/SpecialGlobalVars
-# Style/StringLiterals: { EnforcedStyle: double_quotes }
-# Style/WordArray
-
-# these have been fixed
-# Gemspec/DuplicatedAssignment: { Enabled: false } # Offense count: 1
-# Layout/ElseAlignment: { Enabled: false } # Offense count: 1
-# Layout/EndAlignment: { Enabled: false } # Offense count: 1
-# Lint/DuplicateMethods: { Enabled: false } # Offense count: 1
-# Lint/UselessAssignment: { Enabled: false } # Offense count: 1
-# Style/Encoding: { Enabled: false } # Offense count: 2
-# Style/RedundantBegin: { Enabled: false } # Offense count: 2
-# Style/RedundantInterpolation: { Enabled: false } # Offense count: 1
-# Style/TrailingCommaInArrayLiteral: { Enabled: false } # Offense count: 1
+inherit_gem:
+  rubocop-ronin: rubocop.yml
 
 #
-# This list was generated with:
-# bundle exec rubocop --auto-gen-config --exclude-limit 1
+# ronin-core specific exceptions
 #
+Lint/MissingSuper: { Exclude: ['lib/ronin/core/params/types/*.rb'] }
+Style/CaseEquality: { Exclude: ['lib/ronin/web/server/conditions.rb'] }
+Style/EmptyMethod:
+  Exclude:
+    - 'lib/ronin/core/cli/shell.rb'
+    - 'spec/**/*'
 
-# > 10 violations
-Layout/AssignmentIndentation: { Enabled: false } # Offense count: 11
-Layout/EmptyLinesAroundClassBody: { Enabled: false } # Offense count: 76
-Layout/HashAlignment: { Enabled: false } # Offense count: 28
-Layout/SpaceAfterComma: { Enabled: false } # Offense count: 141
-Layout/SpaceInsideHashLiteralBraces: { Enabled: false } # Offense count: 57
-Layout/TrailingWhitespace: { Enabled: false } # Offense count: 50
-Naming/RescuedExceptionsVariableName: { Enabled: false } # Offense count: 11
-Style/BlockDelimiters: { Enabled: false } # Offense count: 17
-Style/ClassCheck: { Enabled: false } # Offense count: 10
-Style/ClassEqualityComparison: { Enabled: false } # Offense count: 16
-Style/FrozenStringLiteralComment: { Enabled: false } # Offense count: 77
-Style/GlobalStdStream: { Enabled: false } # Offense count: 13
-Style/GuardClause: { Enabled: false } # Offense count: 10
-Style/IfUnlessModifier: { Enabled: false } # Offense count: 13
-Style/MethodCallWithoutArgsParentheses: { Enabled: false } # Offense count: 10
-Style/SpecialGlobalVars: { Enabled: false } # Offense count: 28
-Style/StringLiterals: { Enabled: false } # Offense count: 774
-Lint/ElseLayout: { Enabled: false } # Offense count: 22
-
-# < 10 violations
-Layout/EmptyLinesAroundModuleBody: { Enabled: false } # Offense count: 5
-Layout/ExtraSpacing: { Enabled: false } # Offense count: 6
-Layout/FirstHashElementIndentation: { Enabled: false } # Offense count: 4
-Layout/ParameterAlignment: { Enabled: false } # Offense count: 9
-Layout/SpaceAroundKeyword: { Enabled: false } # Offense count: 7
-Layout/SpaceBeforeComma: { Enabled: false } # Offense count: 4
-Layout/SpaceInsideParens: { Enabled: false } # Offense count: 4
-Lint/EmptyClass: { Enabled: false } # Offense count: 3
-Lint/SuppressedException: { Enabled: false } # Offense count: 4
-Lint/UnusedMethodArgument: { Enabled: false } # Offense count: 5
-Style/AccessorGrouping: { Enabled: false } # Offense count: 7
-Style/Documentation: { Enabled: false } # Offense count: 3
-Style/ExpandPathArguments: { Enabled: false } # Offense count: 8
-Style/KeywordParametersOrder: { Enabled: false } # Offense count: 8
-Style/Lambda: { Enabled: false } # Offense count: 3
-Style/MutableConstant: { Enabled: false } # Offense count: 4
-Style/RaiseArgs: { Enabled: false } # Offense count: 4
-Style/RedundantReturn: { Enabled: false } # Offense count: 7
-Style/SafeNavigation: { Enabled: false } # Offense count: 5
-Style/StringConcatenation: { Enabled: false } # Offense count: 8
-Style/WordArray: { Enabled: false } # Offense count: 4
-
-# 1 or 2 violations
-Layout/ArgumentAlignment: { Enabled: false } # Offense count: 1
-Layout/BlockAlignment: { Enabled: false } # Offense count: 1
-Layout/IndentationWidth: { Enabled: false } # Offense count: 2
-Layout/SpaceAroundOperators: { Enabled: false } # Offense count: 1
-Layout/SpaceBeforeBlockBraces: { Enabled: false } # Offense count: 1
-Lint/MissingSuper: { Enabled: false } # Offense count: 2
-Lint/RescueException: { Enabled: false } # Offense count: 1
-Lint/UnreachableLoop: { Enabled: false } # Offense count: 1
-Lint/UnusedBlockArgument: { Enabled: false } # Offense count: 1
-Naming/MethodParameterName: { Enabled: false } # Offense count: 1
-Style/EmptyMethod: { Enabled: false } # Offense count: 2
-Style/HashConversion: { Enabled: false } # Offense count: 1
-Style/MultilineMemoization: { Enabled: false } # Offense count: 1
-Style/NumericPredicate: { Enabled: false } # Offense count: 1
-Style/OptionalArguments: { Enabled: false } # Offense count: 1
-Style/ParenthesesAroundCondition: { Enabled: false } # Offense count: 1
-Style/PreferredHashMethods: { Enabled: false } # Offense count: 1
-Style/QuotedSymbols: { Enabled: false } # Offense count: 1
-Style/RedundantException: { Enabled: false } # Offense count: 1
-Style/RedundantRegexpEscape: { Enabled: false } # Offense count: 1
-Style/RegexpLiteral: { Enabled: false } # Offense count: 1
-Style/RescueStandardError: { Enabled: false } # Offense count: 1
-Style/SoleNestedConditional: { Enabled: false } # Offense count: 1
-Style/TrailingCommaInHashLiteral: { Enabled: false } # Offense count: 2
-
-# rubocop cannot tell that rubygems_mfa_required is enabled in gemspec.yml
-Gemspec/RequireMFA: { Enabled: false }
-
-# make an exception for our gemspec code
-Gemspec/DuplicatedAssignment:
+Style/GlobalStdStream:
   Exclude:
-    - 'ronin-core.gemspec'
+    - 'lib/ronin/core/cli/ruby_shell.rb'
+    - 'spec/cli/ruby_shell_spec.rb'
+

data/ChangeLog.md

@@ -1,4 +1,12 @@
-### 0.1.0 / 2023-XX-XX
+### 0.1.1 / 2023-03-01
+
+#### CLI
+
+* Allow {Ronin::Core::CLI::Shell} and {Ronin::Core::CLI::CommandShell} to
+  rescue interrupts while a shell command is running, and not exit from the
+  shell.
+
+### 0.1.0 / 2023-02-01
 
 * Initial release:
   * Provides access to the XDG directories (`~/.config/`, `~/.cache/`,

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec
@@ -26,5 +27,6 @@ group :development do
   gem 'dead_end',        require: false
   gem 'sord',            require: false, platform: :mri
   gem 'stackprof',       require: false, platform: :mri
-  gem 'rubocop',         require: false
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
 end

data/Rakefile

@@ -1,4 +1,4 @@
-require 'rubygems'
+# frozen_string_literal: true
 
 begin
   require 'bundler'

data/examples/ruby_shell.rb

@@ -1,9 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 require 'ronin/core/cli/ruby_shell'
 
 module Ronin
+  #
+  # Example namespace that the Ruby shell will spawn within.
+  #
   module Test
   end
 end

data/examples/test_shell.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'ronin/core/cli/command_shell'
+
+#
+# An example interactive CLI shell.
+#
+class TestShell < Ronin::Core::CLI::CommandShell
+
+  shell_name 'test'
+
+  command :foo, summary: 'Command with no arguments'
+  def foo
+    puts "no args"
+  end
+
+  command :bar, usage:       'ARG',
+                completions: %w[arg1 arg2],
+                summary:     'Command with one argument'
+  def bar(arg)
+    puts "arg=#{arg}"
+  end
+
+  command :baz, usage:   '[ARG]',
+                summary: 'Command with optional argument'
+  def baz(arg=nil)
+    puts "arg=#{arg}"
+  end
+
+  command :qux, usage:   '[ARGS...]',
+                summary: 'Command with repeating arguments'
+  def qux(*args)
+    puts "args=#{args.join(' ')}"
+  end
+
+end
+
+TestShell.start

data/lib/ronin/core/class_registry.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
     # `lib/ronin/exploits.rb`:
     #
     #     require 'ronin/core/class_registry'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         include Ronin::Core::ClassRegistry
-    #     
+    #
     #         class_dir "#{__dir__}/classes"
     #       end
     #     end
@@ -40,11 +40,11 @@ module Ronin
     #     module Ronin
     #       module Exploits
     #         class Exploit
-    #     
+    #
     #           def self.register(name)
     #             Exploits.register(name,self)
     #           end
-    #     
+    #
     #         end
     #       end
     #     end
@@ -52,13 +52,13 @@ module Ronin
     # `lib/ronin/exploits/my_exploit.rb`:
     #
     #     require 'ronin/exploits/exploit'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         class MyExploit < Exploit
-    #     
+    #
     #           register 'my_exploit'
-    #     
+    #
     #         end
     #       end
     #     end
@@ -79,6 +79,9 @@ module Ronin
         namespace.extend ClassMethods
       end
 
+      #
+      # Class-methods.
+      #
       module ClassMethods
         #
         # Gets or sets the class directory path.
@@ -88,7 +91,7 @@ module Ronin
         #
         # @return [String]
         #   The class directory path.
-        # 
+        #
         # @raise [NotImplementedError]
         #   The `class_dir` method was not defined in the module.
         #
@@ -188,7 +191,9 @@ module Ronin
           end
 
           previous_entries = registry.keys
+
           require(file)
+
           new_entries = registry.keys - previous_entries
 
           if new_entries.empty?

data/lib/ronin/core/cli/command.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/>.
 #
@@ -38,9 +38,9 @@ module Ronin
       #       module Foo
       #         class CLI
       #           class Command < Core::CLI::Command
-      #     
+      #
       #             man_dir File.join(__dir__,'..','..','..','..','man')
-      #     
+      #
       #           end
       #         end
       #       end
@@ -50,26 +50,26 @@ module Ronin
       #
       #     # lib/ronin/foo/cli/commands/list.rb
       #     require 'ronin/foo/cli/command'
-      #     
+      #
       #     module Ronin
       #       module Foo
       #         class CLI
       #           module Commands
       #             class List < Command
-      #     
+      #
       #               usage '[options] [NAME]'
-      #     
+      #
       #               argument :name, required: false,
       #                               desc:     'Optional name to list'
-      #     
+      #
       #               description 'Lists all things'
-      #     
+      #
       #               man_page 'ronin-foo-list.1'
-      #     
+      #
       #               def run(name=nil)
       #                 # ...
       #               end
-      #     
+      #
       #             end
       #           end
       #         end

data/lib/ronin/core/cli/command_shell/command.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/>.
 #
@@ -22,6 +22,9 @@ module Ronin
   module Core
     module CLI
       class CommandShell < Shell
+        #
+        # Represents a defined command within a {CommandShell} class.
+        #
         class Command
 
           # The command's name.
@@ -77,10 +80,10 @@ module Ronin
           #   Multi-line help information for the command.
           #
           def initialize(name, method_name: name,
-                               usage: nil,
+                               usage:       nil,
                                completions: nil,
-                               summary: ,
-                               help: summary)
+                               summary:     ,
+                               help:        summary)
             @name        = name
             @method_name = method_name
             @usage       = usage

data/lib/ronin/core/cli/command_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/>.
 #
@@ -30,9 +30,9 @@ module Ronin
       # ## Example
       #
       #     class HTTPShell < Ronin::Core::CLI::Shell
-      #     
+      #
       #       shell_name 'http'
-      #     
+      #
       #       command :get, usage: 'PATH [HEADERS...]',
       #                     summary: 'Sends a GET request'
       #       def get(path,*headers)
@@ -44,9 +44,9 @@ module Ronin
       #       def post(path,data,*headers)
       #         # ...
       #       end
-      #     
+      #
       #     end
-      #     
+      #
       #     HTTPShell.start
       #     # http> get /foo
       #
@@ -260,7 +260,7 @@ module Ronin
             command_string.length
           }.max
 
-          command_table.each  do |command_string,summary|
+          command_table.each do |command_string,summary|
             puts "  #{command_string.ljust(max_command_string)}\t#{summary}"
           end
         end
@@ -300,11 +300,11 @@ module Ronin
 
           method(name).parameters.each do |(type,arg)|
             case type
-            when :req 
+            when :req
               minimum += 1
               maximum += 1
             when :opt  then maximum += 1
-            when :rest then maximum = Float::INFINITY
+            when :rest then maximum  = Float::INFINITY
             end
           end
 

data/lib/ronin/core/cli/generator/options/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/>.
 #
@@ -28,7 +28,6 @@ module Ronin
           # for the generator command.
           #
           module Author
-
             #
             # The default author name.
             #
@@ -59,7 +58,7 @@ module Ronin
                                       value: {
                                         type:    String,
                                         usage:   'NAME',
-                                        default: ->{ default_name }
+                                        default: -> { default_name }
                                       },
                                       desc: 'The name of the author' do |author|
                                         @author_name = author
@@ -69,7 +68,7 @@ module Ronin
                                             value: {
                                               type:    String,
                                               usage:   'EMAIL',
-                                              default: ->{ default_email }
+                                              default: -> { default_email }
                                             },
                                             desc: 'The email address of the author' do |email|
                                               @author_email = email

data/lib/ronin/core/cli/generator/options/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/>.
 #

data/lib/ronin/core/cli/generator/options/reference.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/generator/options/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/>.
 #

data/lib/ronin/core/cli/generator.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/>.
 #
@@ -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.