From fc841040e2fa121a0ea63fed36ea197a5edd1660 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Mon, 8 Apr 2019 16:22:42 +0800 Subject: [PATCH] (maint) Update for rubocop errors This commit updates Editor Services for the new cops introduced in Rubocop 0.67.1. --- .rubocop.yml | 3 +++ lib/puppet-debugserver/message_router.rb | 4 ++-- .../puppet_debug_session.rb | 8 ++++---- .../puppet_monkey_patches.rb | 20 +++++++++---------- .../puppet_helper.rb | 4 ++-- .../puppet_parser_helper.rb | 4 ++-- .../epp/validation_provider.rb | 12 +++++------ lib/puppet-languageserver/facter_helper.rb | 8 ++++---- .../manifest/validation_provider.rb | 14 ++++++------- .../puppet_parser_helper.rb | 4 ++-- .../puppetfile/validation_provider.rb | 10 +++++----- lib/puppet-languageserver/sidecar_queue.rb | 4 ++-- lib/puppet-languageserver/validation_queue.rb | 4 ++-- lib/puppet_languageserver_sidecar.rb | 4 ++-- 14 files changed, 53 insertions(+), 50 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index fcd1df1b..fa043b0e 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -80,3 +80,6 @@ Style/HashSyntax: Layout/AlignHash: EnforcedHashRocketStyle: table + +Naming/RescuedExceptionsVariableName: + PreferredName: e diff --git a/lib/puppet-debugserver/message_router.rb b/lib/puppet-debugserver/message_router.rb index a26412d1..50fe51cb 100644 --- a/lib/puppet-debugserver/message_router.rb +++ b/lib/puppet-debugserver/message_router.rb @@ -272,11 +272,11 @@ def receive_request(request, original_json) }, request ) @json_handler.send_response response - rescue => exception # rubocop:disable Style/RescueStandardError + rescue => e # rubocop:disable Style/RescueStandardError response = PuppetDebugServer::Protocol::Response.create_from_request( { 'success' => false, - 'message' => exception.to_s + 'message' => e.to_s }, request ) @json_handler.send_response response diff --git a/lib/puppet-debugserver/puppet_debug_session.rb b/lib/puppet-debugserver/puppet_debug_session.rb index b83189ec..064a5bdf 100644 --- a/lib/puppet-debugserver/puppet_debug_session.rb +++ b/lib/puppet-debugserver/puppet_debug_session.rb @@ -173,8 +173,8 @@ def self.start @puppet_thread = Thread.new do begin PuppetDebugServer::PuppetDebugSession.start_puppet - rescue => err # rubocop:disable Style/RescueStandardError - PuppetDebugServer.log_message(:error, "Error in Puppet Thread: #{err}") + rescue => e # rubocop:disable Style/RescueStandardError + PuppetDebugServer.log_message(:error, "Error in Puppet Thread: #{e}") raise end end @@ -184,8 +184,8 @@ def self.start @watcher_thread = Thread.new do begin PuppetDebugServer::PuppetDebugSession.debug_session_watcher - rescue => err # rubocop:disable Style/RescueStandardError - PuppetDebugServer.log_message(:error, "Error in Watcher Thread: #{err}") + rescue => e # rubocop:disable Style/RescueStandardError + PuppetDebugServer.log_message(:error, "Error in Watcher Thread: #{e}") raise end end diff --git a/lib/puppet-debugserver/puppet_monkey_patches.rb b/lib/puppet-debugserver/puppet_monkey_patches.rb index f9884336..f06ae8bc 100644 --- a/lib/puppet-debugserver/puppet_monkey_patches.rb +++ b/lib/puppet-debugserver/puppet_monkey_patches.rb @@ -49,20 +49,20 @@ def self.compile(node, code_id = nil) PuppetDebugServer::PuppetDebugSession.hooks.exec_hook(:hook_after_compile, [result]) result - rescue Puppet::ParseErrorWithIssue => detail - detail.node = node.name - Puppet.log_exception(detail) + rescue Puppet::ParseErrorWithIssue => e + e.node = node.name + Puppet.log_exception(e) raise - rescue => detail # rubocop:disable Style/RescueStandardError - message = "#{detail} on node #{node.name}" - Puppet.log_exception(detail, message) - raise Puppet::Error, message, detail.backtrace + rescue => e # rubocop:disable Style/RescueStandardError + message = "#{e} on node #{node.name}" + Puppet.log_exception(e, message) + raise Puppet::Error, message, e.backtrace end - rescue Puppet::ParseErrorWithIssue => detail + rescue Puppet::ParseErrorWithIssue => e # TODO: Potential issue here with 4.10.x not implementing .file on the Positioned class # Just re-raise if there is no Puppet manifest file associated with the error - raise if detail.file.nil? || detail.line.nil? || detail.pos.nil? - PuppetDebugServer::PuppetDebugSession.hooks.exec_hook(:hook_exception, [detail]) + raise if e.file.nil? || e.line.nil? || e.pos.nil? + PuppetDebugServer::PuppetDebugSession.hooks.exec_hook(:hook_exception, [e]) raise end end diff --git a/lib/puppet-languageserver-sidecar/puppet_helper.rb b/lib/puppet-languageserver-sidecar/puppet_helper.rb index 1748d3f8..8ba6d201 100644 --- a/lib/puppet-languageserver-sidecar/puppet_helper.rb +++ b/lib/puppet-languageserver-sidecar/puppet_helper.rb @@ -53,8 +53,8 @@ def self.retrieve_classes(cache, options = {}) if path_has_child?(options[:root_path], manifest_file) # rubocop:disable Style/IfUnlessModifier Nicer to read like this classes.concat(load_classes_from_manifest(cache, manifest_file)) end - rescue StandardError => err - PuppetLanguageServerSidecar.log_message(:error, "[PuppetHelper::retrieve_classes] Error loading manifest #{manifest_file}: #{err} #{err.backtrace}") + rescue StandardError => e + PuppetLanguageServerSidecar.log_message(:error, "[PuppetHelper::retrieve_classes] Error loading manifest #{manifest_file}: #{e} #{e.backtrace}") end end end diff --git a/lib/puppet-languageserver-sidecar/puppet_parser_helper.rb b/lib/puppet-languageserver-sidecar/puppet_parser_helper.rb index 0cafc848..108d1c0a 100644 --- a/lib/puppet-languageserver-sidecar/puppet_parser_helper.rb +++ b/lib/puppet-languageserver-sidecar/puppet_parser_helper.rb @@ -17,8 +17,8 @@ def self.compile_node_graph(content) else result.dot_content = node_graph.to_dot(options) end - rescue StandardError => exception - result.set_error("Error while parsing the file. #{exception}") + rescue StandardError => e + result.set_error("Error while parsing the file. #{e}") end result diff --git a/lib/puppet-languageserver/epp/validation_provider.rb b/lib/puppet-languageserver/epp/validation_provider.rb index f072e8a6..4e8328f7 100644 --- a/lib/puppet-languageserver/epp/validation_provider.rb +++ b/lib/puppet-languageserver/epp/validation_provider.rb @@ -9,14 +9,14 @@ def self.validate(content, _max_problems = 100) begin parser = Puppet::Pops::Parser::EvaluatingParser::EvaluatingEppParser.new parser.parse_string(content, nil) - rescue StandardError => detail + rescue StandardError => e # Sometimes the error is in the cause not the root object itself - detail = detail.cause if !detail.respond_to?(:line) && detail.respond_to?(:cause) - ex_line = detail.respond_to?(:line) && !detail.line.nil? ? detail.line - 1 : nil # Line numbers from puppet exceptions are base 1 - ex_pos = detail.respond_to?(:pos) && !detail.pos.nil? ? detail.pos : nil # Pos numbers from puppet are base 1 + e = e.cause if !e.respond_to?(:line) && e.respond_to?(:cause) + ex_line = e.respond_to?(:line) && !e.line.nil? ? e.line - 1 : nil # Line numbers from puppet exceptions are base 1 + ex_pos = e.respond_to?(:pos) && !e.pos.nil? ? e.pos : nil # Pos numbers from puppet are base 1 - message = detail.respond_to?(:message) ? detail.message : nil - message = detail.basic_message if message.nil? && detail.respond_to?(:basic_message) + message = e.respond_to?(:message) ? e.message : nil + message = e.basic_message if message.nil? && e.respond_to?(:basic_message) unless ex_line.nil? || ex_pos.nil? || message.nil? result << LSP::Diagnostic.new('severity' => LSP::DiagnosticSeverity::ERROR, diff --git a/lib/puppet-languageserver/facter_helper.rb b/lib/puppet-languageserver/facter_helper.rb index abffeb2d..1d9872d9 100644 --- a/lib/puppet-languageserver/facter_helper.rb +++ b/lib/puppet-languageserver/facter_helper.rb @@ -48,10 +48,10 @@ def self._load_facts begin Facter.loadfacts @fact_hash = Facter.to_hash - rescue StandardError => ex - PuppetLanguageServer.log_message(:error, "[FacterHelper::_load_facts] Error loading facts #{ex.message} #{ex.backtrace}") - rescue LoadError => ex - PuppetLanguageServer.log_message(:error, "[FacterHelper::_load_facts] Error loading facts (LoadError) #{ex.message} #{ex.backtrace}") + rescue StandardError => e + PuppetLanguageServer.log_message(:error, "[FacterHelper::_load_facts] Error loading facts #{e.message} #{e.backtrace}") + rescue LoadError => e + PuppetLanguageServer.log_message(:error, "[FacterHelper::_load_facts] Error loading facts (LoadError) #{e.message} #{e.backtrace}") end PuppetLanguageServer.log_message(:debug, "[FacterHelper::_load_facts] Finished loading #{@fact_hash.keys.count} facts") @facts_loaded = true diff --git a/lib/puppet-languageserver/manifest/validation_provider.rb b/lib/puppet-languageserver/manifest/validation_provider.rb index e7222d4e..fb1fe763 100644 --- a/lib/puppet-languageserver/manifest/validation_provider.rb +++ b/lib/puppet-languageserver/manifest/validation_provider.rb @@ -79,7 +79,7 @@ def self.validate(content, options = {}) end end # rubocop:disable Lint/HandleExceptions - rescue StandardError => _exception + rescue StandardError # If anything catastrophic happens we resort to puppet parsing anyway end # rubocop:enable Lint/HandleExceptions @@ -101,14 +101,14 @@ def self.validate(content, options = {}) Puppet[:tasks] = original_taskmode if Puppet.tasks_supported? end end - rescue StandardError => detail + rescue StandardError => e # Sometimes the error is in the cause not the root object itself - detail = detail.cause if !detail.respond_to?(:line) && detail.respond_to?(:cause) - ex_line = detail.respond_to?(:line) && !detail.line.nil? ? detail.line - 1 : nil # Line numbers from puppet exceptions are base 1 - ex_pos = detail.respond_to?(:pos) && !detail.pos.nil? ? detail.pos : nil # Pos numbers from puppet are base 1 + e = e.cause if !e.respond_to?(:line) && e.respond_to?(:cause) + ex_line = e.respond_to?(:line) && !e.line.nil? ? e.line - 1 : nil # Line numbers from puppet exceptions are base 1 + ex_pos = e.respond_to?(:pos) && !e.pos.nil? ? e.pos : nil # Pos numbers from puppet are base 1 - message = detail.respond_to?(:message) ? detail.message : nil - message = detail.basic_message if message.nil? && detail.respond_to?(:basic_message) + message = e.respond_to?(:message) ? e.message : nil + message = e.basic_message if message.nil? && e.respond_to?(:basic_message) unless ex_line.nil? || ex_pos.nil? || message.nil? result << LSP::Diagnostic.new('severity' => LSP::DiagnosticSeverity::ERROR, diff --git a/lib/puppet-languageserver/puppet_parser_helper.rb b/lib/puppet-languageserver/puppet_parser_helper.rb index 36fc8023..e9132817 100644 --- a/lib/puppet-languageserver/puppet_parser_helper.rb +++ b/lib/puppet-languageserver/puppet_parser_helper.rb @@ -116,7 +116,7 @@ def self.object_under_cursor(content, line_num, char_num, options) begin result = parser.singleton_parse_string(new_content, options[:tasks_mode], '') break - rescue Puppet::ParseErrorWithIssue => _exception + rescue Puppet::ParseErrorWithIssue next if options[:multiple_attempts] raise end @@ -130,7 +130,7 @@ def self.object_under_cursor(content, line_num, char_num, options) # If during paring we modified the source we may need to change the cursor location begin line_offset = result.line_offsets[line_num] - rescue StandardError => _e + rescue StandardError line_offset = result['locator'].line_index[line_num] end # Typically we're completing after something was typed, so go back one char diff --git a/lib/puppet-languageserver/puppetfile/validation_provider.rb b/lib/puppet-languageserver/puppetfile/validation_provider.rb index 92ac3635..25e53fd5 100644 --- a/lib/puppet-languageserver/puppetfile/validation_provider.rb +++ b/lib/puppet-languageserver/puppetfile/validation_provider.rb @@ -16,18 +16,18 @@ def self.validate(content, _max_problems = 100) begin puppetfile = PuppetLanguageServer::Puppetfile::R10K::Puppetfile.new puppetfile.load!(content) - rescue StandardError, SyntaxError, LoadError => detail + rescue StandardError, SyntaxError, LoadError => e # Find the originating error from within the puppetfile - loc = detail.backtrace_locations - .select { |item| item.absolute_path == PuppetLanguageServer::Puppetfile::R10K::PUPPETFILE_MONIKER } - .first + loc = e.backtrace_locations + .select { |item| item.absolute_path == PuppetLanguageServer::Puppetfile::R10K::PUPPETFILE_MONIKER } + .first start_line_number = loc.nil? ? 0 : loc.lineno - 1 # Line numbers from ruby are base 1 end_line_number = loc.nil? ? content.lines.count - 1 : loc.lineno - 1 # Line numbers from ruby are base 1 # Note - Ruby doesn't give a character position so just highlight the entire line result << LSP::Diagnostic.new('severity' => LSP::DiagnosticSeverity::ERROR, 'range' => LSP.create_range(start_line_number, 0, end_line_number, max_line_length), 'source' => 'Puppet', - 'message' => detail.to_s) + 'message' => e.to_s) puppetfile = nil end diff --git a/lib/puppet-languageserver/sidecar_queue.rb b/lib/puppet-languageserver/sidecar_queue.rb index b8f284eb..d1d7830c 100644 --- a/lib/puppet-languageserver/sidecar_queue.rb +++ b/lib/puppet-languageserver/sidecar_queue.rb @@ -35,8 +35,8 @@ def enqueue(action, additional_args) @queue_threads << Thread.new do begin worker - rescue => err # rubocop:disable Style/RescueStandardError - PuppetLanguageServer.log_message(:error, "Error in SidecarQueue Thread: #{err}") + rescue => e # rubocop:disable Style/RescueStandardError + PuppetLanguageServer.log_message(:error, "Error in SidecarQueue Thread: #{e}") raise end end diff --git a/lib/puppet-languageserver/validation_queue.rb b/lib/puppet-languageserver/validation_queue.rb index e1522db5..c39e5863 100644 --- a/lib/puppet-languageserver/validation_queue.rb +++ b/lib/puppet-languageserver/validation_queue.rb @@ -35,8 +35,8 @@ def self.enqueue(file_uri, doc_version, connection_object) @queue_thread = Thread.new do begin worker - rescue => err # rubocop:disable Style/RescueStandardError - PuppetLanguageServer.log_message(:error, "Error in ValidationQueue Thread: #{err}") + rescue => e # rubocop:disable Style/RescueStandardError + PuppetLanguageServer.log_message(:error, "Error in ValidationQueue Thread: #{e}") raise end end diff --git a/lib/puppet_languageserver_sidecar.rb b/lib/puppet_languageserver_sidecar.rb index caad8cc9..47865b29 100644 --- a/lib/puppet_languageserver_sidecar.rb +++ b/lib/puppet_languageserver_sidecar.rb @@ -102,8 +102,8 @@ def self.parse(options) begin ap.from_json!(json_string) args[:action_parameters] = ap - rescue StandardError => ex - raise "Unable to parse the action parameters: #{ex}" + rescue StandardError => e + raise "Unable to parse the action parameters: #{e}" end end