vagrant-goodhosts 1.0.0.pre.beta4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ef1e50681184f9636c42cb63ef886051aab4f19c388f913f81e3ccee5c9c61
-  data.tar.gz: 60da586ec22b7387b3b7ca20641ec49316e3ecd4ed10e672c82fc48f1c8bb8d0
+  metadata.gz: dae3311603bb8549e1be6f3eb18b46c0c0fd7b1fab7d6c43f42c190fac1dd907
+  data.tar.gz: 168d43266f469c5ba81ebac4ebe6933b0500123cf7809d7276567709bf794bf6
 SHA512:
-  metadata.gz: f140337609b3baae16139812a8013c7bb2396765340db63b8bb8ad740a115ee62fc089327bf9366113029cbc17419b418cc1309c5cfa176e0f863298ac5b75e0
-  data.tar.gz: da008e6cc94397d22242e2b75a5d4c3e15c9c6d0cc7bc7a4a3b508361572304ab0a949211dea4430ce1b5c7b3f68cf8ee3b8f213dac9043d50715953b34025f2
+  metadata.gz: 354b9a2a3945f1ebcf3ba8b7877d6e2bf553a14dcfbd85d140f81dda081fad7c1162eef5e354ad2024d516ac2b31b5641066ac8ff110737248be2699f8c42b04
+  data.tar.gz: 5a46c36236e3933caa25185420f2b055d2c01ae1f73236f5708e53f7f4cec4c45b90d11be1fe48cd219af5a349b23d33361781dc9fed83838ba32f45866093d6

data/README.md

@@ -1,32 +1,39 @@
 # Vagrant::Goodhosts
 
-This plugin adds an entry to your /etc/hosts file on the host system using [GoodHosts](https://github.com/goodhosts/cli). This plugin is based on [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) to be compatible with the same config parameters.
+This vagrant plugin adds host file entries to the host pointing to the guest VM, using the [GoodHosts](https://github.com/goodhosts/cli) cli tool. This plugin is based on [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) and aims to be compatible with the same config parameters.
 
-On **up**, **resume** and **reload** commands, it tries to add the information, if it does not already exist in your hosts file. If it needs to be added, you will be asked for an administrator password, since it uses sudo to edit the file.
+On **up**, **resume** and **reload** commands, it tries to add the hosts if they do not already exist in your hosts file. If it needs to be added, you will be asked for the `sudo` password to make the necessary edits.
 
-On **halt**, **destroy**, and **suspend**, those entries will be removed again.
-By setting the `config.goodhosts.remove_on_suspend  = false`, **suspend** and **halt** will not remove them. 
+On **halt**, **destroy**, and **suspend**, those entries will be removed again. By setting the `config.goodhosts.remove_on_suspend  = false`, **suspend** and **halt** will not remove them. 
 
 
 ## Installation
 
-    $ vagrant plugin install vagrant-goodhosts
+```shell
+vagrant plugin install vagrant-goodhosts
+```
 
-Uninstall it with:
+To uninstall :
 
-    $ vagrant plugin uninstall vagrant-goodhosts
+```shell
+vagrant plugin uninstall vagrant-goodhosts
+```
 
-Update the plugin with:
+To update the plugin:
 
-    $ vagrant plugin update vagrant-goodhosts
+```shell
+vagrant plugin update vagrant-goodhosts
+```
 
 ## Usage
 
 You currently only need the `hostname` and a `:private_network` network with a fixed IP address.
 
-    config.vm.network :private_network, ip: "192.168.3.10"
-    config.vm.hostname = "www.testing.de"
-    config.goodhosts.aliases = ["alias.testing.de", "alias2.somedomain.com"]
+```ruby
+config.vm.network :private_network, ip: "192.168.3.10"
+config.vm.hostname = "www.testing.de"
+config.goodhosts.aliases = ["alias.testing.de", "alias2.somedomain.com"]
+```
 
 This IP address and the hostname will be used for the entry in the `/etc/hosts` file.
 
@@ -34,30 +41,38 @@ This IP address and the hostname will be used for the entry in the `/etc/hosts`
 
 If you have multiple network adapters i.e.:
 
-    config.vm.network :private_network, ip: "10.0.0.1"
-    config.vm.network :private_network, ip: "10.0.0.2"
+```ruby
+config.vm.network :private_network, ip: "10.0.0.1"
+config.vm.network :private_network, ip: "10.0.0.2"
+```
 
-you can specify which hostnames are bound to which IP by passing a hash mapping the IP of the network to an array of hostnames to create, e.g.:
+You can specify which hostnames are bound to which IP by passing a hash mapping the IP of the network to an array of hostnames to create, e.g.:
 
-    config.goodhosts.aliases = {
-        '10.0.0.1' => ['foo.com', 'bar.com'],
-        '10.0.0.2' => ['baz.com', 'bat.com']
-    }
+```ruby
+config.goodhosts.aliases = {
+    '10.0.0.1' => ['foo.com', 'bar.com'],
+    '10.0.0.2' => ['baz.com', 'bat.com']
+}
+```
 
 This will produce `/etc/hosts` entries like so:
 
-    10.0.0.1 foo.com
-    10.0.0.1 bar.com
-    10.0.0.2 baz.com
-    10.0.0.2 bat.com
-        
+```
+10.0.0.1 foo.com
+10.0.0.1 bar.com
+10.0.0.2 baz.com
+10.0.0.2 bat.com
+```
+
 ### Keeping Host Entries After Suspend/Halt
 
-To keep your /etc/hosts file unchanged simply add the line below to your `VagrantFile`:
+To keep your `/etc/hosts` file unchanged simply add the line below to your `VagrantFile`:
 
-    config.goodhosts.remove_on_suspend = false
-    
-This disables vagrant-goodhosts from running on **suspend** and **halt**.
+```ruby
+config.goodhosts.remove_on_suspend = false
+```
+
+This disables `vagrant-goodhosts` from running on **suspend** and **halt**.
 
 
 ## Suppressing prompts for elevating privileges
@@ -85,12 +100,12 @@ You have to open an elevated command prompt; hold `❖ Win` and press `X`, then
 
     cacls %SYSTEMROOT%\system32\drivers\etc\hosts /E /G %USERNAME%:W 
 
-## Installing development version
+## Installing The Development Version
 
-If you would like to install vagrant-goodhosts on the development version perform the following:
+If you would like to install `vagrant-goodhosts` to make contributions or changes, run the following commands::
 
-```
-git clone https://github.com/goodhosts/vagrant
+```shell
+git clone https://github.com/goodhosts/vagrant vagrant-goodhosts
 cd vagrant-goodhosts
 git checkout develop
 ./package.sh

data/lib/vagrant-goodhosts/GoodHosts.rb

@@ -7,7 +7,7 @@ module VagrantPlugins
 
       def getIps
         if Vagrant.has_plugin?("vagrant-hostsupdater")
-            @ui.error "The Vagrant plugin vagrant-hostsupdater is installed but is executed always also when is not configured in your Vagrantfile!" 
+            @ui.error "[vagrant-goodhosts] Warning: The vagrant-hostsupdater plugin is installed, hostsupdater always adds the VM name even if the VagrantFile says not to. This shouldn't cause issues, but if it does, uninstall hostsupdater" 
         end
         
         ips = []
@@ -22,7 +22,7 @@ module VagrantPlugins
             
             @machine.config.vm.provider :hyperv do |v|
                 timeout = @machine.provider_config.ip_address_timeout
-                @ui.output("Waiting for the machine to report its IP address(might take some time, have a patience)...")
+                @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")
 
                 options = {
@@ -105,7 +105,7 @@ module VagrantPlugins
           hostnames[ip].each do |hostname|
               ip_address = ip
               if !ip_address.nil?
-                @ui.info "[vagrant-goodhosts]   found entry for: #{ip_address} #{hostname}"
+                @ui.info "[vagrant-goodhosts] - found entry for: #{ip_address} #{hostname}"
                 if cli.include? ".exe"
                     stdin, stdout, stderr, wait_thr = Open3.popen3(cli, "a", ip_address, hostname)
                 else
@@ -131,7 +131,7 @@ module VagrantPlugins
           hostnames[ip].each do |hostname|
               ip_address = ip
               if !ip_address.nil?
-                @ui.info "[vagrant-goodhosts]   remove entry for: #{ip_address} #{hostname}"
+                @ui.info "[vagrant-goodhosts] - remove entry for: #{ip_address} #{hostname}"
                 if cli.include? ".exe"
                     stdin, stdout, stderr, wait_thr = Open3.popen3(cli, "r", ip_address, hostname)
                 else
@@ -150,11 +150,11 @@ module VagrantPlugins
       def printReadme(error, errorText)
         if error
             cli = get_cli
-            @ui.error "[vagrant-goodhosts] Issue on executing goodhosts: #{errorText}"
-            @ui.error "[vagrant-goodhosts] Cli path: #{cli}"            
-            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/Mte90/vagrant-goodhosts#passwordless-sudo"
+            @ui.error "[vagrant-goodhosts] Issue executing goodhosts CLI: #{errorText}"
+            @ui.error "[vagrant-goodhosts] Cli path: #{cli}"
+            @ui.error "[vagrant-goodhosts] Check the readme at https://github.com/goodhosts/vagrant#passwordless-sudo"
         end
-          
+
       end
 
     end

data/lib/vagrant-goodhosts/plugin.rb

@@ -44,11 +44,6 @@ module VagrantPlugins
         hook.prepend(Action::RemoveHosts)
         hook.append(Action::UpdateHosts)
       end
-
-      command(:goodhosts) do
-        require_relative 'command'
-        Command
-      end
     end
   end
 end

data/lib/vagrant-goodhosts/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module GoodHosts
-    VERSION = '1.0.0-beta4'
+    VERSION = '1.0.0'
   end
 end

data/vagrant-goodhosts.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['mte90net@gmail.com']
   spec.description   = %q{Enables Vagrant to update hosts file on the host machine with goodhosts}
   spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/mte90/vagrant-goodhosts'
+  spec.homepage      = 'https://github.com/goodhosts/vagrant'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-goodhosts
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta4
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniele Scasciafratte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,13 +57,12 @@ files:
 - lib/vagrant-goodhosts/bundle/cli
 - lib/vagrant-goodhosts/bundle/cli.exe
 - lib/vagrant-goodhosts/bundle/cli_osx
-- lib/vagrant-goodhosts/command.rb
 - lib/vagrant-goodhosts/config.rb
 - lib/vagrant-goodhosts/plugin.rb
 - lib/vagrant-goodhosts/version.rb
 - package.sh
 - vagrant-goodhosts.gemspec
-homepage: https://github.com/mte90/vagrant-goodhosts
+homepage: https://github.com/goodhosts/vagrant
 licenses:
 - MIT
 metadata: {}
@@ -78,9 +77,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 

data/lib/vagrant-goodhosts/command.rb

@@ -1,10 +0,0 @@
-module VagrantPlugins
-  module GoodHosts
-    class Command < Vagrant.plugin('2', :command)
-
-      def execute
-        puts "ran command"
-      end
-    end
-  end
-end