puppet-debugger 0.4.1 → 0.4.2

data/lib/puppet-debugger/support/compiler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'tempfile'
 
 module PuppetDebugger
@@ -14,7 +15,6 @@ module PuppetDebugger
       def set_compiler(value)
         @compiler = value
       end
-
     end
   end
 end

data/lib/puppet-debugger/support/environment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module Environment
@@ -25,14 +26,13 @@ module PuppetDebugger
 
       # the cached name of the environment
       def default_puppet_env_name
-         ENV['PUPPET_ENV'] || Puppet[:environment]
+        ENV['PUPPET_ENV'] || Puppet[:environment]
       end
 
       # currently this is not being used
       def environment_loaders
         name = compiler.loaders.public_environment_loader.loader_name
       end
-
     end
   end
 end

data/lib/puppet-debugger/support/errors.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Exception
     class Error < StandardError
       attr_accessor :data
-      def initialize(data={})
+      def initialize(data = {})
         @data = data
       end
-
     end
 
     class FatalError < Error
@@ -34,7 +34,7 @@ Cannot find node with name: #{data[:name]} on remote server
     end
 
     class TimeOutError < Error
-      #Errno::ETIMEDOUT
+      # Errno::ETIMEDOUT
     end
 
     class NoClassError < FatalError
@@ -70,6 +70,5 @@ You will need to edit your auth.conf or conf.d/auth.conf (puppetserver) to allow
 EOF
     end
     end
-
   end
 end

data/lib/puppet-debugger/support/facts.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module Facts
@@ -49,16 +50,16 @@ Using filter: #{facterdb_filter}
 Bad FacterDB filter, please change the filter so it returns a result set.
 See https://github.com/camptocamp/facterdb/#with-a-string-filter
           EOS
-          raise PuppetDebugger::Exception::BadFilter.new(:message => message)
+          raise PuppetDebugger::Exception::BadFilter, message: message
         end
         # fix for when --show-legacy facts are not part of the facter 3 fact set
-        node_facts[:fqdn] = node_facts[:networking].fetch('fqdn',nil) unless node_facts[:fqdn]
+        node_facts[:fqdn] = node_facts[:networking].fetch('fqdn', nil) unless node_facts[:fqdn]
         node_facts
       end
 
       def default_facts
         unless @facts
-          values = Hash[ node_facts.map { |k, v| [k.to_s, v] } ]
+          values = Hash[node_facts.map { |k, v| [k.to_s, v] }]
           name = values['fqdn']
           @facts ||= Puppet::Node::Facts.new(name, values)
         end
@@ -67,12 +68,11 @@ See https://github.com/camptocamp/facterdb/#with-a-string-filter
 
       def server_facts
         data = {}
-        data["servername"] = Facter.value("fqdn") || Facter.value('networking')['fqdn']
-        data['serverip'] = Facter.value("ipaddress")
-        data["serverversion"] = Puppet.version.to_s
+        data['servername'] = Facter.value('fqdn') || Facter.value('networking')['fqdn']
+        data['serverip'] = Facter.value('ipaddress')
+        data['serverversion'] = Puppet.version.to_s
         data
       end
-
     end
   end
 end

data/lib/puppet-debugger/support/functions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module Functions
@@ -7,14 +8,12 @@ module PuppetDebugger
       def function_files
         search_dirs = lib_dirs.map do |lib_dir|
           [File.join(lib_dir, 'puppet', 'functions', '**', '*.rb'),
-            File.join(lib_dir, 'functions', '**', '*.rb'),
-           File.join(lib_dir, 'puppet', 'parser', 'functions', '*.rb')
-           ]
+           File.join(lib_dir, 'functions', '**', '*.rb'),
+           File.join(lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
         end
         # add puppet lib directories
         search_dirs << [File.join(puppet_lib_dir, 'puppet', 'functions', '**', '*.rb'),
-          File.join(puppet_lib_dir, 'puppet', 'parser', 'functions', '*.rb')
-         ]
+                        File.join(puppet_lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
         Dir.glob(search_dirs.flatten)
       end
 

data/lib/puppet-debugger/support/input_responders.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module InputResponders
-
       def static_responder_list
-        ["exit", "functions", "classification","vars", 'facterdb_filter', "krt", "facts",
-         "resources", "classes", "whereami", "play","reset", "help"
-        ]
+        %w(exit functions classification vars facterdb_filter krt facts
+           resources classes whereami play reset help)
       end
 
       # @source_file and @source_line_num instance variables must be set for this
       # method to show the surrounding code
       # @return [String] - string output of the code surrounded by the breakpoint or nil if file or line_num do not exist
-      def whereami(command=nil, args=nil)
-        file=@source_file
-        line_num=@source_line_num
-        if file and line_num
+      def whereami(_command = nil, _args = nil)
+        file = @source_file
+        line_num = @source_line_num
+        if file && line_num
           if file == :code
             source_code = Puppet[:code]
             code = DebuggerCode.from_string(source_code, :puppet)
@@ -27,11 +26,11 @@ module PuppetDebugger
 
       # displays the facterdb filter
       # @param [Array] - args is not used
-      def facterdb_filter(args=[])
+      def facterdb_filter(_args = [])
         dynamic_facterdb_filter.ai
       end
 
-      def help(args=[])
+      def help(_args = [])
         PuppetDebugger::Cli.print_repl_desc
       end
 
@@ -46,7 +45,7 @@ module PuppetDebugger
             reset
             set_remote_node_name(name)
           else
-            out_buffer.puts "Must supply a valid node name"
+            out_buffer.puts 'Must supply a valid node name'
           end
         when /loglevel/
           if level = args.shift
@@ -58,29 +57,29 @@ module PuppetDebugger
         output
       end
 
-      def facts(args=[])
+      def facts(_args = [])
         variables = node.facts.values
-        variables.ai({:sort_keys => true, :indent => -1})
+        variables.ai(sort_keys: true, indent: -1)
       end
 
-      def functions(args=[])
+      def functions(args = [])
         filter = args.first || ''
         function_map.keys.sort.grep(/^#{Regexp.escape(filter)}/)
       end
 
-      def vars(args=[])
+      def vars(_args = [])
         # remove duplicate variables that are also in the facts hash
-        variables = scope.to_hash.delete_if {| key, value | node.facts.values.key?(key) }
+        variables = scope.to_hash.delete_if { |key, _value| node.facts.values.key?(key) }
         variables['facts'] = 'removed by the puppet-debugger' if variables.key?('facts')
-        output = "Facts were removed for easier viewing".ai + "\n"
-        output += variables.ai({:sort_keys => true, :indent => -1})
+        output = 'Facts were removed for easier viewing'.ai + "\n"
+        output += variables.ai(sort_keys: true, indent: -1)
       end
 
-      def environment(args=[])
+      def environment(_args = [])
         "Puppet Environment: #{puppet_env_name}"
       end
 
-      def reset(args=[])
+      def reset(_args = [])
         set_scope(nil)
         set_remote_node_name(nil)
         set_node(nil)
@@ -100,22 +99,22 @@ module PuppetDebugger
         nil
       end
 
-      def krt(args=[])
-        known_resource_types.ai({:sort_keys => true, :indent => -1})
+      def krt(_args = [])
+        known_resource_types.ai(sort_keys: true, indent: -1)
       end
 
-      def play(args=[])
+      def play(args = [])
         config = {}
         config[:play] = args.first
         play_back(config)
-        return nil  # we don't want to return anything
+        nil # we don't want to return anything
       end
 
-      def classification(args=[])
+      def classification(_args = [])
         node.classes.ai
       end
 
-      def resources(args=[])
+      def resources(args = [])
         res = scope.compiler.catalog.resources.map do |res|
           res.to_s.gsub(/\[/, "['").gsub(/\]/, "']") # ensure the title has quotes
         end
@@ -127,10 +126,9 @@ module PuppetDebugger
         end
       end
 
-      def classes(args=[])
+      def classes(_args = [])
         scope.compiler.catalog.classes.ai
       end
-
     end
   end
 end

data/lib/puppet-debugger/support/node.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'puppet/indirector/node/rest'
 
 module PuppetDebugger
@@ -46,7 +47,7 @@ module PuppetDebugger
       def get_remote_node(name)
         indirection = Puppet::Indirector::Indirection.instance(:node)
         indirection.terminus_class = 'rest'
-        remote_node = indirection.find(name, :environment => puppet_environment)
+        remote_node = indirection.find(name, environment: puppet_environment)
         remote_node
       end
 
@@ -59,7 +60,7 @@ module PuppetDebugger
         parameters = remote_node.parameters.dup
         trusted_data = parameters.delete('trusted')
         options[:parameters] = parameters || {}
-        options[:facts] = Puppet::Node::Facts.new(remote_node.name,remote_node.parameters)
+        options[:facts] = Puppet::Node::Facts.new(remote_node.name, remote_node.parameters)
         options[:classes] = remote_node.classes
         options[:environment] = puppet_environment
         node_object = Puppet::Node.new(remote_node.name, options)
@@ -71,11 +72,11 @@ module PuppetDebugger
       # query the remote puppet server and retrieve the node object
       #
       def set_node_from_name(name)
-        out_buffer.puts ("Fetching node #{name}")
+        out_buffer.puts "Fetching node #{name}"
         remote_node = get_remote_node(name)
-        if remote_node and remote_node.parameters.empty?
-          remote_node_name = nil  # clear out the remote name
-          raise PuppetDebugger::Exception::UndefinedNode.new(:name => remote_node.name)
+        if remote_node && remote_node.parameters.empty?
+          remote_node_name = nil # clear out the remote name
+          raise PuppetDebugger::Exception::UndefinedNode, name: remote_node.name
         end
         remote_node_name = remote_node.name
         node_object = convert_remote_node(remote_node)

data/lib/puppet-debugger/support/play.rb

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module Play
-
-      def play_back(config={})
+      def play_back(config = {})
         if config[:play]
           if config[:play] =~ /^http/
             play_back_url(config[:play])
-          elsif File.exists? config[:play]
+          elsif File.exist? config[:play]
             play_back_string(File.read(config[:play]))
           else config[:play]
-            out_buffer.puts "puppet-debugger can't play #{config[:play]}'"
+               out_buffer.puts "puppet-debugger can't play #{config[:play]}'"
           end
         end
       end
@@ -19,18 +19,12 @@ module PuppetDebugger
         url_data = URI(url)
         case url_data.host
         when /^gist\.github*/
-          unless url_data.path =~ /raw/
-            url = url += '.txt'
-          end
+          url = url += '.txt' unless url_data.path =~ /raw/
           url
         when /^github.com/
-          if url_data.path =~ /blob/
-            url.gsub('blob', 'raw')
-          end
+          url.gsub('blob', 'raw') if url_data.path =~ /blob/
         when /^gist.github.com/
-          unless url_data.path =~ /raw/
-            url = url += '.txt'
-          end
+          url = url += '.txt' unless url_data.path =~ /raw/
           url
         when /^gitlab.com/
           if url_data.path =~ /snippets/
@@ -50,15 +44,13 @@ module PuppetDebugger
       end
 
       def play_back_url(url)
-        begin
-          require 'open-uri'
-          require 'net/http'
-          converted_url = convert_to_text(url)
-          str = fetch_url_data(converted_url)
-          play_back_string(str)
-        rescue SocketError
-          abort "puppet-debugger can't play `#{converted_url}'"
-        end
+        require 'open-uri'
+        require 'net/http'
+        converted_url = convert_to_text(url)
+        str = fetch_url_data(converted_url)
+        play_back_string(str)
+      rescue SocketError
+        abort "puppet-debugger can't play `#{converted_url}'"
       end
 
       # plays back the string to the output stream
@@ -70,10 +62,10 @@ module PuppetDebugger
             full_buffer += buf
             # unless this is puppet code, otherwise skip repl keywords
             if keyword_expression.match(buf)
-              out_buffer.write(">> ")
+              out_buffer.write('>> ')
             else
               parser.parse_string(full_buffer)
-              out_buffer.write(">> ")
+              out_buffer.write('>> ')
             end
           rescue Puppet::ParseErrorWithIssue => e
             if multiline_input?(e)

data/lib/puppet-debugger/support/scope.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module Scope
@@ -7,9 +8,7 @@ module PuppetDebugger
 
       # @return [Scope] puppet scope object
       def scope
-        unless @scope
-          @scope ||= create_scope
-        end
+        @scope ||= create_scope unless @scope
         @scope
       end
 
@@ -34,7 +33,7 @@ module PuppetDebugger
 
       # returns a hash of varaibles that are currently in scope
       def scope_vars
-        vars = scope.to_hash.delete_if {| key, value | node.facts.values.key?(key.to_sym) }
+        vars = scope.to_hash.delete_if { |key, _value| node.facts.values.key?(key.to_sym) }
         vars['facts'] = 'removed by the puppet-debugger'
       end
     end

data/lib/puppet-debugger/support.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'puppet/pops'
 require 'facterdb'
 require 'tempfile'
 
 # load all the generators found in the generators directory
-Dir.glob(File.join(File.dirname(__FILE__),'support', '*.rb')).each do |file|
+Dir.glob(File.join(File.dirname(__FILE__), 'support', '*.rb')).each do |file|
   require_relative File.join('support', File.basename(file, '.rb'))
 end
 
@@ -23,18 +24,18 @@ module PuppetDebugger
     def parse_error(error)
       case error
       when SocketError
-        PuppetDebugger::Exception::ConnectError.new(:message => "Unknown host: #{Puppet[:server]}")
+        PuppetDebugger::Exception::ConnectError.new(message: "Unknown host: #{Puppet[:server]}")
       when Net::HTTPError
-        PuppetDebugger::Exception::AuthError.new(:message => error.message)
+        PuppetDebugger::Exception::AuthError.new(message: error.message)
       when Errno::ECONNREFUSED
-        PuppetDebugger::Exception::ConnectError.new(:message => error.message)
+        PuppetDebugger::Exception::ConnectError.new(message: error.message)
       when Puppet::Error
         if error.message =~ /could\ not\ find\ class/i
-          PuppetDebugger::Exception::NoClassError.new(:default_modules_paths => default_modules_paths,
-           :message => error.message)
+          PuppetDebugger::Exception::NoClassError.new(default_modules_paths: default_modules_paths,
+                                                      message: error.message)
         elsif error.message =~ /default\ node/i
-          PuppetDebugger::Exception::NodeDefinitionError.new(:default_site_manifest => default_site_manifest,
-           :message => error.message)
+          PuppetDebugger::Exception::NodeDefinitionError.new(default_site_manifest: default_site_manifest,
+                                                             message: error.message)
         else
           error
         end
@@ -49,7 +50,7 @@ module PuppetDebugger
       dirs = []
       do_initialize if Puppet[:codedir].nil?
       # add the puppet-debugger directory so we can load any defined functions
-      dirs << File.join(Puppet[:environmentpath],default_puppet_env_name,'modules') unless Puppet[:environmentpath].empty?
+      dirs << File.join(Puppet[:environmentpath], default_puppet_env_name, 'modules') unless Puppet[:environmentpath].empty?
       dirs << Puppet.settings[:basemodulepath].split(':')
       dirs.flatten
     end
@@ -75,40 +76,38 @@ module PuppetDebugger
       end
     end
 
-     def keyword_expression
-       @keyword_expression ||= Regexp.new(/^exit|^:set|^play|^classification|^facts|^vars|^functions|^whereami|^classes|^resources|^krt|^environment|^reset|^help/)
-     end
+    def keyword_expression
+      @keyword_expression ||= Regexp.new(/^exit|^:set|^play|^classification|^facts|^vars|^functions|^whereami|^classes|^resources|^krt|^environment|^reset|^help/)
+    end
 
     def known_resource_types
       res = {
-        :hostclasses => scope.environment.known_resource_types.hostclasses.keys,
-        :definitions => scope.environment.known_resource_types.definitions.keys,
-        :nodes => scope.environment.known_resource_types.nodes.keys,
+        hostclasses: scope.environment.known_resource_types.hostclasses.keys,
+        definitions: scope.environment.known_resource_types.definitions.keys,
+        nodes: scope.environment.known_resource_types.nodes.keys
       }
       if sites = scope.environment.known_resource_types.instance_variable_get(:@sites)
-        res.merge!(:sites => scope.environment.known_resource_types.instance_variable_get(:@sites).first)
+        res[:sites] = scope.environment.known_resource_types.instance_variable_get(:@sites).first
       end
       if scope.environment.known_resource_types.respond_to?(:applications)
-        res.merge!(:applications => scope.environment.known_resource_types.applications.keys)
+        res[:applications] = scope.environment.known_resource_types.applications.keys
       end
       # some versions of puppet do not support capabilities
       if scope.environment.known_resource_types.respond_to?(:capability_mappings)
-        res.merge!(:capability_mappings => scope.environment.known_resource_types.capability_mappings.keys)
+        res[:capability_mappings] = scope.environment.known_resource_types.capability_mappings.keys
       end
       res
     end
 
     # this is required in order to load things only when we need them
     def do_initialize
-      begin
-        Puppet.initialize_settings
-        Puppet[:parser] = 'future'  # this is required in order to work with puppet 3.8
-        Puppet[:trusted_node_data] = true
-      rescue ArgumentError => e
-
-      rescue Puppet::DevError => e
-        # do nothing otherwise calling init twice raises an error
-      end
+      Puppet.initialize_settings
+      Puppet[:parser] = 'future' # this is required in order to work with puppet 3.8
+      Puppet[:trusted_node_data] = true
+    rescue ArgumentError => e
+
+    rescue Puppet::DevError => e
+      # do nothing otherwise calling init twice raises an error
     end
 
     # @param String - any valid puppet language code
@@ -125,14 +124,14 @@ module PuppetDebugger
       ::Puppet::Pops::Model::AstTransformer.new('').merge_location(args, model)
 
       ast_code =
-      if model.is_a? ::Puppet::Pops::Model::Program
-        ::Puppet::Parser::AST::PopsBridge::Program.new(model, args)
-      else
-        args[:value] = model
-        ::Puppet::Parser::AST::PopsBridge::Expression.new(args)
-      end
+        if model.is_a? ::Puppet::Pops::Model::Program
+          ::Puppet::Parser::AST::PopsBridge::Program.new(model, args)
+        else
+          args[:value] = model
+          ::Puppet::Parser::AST::PopsBridge::Expression.new(args)
+        end
       # Create the "main" class for the content - this content will get merged with all other "main" content
-      ::Puppet::Parser::AST::Hostclass.new('', :code => ast_code)
+      ::Puppet::Parser::AST::Hostclass.new('', code: ast_code)
     end
 
     # @param String - any valid puppet language code
@@ -146,10 +145,10 @@ module PuppetDebugger
       File.open(file, 'w') do |f|
         f.write(input)
       end
-      Puppet.override( {:code => input, :global_scope => scope, :loaders => scope.compiler.loaders } , 'For puppet-debugger') do
-         # because the repl is not a module we leave the modname blank
-         scope.environment.known_resource_types.import_ast(ast, '')
-         parser.evaluate_string(scope, input, File.expand_path(file))
+      Puppet.override({ code: input, global_scope: scope, loaders: scope.compiler.loaders }, 'For puppet-debugger') do
+        # because the repl is not a module we leave the modname blank
+        scope.environment.known_resource_types.import_ast(ast, '')
+        parser.evaluate_string(scope, input, File.expand_path(file))
       end
     end
 
@@ -165,12 +164,11 @@ module PuppetDebugger
     end
 
     def default_manifests_dir
-      File.join(Puppet[:environmentpath],default_puppet_env_name,'manifests')
+      File.join(Puppet[:environmentpath], default_puppet_env_name, 'manifests')
     end
 
     def default_site_manifest
       File.join(default_manifests_dir, 'site.pp')
     end
-
   end
 end