ronin-support 0.5.2 → 1.0.0.beta2

data/lib/ronin/templates/template.rb

@@ -1,169 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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,
-# 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 <https://www.gnu.org/licenses/>.
-#
-
-require 'data_paths/finders'
-
-module Ronin
-  module Templates
-    #
-    # The {Template} module allows a class to find templates and manage
-    # multiple template directories. The {Template} module also can find
-    # templates within `data/` directories using `DataPaths::Finders`.
-    #
-    module Template
-      include DataPaths::Finders
-
-      protected
-
-      #
-      # A stack of directories to search for other templates within.
-      #
-      # @return [Array]
-      #   The stack of directory paths.
-      #
-      # @api semipublic
-      #
-      def template_dirs
-        @template_dirs ||= []
-      end
-
-      #
-      # The first path in {#template_dirs}, that will be used to search for
-      # other templates in.
-      #
-      # @return [String, nil]
-      #   Returns the first path in {#template_dirs}, or `nil` if
-      #   {#template_dirs} is empty.
-      #
-      # @api semipublic
-      #
-      def template_dir
-        template_dirs.first
-      end
-
-      #
-      # Finds the template within the {#template_dir} or uses
-      # `DataPaths::Finders#find_data_file` to search through all
-      # `data/` directories for the template.
-      #
-      # @param [String] sub_path
-      #   The relative path of the template to find.
-      #
-      # @return [String, nil]
-      #   Returns the absolute path to the template, or `nil` if the
-      #   template could not be found.
-      #
-      # @example
-      #   find_template 'sub/path/template.erb'
-      #
-      # @api semipublic
-      #
-      def find_template(sub_path)
-        sub_path = sub_path.to_s
-
-        if template_dir
-          path = File.expand_path(File.join(template_dir,sub_path))
-
-          return path if File.file?(path)
-        end
-
-        return find_data_file(sub_path)
-      end
-
-      #
-      # Finds the template, pushing the directory that the template resides
-      # within to {#template_dirs}, calls the given block and then pops
-      # the directory off of {#template_dirs}.
-      #
-      # @param [String] sub_path
-      #   The relative path of the template to find.
-      #
-      # @yield [path]
-      #   The block to be called after the directory of the template has
-      #   been pushed onto {#template_dirs}. After the block has returned,
-      #   the directory will be popped off of {#template_dirs}.
-      #
-      # @yieldparam [String] path
-      #   The absolute path of the template.
-      #
-      # @return [Object]
-      #   Result of the given block.
-      #
-      # @raise [RuntimeError]
-      #   The template was not found.
-      #
-      # @example
-      #   enter_template('sub/path/template.erb') do |path|
-      #     # do stuff with the full path
-      #   end
-      #
-      # @api semipublic
-      #
-      def enter_template(sub_path)
-        sub_path = sub_path.to_s
-
-        unless (path = find_template(sub_path))
-          raise(RuntimeError,"could not find template #{sub_path.dump}")
-        end
-
-        template_dirs.unshift(File.dirname(path))
-
-        result = yield(path)
-
-        template_dirs.shift
-        return result
-      end
-
-      #
-      # Finds and reads the contents of a template.
-      #
-      # @param [String] template_path
-      #   The relative path to the template.
-      #
-      # @yield [template]
-      #   The given block will receive the contents of the template.
-      #
-      # @yieldparam [String] template
-      #   The contents of the template.
-      #
-      # @example
-      #   read_template 'path/to/_include.txt'
-      #   # => "..."
-      #
-      # @example Calling read_template with a block
-      #   read_template 'path/to/_include.txt' do |contents|
-      #     # ...
-      #   end
-      #
-      # @api semipublic
-      #
-      def read_template(template_path)
-        enter_template(template_path) do |path|
-          contents = File.read(path)
-
-          if block_given?
-            yield(contents)
-          else
-            contents
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ronin/templates.rb

@@ -1,21 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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,
-# 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 <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/templates/template'
-require 'ronin/templates/erb'

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

@@ -1,296 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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,
-# 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 <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/ui/output/output'
-
-module Ronin
-  module UI
-    module Output
-      #
-      # Helper methods for printing output.
-      #
-      module Helpers
-        #
-        # Writes data unless output has been silenced.
-        #
-        # @param [String, Object] data
-        #   The data to write.
-        #
-        # @return [Integer, nil]
-        #   The number of bytes written.
-        #
-        # @since 1.0.0
-        #
-        # @api public
-        #
-        def write(data)
-          unless Output.silent?
-            data = data.to_s
-
-            Output.handler.write(data)
-            return data.length
-          end
-        end
-
-        #
-        # Prints a character.
-        #
-        # @param [String, Integer] data
-        #   The character or byte to print.
-        #
-        # @return [String, Integer]
-        #   The byte or character.
-        #
-        # @since 1.0.0
-        #
-        # @api public
-        #
-        def putc(data)
-          char = data.chr if data.kind_of?(Integer)
-
-          write(data)
-          return data
-        end
-
-        #
-        # Prints one or more messages.
-        #
-        # @param [Array] arguments
-        #   The messages to print.
-        #
-        # @example
-        #   puts 'some data'
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        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
-        end
-
-        #
-        # Prints formatted data.
-        #
-        # @param [String] format
-        #   The format string.
-        #
-        # @param [Array] arguments
-        #   The data to format.
-        #
-        # @return [nil]
-        # 
-        # @since 1.0.0
-        #
-        # @api public
-        #
-        def printf(format,*arguments)
-          write(format % arguments)
-          return nil
-        end
-
-        #
-        # Prints an `info` message.
-        #
-        # @param [Array] message
-        #   The message to print.
-        #
-        # @return [Boolean]
-        #   Specifies whether the messages were successfully printed.
-        #
-        # @example
-        #   print_info "Connecting ..."
-        #
-        # @example Print a formatted message:
-        #   print_info "Connected to %s", host
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def print_info(*message)
-          unless Output.silent?
-            Output.handler.print_info(Helpers.format(message))
-            return true
-          end
-
-          return false
-        end
-
-        #
-        # Prints a `debug` message.
-        #
-        # @param [Array, String] message
-        #   The message to print.
-        #
-        # @return [Boolean]
-        #   Specifies whether the messages were successfully printed.
-        #
-        # @example Print a formatted message:
-        #   print_debug "vars: %p %p", vars[0], vars[1]
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def print_debug(*message)
-          if (Output.verbose? && !(Output.silent?))
-            Output.handler.print_debug(Helpers.format(message))
-            return true
-          end
-
-          return false
-        end
-
-        #
-        # Prints a `warning` message.
-        #
-        # @param [Array, String] message
-        #   The message to print.
-        #
-        # @return [Boolean]
-        #   Specifies whether the messages were successfully printed.
-        #
-        # @example
-        #   print_warning "Detecting a restricted character in the buffer"
-        #
-        # @example Print a formatted message:
-        #   print_warning "Malformed input detected: %p", user_input
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def print_warning(*message)
-          unless Output.silent?
-            Output.handler.print_warning(Helpers.format(message))
-            return true
-          end
-          
-          return false
-        end
-
-        #
-        # Prints an `error` message.
-        #
-        # @param [Array, String] message
-        #   The message to print.
-        #
-        # @return [Boolean]
-        #   Specifies whether the messages were successfully printed.
-        #
-        # @example
-        #   print_error "Could not connect!"
-        #
-        # @example Print a formatted message:
-        #   print_error "%p: %s", error.class, error.message
-        #
-        # @since 0.3.0
-        #
-        # @api public
-        #
-        def print_error(*message)
-          unless Output.silent?
-            Output.handler.print_error(Helpers.format(message))
-            return true
-          end
-
-          return false
-        end
-
-        #
-        # Prints an exception.
-        #
-        # @param [Exception] exception
-        #   The exception to print.
-        #
-        # @return [Boolean]
-        #   Specifies whether the exception was printed or not.
-        #
-        # @example
-        #   begin
-        #     socket.write(buffer)
-        #   rescue => e
-        #     print_exception(e)
-        #   end
-        #
-        # @since 0.4.0
-        #
-        # @api public
-        #
-        def print_exception(exception)
-          return false if Output.silent?
-
-          print_error "#{exception.class}: #{exception.message}"
-
-          if Output.verbose?
-            exception.backtrace[0,5].each do |line|
-              print_error "  #{line}"
-            end
-          end
-
-          return true
-        end
-
-        protected
-
-        #
-        # Formats a message to be printed.
-        #
-        # @param [Array] arguments
-        #   The message and additional Objects to format.
-        #
-        # @return [String]
-        #   The formatted message.
-        #
-        # @api private
-        #
-        def Helpers.format(arguments)
-          unless arguments.length == 1
-            arguments.first % arguments[1..-1]
-          else
-            arguments.first
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,142 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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,
-# 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 <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/ui/output/terminal/raw'
-require 'ronin/ui/output/terminal/color'
-
-module Ronin
-  module UI
-    #
-    # Controls {Output} from Ronin.
-    #
-    module Output
-      @mode = if ($VERBOSE || $DEBUG) then :verbose
-              else                         :quiet
-              end
-
-      @handler = if $stdout.tty? then Terminal::Color
-                 else                 Terminal::Raw
-                 end
-
-      #
-      # @return [Boolean]
-      #   Specifies whether verbose output is enabled.
-      #
-      # @since 0.3.0
-      #
-      # @api semipublic
-      #
-      def self.verbose?
-        @mode == :verbose
-      end
-
-      #
-      # @return [Boolean]
-      #   Specifies whether quiet output is enabled.
-      #
-      # @since 0.3.0
-      #
-      # @api semipublic
-      #
-      def self.quiet?
-        @mode == :quiet
-      end
-
-      #
-      # @return [Boolean]
-      #   Specifies whether silent output is enabled.
-      #
-      # @since 0.3.0
-      #
-      # @api semipublic
-      #
-      def self.silent?
-        @mode == :silent
-      end
-
-      #
-      # Enables verbose output.
-      #
-      # @return [Output]
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def self.verbose!
-        @mode = :verbose
-        return self
-      end
-
-      #
-      # Disables verbose output.
-      #
-      # @return [Output]
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def self.quiet!
-        @mode = :quiet
-        return self
-      end
-
-      #
-      # Disables all output.
-      #
-      # @return [Output]
-      #
-      # @since 1.0.0
-      #
-      def self.silent!
-        @mode = :silent
-        return self
-      end
-
-      #
-      # @return [Ronin::UI::Output::Handler]
-      #   The current Output handler.
-      #
-      # @since 0.3.0
-      #
-      # @api semipublic
-      #
-      def self.handler
-        @handler
-      end
-
-      #
-      # Sets the current Output handler.
-      #
-      # @param [Handler] new_handler
-      #   The new output handler to use. Must provide the `puts`,
-      #   `print_info`, `print_debug`, `print_warning` and `print_error`
-      #   class methods.
-      #
-      # @since 0.3.0
-      #
-      # @api semipublic
-      #
-      def self.handler=(new_handler)
-        @handler = new_handler
-      end
-    end
-  end
-end