vagrant-goodhosts 1.0.18 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e9466d2e64e39de992c9940235deb31e8d64fd4e17e92d8b271392306dcabf
-  data.tar.gz: 918fb30d3de3daf04492cd8850d5cd1fc5bb2187f9a985f048b401301c527409
+  metadata.gz: af4373106e6048231957edb2d946e4747701f00a75db67f82095b9df0be66a40
+  data.tar.gz: 522c2464ae48082cae2353adc83d0417f1d7361e73aa61b8073be9261c5b5863
 SHA512:
-  metadata.gz: 396c9ad919d3abaea678b2042f57a9ef02dac89d4212ceb5e18887c5be190ae86a3112fa28664fe6e7483fcf6f9e969eda012d891a4d828622b6fc15b671a050
-  data.tar.gz: f1d14ef933bfe527f6d0297300abf1cc3ed9a87f542b1ac5dc0ff017c71a52b32203984e1c04d37988fdbbe1d4f99343255f9ced3dd3a750ec1ded7b06870231
+  metadata.gz: 2fc06a64a1d59d6f330a90fca87db1a0beec8e050f4de156c2311dea315bd9f50f0d7d1518bd43d6398a55f367f3b8c175b83ded1a2cb32c971c6a464299ef1e
+  data.tar.gz: be8a81282a426cbd53339ee8222a2849fe7e3772917073ca57973b576331f33a001c47c889798f6ecf7c805245d3630c92c9d121bc1d673b44ac603b8804e6a5

data/.github/workflows/default.yml

@@ -0,0 +1,15 @@
+name: Linters
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: RuboCop Linter
+        uses: andrewmcodes/rubocop-linter-action@v3.3.0
+        with:
+          exit_on_failure: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -0,0 +1,68 @@
+AllCops:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'lib/vagrant-goodhosts/config.rb'
+
+Naming/FileName:
+    Enabled: false
+Naming/AccessorMethodName:
+    Enabled: false
+Metrics/MethodLength:
+    Enabled: false
+Metrics/PerceivedComplexity:
+    Enabled: false
+Metrics/ModuleLength:
+    Enabled: false
+Metrics/CyclomaticComplexity:
+    Enabled: false
+Metrics/AbcSize:
+    Enabled: false
+Style/FrozenStringLiteralComment:
+    Enabled: false
+Style/RaiseArgs:
+    Enabled: false
+Layout/LineLength:
+    Enabled: false
+Style/StringLiterals:
+    Enabled: false
+Style/ExpandPathArguments:
+    Enabled: false
+Style/RedundantReturn:
+    Enabled: false
+Style/SymbolArray:
+    Enabled: false
+Style/ClassVars:
+    Enabled: false
+Style/YodaCondition:
+    Enabled: false
+Style/MethodCallWithoutArgsParentheses:
+    Enabled: false
+Style/NumericPredicate:
+    Enabled: false
+Style/ParallelAssignment:
+    Enabled: false
+Style/Not:
+    Enabled: false
+Style/EmptyLiteral:
+    Enabled: false
+Style/IfUnlessModifier:
+    Enabled: false
+Style/MutableConstant:
+    Enabled: false
+Style/SymbolLiteral:
+    Enabled: false
+Style/AccessorGrouping:
+    Enabled: false
+Style/Next:
+    Enabled: false
+Style/MultipleComparison:
+    Enabled: false
+Style/FormatStringToken:
+    Enabled: false
+Style/SoleNestedConditional:
+    Enabled: false
+Style/GuardClause:
+    Enabled: false
+Gemspec/RequiredRubyVersion:
+    Enabled: false

data/Gemfile

@@ -7,3 +7,5 @@ end
 group :plugins do
   gem "vagrant-goodhosts", path: "."
 end
+
+gem 'os'

data/lib/vagrant-goodhosts/Action/BaseAction.rb

@@ -1,6 +1,8 @@
+# Action to extend for the plugin needs, detects if it was already executed etc
 module VagrantPlugins
   module GoodHosts
     module Action
+      # Extend it!
       class BaseAction
         include GoodHosts
 
@@ -35,10 +37,9 @@ module VagrantPlugins
           @app.call(env)
         end
 
-        def run(env)
+        def run(_env)
           raise NotImplementedError.new("Must be implemented!")
         end
-
       end
     end
   end

data/lib/vagrant-goodhosts/Action/RemoveHosts.rb

@@ -1,8 +1,9 @@
+# Run when is removing the hosts
 module VagrantPlugins
   module GoodHosts
     module Action
+      # Remove hosts
       class RemoveHosts < BaseAction
-
         def run(env)
           machine_action = env[:machine_action]
 
@@ -12,10 +13,9 @@ module VagrantPlugins
           if ([:halt, :suspend].include? machine_action) && (false == @machine.config.goodhosts.remove_on_suspend)
             @ui.info "[vagrant-goodhosts] Removing hosts on suspend disabled"
           else
-            removeHostEntries
+            remove_host_entries
           end
         end
-
       end
     end
   end

data/lib/vagrant-goodhosts/Action/UpdateHosts.rb

@@ -1,12 +1,12 @@
+# Run when is adding hosts
 module VagrantPlugins
   module GoodHosts
     module Action
+      # Update hosts
       class UpdateHosts < BaseAction
-
-        def run(env)
-          addHostEntries()
+        def run(_env)
+          add_host_entries()
         end
-
       end
     end
   end

data/lib/vagrant-goodhosts/GoodHosts.rb

@@ -1,16 +1,19 @@
+# The core of the plugin
 require "rbconfig"
 require "open3"
 require "resolv"
+require "os"
 
 module VagrantPlugins
   module GoodHosts
+    # Plugin module
     module GoodHosts
-      def getIps
+      def get_ips
         ips = []
 
-        if @machine.config.vm.networks.length == 0
-            @ui.error("[vagrant-goodhosts] No networks are available yet for this virtual machine to add IP/hosts for")
-            return ips
+        if @machine.config.vm.networks.empty?
+          @ui.error("[vagrant-goodhosts] No networks are available yet for this virtual machine to add IP/hosts for")
+          return ips
         end
 
         @machine.config.vm.networks.each do |network|
@@ -21,7 +24,7 @@ module VagrantPlugins
           ip = options[:ip] if (key == :private_network || key == :public_network) && options[:goodhosts] != "skip"
           ips.push(ip) if ip
 
-          @machine.config.vm.provider :hyperv do |v|
+          @machine.config.vm.provider :hyperv do
             timeout = @machine.provider_config.ip_address_timeout
             @ui.output("[vagrant-goodhosts] Waiting for the guest machine to report its IP address ( this might take some time, have patience )...")
             @ui.detail("Timeout: #{timeout} seconds")
@@ -30,43 +33,39 @@ module VagrantPlugins
               vmm_server_address: @machine.provider_config.vmm_server_address,
               proxy_server_address: @machine.provider_config.proxy_server_address,
               timeout: timeout,
-              machine: @machine,
+              machine: @machine
             }
             network = @machine.provider.driver.read_guest_ip(options)
             if network["ip"]
               ips.push(network["ip"]) unless ips.include? network["ip"]
             end
           end
-
         end
         return ips
       end
 
-      # https://stackoverflow.com/a/13586108/1902215
       def get_os_binary
-        return os ||= (host_os = RbConfig::CONFIG["host_os"]
-          case host_os
-          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-            :'cli.exe'
-          when /darwin|mac os/
-            :'cli_osx'
-          when /linux/
-            :'cli'
-          else
-            raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
-          end)
+        if OS.windows?
+          return 'cli.exe'
+        elsif OS.mac?
+          return 'cli_osx'
+        elsif OS.linux?
+          return 'cli'
+        else
+          raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+        end
       end
 
       def get_cli
         binary = get_os_binary
-        path = File.expand_path(File.dirname(File.dirname(__FILE__))) + "/vagrant-goodhosts/bundle/"
+        path = format('%s%s', File.expand_path(File.dirname(File.dirname(__FILE__))), "/vagrant-goodhosts/bundle/")
         path = "#{path}#{binary}"
 
         return path
       end
 
       # Get a hash of hostnames indexed by ip, e.g. { 'ip1': ['host1'], 'ip2': ['host2', 'host3'] }
-      def getHostnames(ips)
+      def get_hostnames(ips)
         hostnames = Hash.new { |h, k| h[k] = [] }
 
         case @machine.config.goodhosts.aliases
@@ -85,20 +84,50 @@ module VagrantPlugins
         return hostnames
       end
 
-      def disableClean(ip_address)
+      def disable_clean(ip_address)
         unless ip_address.nil?
           return @machine.config.goodhosts.disable_clean
         end
+
         return true
       end
 
-      def addHostEntries
-        error = false
-        errorText = ""
+      def check_hostnames_to_add(ip_address, hostnames)
+        hostnames_to_add = Array.new
+        hostnames = hostnames.split
+        # check which hostnames actually need adding
+        hostnames.each do |hostname|
+          address = Resolv.getaddress(hostname)
+          if address != ip_address
+            hostnames_to_add.append(hostname)
+          end
+        rescue StandardError => _e
+          hostnames_to_add.append(hostname)
+        end
+        return hostnames_to_add.join(' ')
+      end
+
+      def add_goodhost_entries(ip_address, hostnames)
         cli = get_cli
-        hostnames_by_ips = generateHostnamesByIps
+        if cli.include? ".exe"
+          clean = get_clean_parameter_by_system(ip_address, true)
+          command = "Start-Process '#{cli}' -ArgumentList \"add\",#{clean}\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs"
+          stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", command)
+        else
+          clean = get_clean_parameter_by_system(ip_address, false)
+          command = "sudo '#{cli}' add #{clean} #{ip_address} #{hostnames}"
+          stdin, stdout, stderr, wait_thr = Open3.popen3(command)
+        end
+        return stdin, stdout, stderr, wait_thr, command
+      end
 
-        return if not hostnames_by_ips.any?
+      def add_host_entries
+        error = false
+        error_text = ''
+        command = ''
+        hostnames_by_ips = generate_hostnames_by_ips
+
+        return if hostnames_by_ips.none?
 
         @ui.info "[vagrant-goodhosts] Checking for host entries"
 
@@ -109,59 +138,39 @@ module VagrantPlugins
           end
 
           # filter out the hosts we've already added
-          hosts_to_add = check_hostnames_to_add( ip_address, hostnames)
-          next if not hosts_to_add.any?
+          hosts_to_add = check_hostnames_to_add(ip_address, hostnames)
+          next if hosts_to_add.empty?
 
-          stdin, stdout, stderr, wait_thr = add_goodhost_entries(ip_address, hosts_to_add)
-          if !wait_thr.value.success?
+          _stdin, _stdout, stderr, wait_thr, command = add_goodhost_entries(ip_address, hosts_to_add)
+          unless wait_thr.value.success?
             error = true
-            errorText = stderr.read.strip
-          end
-        end
-        printReadme(error, errorText)
-      end
-
-      def check_hostnames_to_add(ip_address, hostnames)
-        hostnames_to_add = Array.new
-
-        # check which hostnames actually need adding
-        hostnames.each do |hostname|
-          begin
-            address = Resolv.getaddress(hostname)
-            if address != ip_address
-              hostnames_to_add.append( hostname )
-            end
-          rescue => exception
-            hostnames_to_add.append(hostname)
+            error_text = stderr.read.strip
           end
         end
-        return hostnames_to_add
+        print_readme(error, error_text, command)
       end
 
-      def add_goodhost_entries(ip_address, hostnames)
+      def remove_goodhost_entries(ip_address, hostnames)
+        cli = get_cli
         if cli.include? ".exe"
-          clean = "\"--clean\","
-          if disableClean(ip_address)
-              clean = ''
-          end
-          stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", "Start-Process '#{cli}' -ArgumentList \"add\",#{clean}\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs")
+          clean = get_clean_parameter_by_system(ip_address, true)
+          command = "Start-Process '#{cli}' -ArgumentList \"remove\",#{clean}\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs"
+          stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", command)
         else
-          clean = "--clean"
-          if disableClean(ip_address)
-              clean = ''
-          end
-          stdin, stdout, stderr, wait_thr = Open3.popen3("sudo '#{cli}' add #{clean} #{ip_address} #{hostnames}")
+          clean = get_clean_parameter_by_system(ip_address, false)
+          command = "sudo '#{cli}' remove #{clean} #{ip_address} #{hostnames}"
+          stdin, stdout, stderr, wait_thr = Open3.popen3(command)
         end
-        return stdin, stdout, stderr, wait_thr
+        return stdin, stdout, stderr, wait_thr, command
       end
 
-      def removeHostEntries
+      def remove_host_entries
         error = false
-        errorText = ""
-        cli = get_cli
-        hostnames_by_ips = generateHostnamesByIps
+        error_text = ''
+        command = ''
+        hostnames_by_ips = generate_hostnames_by_ips
 
-        return if not hostnames_by_ips.any?
+        return if hostnames_by_ips.none?
 
         @ui.info "[vagrant-goodhosts] Removing hosts"
 
@@ -171,76 +180,72 @@ module VagrantPlugins
             next
           end
 
-          stdin, stdout, stderr, wait_thr = remove_goodhost_entries(ip_address, hostnames)
-          if !wait_thr.value.success?
+          _stdin, _stdout, stderr, wait_thr, command = remove_goodhost_entries(ip_address, hostnames)
+          unless wait_thr.value.success?
             error = true
-            errorText = stderr.read.strip
+            error_text = stderr.read.strip
           end
         end
-        printReadme(error, errorText)
+        print_readme(error, error_text, command)
       end
 
-      def remove_goodhost_entries(ip_address, hostnames)
-        if cli.include? ".exe"
+      def get_clean_parameter_by_system(ip_address, is_win)
+        clean = "--clean"
+        if is_win
           clean = "\"--clean\","
-          if disableClean(ip_address)
-              clean = ''
-          end
-          stdin, stdout, stderr, wait_thr = Open3.popen3("powershell", "-Command", "Start-Process '#{cli}' -ArgumentList \"remove\",#{clean}\"#{ip_address}\",\"#{hostnames}\" -Verb RunAs")
+        end
+
+        if disable_clean(ip_address)
+          clean = ''
+        end
+        return clean
+      end
+
+      def print_readme(error, error_text, command)
+        unless error
+          return false
+        end
+
+        cli = get_cli
+        @ui.error "[vagrant-goodhosts] Issue executing goodhosts CLI: #{error_text}"
+        @ui.error "[vagrant-goodhosts] Command: #{command}"
+        @ui.error "[vagrant-goodhosts] Cli path: #{cli}"
+        if cli.include? ".exe"
+          @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#windows-uac-prompt"
+          exit
         else
-          clean = "\"--clean\","
-          if disableClean(ip_address)
-              clean = ''
-          end
-          stdin, stdout, stderr, wait_thr = Open3.popen3("sudo '#{cli}' remove #{clean} #{ip_address} #{hostnames}")
+          @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#passwordless-sudo"
         end
-        return stdin, stdout, stderr, wait_thr
       end
 
-      def printReadme(error, errorText)
-        if error
-          cli = get_cli
-          @ui.error "[vagrant-goodhosts] Issue executing goodhosts CLI: #{errorText}"
-          @ui.error "[vagrant-goodhosts] Cli path: #{cli}"
-          if cli.include? ".exe"
-            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#windows-uac-prompt"
-            exit
-          else
-            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#passwordless-sudo"
+      def append_hostsnames_by_ips(hostnames_by_ips, hostnames, ip_address, ip_index)
+        if hostnames[ip_index].count() > 0
+          hostnames[ip_index].each do |hostname|
+            unless ip_address.nil?
+              @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
+            end
           end
+          hostnames_by_ips = { ip_address => hostnames[ip_index].join(" ") }
         end
+        return hostnames_by_ips
       end
 
-      def generateHostnamesByIps()
+      def generate_hostnames_by_ips
         hostnames_by_ips = []
-        ips = getIps
+        ips = get_ips
         if ips.count() < 1
           @ui.error("[vagrant-goodhosts] No ip address found for this virtual machine")
           return hostnames_by_ips
         end
-        hostnames = getHostnames(ips)
+        hostnames = get_hostnames(ips)
         if ips.count() > 1
           ips.each do |ip|
             ip_address = ip
-            if hostnames[ip].count() > 0
-              hostnames[ip].each do |hostname|
-                if !ip_address.nil?
-                  @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
-                end
-              end
-              hostnames_by_ips = { ip_address => hostnames[ip].join(" ") }
-            end
+            hostnames_by_ips = append_hostsnames_by_ips(hostnames_by_ips, hostnames, ip_address, ip)
           end
         else
           ip_address = ips[0]
-          if hostnames[ip_address].count() > 0
-            hostnames[ip_address].each do |hostname|
-              if !ip_address.nil?
-                @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
-              end
-            end
-            hostnames_by_ips = { ip_address => hostnames[ip_address].join(" ") }
-          end
+          hostnames_by_ips = append_hostsnames_by_ips(hostnames_by_ips, hostnames, ip_address, ip_address)
         end
 
         return hostnames_by_ips

data/lib/vagrant-goodhosts/config.rb

@@ -2,16 +2,17 @@ require "vagrant"
 
 module VagrantPlugins
   module GoodHosts
+    # Vagrant plugin definition
     class Config < Vagrant.plugin("2", :config)
-        attr_accessor :aliases
-        attr_accessor :id
-        attr_accessor :remove_on_suspend
-        attr_accessor :disable_clean
-        
-        def initialize
-            @remove_on_suspend = true
-            @disable_clean = true
-        end
+      attr_accessor :aliases
+      attr_accessor :id
+      attr_accessor :remove_on_suspend
+      attr_accessor :disable_clean
+
+      def initialize
+        @remove_on_suspend = true
+        @disable_clean = true
+      end
     end
   end
 end

data/lib/vagrant-goodhosts/plugin.rb

@@ -5,6 +5,7 @@ require_relative "Action/RemoveHosts"
 
 module VagrantPlugins
   module GoodHosts
+    # Various Vagrant hooks
     class Plugin < Vagrant.plugin('2')
       name 'GoodHosts'
       description <<-DESC

data/lib/vagrant-goodhosts/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module GoodHosts
-    VERSION = '1.0.18'
+    VERSION = '1.1.0'
   end
 end

data/lib/vagrant-goodhosts.rb

@@ -1,11 +1,13 @@
+# Root file of the plugin
 require "vagrant-goodhosts/version"
 require "vagrant-goodhosts/plugin"
 
+# Extend Vagrant Plugins
 module VagrantPlugins
+  # Load our plugin
   module GoodHosts
     def self.source_root
       @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
     end
   end
 end
-

data/vagrant-goodhosts.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'vagrant-goodhosts/version'
@@ -14,7 +13,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/goodhosts/vagrant'
   s.license       = 'MIT'
 
-  s.files         = `git ls-files`.split($/)
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.files        += Dir.glob("lib/vagrant-goodhosts/bundle/*")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
@@ -22,4 +21,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'
+
+  s.add_runtime_dependency "os"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-goodhosts
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniele Scasciafratte
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Enables Vagrant to update hosts file on the host machine with goodhosts
 email:
 - mte90net@gmail.com
@@ -45,7 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/default.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,7 +83,7 @@ homepage: https://github.com/goodhosts/vagrant
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Enables Vagrant to update hosts file on the host machine with goodhosts
 test_files: []