nugrant 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0de10dfbe571d6be4e0c7a7c3fa3c7d4893fc88
-  data.tar.gz: 9fbec16a209341335a171f6fe57128b71bfa6e60
+  metadata.gz: 89aef5f2cae21cfe30f4fd15204955cd83ee5fd7
+  data.tar.gz: 85aff126d8c8cb3719d5f4a75ace5a95ce4460df
 SHA512:
-  metadata.gz: a7d7b102855c2af842e76eaa609b96b4a6b5316a4f8a05a956e5515b514024e356ff5b4afd23dc9a2fc25126998d90146626e018e29851ed1952721351259b41
-  data.tar.gz: 5c16317e800d0c725ae2f2544935de78da3cf994b1214032f4a0ddbf1ffc3b86ec84437a7e188f4864a230dd172b35809ac9d1afa2b0c666b52bc767704cedce
+  metadata.gz: b9fb53dbf9edcb2cf22060430ea36fe6a54c07002fe4601e374f98e5d8a001243f1ff0550b07d8a3a576729d69c3b9da5478f8f7f6fd08485cd07b05f0641597
+  data.tar.gz: 0ee9ef8856832546e5048f614a42ca6ad166387b905d3cfa119bce4a8d2ffd185c9814ea26f15ef714bad9c36fa50e4b807f6c3d23493fbf58bf992b5888919d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 2.0.0 (In progress)
 
+ * Fixed retrieval of current directory for `.vagrantuser`. The directory
+   is now that same as the one of the `Vagrantfile`. Rules have been
+   copied for Vagrant's one, hence, the behavior should be the same.
+
  * Fixed bad implementation of config class `::Vagrant.plugin("2", :config)`
    where `merge` was not implemented and was causing errors. Now, all objects
    (i.e. `Config`, `Bag` and `Parameters` implements `merge` and `merge!`

data/README.md

@@ -30,8 +30,8 @@ Let's start with an example. You need to distribute among your enterprise a
 The `aws_access_key` and `aws_secret_key` should be configurable depending on the user
 running `vagrant up`.
 
-To achieve this, simply create a file named `.vagrantuser` in the project directory with
-the following content:
+To achieve this, simply create a file named `.vagrantuser` that resides in the directory
+as your `Vagrantfile`:
 
     aws:
       access_key: "123456"
@@ -60,16 +60,32 @@ must be filled in, something like:
       access_key: "<ACCESS_KEY_HERE>"
       secret_key: "<SECRET_KEY_HERE>"
 
-Moreover, there is a hierarchy of `.vagrantuser` files that you can leverage.
-The order is project `.vagrantuser` overrides `$HOME/.vagrantuser` overrides
-`$SYSTEM/.vagrantuser` where `$HOME` is the user's home directory and `$SYSTEM`
-is the platform dependent folder where system global parameters are set.
+To find where your project `.vagrantuser` is located, Nugrant uses the directory
+where the `Vagrantfile` is located. It achieves this using the same set of
+rules as Vagrant meaning you can be in a nested directory and parameters
+will still be fetched correctly.
 
-Use the command `vagrant user parameters` to see the final merged hierarchy
-seen by Nugrant. This command also prints [restricted keys](#restricted-keys) defined
-in your hierarchy.
+Moreover, like other similar system, there is a hierarchy of `.vagrantuser` files
+that you can leverage:
 
-You can access parameters in your `Vagrantfile` either by method access
+| Name     | Location                                | Priority  | Overrides                |
+| ---------|-----------------------------------------|:---------:|--------------------------|
+| Defaults | [config.user.defaults](#default-values) | 4         | -                        |
+| System   | $SYSTEM/.vagrantuser                    | 3         | Defaults                 |
+| User     | ~/.vagrantuser                          | 2         | Defaults & System        |
+| Project  | .vagrantuser                            | 1         | Defaults & System & User |
+
+The project level directory is always the same as the directory where your
+`Vagrantfile` resides and same rules as Vagrant are used to find it.
+The `~` is the user's home directory and `$SYSTEM` is the platform dependent
+folder where system global can be put. Check [Hierarchy](#hierarchy) section
+for where `$SYSTEM` maps exactly.
+
+You can use the command `vagrant user parameters` to see the final merged
+hierarchy seen by Nugrant. This command also prints [restricted keys](#restricted-keys)
+defined in your hierarchy.
+
+Accessing parameters in your `Vagrantfile` can be done either by method access
 (i.e. `config.user.<key>`) or by array access (i.e. `config.user[<key>]`).
 This support is working for any deepness, only `config.user` is different
 because provided directly by `Vagrant` and not by this plugin.
@@ -230,6 +246,8 @@ That would be equivalent to:
       config.vm.synced_folder "/home/user/personal/git", "/personal"
     end
 
+#### Hierarchy
+
 As you can see, the parameters defined in the second `.vagrantuser` file
 (the current one) overrides settings defined in the `.vagrantuser` found
 in the home directory (the user one).
@@ -239,7 +257,7 @@ 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. current (`.vagrantuser` within the same folder as the `Vagrantfile`)
+ 4. Project (`.vagrantuser` within the same folder as the `Vagrantfile`)
 
 #### Paths
 

data/lib/nugrant/config.rb

@@ -44,6 +44,30 @@ module Nugrant
       "/etc"
     end
 
+    ##
+    # Method to fix-up a received path. The fix-up do the follows
+    # the following rules:
+    #
+    # 1. If the path is callable, call it to get the value.
+    # 2. If value is nil, return default value.
+    # 3. If value is a directory, return path + params_filename to it.
+    # 4. Otherwise, return value
+    #
+    # @param path The path parameter received.
+    # @param default The default path to use, can be a directory.
+    # @param params_filename The params filename to append if path is a directory
+    #
+    # @return The fix-up path following rules defined above.
+    #
+    def self.fixup_path(path, default, params_filename)
+      path = path.call if path.respond_to?(:call)
+
+      path = File.expand_path(path || default)
+      path = "#{path}/#{params_filename}" if ::File.directory?(path)
+
+      path
+    end
+
     def self.supported_array_merge_strategy(strategy)
       SUPPORTED_ARRAY_MERGE_STRATEGIES.include?(strategy)
     end
@@ -108,9 +132,9 @@ module Nugrant
       @params_filename = options[:params_filename] || DEFAULT_PARAMS_FILENAME
       @params_format = options[:params_format] || DEFAULT_PARAMS_FORMAT
 
-      @current_path = File.expand_path(options[:current_path] || "./#{@params_filename}")
-      @user_path = File.expand_path(options[:user_path] || "#{Config.default_user_path()}/#{@params_filename}")
-      @system_path = File.expand_path(options[:system_path] || "#{Config.default_system_path()}/#{@params_filename}")
+      @current_path = Config.fixup_path(options[:current_path], ".", @params_filename)
+      @user_path = Config.fixup_path(options[:user_path], Config.default_user_path(), @params_filename)
+      @system_path = Config.fixup_path(options[:system_path], Config.default_system_path(), @params_filename)
 
       @array_merge_strategy = options[:array_merge_strategy] || :replace
 

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

@@ -1,6 +1,6 @@
 require 'nugrant'
 require 'nugrant/helper/yaml'
-require 'nugrant/vagrant/v2/command/helper'
+require 'nugrant/vagrant/v2/helper'
 
 module Nugrant
   module Vagrant
@@ -101,7 +101,7 @@ module Nugrant
           end
 
           def project(parameters)
-            print_bag("Project", parameters.__project)
+            print_bag("Project", parameters.__current)
           end
 
           def all(parameters)

data/lib/nugrant/vagrant/v2/command/restricted_keys.rb

@@ -1,5 +1,5 @@
 require 'nugrant'
-require 'nugrant/vagrant/v2/command/helper'
+require 'nugrant/vagrant/v2/helper'
 
 module Nugrant
   module Vagrant
@@ -30,8 +30,8 @@ module Nugrant
 
                parser.separator ""
                parser.separator "Prints keys that cannot be accessed using the method access syntax\n" +
-                                "(`config.user.local`). Use array access syntax (`config.user['local']`)\n" +
-                                "if you really want to use of the restricted keys\n"
+                                "(`config.user.<key>`). Use array access syntax (`config.user['<key>']`)\n" +
+                                "if you really want to use of the restricted keys.\n"
             end
           end
 
@@ -41,9 +41,9 @@ module Nugrant
 
             return help(parser) if @show_help
 
-            @env.ui.info("The following keys are restricted, i.e. that method access (`config.user.first`)", :prefix => false)
+            @env.ui.info("The following keys are restricted, i.e. that method access (`config.user.<key>`)", :prefix => false)
             @env.ui.info("will not work. If you really want to use a restricted key, use array access ", :prefix => false)
-            @env.ui.info("instead (`config.user['local']`).", :prefix => false)
+            @env.ui.info("instead (`config.user['<key>']`).", :prefix => false)
             @env.ui.info("", :prefix => false)
 
             @env.ui.info("You can run `vagrant user parameters` to check if your config currently defines", :prefix => false)

data/lib/nugrant/vagrant/v2/config/user.rb

@@ -12,6 +12,7 @@ module Nugrant
           def initialize(defaults = {}, config = {})
             setup!(defaults,
               :params_filename => ".vagrantuser",
+              :current_path => Helper.find_project_path(),
               :key_error => Proc.new do |key|
                 raise Errors::ParameterNotFoundError, :key => key.to_s
               end,
@@ -20,8 +21,6 @@ module Nugrant
               end
             )
           end
-
-
         end
       end
     end

data/lib/nugrant/vagrant/v2/helper.rb

@@ -0,0 +1,95 @@
+require 'pathname'
+
+require 'nugrant'
+require 'nugrant/bag'
+require 'nugrant/vagrant/v2/config/user'
+
+module Nugrant
+  module Vagrant
+    module V2
+      class Helper
+
+        ##
+        # The project path is the path where the top-most (loaded last)
+        # Vagrantfile resides. It can be considered the project root for
+        # this environment.
+        #
+        # Copied from `lib\vagrant\environment.rb#532` (tag: v1.6.2)
+        #
+        # @return [String] The project path to use.
+        #
+        def self.find_project_path()
+          vagrantfile_name = ENV["VAGRANT_VAGRANTFILE"]
+
+          root_finder = lambda do |path|
+            vagrantfile = find_vagrantfile(path, vagrantfile_name)
+
+            return path if vagrantfile
+            return nil if path.root? || !File.exist?(path)
+
+            root_finder.call(path.parent)
+          end
+
+          root_finder.call(get_vagrant_working_directory())
+        end
+
+        ##
+        # Finds the Vagrantfile in the given directory.
+        #
+        # Copied from `lib\vagrant\environment.rb#732` (tag: v1.6.2)
+        #
+        # @param [Pathname] path Path to search in.
+        # @return [Pathname]
+        #
+        def self.find_vagrantfile(search_path, filenames = nil)
+          filenames ||= ["Vagrantfile", "vagrantfile"]
+          filenames.each do |vagrantfile|
+            current_path = search_path.join(vagrantfile)
+            return current_path if current_path.file?
+          end
+
+          nil
+        end
+
+        ##
+        # Returns Vagrant working directory to use.
+        #
+        # Copied from `lib\vagrant\environment.rb#80` (tag: v1.6.2)
+        #
+        # @return [Pathname] The working directory to start search in.
+        #
+        def self.get_vagrant_working_directory()
+          cwd = nil
+
+          # Set the default working directory to look for the vagrantfile
+          cwd ||= ENV["VAGRANT_CWD"] if ENV.has_key?("VAGRANT_CWD")
+          cwd ||= Dir.pwd
+          cwd = Pathname.new(cwd)
+
+          if !cwd.directory?
+            raise Errors::EnvironmentNonExistentCWD, cwd: cwd.to_s
+          end
+
+          cwd = cwd.expand_path
+        end
+
+        def self.get_restricted_keys()
+          bag_methods = Nugrant::Bag.instance_methods
+          parameters_methods = V2::Config::User.instance_methods
+
+          (bag_methods | parameters_methods).map(&:to_s)
+        end
+
+        def self.get_used_restricted_keys(hash, restricted_keys)
+          keys = []
+          hash.each do |key, value|
+            keys << key if restricted_keys.include?(key)
+            keys += get_used_restricted_keys(value, restricted_keys) if value.kind_of?(Hash)
+          end
+
+          keys.uniq
+        end
+      end
+    end
+  end
+end

data/lib/nugrant/vagrant/v2/plugin.rb

@@ -4,6 +4,9 @@ module Nugrant
     module V2
       class Plugin < ::Vagrant.plugin("2")
         name "Nugrant"
+        description <<-DESC
+          Plugin to define and use user specific parameters from various location inside your Vagrantfile.
+        DESC
 
         command "user" do
           require_relative "command/root"

data/lib/nugrant/version.rb

@@ -1,3 +1,3 @@
 module Nugrant
-  VERSION = "2.0.0.rc1"
+  VERSION = "2.0.0"
 end

data/locales/en.yml

@@ -9,8 +9,8 @@ en:
 
           %{context}
 
-          If you think it should be found, don't hesitate to fill an
-          issue @ https://github.com/maoueh/nugrant/issues.
+          If you think the parameter '%{key}' should have been found, don't
+          hesitate to fill an issue @ https://github.com/maoueh/nugrant/issues.
 
         parse_error: |-
           Nugrant: Vagrant user file could not be parsed correctly,

data/locales/fr.yml

@@ -0,0 +1,24 @@
+en:
+  nugrant:
+    vagrant:
+      errors:
+        parameter_not_found: |-
+          Nugrant: Le paramètre '%{key}' n'a pu être trouvé, est-il définie
+          dans votre fichier .vagrantuser ? Voici où nous pensons que l'erreur
+          se trouve dans votre fichier Vagrantfile:
+
+          %{context}
+
+          Si vous croyez que le paramètre '%{key}' devrait être trouvé, n'hésitez
+          pas à rapporter le problème @ https://github.com/maoueh/nugrant/issues.
+
+        parse_error: |-
+          Nugrant: Le fichier de paramètres Vagrant n'a pu être lu correctement,
+          le fichier contient probablement une erreur de syntaxe.
+
+           File: %{filename}
+           Error: %{error}
+
+          Si vous croyez que ceci est un bug, n'hésitez pas à rapporter le
+          problème @ https://github.com/maoueh/nugrant/issues.
+

data/test/lib/nugrant/test_config.rb

@@ -54,6 +54,28 @@ module Nugrant
       assert_equal("#{@user_dir}/.currentcustomparams", config.current_path())
     end
 
+    def test_custom_current_path_without_filename
+      config = Nugrant::Config.new({
+        :params_filename => ".customparams",
+        :current_path => "#{@user_dir}"
+      })
+
+      assert_equal(".customparams", config.params_filename())
+      assert_equal("#{@user_dir}/.customparams", config.current_path())
+    end
+
+    def test_custom_current_path_using_callable
+      config = Nugrant::Config.new({
+        :params_filename => ".customparams",
+        :current_path => lambda do ||
+          "#{@user_dir}/"
+        end
+      })
+
+      assert_equal(".customparams", config.params_filename())
+      assert_equal("#{@user_dir}/.customparams", config.current_path())
+    end
+
     def test_custom_user_path
       config = Nugrant::Config.new({
         :params_filename => ".customparams",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nugrant
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthieu Vachon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -64,14 +64,15 @@ files:
 - lib/nugrant/parameters.rb
 - lib/nugrant/vagrant/errors.rb
 - lib/nugrant/vagrant/v2/command/env.rb
-- lib/nugrant/vagrant/v2/command/helper.rb
 - lib/nugrant/vagrant/v2/command/parameters.rb
 - lib/nugrant/vagrant/v2/command/restricted_keys.rb
 - lib/nugrant/vagrant/v2/command/root.rb
 - lib/nugrant/vagrant/v2/config/user.rb
+- lib/nugrant/vagrant/v2/helper.rb
 - lib/nugrant/vagrant/v2/plugin.rb
 - lib/nugrant/version.rb
 - locales/en.yml
+- locales/fr.yml
 - nugrant.gemspec
 - test/lib/nugrant/helper/env/test_exporter.rb
 - test/lib/nugrant/helper/test_bag.rb
@@ -139,9 +140,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: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/lib/nugrant/vagrant/v2/command/helper.rb

@@ -1,30 +0,0 @@
-require 'nugrant'
-require 'nugrant/bag'
-require 'nugrant/vagrant/v2/config/user'
-
-module Nugrant
-  module Vagrant
-    module V2
-      module Command
-        class Helper
-          def self.get_restricted_keys()
-            bag_methods = Nugrant::Bag.instance_methods
-            parameters_methods = V2::Config::User.instance_methods
-
-            (bag_methods | parameters_methods).map(&:to_s)
-          end
-
-          def self.get_used_restricted_keys(hash, restricted_keys)
-            keys = []
-            hash.each do |key, value|
-              keys << key if restricted_keys.include?(key)
-              keys += get_used_restricted_keys(value, restricted_keys) if value.kind_of?(Hash)
-            end
-
-            keys.uniq
-          end
-        end
-      end
-    end
-  end
-end