puppet-debugger 0.16.0 → 1.1.0

data/lib/puppet-debugger/cli.rb

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
 
-require "puppet"
-require "readline"
-require "json"
-require "puppet-debugger/support"
-require "pluginator"
-require "puppet-debugger/hooks"
-require "forwardable"
-require "plugins/puppet-debugger/input_responders/functions"
-require "plugins/puppet-debugger/input_responders/datatypes"
-
+require 'puppet'
+require 'readline'
+require 'json'
+require 'puppet-debugger/support'
+require 'pluginator'
+require 'puppet-debugger/hooks'
+require 'forwardable'
+require 'plugins/puppet-debugger/input_responders/functions'
+require 'plugins/puppet-debugger/input_responders/datatypes'
+require 'tty-pager'
 module PuppetDebugger
   class Cli
     include PuppetDebugger::Support
     extend Forwardable
     attr_accessor :settings, :log_level, :in_buffer, :out_buffer, :html_mode, :extra_prompt, :bench
-    attr_reader :source_file, :source_line_num, :hooks
+    attr_reader :source_file, :source_line_num, :hooks, :options
     def_delegators :hooks, :exec_hook, :add_hook, :delete_hook
-
+    OUT_SYMBOL = ' => '
     def initialize(options = {})
       do_initialize if Puppet[:codedir].nil?
       Puppet.settings[:name] = :debugger
-      Puppet.settings[:trusted_server_facts] = true unless Puppet.settings[:trusted_server_facts].nil?
+      @options = options
       Puppet[:static_catalogs] = false unless Puppet.settings[:static_catalogs].nil?
       set_remote_node_name(options[:node_name])
       initialize_from_scope(options[:scope])
-      @log_level = "notice"
+      set_catalog(options[:catalog])
+      @log_level = 'notice'
       @out_buffer = options[:out_buffer] || $stdout
       @html_mode = options[:html_mode] || false
       @source_file = options[:source_file] || nil
@@ -33,14 +34,23 @@ module PuppetDebugger
       @in_buffer = options[:in_buffer] || $stdin
       Readline.input = @in_buffer
       Readline.output = @out_buffer
-      Readline.completion_append_character = ""
-      Readline.basic_word_break_characters = " "
+      Readline.completion_append_character = ''
+      Readline.basic_word_break_characters = ' '
       Readline.completion_proc = command_completion
       AwesomePrint.defaults = {
         html: @html_mode,
         sort_keys: true,
-        indent: 2,
+        indent: 2
       }
+      # Catch control-c sequences
+      trap('SIGINT') do
+        # control-d
+        exit 0
+      end
+      trap('INT') do
+        # control-c
+        # handle_output('Type exit or use control-d')
+      end
     end
 
     # @return [Proc] the proc used in the command completion for readline
@@ -50,11 +60,12 @@ module PuppetDebugger
       proc do |input|
         words = Readline.line_buffer.split(Readline.basic_word_break_characters)
         next key_words.grep(/^#{Regexp.escape(input)}/) if words.empty?
+
         first_word = words.shift
         plugins = PuppetDebugger::InputResponders::Commands.plugins.find_all do |p|
           p::COMMAND_WORDS.find { |word| word.start_with?(first_word) }
         end
-        if plugins.count == 1 and /\A#{first_word}\s/.match(Readline.line_buffer)
+        if (plugins.count == 1) && /\A#{first_word}\s/.match(Readline.line_buffer)
           plugins.first.command_completion(words)
         else
           key_words.grep(/^#{Regexp.escape(input)}/)
@@ -76,7 +87,8 @@ module PuppetDebugger
       PuppetDebugger::InputResponders::Functions.instance.debugger = self
       funcs = PuppetDebugger::InputResponders::Functions.instance.func_list
       PuppetDebugger::InputResponders::Datatypes.instance.debugger = self
-      (scoped_vars + funcs + static_responder_list + PuppetDebugger::InputResponders::Datatypes.instance.all_data_types).uniq.sort
+      (scoped_vars + funcs + static_responder_list +
+        PuppetDebugger::InputResponders::Datatypes.instance.all_data_types).uniq.sort
     end
 
     # looks up the type in the catalog by using the type and title
@@ -106,7 +118,7 @@ module PuppetDebugger
     end
 
     def contains_resources?(result)
-      !Array(result).flatten.find { |r| r.class.to_s =~ /Puppet::Pops::Types/ }.nil?
+      !Array(result).flatten.find { |r| r.class.to_s =~ /Puppet::Pops::Types::PResourceType/ }.nil?
     end
 
     def normalize_output(result)
@@ -116,87 +128,108 @@ module PuppetDebugger
         # if the only output is a resource then return it
         # otherwise it is multiple items or an actually array
         return output.first if output.count == 1
+
         return output
       end
       result
     end
 
     def responder_list
-      plugins = Pluginator.find(PuppetDebugger)
+      Pluginator.find(PuppetDebugger)
+    end
+
+    # @return [TTY::Pager] the pager object, disable if CI or testing is present
+    def pager
+      @pager ||= TTY::Pager.new(output: out_buffer, enabled: pager_enabled?)
+    end
+
+    def pager_enabled?
+      ENV['CI'].nil?
+    end
+
+    # @param output [String] - the content to output
+    # @summary outputs the output to the output buffer
+    #   uses the pager if the screen height is less than the height of the
+    #   output content
+    #   Disabled if CI or testing is being done
+    def handle_output(output)
+      return if output.nil?
+
+      if pager_enabled? && output.lines.count >= TTY::Screen.height
+        output << "\n"
+        pager.page(output)
+      else
+        out_buffer.puts(output) unless output.empty?
+      end
     end
 
     # this method handles all input and expects a string of text.
-    #
+    # @param input [String] - the input content to parse or run
     def handle_input(input)
       raise ArgumentError unless input.instance_of?(String)
-      begin
-        output = ""
-        case input.strip
-        when PuppetDebugger::InputResponders::Commands.command_list_regex
-          args = input.split(" ")
-          command = args.shift
-          plugin = PuppetDebugger::InputResponders::Commands.plugin_from_command(command)
-          output = plugin.execute(args, self)
-          return out_buffer.puts output
-        when "_"
-          output = " => #{@last_item}"
-        else
-          result = puppet_eval(input)
-          @last_item = result
-          output = normalize_output(result)
-          output = output.nil? ? "" : output.ai
+
+      output =
+        begin
+          case input.strip
+          when PuppetDebugger::InputResponders::Commands.command_list_regex
+            args = input.split(' ')
+            command = args.shift
+            plugin = PuppetDebugger::InputResponders::Commands.plugin_from_command(command)
+            plugin.execute(args, self) || ''
+          when '_'
+            " => #{@last_item}"
+          else
+            result = puppet_eval(input)
+            @last_item = result
+            o = normalize_output(result)
+            o.nil? ? '' : o.ai
+          end
+        rescue PuppetDebugger::Exception::InvalidCommand => e
+          e.message.fatal
+        rescue LoadError => e
+          e.message.fatal
+        rescue Errno::ETIMEDOUT => e
+          e.message.fatal
+        rescue ArgumentError => e
+          e.message.fatal
+        rescue Puppet::ResourceError => e
+          e.message.fatal
+        rescue Puppet::Error => e
+          e.message.fatal
+        rescue Puppet::ParseErrorWithIssue => e
+          e.message.fatal
+        rescue PuppetDebugger::Exception::FatalError => e
+          handle_output(e.message.fatal)
+          exit 1 # this can sometimes causes tests to fail
+        rescue PuppetDebugger::Exception::Error => e
+          e.message.fatal
+        rescue ::RuntimeError => e
+          handle_output(e.message.fatal)
+          exit 1
         end
-      rescue PuppetDebugger::Exception::InvalidCommand => e
-        output = e.message.fatal
-      rescue LoadError => e
-        output = e.message.fatal
-      rescue Errno::ETIMEDOUT => e
-        output = e.message.fatal
-      rescue ArgumentError => e
-        output = e.message.fatal
-      rescue Puppet::ResourceError => e
-        output = e.message.fatal
-      rescue Puppet::Error => e
-        output = e.message.fatal
-      rescue Puppet::ParseErrorWithIssue => e
-        output = e.message.fatal
-      rescue PuppetDebugger::Exception::FatalError => e
-        output = e.message.fatal
-        out_buffer.puts output
-        exit 1 # this can sometimes causes tests to fail
-      rescue PuppetDebugger::Exception::Error => e
-        output = e.message.fatal
-      rescue ::RuntimeError => e
-        output = e.message.fatal
-        out_buffer.puts output
-        exit 1
-      end
-      unless output.empty?
-        out_buffer.print " => "
-        out_buffer.puts output unless output.empty?
-        exec_hook :after_output, out_buffer, self, self
-      end
+      output = OUT_SYMBOL + output unless output.empty?
+      handle_output(output)
+      exec_hook :after_output, out_buffer, self, self
     end
 
     def self.print_repl_desc
-      output = <<-EOT
-Ruby Version: #{RUBY_VERSION}
-Puppet Version: #{Puppet.version}
-Puppet Debugger Version: #{PuppetDebugger::VERSION}
-Created by: NWOps <corey@nwops.io>
-Type "commands" for a list of debugger commands
-or "help" to show the help screen.
+      <<~OUT
+        Ruby Version: #{RUBY_VERSION}
+        Puppet Version: #{Puppet.version}
+        Puppet Debugger Version: #{PuppetDebugger::VERSION}
+        Created by: NWOps <corey@nwops.io>
+        Type "commands" for a list of debugger commands
+        or "help" to show the help screen.
 
 
-      EOT
-      output
+      OUT
     end
 
     # tries to determine if the input is going to be a multiline input
     # by reading the parser error message
     # @return [Boolean] - return true if this is a multiline input, false otherwise
-    def multiline_input?(e)
-      case e.message
+    def multiline_input?(data)
+      case data.message
       when /Syntax error at end of/i
         true
       else
@@ -211,7 +244,7 @@ or "help" to show the help screen.
     # input
     def read_loop
       line_number = 1
-      full_buffer = ""
+      full_buffer = ''
       while buf = Readline.readline("#{line_number}:#{extra_prompt}>> ", true)
         begin
           full_buffer += buf
@@ -222,14 +255,14 @@ or "help" to show the help screen.
               parser.parse_string(full_buffer)
             rescue Puppet::ParseErrorWithIssue => e
               if multiline_input?(e)
-                out_buffer.print "  "
+                out_buffer.print '  '
                 full_buffer += "\n"
                 next
               end
             end
           end
           handle_input(full_buffer)
-          full_buffer = ""
+          full_buffer = ''
         end
       end
     end
@@ -251,7 +284,7 @@ or "help" to show the help screen.
       repl_obj.out_buffer.puts print_repl_desc unless options[:quiet]
       repl_obj.handle_input(options[:content]) if options[:content]
       # TODO: make the output optional so we can have different output destinations
-      repl_obj.handle_input("whereami") if options[:source_file] && options[:source_line]
+      repl_obj.handle_input('whereami') if options[:source_file] && options[:source_line]
       repl_obj.handle_input("play #{options[:play]}") if options[:play]
       repl_obj.read_loop unless options[:run_once]
     end
@@ -262,10 +295,15 @@ or "help" to show the help screen.
     # @param [Hash] puppet scope object
     def self.start(options = { scope: nil })
       opts = Trollop.options do
-        opt :play, "Url or file to load from", required: false, type: String
-        opt :run_once, "Evaluate and quit", required: false, default: false
-        opt :node_name, "Remote Node to grab facts from", required: false, type: String
-        opt :quiet, "Do not display banner", required: false, default: false
+        opt :play, 'Url or file to load from', required: false, type: String
+        opt :run_once, 'Evaluate and quit', required: false, default: false
+        opt :node_name, 'Remote Node to grab facts from', required: false, type: String
+        opt :catalog, 'Import a catalog file to inspect', required: false, type: String
+        opt :quiet, 'Do not display banner', required: false, default: false
+      end
+      if !STDIN.tty? && !STDIN.closed?
+        options[:run_once] = true
+        options[:quiet] = true
       end
       options = opts.merge(options)
       options[:play] = options[:play].path if options[:play].respond_to?(:path)
@@ -273,14 +311,14 @@ or "help" to show the help screen.
       repl_obj.out_buffer.puts print_repl_desc unless options[:quiet]
       if options[:play]
         repl_obj.handle_input("play #{options[:play]}")
-      elsif ARGF.filename != "-"
-        # when the user supplied a file name without using the args (stdin)
-        path = File.expand_path(ARGF.filename)
-        repl_obj.handle_input("play #{path}")
-      elsif (ARGF.filename == "-") && (!STDIN.tty? && !STDIN.closed?)
+      elsif (ARGF.filename == '-') && (!STDIN.tty? && !STDIN.closed?)
         # when the user supplied a file content using stdin, aka. cat,pipe,echo or redirection
         input = ARGF.read
         repl_obj.handle_input(input)
+      elsif ARGF.filename != '-'
+        # when the user supplied a file name without using the args (stdin)
+        path = File.expand_path(ARGF.filename)
+        repl_obj.handle_input("play #{path}")
       end
       # helper code to make tests exit the loop
       repl_obj.read_loop unless options[:run_once]

data/lib/puppet-debugger/code/code_file.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 class CodeFile
@@ -10,18 +9,18 @@ class CodeFile
   # List of all supported languages.
   # @return [Hash]
   EXTENSIONS = {
-    %w[.py]        => :python,
-    %w[.js]        => :javascript,
-    %w[.pp]        => :puppet,
-    %w[.css]       => :css,
-    %w[.xml]       => :xml,
-    %w[.php]       => :php,
-    %w[.html]      => :html,
-    %w[.diff]      => :diff,
-    %w[.java]      => :java,
-    %w[.json]      => :json,
-    %w[.c .h]      => :c,
-    %w[.rhtml]     => :rhtml,
+    %w[.py] => :python,
+    %w[.js] => :javascript,
+    %w[.pp] => :puppet,
+    %w[.css] => :css,
+    %w[.xml] => :xml,
+    %w[.php] => :php,
+    %w[.html] => :html,
+    %w[.diff] => :diff,
+    %w[.java] => :java,
+    %w[.json] => :json,
+    %w[.c .h] => :c,
+    %w[.rhtml] => :rhtml,
     %w[.yaml .yml] => :yaml,
     %w[.cpp .hpp .cc .h cxx] => :cpp,
     %w[.rb .ru .irbrc .gemspec .pryrc] => :ruby
@@ -96,4 +95,4 @@ class CodeFile
   def from_load_path
     $LOAD_PATH.map { |path| File.expand_path(@filename, path) }
   end
-  end
+end

data/lib/puppet-debugger/code/code_range.rb

@@ -47,13 +47,15 @@ class DebuggerCode
 
     # @return [Integer]
     def find_start_index(lines)
-      return start_line if start_line < 0
+      return start_line if start_line.negative?
+
       lines.index { |loc| loc.lineno >= start_line } || lines.length
     end
 
     # @return [Integer]
     def find_end_index(lines)
-      return end_line if end_line < 0
+      return end_line if end_line.negative?
+
       (lines.index { |loc| loc.lineno > end_line } || 0) - 1
     end
 
@@ -66,4 +68,4 @@ class DebuggerCode
       @start_line = start_line.first
     end
   end
-  end
+end

data/lib/puppet-debugger/code/loc.rb

@@ -76,4 +76,4 @@ class DebuggerCode
       tuple[0] = "#{' ' * distance}#{line}"
     end
   end
-  end
+end

data/lib/puppet-debugger/debugger_code.rb

@@ -164,6 +164,7 @@ class DebuggerCode
   # @return [Code]
   def grep(pattern)
     return self unless pattern
+
     pattern = Regexp.new(pattern)
 
     select do |loc|
@@ -238,6 +239,7 @@ class DebuggerCode
 
   def add_file_reference
     return "From inline code: \n" unless filename
+
     "From file: #{File.basename(filename)}\n"
   end
 

data/lib/puppet-debugger/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/support/errors'
 
 module PuppetDebugger
@@ -18,7 +20,7 @@ module PuppetDebugger
     end
 
     # Ensure that duplicates have their @hooks object.
-    def initialize_copy(orig)
+    def initialize_copy(_orig)
       hooks_dup = @hooks.dup
       @hooks.each do |k, v|
         hooks_dup[k] = v.dup
@@ -37,8 +39,9 @@ module PuppetDebugger
     # @return [PuppetDebugger::Hooks] The receiver.
     # @see {#merge}
     def merge!(other)
-      @hooks.merge!(other.dup.hooks) do |key, array, other_array|
-        temp_hash, output = {}, []
+      @hooks.merge!(other.dup.hooks) do |_key, array, other_array|
+        temp_hash = {}
+        output = []
 
         (array + other_array).reverse_each do |pair|
           temp_hash[pair.first] ||= output.unshift(pair)
@@ -57,7 +60,7 @@ module PuppetDebugger
     # @return [PuppetDebugger::Hooks] a new `PuppetDebugger::Hooks` instance containing a merge of the
     #   contents of two `PuppetDebugger::Hooks` instances.
     def merge(other)
-      self.dup.tap do |v|
+      dup.tap do |v|
         v.merge!(other)
       end
     end
@@ -68,7 +71,7 @@ module PuppetDebugger
     # @param [#call] callable The callable.
     # @yield The block to use as the callable (if no `callable` provided).
     # @return [PuppetDebugger::Hooks] The receiver.
-    def add_hook(event_name, hook_name, callable=nil, &block)
+    def add_hook(event_name, hook_name, callable = nil, &block)
       event_name = event_name.to_s
 
       # do not allow duplicates, but allow multiple `nil` hooks
@@ -77,12 +80,10 @@ module PuppetDebugger
         raise ArgumentError, "Hook with name '#{hook_name}' already defined!"
       end
 
-      if !block && !callable
-        raise ArgumentError, "Must provide a block or callable."
-      end
+      raise ArgumentError, 'Must provide a block or callable.' if !block && !callable
 
       # ensure we only have one anonymous hook
-      @hooks[event_name].delete_if { |h, k| h.nil? } if hook_name.nil?
+      @hooks[event_name].delete_if { |h, _k| h.nil? } if hook_name.nil?
 
       if block
         @hooks[event_name] << [hook_name, block]
@@ -98,7 +99,7 @@ module PuppetDebugger
     # @param [Array] args The arguments to pass to each hook function.
     # @return [Object] The return value of the last executed hook.
     def exec_hook(event_name, *args, &block)
-      @hooks[event_name.to_s].map do |hook_name, callable|
+      @hooks[event_name.to_s].map do |_hook_name, callable|
         begin
           callable.call(*args, &block)
         rescue PuppetDebugger::Exception::Error, ::RuntimeError => e
@@ -118,10 +119,10 @@ module PuppetDebugger
     # @param [Symbol] hook_name The name of the hook
     # @return [#call] a specific hook for a given event.
     def get_hook(event_name, hook_name)
-      hook = @hooks[event_name.to_s].find do |current_hook_name, callable|
+      hook = @hooks[event_name.to_s].find do |current_hook_name, _callable|
         current_hook_name == hook_name
       end
-      hook.last if hook
+      hook&.last
     end
 
     # @param [Symbol] event_name The name of the event.
@@ -167,8 +168,6 @@ module PuppetDebugger
 
     protected
 
-    def hooks
-      @hooks
-    end
+    attr_reader :hooks
   end
-end
+end