nugrant 0.0.12 → 0.0.13

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.0.13
+
+* 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
+
 # 0.0.12
 
 * Added travis configuration file

data/lib/nugrant/parameter_bag.rb

@@ -1,26 +1,29 @@
 module Nugrant
   class ParameterBag
     def initialize(parameters)
-      if parameters == nil
-        return
-      end
+      @bag = recompute(parameters)
+    end
 
-      @bag = {}
-      @defaults = {}
+    def recompute(parameters)
+      @bag = transform(parameters)
+      return @bag
+    end
 
-      parameters.each do |key, value|
-        if key == "defaults"
-          raise ArgumentError, "The key 'defaults' has restricted usage and cannot be defined"
-        end
+    def transform(parameters)
+      bag = {}
+      return bag if parameters == nil
 
+      parameters.each do |key, value|
         if not value.is_a?(Hash)
-          @bag[key] = value
+          bag[key] = value
           next
         end
 
         # It is a hash, transform it into a bag
-        @bag[key] = Nugrant::ParameterBag.new(value)
+        bag[key] = Nugrant::ParameterBag.new(value)
       end
+
+      return bag
     end
 
     def [](param_name)
@@ -32,15 +35,11 @@ module Nugrant
     end
 
     def has_param?(param_name)
-      return @bag != nil && @bag.has_key?(param_name)
+      return @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
 
@@ -50,19 +49,5 @@ module Nugrant
     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

data/lib/nugrant/parameters.rb

@@ -5,57 +5,44 @@ require 'yaml'
 
 module Nugrant
   class Parameters < Nugrant::ParameterBag
+    attr_reader :defaults, :system, :user, :project, :all
+
     def initialize(config = nil)
       if config == nil
         config = Nugrant::Config.new()
       end
 
       @config = config
-      @parameters = load_parameters()
-
-      super(@parameters)
-    end
-
-    def get_bag()
-      @bag
-    end
 
-    def get_params()
-      return @parameters
-    end
+      @defaults = nil
+      @system = parse_parameters(@config.system_params_path)
+      @user = parse_parameters(@config.user_params_path)
+      @project = parse_parameters(@config.project_params_path)
 
-    def get_project_params()
-      return @project_parameters
+      @all = compute_all()
     end
 
-    def get_user_params()
-      return @user_parameters
-    end
+    def defaults=(parameters)
+      @defaults = parameters
 
-    def get_system_params()
-      return @system_parameters
+      # When defaults change, we need to recompute parameters hierarchy
+      compute_all()
     end
 
-    def load_parameters()
-      @project_parameters = load_parameters_file(@config.project_params_path)
-      @user_parameters = load_parameters_file(@config.user_params_path)
-      @system_parameters = load_parameters_file(@config.system_params_path)
-
-      parameters = Hash.new()
-
-      if @project_parameters == nil and @user_parameters == nil and @system_parameters == nil
-        return parameters
-      end
+    def compute_all()
+      @all = Hash.new()
+      @all.deep_merge!(@defaults) if @defaults != nil
+      @all.deep_merge!(@system) if @system != nil
+      @all.deep_merge!(@user) if @user != nil
+      @all.deep_merge!(@project) if @project != nil
 
-      parameters.deep_merge!(@system_parameters) if @system_parameters != nil
-      parameters.deep_merge!(@user_parameters) if @user_parameters != nil
-      parameters.deep_merge!(@project_parameters) if @project_parameters != nil
+      self.recompute(@all)
 
-      return parameters
+      return @all
     end
 
-    def load_parameters_file(file_path)
-      data = parse(file_path)
+    def parse_parameters(file_path)
+      data = parse_data(file_path)
       if data == nil || !data.kind_of?(Hash)
         return
       end
@@ -68,7 +55,7 @@ module Nugrant
       return data
     end
 
-    def parse(file_path)
+    def parse_data(file_path)
       return if not File.exists?(file_path)
 
       begin

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

@@ -9,6 +9,7 @@ module Nugrant
           super(arguments, environment)
 
           @show_help = false
+          @show_defaults = false
           @show_system = false
           @show_user = false
           @show_project = false
@@ -26,6 +27,10 @@ module Nugrant
               @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
@@ -43,11 +48,6 @@ module Nugrant
                               "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."
-
-            parser.separator ""
-            parser.separator "Notice: For now, defaults directly defined in the Vagrantfile are not \n" +
-                             "considered by this command. This is something we would like to fix in \n" +
-                             "the near future."
           end
         end
 
@@ -57,11 +57,19 @@ module Nugrant
 
           return help(parser) if @show_help
 
-          system() if @show_system
-          user() if @show_user
-          project() if @show_project
+          @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)
 
-          all() if !@show_system && !@show_user && !@show_project
+            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
@@ -70,55 +78,57 @@ module Nugrant
           @env.ui.info(parser.help, :prefix => false)
         end
 
-        def system()
-          parameters = Nugrant::Parameters.new()
-
-          print_header("System")
-          print_parameters(parameters.get_system_params())
+        def defaults(parameters)
+          print_results("Defaults", parameters.defaults)
         end
 
-        def user()
-          parameters = Nugrant::Parameters.new()
-
-          print_header("User")
-          print_parameters(parameters.get_user_params())
+        def system(parameters)
+          print_results("System", parameters.system)
         end
 
-        def project()
-          parameters = Nugrant::Parameters.new()
-
-          print_header("Project")
-          print_parameters(parameters.get_project_params())
+        def user(parameters)
+          print_results("User", parameters.user)
         end
 
-        def all()
-          parameters = Nugrant::Parameters.new()
-
-          print_parameters(parameters.get_params())
+        def project(parameters)
+          print_results("Project", parameters.project)
         end
 
-        def print_header(kind)
-          @env.ui.info("#{kind.capitalize} parameters", :prefix => false)
-          @env.ui.info("-----------------------------------------------", :prefix => false)
+        def all(parameters)
+          print_results("All", parameters.all)
         end
 
-        def print_parameters(parameters)
+        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
 
-          data = {
+          print_parameters(kind, {
             'config' => {
               'user' => parameters
             }
-          }
+          })
+        end
 
-          string = Nugrant::Helper::Yaml.format(data.to_yaml)
+        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

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

@@ -4,6 +4,8 @@ module Nugrant
   module Vagrant
     module Config
       class User < ::Vagrant::Config::Base
+        attr_reader :parameters
+
         def initialize()
           @parameters = Nugrant::Parameters.new()
         end

data/lib/nugrant/version.rb

@@ -1,3 +1,3 @@
 module Nugrant
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/nugrant.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/nuecho/nugrant"
   gem.summary       = "Vagrant plugin to enable user specific configuration parameters."
   gem.description   = <<-EOF
-     This gem is in fact a Vagrant pluging. By installing this gem, it will be
+     This gem is in fact a Vagrant plugin. By installing this gem, it will be
      possible to define user specific configuration files that will be merge
-     directly into the Vagrant configuration. This is usefull if you need to
+     directly into the Vagrant configuration. This is useful if you need to
      share a Vagrantfile to multiple developers but would like to customize
      some parameters for each users differently.
   EOF

data/test/lib/nugrant/test_parameters.rb

@@ -183,11 +183,6 @@ class Nugrant::TestParameters < Test::Unit::TestCase
   def test_defaults()
     filetypes.each do |params_filetype|
       parameters = create_parameters(params_filetype, "params_simple", invalid_path, invalid_path)
-      parameters.defaults({"test" => "override", "level" => "new"})
-
-      assert_equal("value", parameters.test)
-      assert_equal("new", parameters.level)
-
       parameters.defaults = {"test" => "override1", "level" => "new1"}
 
       assert_equal("value", parameters.test)
@@ -198,7 +193,7 @@ class Nugrant::TestParameters < Test::Unit::TestCase
   def test_empty_file()
     filetypes.each do |params_filetype|
       parameters = create_parameters(params_filetype, "params_empty", invalid_path, invalid_path)
-      parameters.defaults({"test" => "value"})
+      parameters.defaults = {"test" => "value"}
 
       assert_equal("value", parameters.test)
     end
@@ -208,7 +203,7 @@ class Nugrant::TestParameters < Test::Unit::TestCase
     ["boolean", "list"].each do |wrong_type|
       filetypes.each do |params_filetype|
         parameters = create_parameters(params_filetype, "params_#{wrong_type}", invalid_path, invalid_path)
-        parameters.defaults({"test" => "value"})
+        parameters.defaults = {"test" => "value"}
 
         assert_equal("value", parameters.test)
       end

data/test/lib/nugrant/test_parameters_bag.rb

@@ -81,84 +81,4 @@ class Nugrant::TestParameterBag < Test::Unit::TestCase
       bag["invalid_value"]
     end
   end
-
-  def test_restricted_key_defaults()
-    assert_raise(ArgumentError) do
-      results = create_bag({"defaults" => "one"})
-      puts("Results: #{results.inspect} (Should have thrown!)")
-    end
-
-    assert_raise(ArgumentError) do
-      results = create_bag({"level" => {"defaults" => "value"}})
-      puts("Results: #{results.inspect} (Should have thrown!)")
-    end
-  end
-
-  def test_defaults()
-    run_test_defaults({
-      "first" => {
-        "level1" => "value1",
-        "level2" => "value2",
-        "deeper" => {
-          "level3" => "value3"
-        }
-      },
-    }, {
-      "first" => {
-        "level1" => "default1",
-        "level3" => "default3",
-        "deeper" => {
-          "level3" => "default3",
-          "level4" => "value4"
-        }
-      },
-      "second" => {
-        "level1" => "default1"
-      },
-      "third" => "default3"
-    }, {
-      "first" => {
-        "level1" => "value1",
-        "level2" => "value2",
-        "level3" => "default3",
-        "deeper" => {
-          "level3" => "value3",
-          "level4" => "value4"
-        }
-      },
-      "second" => {
-        "level1" => "default1"
-      },
-      "third" => "default3"
-    })
-  end
-
-  def test_defaults_empty()
-    defaults = {
-      "first" => {
-        "second" => {
-          "third" => {
-            "value1" => "one",
-            "value2" => "two"
-          },
-          "fourth" => "third",
-        },
-        "fifth" => "four"
-      }
-    }
-
-    run_test_defaults({}, defaults, defaults)
-  end
-
-  def run_test_defaults(parameters, parameters_defaults, expected)
-    bag = create_bag(parameters)
-    bag.defaults(parameters_defaults)
-
-    assert_bag(expected, bag)
-
-    bag = create_bag(parameters)
-    bag.defaults = parameters_defaults
-
-    assert_bag(expected, bag)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nugrant
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -59,9 +59,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.5
-description: ! "     This gem is in fact a Vagrant pluging. By installing this gem,
+description: ! "     This gem is in fact a Vagrant plugin. By installing this gem,
   it will be\n     possible to define user specific configuration files that will
-  be merge\n     directly into the Vagrant configuration. This is usefull if you need
+  be merge\n     directly into the Vagrant configuration. This is useful if you need
   to\n     share a Vagrantfile to multiple developers but would like to customize\n
   \    some parameters for each users differently.\n"
 email:
@@ -141,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -519440520645182635
+      hash: -1143289133319579260
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -519440520645182635
+      hash: -1143289133319579260
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24