nugrant 1.4.2 → 2.0.0.dev1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjIwNTk3YTQ5YjkyNTY5NWNkZjhlZWFlMDRmZGJkNDE4OWNjZGRiYQ==
+  data.tar.gz: !binary |-
+    Yjg0NmU5NDc2MzM3ZTk0Yjg3OTkxZDhiZGIzY2YxMDEzYzNmOTk4OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjBlNmI3MjJhYTJhZGZkYTFjNzA4YjU0ZGMyMjc0YzY4NzZlOGZmNjE1OTYz
+    MjdiNzBmYmFiZjE5NWJjY2I5OGRjZWUxZWY2ZGFhN2EwZDlhMzYyNmNiMTI1
+    ZmZmMjhlODkyMDJmOTM0Y2RiMzJlYzc1MGYwZGZhNzM1MjQ1NDU=
+  data.tar.gz: !binary |-
+    Yjc3YmZkNzk1Y2I1OTNmYTQ2M2Q3NDYyNzlhMTM0MzY4NDI1ODA2OTY1MjRk
+    MGMyMzJkZTMzNWMyODE4NTU5MTkyOGQxNTRmYmJhODZhZDg0ODBmNDY3OTI5
+    OGY0OGNiYWZhOGI5N2Y3MDlhZDk3ZjgwZjIyYzU0ZmQ1MDJiN2I=

data/.gitignore

@@ -18,5 +18,4 @@ test/tmp
 test/version_tmp
 tmp
 
-test/resources/vagrantfiles/Vagrantfile
-test/resources/vagrantfiles/.vagrantuser
+test/resources/Vagrantfile

data/.travis.yml

@@ -1,10 +1,4 @@
 language: ruby
-
-before_install:
- - gem install rubygems-update -v2.1.11
- - gem update --system 2.1.11
- - gem --version
-
 rvm:
   - "1.8.7"
   - "1.9.2"

data/CHANGELOG.md

@@ -1,77 +1,12 @@
-# 1.4.2 (January 11th, 2014)
-
-* Fixed Vagrant `user` config class to make the `has?` method
-  available to people using Vagrant. This considered has a bug
-  fix because using `has?` was not working anyway before.
-
-# 1.4.1 (December 15th, 2013)
-
-* Fixed a superfluous warning message when using ruby >= 2.0.0 which is now the
-  default when installing Vagrant >= 1.4.0 (at least on Windows).
-
-# 1.4.0 (November 28th, 2013)
-
-* Adding support to export to an [autoenv](https://github.com/kennethreitz/autoenv)
-  file. See [GH-13](https://github.com/maoueh/nugrant/issues/13).
-
-* Deprecated usage of `-s, --script` option for command
-  `vagrant user env`. This was replaced by the more generic
-  and extensible `-f, --format FORMAT` option. The
-  `-s, --script` option will be removed in 2.0.
-
-# 1.3.0 (November 19th, 2013)
-
-* Now using [minitest](https://github.com/seattlerb/minitest) as our
-  testing library.
-
-* Added a new command that can be used either standalone or via
-  a small bash script to easily export environment variables
-  from your currently set parameters. See
-  [GH-13](https://github.com/maoueh/nugrant/issues/13).
-
-* Keys associated to a null value are considered as being missing
-  by the merge process. It is still possible to define a null
-  parameter, but it will be overridden by any parameter and will not
-  override any. See [GH-12](https://github.com/maoueh/nugrant/issues/12).
-
-* Fixed output of command `vagrant user parameters`, the keys were
-  serialized as symbol instead of string.
-
-# 1.2.0 (October 24th, 2013)
-
-* Now showing better error message to the end-user when a parameter
-  cannot be found. The message displays which key could not be found.
-  Moreover, we show the context within the Vagrantfile where we think
-  the error occurred:
-
-  ```
-  Nugrant: Parameter 'param' was not found, is it defined in
-  your .vagrantuser file? Here where we think the error
-  could be in your Vagrantfile:
-
-   1:     Vagrant.configure("2") do |config|
-   2:>>     puts config.user.param
-   3:     end
-  ```
-
-  See [GH-8] (https://github.com/maoueh/nugrant/issues/8).
-
-* Ensured that keys used within a `Bag` are always symbol. This make
-  sure that it is possible to retrieve a value with any access method.
-  See [GH-9](https://github.com/maoueh/nugrant/issues/9).
-
-* Now using [multi_json](https://rubygems.org/gems/multi_json)
-  for JSON handling.
+# 1.1.1 (unreleased)
 
 # 1.1.0 (May 17th, 2013)
 
 * Rewrite completely classes `Parameters` and `Bag`.
 * Reduced chances to have a parameter name collapsing with an
   implementation method.
-
 * Removed dependency on `deep_merge`. We do now perform
   our own merge.
-
 * Added possibility to iterate through keys by using
   `.each`:
 
@@ -84,7 +19,6 @@
 ### Backward Incompatibilities
 
 * `Parameters` is not extending the `Bag` class anymore.
-
 * `Parameters` and `Bag` attributes and methods are now almost
   all prefixed with __ to reduce clashes to a minimum when
   accessing parameters with method-like syntax
@@ -93,8 +27,7 @@
 # 1.0.1 (April 9th, 2013)
 
 * Fixed a crash when `user` config value is `nil` preventing `vagrant user parameters`
-  from working as expected. See [GH-4](https://github.com/maoueh/nugrant/issues/4).
-
+  from working as expected. [GH-4](https://github.com/maoueh/nugrant/issues/4)
 * Fixed a bug preventing the version from being printed when doing `vagrant user -v`.
 
 # 1.0.0 (March 21th, 2013)
@@ -106,7 +39,6 @@
 # 0.0.14
 
 * Renamed `ParameterBag` to `Bag`
-
 * Cleanup `Bag` api
  * Renamed method `has_param?` to `has_key?` in `Bag`
  * Removed method `get_params` from `Bag`
@@ -116,7 +48,6 @@
 * Cleanup `Parameters` and `ParameterBag` interface
  * The method `defaults` has been removed from the bag
  * Setting defaults on `Parameters` now recompute the final bag
-
 * Improved `vagrant user parameters` command
  * Now using the exact config as seen by Vagrant, this includes defaults parameters
  * An option has been added to only see defaults parameters
@@ -124,11 +55,8 @@
 # 0.0.12
 
 * Added travis configuration file
-
 * Added travis build status icon to readme
-
 * Fixed a bug when `.vagrantuser` file is empty or not a hash type
-
 * Improved parameters command
  * The parameters command is now a proper subcommand
  * An option has been added to see system parameters
@@ -142,7 +70,6 @@
 # 0.0.10
 
 * Added a subcommand `parameters` for vagrant command `user`
-
 * Added a vagrant command `vagrant user subcommand [options]`
 
 # 0.0.9
@@ -152,9 +79,7 @@
 # 0.0.8
 
 * Introduced possibility to set default values
-
-* Introduced restricted keys (For now, restricted keys are [`defaults`]).
-
+* Introduced restricted keys (For now, restricted keys are [`defaults`])
 * Fixed a bug with system-wide parameters
 
 # 0.0.7
@@ -172,5 +97,4 @@
 # 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

@@ -5,16 +5,16 @@ gemspec
 group :development do
   vagrant_dependencies = {
     'v1' => {
-      'home' => "~/.vagrant.d.v1",
-      'gem' => Proc.new do
-        gem "vagrant", "~> 1.0.7"
-      end,
+        'home' => "~/.vagrant.d.v1",
+        'gem' => Proc.new do
+            gem "vagrant", "~> 1.0.7"
+        end,
     },
     'v2' => {
-      'home' => "~/.vagrant.d",
-      'gem' => Proc.new do
-        gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git", :tag => "v1.4.3"
-      end,
+        'home' => "~/.vagrant.d",
+        'gem' => Proc.new do
+            gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+        end,
     },
   }
 

data/README.md

@@ -1,18 +1,8 @@
-# Nugrant
-
-[![Gem Version](https://badge.fury.io/rb/nugrant.png)][gem]
-[![Build Status](https://secure.travis-ci.org/maoueh/nugrant.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/maoueh/nugrant.png?travis)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/maoueh/nugrant.png)][codeclimate]
-
-[gem]: https://rubygems.org/gems/nugrant
-[travis]: http://travis-ci.org/maoueh/nugrant
-[gemnasium]: https://gemnasium.com/maoueh/nugrant
-[codeclimate]: https://codeclimate.com/github/maoueh/nugrant
+# Nugrant [![Build Status](https://travis-ci.org/maoueh/nugrant.png)](https://travis-ci.org/maoueh/nugrant)
 
 Nugrant is a library to easily handle parameters that need to be
 injected into an application via different sources (system, user,
-project, defaults).
+current, defaults).
 
 But Nugrant is foremost a Vagrant plugin that will enhance
 Vagrantfile to allow user specific configuration values. The plugin
@@ -27,7 +17,7 @@ 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.
 
-    "nugrant", "~> 1.4"
+    nugrant ~> 1.0.1
 
 ### Vagrant
 
@@ -63,7 +53,7 @@ container, please use this command instead:
 
     > gem install nugrant
 
-#### Version 1.y.z (latest version tested 1.4.0)
+#### Version 1.y.z (latest version tested 1.1.3)
 
 In those versions, probably until 2.y.z is out, there
 is a new way to install and register plugin with the Vagrant
@@ -97,9 +87,9 @@ priority will be overridden by values defined on higher priorities).
  1. Defaults
  2. System
  3. User
- 4. Project
+ 4. Current
 
-In text, this means that project parameters overrides user
+In text, this means that current parameters overrides user
 parameters, user parameters overrides system parameters and
 finally system parameters overrides defaults parameters.
 
@@ -116,7 +106,7 @@ and the format of the parameters file.
 ### Vagrant
 
 All examples shown here are for Vagrant 1.1+. They have
-been tested with Vagrant 1.4.0. Keep this in mind when
+been tested with Vagrant 1.2.2. Keep this in mind when
 copying examples.
 
 Let start with a small use case. Say the git repository you want
@@ -201,7 +191,7 @@ That would be equivalent to:
     end
 
 As you can see, the parameters defined in the second `.vagrantuser` file
-(the project one) overrides settings defined in the `.vagrantuser` found
+(the current one) overrides settings defined in the `.vagrantuser` found
 in the home directory (the user one).
 
 Here the list of locations where Nugrant looks for parameters:
@@ -209,12 +199,12 @@ Here the list of locations where Nugrant looks for parameters:
  1. Defaults (via `config.user.defaults` in `Vagrantfile`)
  2. System (`/etc/.vagrantuser` on Unix, `%PROGRAMDATA%/.vagrantuser` or `%ALLUSERSPROFILE%/.vagrantuser` on Windows)
  3. Home (`~/.vagrantuser`)
- 4. Project (`.vagrantuser` within the same folder as the `Vagrantfile`)
+ 4. current (`.vagrantuser` within the same folder as the `Vagrantfile`)
 
 ### Paths
 
 When you want to specify paths on, specially on Windows, it's probably
-better to only use forward slash (`/`). The main reason for this is because
+better to only use foward slash (`/`). The main reason for this is because
 Ruby, which will be used at the end by Vagrant is able to deal with forward
 slash even on Windows. This is great because with this, you can avoid
 values escaping in YAML file. If you need to use backward slash (`\`), don't
@@ -223,18 +213,6 @@ forget to properly escape it!
     value: "C:/Users/user/work/git"
     value: "C:\\Users\\user\\work\\git"
 
-Moreover, it is preferable that paths are specified in full
-(i.e. no `~` for HOME directory for example). Normally, they
-should be handled by `Vagrant` but it may happen that it's not
-the case. If your have an error with a specific parameter,
-either expand it in your config:
-
-    project: "/home/joe/work/ruby/git"
-
-Of expand it in the `Vagrantfile`:
-
-    config.vm.synced_folder File.expand_path(config.user.repository.project), "/git"
-
 ### Parameters access
 
 Parameters in the `Vagrantfile` can be retrieved via method call
@@ -307,120 +285,6 @@ Usage:
           nodes_path: /Users/Chef/kitchen/nodes
           roles_path: /Users/Chef/kitchen/roles
 
-Add flag `-h` (or `--help`) for description of the command and a
-list of available options.
-
-#### Env
-
-Sometimes, you would like to have acces to the different values
-stored in your `.vagrantuser` from environment variables. This
-command is meant is exactly for this.
-
-By using one of the three methods below, you will be able to export
-(but also unset) environment variables from your current
-parameters as seen by Nugrant.
-
-You can see the commands that will be executed by simply
-calling the method:
-
-    vagrant user env
-
-The name of the environment will be upper cased and full path of
-the key, without the `config.user` prefix, separated
-with `_`. For example, the key accessible using
-`config.user.db.user` and with value `root` would generate the
-export command:
-
-    export DB_USER=root
-
-And the unset command:
-
-    unset DB_USER
-
-The value are escaped so it is possible to define value containing
-spaces for example.
-
-A last note about generate commands is that pre-existing environment
-variable are not taking in consideration by this command. So if
-an environment variable with name `DB_USER` already exist, it
-would be overwritten by an export command.
-
-Add flag `-h` (or `--help`) for description of the command and a
-list of available options.
-
-##### Method #1
-
-If you plan to use frequently this feature, our best suggestion
-is to create a little bash script that will simply delegates
-to the real command. By having a bash script that calls the
-command, you will be able to easily export environment variables
-by sourcing the script.
-
-Create a file named `nugrant2env` somewhere accessible from
-the `$PATH` variable with the following content:
-
-    #!/bin/env sh
-
-    $(vagrant user env "$@")
-
-This script will simply delegates to the `vagrant user env`
-command and pass all arguments it receives to it. The
-magic happens because the command `vagrant user env` outputs
-the various export commands to the standard output.
-
-By sourcing the simple delegating bash script, the parameters
-seen by Nugrant will be available in your environment:
-
-    . nugrant2env
-
-By default, export commands are generated. But you can pass
-some options to the `nugrant2env` script, For example, to
-generate the unset ones, add `--unset` (or simply `-u`).
-
-    . nugrant2env --unset
-
-For a list of options, see the help of the command delegated
-to:
-
-    vagrant user env -h
-
-##### Method #2
-
-Use the command to generate a base script in the current
-directory that you will then source:
-
-    vagrant user env --format script
-
-This will generate a script called `nugrant2env.sh` into the
-current directory. You then simply source this script:
-
-    . nugrant2env.sh
-
-Using `vagrant user env -u --format script` will instead generate the bash
-script that will unset the environment variables. Don't forget
-to source it to unset variables.
-
-##### Method #3
-
-Use the command to generate an [autoenv](https://github.com/kennethreitz/autoenv)
-file in the current directory. By using the [autoenv] project, anytime you
-will enter the project directory via the `cd` command, variables
-exported found in the `.env` file generated will be exported to
-your environment.
-
-    vagrant user env --format autoenv
-
-This will generate a file called `.env` in the
-current directory. You then simply change to the directory
-where the `.env` file was generated to made exported variables
-available in your environment.
-
-    cd ..
-    cd <project_dir>
-
-Using `vagrant user env -u --format autoenv` will instead generate
-the autoenv file that will unset the environment variables.
-
 ## Contributing
 
 You can contribute by filling issues when something goes

data/lib/nugrant.rb

@@ -2,31 +2,13 @@ require 'pathname'
 require 'nugrant/config'
 require 'nugrant/parameters'
 
+# 1.8 Compatibility check
 unless defined?(KeyError)
   class KeyError < IndexError
   end
 end
 
-module Nugrant
-  def self.create_parameters(options)
-    config = Nugrant::Config.new(options)
-
-    return Nugrant::Parameters.new(config)
-  end
-
-  def self.setup_i18n()
-    I18n.load_path << File.expand_path("locales/en.yml", Nugrant.source_root)
-    I18n.reload!
-  end
-
-  def self.source_root
-    @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
-  end
-end
-
 if defined?(Vagrant)
-  Nugrant.setup_i18n()
-
   case
   when defined?(Vagrant::Plugin::V2)
     require 'nugrant/vagrant/v2/plugin'
@@ -36,3 +18,6 @@ if defined?(Vagrant)
     abort("You are trying to use Nugrant with an unsupported Vagrant version [#{Vagrant::VERSION}]")
   end
 end
+
+module Nugrant
+end