nugrant 0.0.11

data/.buildpath

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildpath>
+	<buildpathentry kind="src" path="test"/>
+	<buildpathentry kind="src" path="lib"/>
+	<buildpathentry kind="con" path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER"/>
+</buildpath>

data/.gitattributes

@@ -0,0 +1,33 @@
+# Handle line endings automatically for files detected as text
+# and leave all files detected as binary untouched.
+* text=auto
+
+#
+# The above will handle all files NOT found below
+#
+# These files are text and should be normalized (Convert crlf => lf)
+Gemfile
+Rakefile
+Vagrantfile
+*.rb text
+*.md text
+*.gemspec text
+*.lock text
+*.txt text
+*.yml text
+*.yaml text
+*.prefs text
+
+# Eclipse specific files
+*.project text
+*.buildpath text
+
+# Those have specific eol for testing purpose
+test/resources/json/params_unix_eol.json eol=lf
+test/resources/json/params_windows_eol.json eol=crlf
+test/resources/yml/params_unix_eol.yml eol=lf
+test/resources/yml/params_windows_eol.yml eol=crlf
+
+# These files are binary and should be left untouched
+# (binary is a macro for -text -diff)
+*.gem binary

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.vagrant
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/nugrant_debug.rb
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>nugrant</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.dltk.core.scriptbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.dltk.ruby.core.nature</nature>
+	</natures>
+</projectDescription>

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# 0.0.11
+
+* Updated README file for installation via rubygems.org
+
+# 0.0.10
+
+* Added a subcommand `parameters` for vagrant command `user`.
+* Added a vagrant command `vagrant user subcommand [options]`.
+
+# 0.0.9
+
+* Fixed a bug with the new default values implementation
+
+# 0.0.8
+
+* Introduced possibility to set default values
+* Introduced restricted keys (For now, restricted keys are [`defaults`])
+* Fixed a bug with system-wide parameters
+
+# 0.0.7
+
+* YAML is back as the default file format for parameters
+
+# 0.0.6
+
+* Fixed a bug on ruby 1.8.7 which doesn't have yaml included in its load path by default
+
+# 0.0.5
+
+* Introduced system-wide parameters file
+
+# 0.0.4
+
+* JSON is now the default file format for parameters (due to problem with YAML)
+* It is now possible to store parameters in the JSON format

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nugrant.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthieu Vachon
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,198 @@
+# 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.
+
+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.
+
+## Installation
+
+First, you need to have Vagrant installed for this gem
+to work correctly.
+
+There is two different way to install the gem. You can
+install it via Vagrant or via the system gem containers.
+
+When you install from Vagrant, the main benefit is that
+it's decoupled from your 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,
+please use this command instead:
+
+    > gem install nugrant
+
+## Usage
+
+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
+methods we listed above, you DO NOT need to setup this
+environment variable.
+
+To use the plugin, first create a yaml file named
+`.vagrantuser` where your `Vagrantfile` is located. The file
+must be a valid yaml file:
+
+    vm_port: 2223
+    repository:
+      project: "/home/user/work/git"
+
+The configuration hierarchy you define in the `.vagrantuser` file
+is imported into the `config` object of the `Vagrantfile`
+under the key `user`. So, with the `.vagrantuser` file above, you
+could have this `Vagrantfile` that abstract absolute paths.
+
+    Vagrant::Config.run do |config|
+      config.ssh.port config.user.vm_port
+
+      config.vm.share_folder "git", "/git", config.user.repository.project
+    end
+
+This way, paths can be customized by every developer. They just
+have to add a `.vagrantuser` file where user specific configuration
+values can be specified. The `.vagrantuser` should be ignored by you
+version control system so it is to committed with the project.
+
+Additionally, you can also have a `.vagrantuser` under your user home
+directory. This way, you can set parameters that will be
+available to all your `Vagrantfile'. The project `.vagrantuser`
+file will overrides parameters defined in the `.vagrantuser` file
+defined in the user home directory
+
+For example, you have `.vagrantuser` file located at `~/.vagrantuser`
+that has the following content:
+
+    vm_port: 2223
+    repository:
+      project: "/home/user/work/git"
+
+And another `.vagrantuser` at the root of your `Vagrantfile`:
+
+    vm_port: 3332
+    repository:
+      personal: "/home/user/personal/git"
+
+Then, the `Vagrantfile` could be defined like this:
+
+    Vagrant::Config.run do |config|
+      config.ssh.port config.user.vm_port
+
+      config.vm.share_folder "git", "/git", config.user.repository.project
+      config.vm.share_folder "personal", "/personal", config.user.repository.personal
+    end
+
+That would be equivalent to:
+
+    Vagrant::Config.run do |config|
+      config.ssh.port 3332
+
+      config.vm.share_folder "git", "/git", "/home/user/work/git"
+      config.vm.share_folder "personal", "/personal", "/home/user/personal/git"
+    end
+
+As you can see, the parameters defined in the second `.vagrantuser` file
+(the project one) overrides settings defined in the `.vagrantuser` found
+in the home directory (the user one).
+
+### Parameters access
+
+Parameters in the `Vagrantfile` can be retrieved via method call
+of array access.
+
+    config.user['repository']['project'] # Array access
+    config.user.repository.project       # Method access
+
+You can even mix the two if you want, but we do not recommend
+it since its always better to be consistent:
+
+    config.user['repository'].project # Mixed access
+    config.user.repository['project'] # Mixed access
+
+Only the root key, i.e. `config.user`, cannot be access with
+both syntax, only the method syntax can be used since this
+is not provided by this plugin but by Vagrant itself.
+
+### Default values
+
+When using parameters, it is often needed so set default values
+for certain parameters so if the user does not define one, the
+default value will be picked up.
+
+For example, say you want a parameter that will hold the ssh
+port of the vm. This parameter will be accessible via the
+parameter `config.user.vm.ssh_port`.
+
+You can use the following snippet directly within your Vagrantfile
+to set a default value for this parameter:
+
+    Vagrant::Config.run do |config|
+      config.user.defaults = {
+        "vm" => {
+          "ssh_port" => "3335"
+        }
+      }
+
+      config.ssh.port config.user.vm.ssh_port
+    end
+
+With this Vagrantfile, the parameter `config.user.vm.ssh_port`
+will default to `3335` in cases where it is not defined by the
+user.
+
+If the user decides to change it, he just has to set it in his
+own `.vagrantuser` and it will override the default value defined
+in the Vagrantfile.
+
+### Vagrant commands
+
+In this section, we describe the various vagrant commands defined
+by this plugin that can be used to interact with it.
+
+#### Parameters
+
+This command will print the currently defined parameters at the
+given location. All rules are respected when using this command.
+It is usefull to see what parameters are available and what are
+the current values of those parameters.
+
+Usage:
+
+    > vagrant user parameters
+    ---
+    config:
+      user:
+        chef:
+          cookbooks_path: /Users/Chef/kitchen/cookbooks
+          nodes_path: /Users/Chef/kitchen/nodes
+          roles_path: /Users/Chef/kitchen/roles
+
+## Contributing
+
+You can contribute by filling issues when something goes
+wrong or was not what you expected. I will do my best
+to fix the issue either in the code or in the documentation,
+where applicable.
+
+You can also send pull requests for any feature or improvement
+you think should be included in this plugin. I will evaluate
+each of them and merge them as fast as possible.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.test_files = FileList['test/**/test*.rb']
+end
+
+desc "Run tests"
+task :default => :test
+

data/lib/nugrant.rb

@@ -0,0 +1,12 @@
+require 'nugrant'
+require 'nugrant/config'
+require 'nugrant/parameter_bag'
+require 'nugrant/parameters'
+
+module Nugrant
+  def self.create_parameters(options)
+    config = Nugrant::Config.new(options)
+
+    return Nugrant::Parameters.new(config)
+  end
+end

data/lib/nugrant/config.rb

@@ -0,0 +1,51 @@
+require 'rbconfig'
+
+module Nugrant
+  class Config
+    DEFAULT_PARAMS_FILENAME = ".vagrantuser"
+    DEFAULT_PARAMS_FILETYPE = "yml"
+
+    attr :params_filename, true
+    attr :params_filetype, true
+
+    def self.user_base_path()
+      return 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"
+      end
+
+      return "/etc"
+    end
+
+    def self.on_windows?()
+      return (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/) != nil
+    end
+
+    def initialize(options = {})
+      options.delete_if { |key, value| value == nil }
+
+      @params_filename = options.fetch(:params_filename, DEFAULT_PARAMS_FILENAME)
+      @params_filetype = options.fetch(:params_filetype, DEFAULT_PARAMS_FILETYPE)
+
+      @project_params_path = options.fetch(:project_params_path, nil)
+      @user_params_path = options.fetch(:user_params_path, nil)
+      @system_params_path = options.fetch(:system_params_path, nil)
+    end
+
+    def project_params_path()
+      File.expand_path(@project_params_path || "./#{@params_filename}")
+    end
+
+    def user_params_path()
+      File.expand_path(@user_params_path || "#{Config.user_base_path()}/#{@params_filename}")
+    end
+
+    def system_params_path()
+      File.expand_path(@system_params_path || "#{Config.system_base_path()}/#{@params_filename}")
+    end
+  end
+end

data/lib/nugrant/parameter_bag.rb

@@ -0,0 +1,68 @@
+module Nugrant
+  class ParameterBag
+    def initialize(parameters)
+      if parameters == nil
+        return
+      end
+
+      @bag = {}
+      @defaults = {}
+
+      parameters.each do |key, value|
+        if key == "defaults"
+          raise ArgumentError, "The key 'defaults' has restricted usage and cannot be defined"
+        end
+
+        if not value.is_a?(Hash)
+          @bag[key] = value
+          next
+        end
+
+        # It is a hash, transform it into a bag
+        @bag[key] = Nugrant::ParameterBag.new(value)
+      end
+    end
+
+    def [](param_name)
+      return get_param(param_name)
+    end
+
+    def method_missing(method, *args, &block)
+      return get_param(method.to_s)
+    end
+
+    def has_param?(param_name)
+      return @bag != nil && @bag.has_key?(param_name)
+    end
+
+    def get_param(param_name)
+      if not has_param?(param_name)
+        if @defaults[param_name]
+          return @defaults[param_name]
+        end
+
+        raise KeyError, "Undefined parameter '#{param_name}'"
+      end
+
+      return @bag[param_name]
+    end
+
+    def get_params()
+      return @bag
+    end
+
+    def defaults(parameters)
+      parameters.each do |key, value|
+        if value.is_a?(Hash) and has_param?(key)
+          @bag[key].defaults(value)
+        end
+      end
+
+      @defaults = Nugrant::ParameterBag.new(parameters)
+    end
+
+    def defaults=(parameters)
+      defaults(parameters)
+    end
+  end
+end