ronin-support 0.4.1 → 0.5.2

data/lib/ronin/ui/output/helpers.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support 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 Support is distributed in the hope that it will be useful,
+# ronin-support 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 Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/ui/output/output'
@@ -71,7 +71,7 @@ module Ronin
         #
         # Prints one or more messages.
         #
-        # @param [Array] messages
+        # @param [Array] arguments
         #   The messages to print.
         #
         # @example
@@ -81,11 +81,27 @@ module Ronin
         #
         # @api public
         #
-        def puts(*messages)
-          unless messages.empty?
-            messages.each { |message| write("#{message}#{$/}") }
-          else
+        def puts(*arguments)
+          if arguments.empty?
             write($/)
+            return nil
+          end
+
+          arguments.each do |argument|
+            if argument.kind_of?(Array)
+              argument.each { |element| puts(element) }
+            else
+              str = case argument
+                    when nil
+                      if RUBY_VERSION > '1.9' then ''
+                      else                         'nil'
+                      end
+                    else
+                      argument.to_s
+                    end
+
+              write("#{str}#{$/}")
+            end
           end
 
           return nil
@@ -97,7 +113,7 @@ module Ronin
         # @param [String] format
         #   The format string.
         #
-        # @param [Array] data
+        # @param [Array] arguments
         #   The data to format.
         #
         # @return [nil]
@@ -106,8 +122,8 @@ module Ronin
         #
         # @api public
         #
-        def printf(format,*data)
-          write(format % data)
+        def printf(format,*arguments)
+          write(format % arguments)
           return nil
         end
 
@@ -123,7 +139,7 @@ module Ronin
         # @example
         #   print_info "Connecting ..."
         #
-        # @example Print a formatted message.
+        # @example Print a formatted message:
         #   print_info "Connected to %s", host
         #
         # @since 0.3.0
@@ -132,7 +148,7 @@ module Ronin
         #
         def print_info(*message)
           unless Output.silent?
-            Output.handler.print_info(format_message(message))
+            Output.handler.print_info(Helpers.format(message))
             return true
           end
 
@@ -148,7 +164,7 @@ module Ronin
         # @return [Boolean]
         #   Specifies whether the messages were successfully printed.
         #
-        # @example Print a formatted message.
+        # @example Print a formatted message:
         #   print_debug "vars: %p %p", vars[0], vars[1]
         #
         # @since 0.3.0
@@ -157,7 +173,7 @@ module Ronin
         #
         def print_debug(*message)
           if (Output.verbose? && !(Output.silent?))
-            Output.handler.print_debug(format_message(message))
+            Output.handler.print_debug(Helpers.format(message))
             return true
           end
 
@@ -176,7 +192,7 @@ module Ronin
         # @example
         #   print_warning "Detecting a restricted character in the buffer"
         #
-        # @example Print a formatted message.
+        # @example Print a formatted message:
         #   print_warning "Malformed input detected: %p", user_input
         #
         # @since 0.3.0
@@ -185,7 +201,7 @@ module Ronin
         #
         def print_warning(*message)
           unless Output.silent?
-            Output.handler.print_warning(format_message(message))
+            Output.handler.print_warning(Helpers.format(message))
             return true
           end
           
@@ -204,7 +220,7 @@ module Ronin
         # @example
         #   print_error "Could not connect!"
         #
-        # @example Print a formatted message.
+        # @example Print a formatted message:
         #   print_error "%p: %s", error.class, error.message
         #
         # @since 0.3.0
@@ -213,7 +229,7 @@ module Ronin
         #
         def print_error(*message)
           unless Output.silent?
-            Output.handler.print_error(format_message(message))
+            Output.handler.print_error(Helpers.format(message))
             return true
           end
 
@@ -259,21 +275,19 @@ module Ronin
         #
         # Formats a message to be printed.
         #
-        # @param [Array] message
+        # @param [Array] arguments
         #   The message and additional Objects to format.
         #
         # @return [String]
         #   The formatted message.
         #
-        # @since 1.0.0
-        #
         # @api private
         #
-        def format_message(message)
-          if message.length == 1
-            message[0]
+        def Helpers.format(arguments)
+          unless arguments.length == 1
+            arguments.first % arguments[1..-1]
           else
-            message[0] % message[1..-1]
+            arguments.first
           end
         end
       end

data/lib/ronin/ui/output/output.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support 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 Support is distributed in the hope that it will be useful,
+# ronin-support 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 Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/ui/output/terminal/raw'
@@ -26,16 +26,12 @@ module Ronin
     # Controls {Output} from Ronin.
     #
     module Output
-      @mode = if ($VERBOSE || $DEBUG || ENV['VERBOSE'])
-                :verbose
-              else
-                :quiet
+      @mode = if ($VERBOSE || $DEBUG) then :verbose
+              else                         :quiet
               end
 
-      @handler = if $stdout.tty?
-                   Terminal::Color
-                 else
-                   Terminal::Raw
+      @handler = if $stdout.tty? then Terminal::Color
+                 else                 Terminal::Raw
                  end
 
       #
@@ -46,7 +42,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.verbose?
+      def self.verbose?
         @mode == :verbose
       end
 
@@ -58,7 +54,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.quiet?
+      def self.quiet?
         @mode == :quiet
       end
 
@@ -70,7 +66,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.silent?
+      def self.silent?
         @mode == :silent
       end
 
@@ -83,7 +79,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.verbose!
+      def self.verbose!
         @mode = :verbose
         return self
       end
@@ -97,7 +93,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.quiet!
+      def self.quiet!
         @mode = :quiet
         return self
       end
@@ -109,7 +105,7 @@ module Ronin
       #
       # @since 1.0.0
       #
-      def Output.silent!
+      def self.silent!
         @mode = :silent
         return self
       end
@@ -122,7 +118,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.handler
+      def self.handler
         @handler
       end
 
@@ -138,7 +134,7 @@ module Ronin
       #
       # @api semipublic
       #
-      def Output.handler=(new_handler)
+      def self.handler=(new_handler)
         @handler = new_handler
       end
     end

data/lib/ronin/ui/output/terminal.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support 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 Support is distributed in the hope that it will be useful,
+# ronin-support 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 Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/ui/output/terminal/raw'

data/lib/ronin/ui/output/terminal/color.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support 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 Support is distributed in the hope that it will be useful,
+# ronin-support 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 Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 module Ronin
@@ -38,6 +38,12 @@ module Ronin
           # ANSI Red code
           RED = "\e[31m"
 
+          # ANSI Bright code
+          BRIGHT = "\e[1m"
+
+          # ANSI Bright-Off code
+          BRIGHT_OFF = "\e[21m"
+
           # ANSI Clear code
           CLEAR = "\e[0m"
 
@@ -66,7 +72,7 @@ module Ronin
           # @api private
           #
           def self.print_info(message)
-            $stdout.puts "#{GREEN}[-] #{message}#{CLEAR}"
+            $stdout.puts "#{GREEN}#{BRIGHT}[-]#{BRIGHT_OFF} #{message}#{CLEAR}"
           end
 
           #
@@ -80,7 +86,7 @@ module Ronin
           # @api private
           #
           def self.print_debug(message)
-            $stdout.puts "#{CYAN}[=] #{message}#{CLEAR}"
+            $stdout.puts "#{CYAN}#{BRIGHT}[=]#{BRIGHT_OFF} #{message}#{CLEAR}"
           end
 
           #
@@ -94,7 +100,7 @@ module Ronin
           # @api private
           #
           def self.print_warning(message)
-            $stdout.puts "#{YELLOW}[*] #{message}#{CLEAR}"
+            $stdout.puts "#{YELLOW}#{BRIGHT}[*]#{BRIGHT_OFF} #{message}#{CLEAR}"
           end
 
           #
@@ -108,7 +114,7 @@ module Ronin
           # @api private
           #
           def self.print_error(message)
-            $stdout.puts "#{RED}[!] #{message}#{CLEAR}"
+            $stdout.puts "#{RED}#{BRIGHT}[!]#{BRIGHT_OFF} #{message}#{CLEAR}"
           end
 
         end

data/lib/ronin/ui/output/terminal/raw.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support 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 Support is distributed in the hope that it will be useful,
+# ronin-support 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 Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 module Ronin

data/lib/ronin/ui/shell.rb

@@ -1,20 +1,20 @@
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
+# This file is part of ronin-support.
 #
-# Ronin Support is free software: you can redistribute it and/or modify
+# ronin-support 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 Support is distributed in the hope that it will be useful,
+# ronin-support 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 Support.  If not, see <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'ronin/ui/output/helpers'
@@ -271,12 +271,9 @@ module Ronin
           command_method = method(name)
           arguments = command_method.parameters.map do |param|
             case param[0]
-            when :opt
-              "[#{param[1]}]"
-            when :rest
-              "[#{param[1]} ...]"
-            else
-              param[1]
+            when :opt  then "[#{param[1]}]"
+            when :rest then "[#{param[1]} ...]"
+            else                param[1]
             end
           end