Fix rubocop-related issues (part 1)

[jay7x]

This PR includes rubocop-inspired fixes. Though there was few unrelated changes:

• Gemfile.local was removed
• vendor directory was added to the .gitignore
• .editorconfig added (mostly to keep trailing spaces and newlines under control)
• bin/beaker-docker was fixed (it seems it was never really working 🤔)
• 00_default_spec.rb was rewritten in Beaker DSL (beaker-rspec was not really used there)

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (a0398f0) 85.61% compared to head (6716908) 85.61%.

❗ Current head 6716908 differs from pull request most recent head 08189b8. Consider uploading reports for the commit 08189b8 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #75   +/-   ##
=======================================
  Coverage   85.61%   85.61%           
=======================================
  Files           1        1           
  Lines         292      292           
=======================================
  Hits          250      250           
  Misses         42       42           

Impacted Files	Coverage Δ
lib/beaker/hypervisor/docker.rb	85.61% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jay7x]

🆙

[ekohl]

I've been working on a script to fix it per cop. For voxpupuli/beaker#1761 I used https://gist.github.com/ekohl/b41006003553dce67b9c551f306f8080 to fix TODOs. Then in rebases I'd order things around again. Some of the commits are manual, in case there was no autofix. It relies on https://pypi.org/project/yq/ to get all the keys from the TODO file.

[jay7x]

I've been working on a script to fix it per cop. For voxpupuli/beaker#1761 I used https://gist.github.com/ekohl/b41006003553dce67b9c551f306f8080 to fix TODOs. Then in rebases I'd order things around again. Some of the commits are manual, in case there was no autofix. It relies on https://pypi.org/project/yq/ to get all the keys from the TODO file.

Thank you for the idea! JFYI I implemented it as a rake task here! Execute it as bundle exec rake rubocop:fix_todos

[jay7x]

Anything more is expected from me here? Or we can squash it a bit and merge?

[ekohl]

I've been very busy but I'll try to revisit it.

[bastelfreak]

@jay7x can you maybe rebase this please?

[jay7x]

@jay7x can you maybe rebase this please?

Sure.. Though I think we should recheck the rubocop rules and maybe sync the config with other gems. I'll poke you later today in Slack.

[ekohl]

I'm not happy with a huge implementation of this in a Rakefile. If we decide to go this route it belongs in a separate gem IMHO. Otherwise we end up duplicating it many times.

[bastelfreak]

I don't think we need this. It's only useful when fixing the todo file, and that's done after some point. I think it should be replaced with our default block:

begin
  require 'rubocop/rake_task'
rescue LoadError
  # RuboCop is an optional group
else
  RuboCop::RakeTask.new(:rubocop) do |task|
    # 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
  end
end

[bastelfreak]

maybe task.options = ['--display-cop-names', '--display-style-guide', '--extra-details'] isn't even required anymore

[jay7x]

Rakefile and GHA config should be synced across all beaker plugins I'd say.. beaker-hcloud has the simplest one which we can reuse maybe 🤔

[bastelfreak]

I want to sync them, but before we do that I want to:

• bump all plugins to Ruby 2.7
• Introduce rubocop
• fix most rubocop violations
• have a shared rubocop config in beaker that's used by all beaker plugins

[bastelfreak]

Edit: I'm tracking all the rubocop/ruby refactoring in https://github.com/orgs/voxpupuli/projects/4

[ekohl]

@jay7x I introduced merge conflicts, but I'd also raise another point: the Rakefile has large amount of code for yard, but we don't even include it in our Gemfile. When I manually add it and run it, it fails to generate. Right now I'd suggest to drop it altogether. #96 will remove more merge conflicts.