Merge pull request #122 from bastelfreak/rubocop

Rubocop: Fix Style cops

Author: bastelfreak

.rubocop.yml

@@ -32,8 +32,5 @@ Style/TrailingCommaInArguments:
 Metrics:
   Enabled: false
 
-Style:
-  Enabled: false
-
 Layout:
   Enabled: false

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-17 13:00:57 UTC using RuboCop version 1.48.1.
+# on 2023-03-24 13:46:36 UTC using RuboCop version 1.48.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
@@ -63,3 +63,75 @@ RSpec/DescribeClass:
 RSpec/NoExpectationExample:
   Exclude:
     - 'spec/acceptance/example_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, conditionals
+Style/AndOr:
+  Exclude:
+    - 'lib/beaker-rspec/helpers/serverspec.rb'
+
+# Offense count: 7
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/beaker-rspec/helpers/serverspec.rb'
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    - 'lib/beaker-rspec/helpers/serverspec.rb'
+
+# Offense count: 10
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/beaker-rspec.rb'
+    - 'lib/beaker-rspec/helpers/serverspec.rb'
+
+# Offense count: 10
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'beaker-rspec.gemspec'
+    - 'lib/beaker-rspec.rb'
+    - 'lib/beaker-rspec/beaker_shim.rb'
+    - 'lib/beaker-rspec/helpers/serverspec.rb'
+    - 'lib/beaker-rspec/rake_task.rb'
+    - 'lib/beaker-rspec/spec_helper.rb'
+    - 'lib/beaker-rspec/version.rb'
+    - 'spec/acceptance/example_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/beaker-rspec/helpers/serverspec.rb'
+
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'lib/beaker-rspec/spec_helper.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/beaker-rspec/version.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireEnglish.
+# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_perl_names

Gemfile

@@ -1,20 +1,20 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 def location_for(place, fake_version = nil)
   if place =~ /^(git:[^#]*)#(.*)/
-    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
-  elsif place =~ /^file:\/\/(.*)/
-    ['>= 0', { :path => File.expand_path($1), :require => false }]
+    [fake_version, { git: Regexp.last_match(1), branch: Regexp.last_match(2), require: false }].compact
+  elsif place =~ %r{^file://(.*)}
+    ['>= 0', { path: File.expand_path(Regexp.last_match(1)), require: false }]
   else
-    [place, { :require => false }]
+    [place, { require: false }]
   end
 end
 
-if (beaker_version = ENV['BEAKER_VERSION'])
+if (beaker_version = ENV.fetch('BEAKER_VERSION', nil))
   gem 'beaker', *location_for(beaker_version)
 end
 
-case ENV['BEAKER_HYPERVISOR']
+case ENV.fetch('BEAKER_HYPERVISOR', nil)
 when 'docker'
   gem 'beaker-docker'
 when 'vagrant', 'vagrant_libvirt'

Rakefile

@@ -28,8 +28,6 @@ else
     # These make the rubocop experience maybe slightly less terrible
     task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
     # Use Rubocop's Github Actions formatter if possible
-    if ENV['GITHUB_ACTIONS'] == 'true'
-      task.formatters << 'github'
-    end
+    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
   end
 end

beaker-rspec.gemspec

@@ -1,22 +1,21 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('lib', __dir__)
 require 'beaker-rspec/version'
 
 Gem::Specification.new do |s|
-  s.name        = "beaker-rspec"
+  s.name        = 'beaker-rspec'
   s.version     = BeakerRSpec::Version::STRING
-  s.authors     = ["Vox Pupuli"]
-  s.email       = ["voxpupuli@groups.io"]
-  s.homepage    = "https://github.com/voxpupuli/beaker-rspec"
-  s.summary     = %q{RSpec bindings for beaker}
-  s.description = %q{RSpec bindings for beaker, see https://github.com/voxpupuli/beaker}
+  s.authors     = ['Vox Pupuli']
+  s.email       = ['voxpupuli@groups.io']
+  s.homepage    = 'https://github.com/voxpupuli/beaker-rspec'
+  s.summary     = 'RSpec bindings for beaker'
+  s.description = 'RSpec bindings for beaker, see https://github.com/voxpupuli/beaker'
   s.license     = 'Apache-2.0'
 
   s.required_ruby_version = '>= 2.7.0', '<4.0.0'
 
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   # Testing dependencies
   s.add_development_dependency 'fakefs', '>= 0.6', '< 2'

lib/beaker-rspec/beaker_shim.rb

@@ -70,7 +70,7 @@ def hosts
     end
 
     # Setter for hosts object
-    def hosts= v
+    def hosts=(v)
       RSpec.configuration.hosts = v
     end
 

lib/beaker-rspec/helpers/serverspec.rb

@@ -15,11 +15,10 @@ def cur_example
   def get_working_node
     example = cur_example
     if example and example.metadata[:node]
-      node = example.metadata[:node]
+      example.metadata[:node]
     else
-      node = default_node
+      default_node
     end
-    node
   end
 
   # The cygwin backend
@@ -40,20 +39,20 @@ def exec_backend
 module Specinfra
   module Configuration
     class << self
-      VALID_OPTIONS_KEYS = [
-        :backend,
-        :env,
-        :path,
-        :pre_command,
-        :sudo_path,
-        :disable_sudo,
-        :sudo_options,
-        :docker_image,
-        :docker_url,
-        :lxc,
-        :request_pty,
-        :ssh_options,
-        :dockerfile_finalizer,
+      VALID_OPTIONS_KEYS = %i[
+        backend
+        env
+        path
+        pre_command
+        sudo_path
+        disable_sudo
+        sudo_options
+        docker_image
+        docker_url
+        lxc
+        request_pty
+        ssh_options
+        dockerfile_finalizer
       ].freeze
     end
 
@@ -66,9 +65,7 @@ module Specinfra::Helper::Os
 
   def os
     working_node_name = get_working_node.to_s
-    if !@@known_nodes[working_node_name] # haven't seen this yet, better detect the os
-      @@known_nodes[working_node_name] = property[:os] = detect_os
-    end
+    @@known_nodes[working_node_name] = property[:os] = detect_os unless @@known_nodes[working_node_name] # haven't seen this yet, better detect the os
     @@known_nodes[working_node_name]
   end
 
@@ -80,9 +77,7 @@ def detect_os
     return Specinfra.configuration.os if Specinfra.configuration.os
     backend = Specinfra.backend
     node = get_working_node
-    if node['platform'].include?('windows')
-      return {:family => 'windows'}
-    end
+    return {family: 'windows'} if node['platform'].include?('windows')
     Specinfra::Helper::DetectOs.subclasses.each do |c|
       res = c.detect
       if res
@@ -109,11 +104,8 @@ def get_windows_cmd(meth, *args)
       command_class = version_class.const_get(resource_type.to_camel_case)
 
       command_class = command_class.create
-      if command_class.respond_to?(method)
-        command_class.send(method, *args)
-      else
-        raise NotImplementedError.new("#{method} is not implemented in #{command_class}")
-      end
+      raise NotImplementedError, "#{method} is not implemented in #{command_class}" unless command_class.respond_to?(method)
+      command_class.send(method, *args)
     end
 
   end
@@ -135,12 +127,10 @@ def self.method_missing(meth, *args)
         else
           run(meth, *args)
         end
+      elsif backend.respond_to?(meth)
+        backend.send(meth, *args)
       else
-        if backend.respond_to?(meth)
-          backend.send(meth, *args)
-        else
-          run(meth, *args)
-        end
+        run(meth, *args)
       end
     end
 
@@ -167,7 +157,7 @@ def convert_regexp(target)
       when Regexp
         target.source
       else
-        Regexp.escape(target.to_s.gsub '/', '\/').gsub('\n', '(\r\n|\n)')
+        Regexp.escape(target.to_s.gsub('/', '\/')).gsub('\n', '(\r\n|\n)')
       end
     end
   end
@@ -176,19 +166,17 @@ def convert_regexp(target)
 module Specinfra::Backend
   class BeakerBase < Specinfra::Backend::Base
     # Example accessor
-    def example
-      @example
-    end
+    attr_reader :example
 
     # Execute the provided ssh command
     # @param [String] command The command to be executed
     # @return [Hash] Returns a hash containing :exit_status, :stdout and :stderr
     def ssh_exec!(node, command)
-      r = on node, command, { :acceptable_exit_codes => (0..127) }
+      r = on node, command, { acceptable_exit_codes: (0..127) }
       {
-        :exit_status => r.exit_code,
-        :stdout      => r.stdout,
-        :stderr      => r.stderr,
+        exit_status: r.exit_code,
+        stdout: r.stdout,
+        stderr: r.stderr,
       }
     end
 
@@ -237,11 +225,11 @@ def run_command(cmd, _opt = {})
       #when node is not cygwin rm -rf will fail so lets use native del instead
       #There should be a better way to do this, but for now , this works
       if node.is_cygwin?
-        delete_command = "rm -rf"
-        redirection = "< /dev/null"
+        delete_command = 'rm -rf'
+        redirection = '< /dev/null'
       else
-        delete_command = "del"
-        redirection = "< NUL"
+        delete_command = 'del'
+        redirection = '< NUL'
       end
       on node, "#{delete_command} script.ps1"
       create_remote_file(node, 'script.ps1', script)
@@ -288,9 +276,7 @@ def build_command(cmd)
       cmd = "#{String(useshell).shellescape} -c #{String(cmd).shellescape}"
 
       path = Specinfra.configuration.path
-      if path
-        cmd = %Q{env PATH="#{path}" #{cmd}}
-      end
+      cmd = %(env PATH="#{path}" #{cmd}) if path
 
       cmd
     end

lib/beaker-rspec/rake_task.rb

@@ -1,5 +1,5 @@
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:beaker) do |c|
-  c.pattern = "spec/acceptance/**/*_spec.rb"
+  c.pattern = 'spec/acceptance/**/*_spec.rb'
 end