(maint) Fix rubocop violations

Author: glennsarti

server/.rubocop.yml

@@ -42,6 +42,14 @@ Style/EmptyMethod:
 Style/RegexpLiteral:
   Enabled: false
 
+# Sometimes, I actually want both!
+Style/DateTime:
+  Enabled: false
+
+# Please don't fail at failing.
+Lint/UnneededDisable:
+  Enabled: false
+
 # In some cases readability is better without these cops enabled
 Style/ConditionalAssignment:
   Enabled: false

server/.rubocop_todo.yml

@@ -1,17 +1 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-06-16 13:39:02 -0700 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-Lint/HandleExceptions:
-  Exclude:
-    - 'lib/puppet-languageserver/simple_tcp_server.rb'
-
-# Offense count: 1
-Lint/ScriptPermission:
-  Exclude:
-    - 'puppet-languageserver'
+# Rubocop TODO file

server/lib/puppet-languageserver.rb

@@ -25,7 +25,7 @@ def self.parse(options)
         preload_puppet: true,
         debug: nil,
         fast_start_tcpserver: true,
-        workspace: nil,
+        workspace: nil
       }
 
       opt_parser = OptionParser.new do |opts|

server/lib/puppet-languageserver/completion_provider.rb

@@ -86,7 +86,7 @@ def self.keywords(keywords = [], &block)
     end
 
     def self.all_facts(&block)
-      PuppetLanguageServer::FacterHelper.facts.each do |name, _value|
+      PuppetLanguageServer::FacterHelper.facts.each_key do |name|
         item = LanguageServer::CompletionItem.create('label' => name.to_s,
                                                      'insertText' => "'#{name}'",
                                                      'kind'       => LanguageServer::COMPLETIONITEMKIND_VARIABLE,
@@ -110,7 +110,7 @@ def self.all_resources(&block)
 
     def self.all_statement_functions(&block)
       # Find functions which don't return values i.e. statements
-      PuppetLanguageServer::PuppetHelper.functions.select { |_key, obj| obj[:type] == :statement }.each do |key, _obj|
+      PuppetLanguageServer::PuppetHelper.functions.select { |_key, obj| obj[:type] == :statement }.each_key do |key|
         item = LanguageServer::CompletionItem.create('label' => key.to_s,
                                                      'kind'   => LanguageServer::COMPLETIONITEMKIND_FUNCTION,
                                                      'detail' => 'Function',

server/lib/puppet-languageserver/document_validator.rb

@@ -50,7 +50,7 @@ def self.validate(content, workspace, _max_problems = 100)
             next if problem[:kind] == :error && problem[:check] == :syntax
             # Ignore linting errors what were ignored by puppet-lint
             next if problem[:kind] == :ignored
-            
+
             severity = case problem[:kind]
                        when :error
                          LanguageServer::DIAGNOSTICSEVERITY_ERROR
@@ -74,7 +74,7 @@ def self.validate(content, workspace, _max_problems = 100)
           end
         end
       # rubocop:disable Lint/HandleExceptions
-      rescue => _exception
+      rescue StandardError => _exception
         # If anything catastrophic happens we resort to puppet parsing anyway
       end
 
@@ -87,7 +87,7 @@ def self.validate(content, workspace, _max_problems = 100)
           validation_environment = env
           validation_environment.check_for_reparse
           validation_environment.known_resource_types.clear
-        rescue => detail
+        rescue StandardError => detail
           # Somtimes the error is in the cause not the root object itself
           detail = detail.cause if !detail.respond_to?(:line) && detail.respond_to?(:cause) && detail.cause.respond_to?(:line)
 

server/lib/puppet-languageserver/message_router.rb

@@ -27,44 +27,47 @@ def self.document_uris
 
   module CrashDump
     def self.default_crash_file
-      File.join(Dir.tmpdir(),'puppet_language_server_crash.txt')
+      File.join(Dir.tmpdir, 'puppet_language_server_crash.txt')
     end
 
     def self.write_crash_file(err, filename = nil, additional = {})
       # Create the crash text
 
-      puppet_version         = Puppet.version rescue 'Unknown'
-      facter_version         = Facter.version rescue 'Unknown'
-      languageserver_version = PuppetLanguageServer.version rescue 'Unknown'
+      puppet_version         = Puppet.version rescue 'Unknown' # rubocop:disable Lint/RescueWithoutErrorClass, Style/RescueModifier
+      facter_version         = Facter.version rescue 'Unknown' # rubocop:disable Lint/RescueWithoutErrorClass, Style/RescueModifier
+      languageserver_version = PuppetLanguageServer.version rescue 'Unknown' # rubocop:disable Lint/RescueWithoutErrorClass, Style/RescueModifier
 
+      # rubocop:disable Layout/IndentHeredoc
       crashtext = <<-TEXT
 Puppet Language Server Crash File
 -=--=--=--=--=--=--=--=--=--=--=-
-#{DateTime.now.strftime("%a %b %e %Y %H:%M:%S %Z")}
+#{DateTime.now.strftime('%a %b %e %Y %H:%M:%S %Z')}
 Puppet Version #{puppet_version}
 Facter Version #{facter_version}
 Ruby Version #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}
 Language Server Version #{languageserver_version}
 
-Error: #{err.to_s}
+Error: #{err}
 
 Backtrace
 ---------
-#{err.backtrace.join("\n") }
+#{err.backtrace.join("\n")}
 
 TEXT
+      # rubocop:enable Layout/IndentHeredoc
+
       # Append the documents in the cache
       PuppetLanguageServer::DocumentStore.document_uris.each do |uri|
         crashtext += "Document - #{uri}\n---\n#{PuppetLanguageServer::DocumentStore.document(uri)}\n\n"
       end
       # Append additional objects from the crash
-      additional.each do |k,v|
-        crashtext += "#{k}\n---\n#{v.to_s}\n\n"
+      additional.each do |k, v|
+        crashtext += "#{k}\n---\n#{v}\n\n"
       end
 
       crash_file = filename.nil? ? default_crash_file : filename
       File.open(crash_file, 'wb') { |file| file.write(crashtext) }
-    rescue
+    rescue # rubocop:disable Lint/RescueWithoutErrorClass, Lint/HandleExceptions
       # Swallow all errors.  Errors in the error handler should not
       # terminate the application
     end
@@ -98,8 +101,7 @@ def receive_request(request)
                                                                   'facterVersion'   => Facter.version,
                                                                   'factsLoaded'     => PuppetLanguageServer::FacterHelper.facts_loaded?,
                                                                   'functionsLoaded' => PuppetLanguageServer::PuppetHelper.functions_loaded?,
-                                                                  'typesLoaded'     => PuppetLanguageServer::PuppetHelper.types_loaded?
-                                                                  ))
+                                                                  'typesLoaded'     => PuppetLanguageServer::PuppetHelper.types_loaded?))
 
       when 'puppet/getResource'
         type_name = request.params['typename']
@@ -117,7 +119,7 @@ def receive_request(request)
           resources = [resources] unless resources.nil?
         end
         if resources.nil? || resources.length.zero?
-          request.reply_result(LanguageServer::PuppetCompilation.create('data' => '')) 
+          request.reply_result(LanguageServer::PuppetCompilation.create('data' => ''))
           return
         end
         # TODO: Should probably move this to a helper?
@@ -140,11 +142,11 @@ def receive_request(request)
           }
           node_graph = PuppetLanguageServer::PuppetParserHelper.compile_to_pretty_relationship_graph(content)
           if node_graph.vertices.count.zero?
-            error_content = "There were no resources created in the node graph. Is there an include statement missing?"
+            error_content = 'There were no resources created in the node graph. Is there an include statement missing?'
           else
             dot_content = node_graph.to_dot(options)
           end
-        rescue => exception
+        rescue StandardError => exception
           error_content = "Error while parsing the file. #{exception}"
         end
         request.reply_result(LanguageServer::PuppetCompilation.create('dotContent' => dot_content,
@@ -157,15 +159,15 @@ def receive_request(request)
         content = documents.document(file_uri)
         begin
           request.reply_result(PuppetLanguageServer::CompletionProvider.complete(content, line_num, char_num))
-        rescue => exception
+        rescue StandardError => exception
           PuppetLanguageServer.log_message(:error, "(textDocument/completion) #{exception}")
           request.reply_result(LanguageServer::CompletionList.create_nil_response)
         end
 
       when 'completionItem/resolve'
         begin
           request.reply_result(PuppetLanguageServer::CompletionProvider.resolve(request.params.clone))
-        rescue => exception
+        rescue StandardError => exception
           PuppetLanguageServer.log_message(:error, "(completionItem/resolve) #{exception}")
           # Spit back the same params if an error happens
           request.reply_result(request.params)
@@ -178,18 +180,15 @@ def receive_request(request)
         content = documents.document(file_uri)
         begin
           request.reply_result(PuppetLanguageServer::HoverProvider.resolve(content, line_num, char_num))
-        rescue => exception
+        rescue StandardError => exception
           PuppetLanguageServer.log_message(:error, "(textDocument/hover) #{exception}")
           request.reply_result(LanguageServer::Hover.create_nil_response)
         end
       else
         PuppetLanguageServer.log_message(:error, "Unknown RPC method #{request.rpc_method}")
       end
-    rescue => err
-      PuppetLanguageServer::CrashDump.write_crash_file(err, nil, {
-        'request' => request.rpc_method,
-        'params'  => request.params,
-      })
+    rescue StandardError => err
+      PuppetLanguageServer::CrashDump.write_crash_file(err, nil, 'request' => request.rpc_method, 'params' => request.params)
       raise
     end
 
@@ -227,11 +226,8 @@ def receive_notification(method, params)
       else
         PuppetLanguageServer.log_message(:error, "Unknown RPC notification #{method}")
       end
-    rescue => err
-      PuppetLanguageServer::CrashDump.write_crash_file(err, nil, {
-        'notification' => method,
-        'params'  => params,
-      })
+    rescue StandardError => err
+      PuppetLanguageServer::CrashDump.write_crash_file(err, nil, 'notification' => method, 'params' => params)
       raise
     end
   end

server/lib/puppet-languageserver/puppet_helper.rb

@@ -10,7 +10,7 @@ module PuppetHelper
     @function_module = nil
     @types_loaded = nil
     @functions_loaded = nil
-    
+
     def self.reset
       @ops_lock_types.synchronize do
         @ops_lock_funcs.synchronize do
@@ -142,13 +142,14 @@ def self._load_types
 
       autoloader = Puppet::Util::Autoload.new(self, 'puppet/type')
       autoloader.files_to_load.each do |file|
-        name = file.gsub(autoloader.path + '/','')
+        name = file.gsub(autoloader.path + '/', '')
+        next if autoloader.loaded?(name)
         begin
           result = autoloader.load(name)
           PuppetLanguageServer.log_message(:error, "[PuppetHelper::_load_types] type #{file} did not load") unless result
         rescue StandardError => err
           PuppetLanguageServer.log_message(:error, "[PuppetHelper::_load_types] Error loading type #{file}: #{err}")
-        end unless autoloader.loaded?(name)
+        end
       end
 
       Puppet::Type.eachtype do |type|
@@ -172,13 +173,14 @@ def self._load_functions
 
       # This is an expensive call
       autoloader.files_to_load.each do |file|
-        name = file.gsub(autoloader.path + '/','')
+        name = file.gsub(autoloader.path + '/', '')
+        next if autoloader.loaded?(name)
         begin
           result = autoloader.load(name)
           PuppetLanguageServer.log_message(:error, "[PuppetHelper::_load_functions] function #{file} did not load") unless result
         rescue StandardError => err
           PuppetLanguageServer.log_message(:error, "[PuppetHelper::_load_functions] Error loading function #{file}: #{err}")
-        end unless autoloader.loaded?(name)
+        end
       end
 
       @function_module = Puppet::Parser::Functions.environment_module(Puppet.lookup(:current_environment))

server/lib/puppet-languageserver/puppet_parser_helper.rb

@@ -122,7 +122,7 @@ def self.object_under_cursor(content, line_num, char_num, multiple_attempts = fa
       #   If during paring we modified the source we may need to change the cursor location
       begin
         line_offset = result.line_offsets[line_num]
-      rescue
+      rescue StandardError => _e
         line_offset = result['locator'].line_index[line_num]
       end
       # Typically we're completing after something was typed, so go back one char

server/lib/puppet-languageserver/simple_tcp_server.rb

@@ -80,7 +80,7 @@ def get_data(io, connection_data)
 
       # We're already in a callback so no need to invoke as a callback
       connection_data[:handler].receive_data(data)
-    rescue => e
+    rescue StandardError => e
       # should also log error
       remove_connection(io)
       log("Closed socket due to error - #{e}\n#{e.backtrace}")
@@ -102,7 +102,8 @@ def start(handler = PuppetLanguageServer::SimpleTCPServerConnection, connection_
       thread_cycle = proc do
         begin
           io_review
-        rescue
+        rescue # rubocop:disable Lint/RescueWithoutErrorClass
+          # Swallow all errors
           false
         end
         true while fire_event
@@ -122,7 +123,7 @@ def start(handler = PuppetLanguageServer::SimpleTCPServerConnection, connection_
 
       # Output to STDOUT.  This is required by Langugage Client so it knows the server is now running
       self.class.s_locker.synchronize do
-        self.class.services.each do |_service, options|
+        self.class.services.each_value do |options|
           $stdout.write("LANGUAGE SERVER RUNNING #{options[:hostname]}:#{options[:port]}\n")
         end
       end
@@ -144,7 +145,9 @@ def start(handler = PuppetLanguageServer::SimpleTCPServerConnection, connection_
               end
             end
           end
-        rescue true
+        rescue # rubocop:disable Lint/RescueWithoutErrorClass
+          # Swallow all errors
+          true
         end
         break if self.class.services.empty?
       end
@@ -233,8 +236,9 @@ def io_review
             if self.class.services[io]
               begin
                 callback(self, :add_connection, io.accept_nonblock, self.class.services[io])
-              rescue Errno::EWOULDBLOCK => _
-              rescue => e
+              rescue Errno::EWOULDBLOCK => _ # rubocop:disable Lint/HandleExceptions
+                # There's nothing too handle. Swallow the error
+              rescue StandardError => e
                 log(e.message)
               end
             elsif self.class.io_connection_dic[io]
@@ -248,7 +252,8 @@ def io_review
           io_r[2].each do |io|
             begin
               (remove_connection(io) || self.class.services.delete(io)).close
-            rescue
+            rescue # rubocop:disable Lint/RescueWithoutErrorClass
+              # Swallow all errors
               true
             end
           end
@@ -279,7 +284,8 @@ def stop_services
         self.class.services.each do |s, p|
           begin
             s.close
-          rescue
+          rescue # rubocop:disable Lint/RescueWithoutErrorClass
+            # Swallow all errors
             true
           end
           log("Stopped listening on #{p[:hostname]}:#{p[:port]}")
@@ -299,10 +305,11 @@ def remove_connection_async(io)
     # @api private
     def stop_connections
       self.class.c_locker.synchronize do
-        self.class.io_connection_dic.each do |io, _params|
+        self.class.io_connection_dic.each_key do |io|
           begin
             io.close
-          rescue
+          rescue # rubocop:disable Lint/RescueWithoutErrorClass
+            # Swallow all errors
             true
           end
         end
@@ -333,7 +340,8 @@ def remove_connection(io)
         connection_count = self.class.io_connection_dic.count
         begin
           io.close
-        rescue
+        rescue # rubocop:disable Lint/RescueWithoutErrorClass
+          # Swallow all errors
           true
         end
       end