nugrant 0.0.14 → 1.0.0.pre1

data/.gitignore

@@ -17,3 +17,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+test/resources/Vagrantfile

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0 (unreleased)
+
+* For now on, this gem will follow semantic versioning.
+
 # 0.0.14
 
 * Renamed `ParameterBag` to `Bag`

data/Gemfile

@@ -1,4 +1,27 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in nugrant.gemspec
 gemspec
+
+group :development do
+  vagrant_dependencies = {
+    'v1' => {
+        'home' => "C:/Users/Matt/.vagrant.d.v1",
+        'gem' => Proc.new do
+            gem "vagrant", "~> 1.0.5"
+        end,
+    },
+    'v2' => {
+        'home' => "C:/Users/Matt/.vagrant.d",
+        'gem' => Proc.new do
+            gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+        end,
+    },
+  }
+
+  vagrant_plugin_version = ENV['VAGRANT_PLUGIN_VERSION'] || "v2"
+  vagrant_dependency = vagrant_dependencies[vagrant_plugin_version]
+
+  ENV['VAGRANT_HOME'] = vagrant_dependency['home']
+
+  vagrant_dependency['gem'].call()
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Matthieu Vachon
+Copyright (c) 2012-2013 Matthieu Vachon
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,48 +1,95 @@
 # Nugrant [![Build Status](https://travis-ci.org/maoueh/nugrant.png)](https://travis-ci.org/maoueh/nugrant)
 
-Vagrant plugin that brings user specific configuration
-options. It will enable a `.vagrantuser` at different
-location that will get imported into the main vagrant
-config.
+Nugrant is a library to easily handle parameters that need to be
+injected into an application via different sources (system, user,
+project, defaults).
 
-For example, let say the git repository you want to
-expose is not located under the root folder of
-your `Vagrantfile`. That means you will need to specify
-an absolute host path to share the folder on the guest vm.
+But Nugrant is foremost a Vagrant plugin that will enhance
+Vagrantfile to allow user specific configuration values. The plugin
+will let users define a `.vagrantuser` file at different locations. This
+file will contain parameters that will be injected into the Vagrantfile.
 
-Your `Vagrantfile` would look like this:
+## Installation
 
-    Vagrant::Config.run do |config|
-      config.vm.share_folder "git", "/git", "/home/user/work/git"
-    end
+### Library
 
-However, what happens when multiple developers
-need to share the same `Vagrantfile`? This is the main
-use case this plugin address.
+If you would like to use Nugrant as a library, simply reference
+it as a dependency of your application. Probably by adding it to
+your `Gemfile` or your `.gemspec` file.
 
-## Installation
+    nugrant ~> 0.0.15
 
-First, you need to have Vagrant installed for this gem
-to work correctly.
+### Vagrant
 
-There is two different way to install the gem. You can
-install it via Vagrant or via the system gem containers.
+If you would like to use Nugrant as a Vagrant plugin, the
+detailed installation steps are provided below. Without a
+doubt, you need Vagrant installed for those steps to work ;)
 
-When you install from Vagrant, the main benefit is that
-it's decoupled from your other system gems. There is less
+There are two different ways to install the gem. You can
+install it via Vagrant or via the system gem container.
+
+When you install via Vagrant, the main benefit is that
+it's decoupled from other system gems. There is less
 chance for this gem's dependencies, even if they are minimal,
 to clash with gems already installed on your system. This is the
 recommended installation method. To install, simply run:
 
     > vagrant gem install nugrant
 
-If you prefer to install the gem in a system wide matters,
+If you prefer to install the gem in a system wide manner,
 please use this command instead:
 
     > gem install nugrant
 
 ## Usage
 
+Whether used as a library or a Vagrant plugin, Nugrant has some
+common concepts that apply to both usages. The most important
+one is the parameters hierarchy.
+
+Nugrant can read parameters from various locations and will merge
+them all together in a single set. Merging is done in a fairly
+standard fashion.
+
+Here the precedence rules that apply when merging parameters
+from various location:
+
+ - Defaults
+ - System
+ - User
+ - Project
+
+In text, this means that project parameters overrides user
+parameters, user parameters overrides system parameters and
+finally system parameters overrides defaults parameters.
+
+### Library
+
+Using Nugrant as a library to handle parameters from various
+location is really easy. Two main classes need to be handled.
+
+First, you need to create a `Nugrant::Config` object. This
+configuration holds the values that needs to be customized
+by your own application. This includes the different parameters paths
+and the format of the parameters file.
+
+### Vagrant
+
+For example, let say the git repository you want to
+expose is not located under the root folder of
+your `Vagrantfile`. That means you will need to specify
+an absolute host path to share the folder on the guest vm.
+
+Your `Vagrantfile` would look like this:
+
+    Vagrant::Config.run do |config|
+      config.vm.share_folder "git", "/git", "/home/user/work/git"
+    end
+
+However, what happens when multiple developers
+need to share the same `Vagrantfile`? This is the main
+use case this plugin address.
+
 When Vagrant starts, via any of the `vagrant` commands,
 it loads all vagrant plugins it founds under the `GEM_PATH`
 variable. If you installed the plugin with one of the two

data/Rakefile

@@ -1,6 +1,16 @@
-require "bundler/gem_tasks"
+require "bundler/setup"
 require "rake/testtask"
 
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+Bundler::GemHelper.install_tasks
+
 Rake::TestTask.new do |task|
   task.test_files = FileList['test/**/test*.rb']
 end

data/lib/nugrant.rb

@@ -1,4 +1,4 @@
-require 'nugrant'
+require 'pathname'
 require 'nugrant/config'
 require 'nugrant/parameters'
 
@@ -7,6 +7,17 @@ unless defined?(KeyError)
   end
 end
 
+if defined?(Vagrant)
+  case
+  when defined?(Vagrant::Plugin::V2)
+    require 'nugrant/vagrant/v2/plugin'
+  when Vagrant::VERSION =~ /1\.0\..*/
+    # Nothing to do, v1 plugins are picked by the vagrant_init.rb file
+  else
+    abort("You are trying to use Nugrant with an unsupported Vagrant version [#{Vagrant::VERSION}]")
+  end
+end
+
 module Nugrant
   def self.create_parameters(options)
     config = Nugrant::Config.new(options)

data/lib/nugrant/config.rb

@@ -9,20 +9,19 @@ module Nugrant
     attr :params_filetype, true
 
     def self.user_base_path()
-      return File.expand_path("~")
+      File.expand_path("~")
     end
 
     def self.system_base_path()
-      # TODO: Fixme, find the right location to put system wide settings on windows...
       if Config.on_windows?
-        return "C:/etc"
+        return File.expand_path(ENV['PROGRAMDATA'] || ENV['ALLUSERSPROFILE'])
       end
 
-      return "/etc"
+      "/etc"
     end
 
     def self.on_windows?()
-      return (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/) != nil
+      (RbConfig::CONFIG['host_os'].downcase =~ /mswin|mingw|cygwin/) != nil
     end
 
     def initialize(options = {})

data/lib/nugrant/vagrant/v1/command/parameters.rb

@@ -0,0 +1,137 @@
+require 'nugrant'
+require 'nugrant/helper/yaml'
+
+module Nugrant
+  module Vagrant
+    module V1
+      module Command
+        class Parameters < ::Vagrant::Command::Base
+          def initialize(arguments, environment)
+            super(arguments, environment)
+
+            @show_help = false
+            @show_defaults = false
+            @show_system = false
+            @show_user = false
+            @show_project = false
+          end
+
+          def create_parser()
+            return OptionParser.new do |parser|
+              parser.banner = "Usage: vagrant user parameters [<options>]"
+              parser.separator ""
+
+              parser.separator "Available options:"
+              parser.separator ""
+
+              parser.on("-h", "--help", "Print this help") do
+                @show_help = true
+              end
+
+              parser.on("-d", "--defaults", "Show only defaults parameters") do
+                @show_defaults = true
+              end
+
+              parser.on("-s", "--system", "Show only system parameters") do
+                @show_system = true
+              end
+
+              parser.on("-u", "--user", "Show only user parameters") do
+                 @show_user = true
+               end
+
+               parser.on("-p", "--project", "Show only project parameters") do
+                 @show_project = true
+               end
+
+               parser.separator ""
+               parser.separator "When no options is provided, the command prints the names and values \n" +
+                                "of all parameters that would be available for usage in the Vagrantfile.\n" +
+                                "The hierarchy of the parameters is respected, so the final values are\n" +
+                                "displayed."
+            end
+          end
+
+          def execute
+            parser = create_parser()
+            arguments = parse_options(parser)
+
+            return help(parser) if @show_help
+
+            @logger.debug("'Parameters' each target VM...")
+            with_target_vms(arguments) do |vm|
+              parameters = vm.config.keys[:user].parameters
+
+              @env.ui.info("# Vm '#{vm.name}'", :prefix => false)
+
+              defaults(parameters) if @show_defaults
+              system(parameters) if @show_system
+              user(parameters) if @show_user
+              project(parameters) if @show_project
+
+              all(parameters) if !@show_defaults && !@show_system && !@show_user && !@show_project
+            end
+
+            return 0
+          end
+
+          def help(parser)
+            @env.ui.info(parser.help, :prefix => false)
+          end
+
+          def defaults(parameters)
+            print_results("Defaults", parameters.defaults)
+          end
+
+          def system(parameters)
+            print_results("System", parameters.system)
+          end
+
+          def user(parameters)
+            print_results("User", parameters.user)
+          end
+
+          def project(parameters)
+            print_results("Project", parameters.project)
+          end
+
+          def all(parameters)
+            print_results("All", parameters.all)
+          end
+
+          def print_results(kind, parameters)
+            if !parameters || parameters.empty?()
+              print_header(kind)
+              @env.ui.info(" Empty", :prefix => false)
+              @env.ui.info("", :prefix => false)
+              return
+            end
+
+            print_parameters(kind, {
+              'config' => {
+                'user' => parameters
+              }
+            })
+          end
+
+          def print_parameters(kind, data)
+            string = Nugrant::Helper::Yaml.format(data.to_yaml, :indent => 1)
+
+            print_header(kind)
+            @env.ui.info(string, :prefix => false)
+            @env.ui.info("", :prefix => false)
+          end
+
+          def print_header(kind, length = 50)
+            @env.ui.info(" #{kind.capitalize} Parameters", :prefix => false)
+            @env.ui.info(" " + "-" * length, :prefix => false)
+          end
+
+          def compute_header_length(string)
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nugrant/vagrant/v1/command/root.rb

@@ -0,0 +1,80 @@
+require 'nugrant'
+
+module Nugrant
+  module Vagrant
+    module V1
+      module Command
+        class Root < ::Vagrant::Command::Base
+          def initialize(arguments, environment)
+            super(arguments, environment)
+
+            @arguments, @subcommand, @subarguments = split_main_and_subcommand(arguments)
+
+            # Change super class available arguments to main ones only
+            @argv = @arguments
+
+            @subcommands = ::Vagrant::Registry.new()
+            @subcommands.register(:parameters) do
+              require File.expand_path("../parameters", __FILE__)
+              Parameters
+            end
+
+            @show_help = false
+            @show_version = false
+          end
+
+          def create_parser()
+            return OptionParser.new do |parser|
+              parser.banner = "Usage: vagrant user [-h] [-v] <command> [<args>]"
+
+              parser.separator ""
+              parser.on("-h", "--help", "Print this help") do
+                @show_help = true
+              end
+
+              parser.on("-v", "--version", "Print plugin version and exit.") do
+                @show_version = true
+              end
+
+              parser.separator ""
+              parser.separator "Available subcommands:"
+
+              keys = []
+              @subcommands.each { |key, value| keys << key.to_s }
+
+              keys.sort.each do |key|
+                parser.separator "     #{key}"
+              end
+
+              parser.separator ""
+              parser.separator "For help on any individual command run `vagrant user COMMAND -h`"
+            end
+          end
+
+          def execute
+            parser = create_parser()
+            arguments = parse_options(parser)
+
+            return version() if @show_version
+            return help(parser) if @show_help
+
+            command_class = @subcommands.get(@subcommand.to_sym) if @subcommand
+            return help(parser) if !command_class || !@subcommand
+
+            @logger.debug("Invoking nugrant command class: #{command_class} #{@subarguments.inspect}")
+
+            command_class.new(@subarguments, @env).execute
+          end
+
+          def help(parser)
+            @env.ui.info(parser.help, :prefix => false)
+          end
+
+          def version()
+            @env.ui.info("Nugrant version #{Nugrant::VERSION}", :prefix => false)
+          end
+        end
+      end
+    end
+  end
+end