vagrant-port-range 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c3517827e5226f3b01631295d376b047a6ed6b5
-  data.tar.gz: 57c6917b1d4d0101df31ea54be7e183f338e42e7
+  metadata.gz: fbb290ba667171dfe779bd0bd7c0256f8f86bbcc
+  data.tar.gz: 171cdf86d4169bf466fd15c043f226c9143ff566
 SHA512:
-  metadata.gz: 174f5a6e386bfe4ba7348bfda448b3e6abdc2dc977a0d9be27f21a3d85d7f47c44bfa38551cea1ea8eef28237a84f44c9ffc8364e6aab3d315bcf7c795d96aba
-  data.tar.gz: f7c9b305dc695337c6e74ce9bca383ef0f2735db26c6f6e80ad9800641b4d1c68d35277084dd7fe06ec40feb3557b1d559b5cd3d8eb52abc636acc8d81051922
+  metadata.gz: 2ad740655459d9fc65c97b441a9e199c8c6b8a6d2d59b93b1f5b79d854d479718ac73da7f52dcb8130e67d727c7984d0ebc4f3a86683b6e174a784d25c44e7cc
+  data.tar.gz: d0144c2850a0af1608b7ad62efe12c198046914975df4c3bc39df5b737832c2160ad54f46f11a30abf6034b676337eec9460bb8c2ca187ac9b85ce57e1d5486f

data/Gemfile

@@ -1,9 +1,9 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 group :development do
-  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
 end
 
 group :plugins do
-  gem "vagrant-port-range", path: "."
+  gem 'vagrant-port-range', path: '.'
 end

data/README.md

@@ -1,2 +1,85 @@
 # vagrant-port-range
-Vagrant plugin for picking free port from given range
+
+[![Gem Version](https://badge.fury.io/rb/vagrant-port-range.svg)](https://badge.fury.io/rb/vagrant-port-range)
+
+vagrant-port-range is a Vagrant plugin for mapping forwarded ports using range of host ports.
+
+## Installation
+
+```console
+foo@bar:~$ vagrant plugin install vagrant-port-range
+```
+
+## Usage
+
+The plugin is loaded automatically once installed.
+
+## Configuration
+
+### config.portrange.forwarded_port
+
+Use [standart options from forwarded_port](https://www.vagrantup.com/docs/networking/forwarded_ports.html), except for one option **host**. Instead of **host** use **host_range** with desired port range. Plugin will automatically pick free port from given range and insert it into **host** option.
+
+Example Vagrantfile:
+
+```ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.portrange.forwarded_port guest: 6901, host_range: [3000, 4100]
+  config.portrange.forwarded_port guest: 8080, host_range: [3000, 4100]
+  config.vm.provider "docker" do |d|
+    d.image = "consol/ubuntu-xfce-vnc"
+  end
+end
+
+```
+
+The result:
+
+```console
+foo@bar:~$ vagrant up
+
+Bringing machine 'default' up with 'docker' provider...
+==> default: [vagrant-port-range] get free port 4022
+==> default: [vagrant-port-range] get free port 3744
+==> default: Creating the container...
+    default:   Name: vagrantportrange_default_1514061829
+    default:  Image: consol/ubuntu-xfce-vnc
+    default:   Port: 4022:6901
+    default:   Port: 3744:8080
+    default:  
+    default: Container created: b01667fcb339703a
+==> default: Starting container...
+
+foo@bar:~$
+```
+
+In case of situation when all ports from range are in use:
+
+```ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.portrange.forwarded_port guest: 6901, host_range: [80, 81]
+  config.vm.provider "docker" do |d|
+    d.image = "consol/ubuntu-xfce-vnc"
+  end
+end
+
+```
+
+```console
+# make them busy
+foo@bar:~$ python3 -m http.server 80
+foo@bar:~$ python3 -m http.server 81
+
+foo@bar:~$ vagrant up
+
+Bringing machine 'default' up with 'docker' provider...
+==> default: [vagrant-port-range] Can't get free port from range [80, 81]
+
+foo@bar:~$
+```

data/Rakefile

@@ -1,3 +1,5 @@
 require 'rubygems'
 require 'bundler/setup'
+
+# This installs the tasks that help with gem creation and publishing
 Bundler::GemHelper.install_tasks

data/lib/vagrant-port-range.rb

@@ -1,9 +1,16 @@
-begin
-  require 'vagrant'
-rescue LoadError
-  raise "This plugin must run within Vagrant."
-end
-
-require 'vagrant-port-range/action'
-require 'vagrant-port-range/config'
+require 'pathname'
 require 'vagrant-port-range/plugin'
+
+module VagrantPlugins
+    module PortRange
+        lib_path = Pathname.new(File.expand_path('../vagrant-port-range', __FILE__))
+        autoload :Action, lib_path.join('action')
+
+        # This returns the path to the source of this plugin
+        #
+        # @return [Pathname]
+        def self.source_root
+            @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+        end
+    end
+end

data/lib/vagrant-port-range/{action.rb → action/port_range.rb}

@@ -12,29 +12,31 @@ module VagrantPlugins
                 end
 
                 def call(env)
-                    setuped = true
+                    setupped = true
                     
                     # setup forwarded ports
                     forwarded_ports = @machine.config.portrange.forwarded_ports
                     forwarded_ports.each do |id, options|
                         # get free port and add to host
                         host_port = get_free_port(options[:host_range])
+
                         if host_port == -1
-                            setuped = false
+                            setupped = false
                             break
                         end 
+                        
                         options[:host] = host_port
                         @ui.info("[vagrant-port-range] get free port #{host_port}")
                         
                         # delete port range option
                         options.tap { |op| op.delete(:host_range) }
 
-                        # add options in standart way
+                        # standart way to add forwarded_port
                         @machine.config.vm.network "forwarded_port", options
                     end
 
-                    # continue if all good
-                    if setuped
+                    # continue if all ports setupped
+                    if setupped
                         @app.call(env)
                     end
                 end

data/lib/vagrant-port-range/config.rb

@@ -2,7 +2,6 @@ require 'securerandom'
 
 module VagrantPlugins
     module PortRange
-
         class Config < Vagrant.plugin("2", :config)
             attr_reader :forwarded_ports
 
@@ -21,6 +20,5 @@ module VagrantPlugins
                 forwarded_ports[id] = options
             end
         end
-
     end
 end

data/lib/vagrant-port-range/plugin.rb

@@ -1,8 +1,21 @@
+begin
+    require 'vagrant'
+rescue LoadError
+    raise 'This plugin must run within Vagrant.'
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < '1.2.0'
+    raise 'The vagrant-port-range plugin is only compatible with Vagrant 1.2+'
+end
+
+require_relative 'action/port_range'
+
 module VagrantPlugins
     module PortRange
-
         class Plugin < Vagrant.plugin('2')
-            name "vagrant-port-range"
+            name 'vagrant-port-range'
 
             description <<-DESC
             This plugin picks free port number from given range and inserts
@@ -10,7 +23,7 @@ module VagrantPlugins
             DESC
 
             config(:portrange) do
-                require_relative "config"
+                require_relative 'config'
                 Config
             end
 
@@ -18,6 +31,5 @@ module VagrantPlugins
                 hook.prepend(Action::SetupPorts)
             end
         end
-
     end
 end

data/lib/vagrant-port-range/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
     module PortRange
-        VERSION = '0.1.2'
+        VERSION = '0.1.3'
     end
 end

data/vagrant-port-range.gemspec

@@ -1,16 +1,25 @@
-require File.expand_path('../lib/vagrant-port-range/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-port-range/version'
 
 Gem::Specification.new do |s|
   s.name            = 'vagrant-port-range'
   s.version         = VagrantPlugins::PortRange::VERSION
+  s.platform        = Gem::Platform::RUBY
   s.date            = '2017-12-01'
   s.description     = 'Vagrant plugin for mapping ports with given port range'
   s.summary         = s.description
+  s.homepage        = 'https://github.com/pr3sto/vagrant-port-range'
+  s.license         = 'MIT'
+
   s.authors         = ['Alexey Chirukhin']
   s.email           = 'pr3sto1377@gmail.com'
+
   s.files           = `git ls-files`.split($\)
   s.executables     = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files      = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths   = ['lib']
-  s.homepage        = 'https://github.com/pr3sto/vagrant-port-range'
-  s.license         = 'MIT'
-end
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-port-range
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alexey Chirukhin
@@ -9,7 +9,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2017-12-01 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Vagrant plugin for mapping ports with given port range
 email: pr3sto1377@gmail.com
 executables: []
@@ -22,7 +50,7 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-port-range.rb
-- lib/vagrant-port-range/action.rb
+- lib/vagrant-port-range/action/port_range.rb
 - lib/vagrant-port-range/config.rb
 - lib/vagrant-port-range/plugin.rb
 - lib/vagrant-port-range/version.rb