nugrant 1.4.2 → 2.0.0.dev1

data/lib/nugrant/bag.rb

@@ -15,11 +15,11 @@ module Nugrant
     end
 
     def method_missing(method, *args, &block)
-      return __fetch(method)
+      return __fetch(method.to_s)
     end
 
     def has?(key)
-      return @__elements.has_key?(key.to_sym)
+      return @__elements.has_key?(key)
     end
 
     def empty?()
@@ -42,7 +42,7 @@ module Nugrant
             current.__merge!(value)
           elsif current.kind_of?(Array) and value.kind_of?(Array)
             @__elements[key] = current | value
-          elsif value != nil
+          else
             @__elements[key] = value
           end
 
@@ -59,16 +59,12 @@ module Nugrant
       end
     end
 
-    def __to_hash(options = {})
+    def __to_hash()
       return {} if empty?()
 
-      string_key = options[:string_key]
-
       hash = {}
       each do |key, value|
-        key = key.to_s() if string_key
-
-        hash[key] = value.kind_of?(Bag) ? value.__to_hash(:string_key => string_key) : value
+        hash[key] = value.kind_of?(Bag) ? value.__to_hash() : value
       end
 
       return hash
@@ -80,12 +76,12 @@ module Nugrant
 
       hash.each do |key, value|
         if not value.kind_of?(Hash)
-          @__elements[key.to_sym] = value
+          @__elements[key] = value
           next
         end
 
         # It is a hash, transform it into a bag
-        @__elements[key.to_sym] = Bag.new(value)
+        @__elements[key] = Bag.new(value)
       end
     end
 
@@ -94,7 +90,7 @@ module Nugrant
         raise KeyError, "Undefined parameter '#{key}'"
       end
 
-      return @__elements[key.to_sym]
+      return @__elements[key]
     end
   end
 end

data/lib/nugrant/config.rb

@@ -2,17 +2,24 @@ require 'rbconfig'
 
 module Nugrant
   class Config
-    DEFAULT_PARAMS_FILENAME = ".vagrantuser"
-    DEFAULT_PARAMS_FILETYPE = "yml"
+    DEFAULT_PARAMS_FILENAME = ".nuparams"
+    DEFAULT_PARAMS_FORMAT = :yaml
 
-    attr :params_filename, true
-    attr :params_filetype, true
+    attr_reader :params_filename, :params_format, :current_path, :user_path, :system_path
 
-    def self.user_base_path()
+    ##
+    # Return the fully expanded path of the user parameters
+    # default location that is used in the constructor.
+    #
+    def self.default_user_path()
       File.expand_path("~")
     end
 
-    def self.system_base_path()
+    ##
+    # Return the fully expanded path of the system parameters
+    # default location that is used in the constructor.
+    #
+    def self.default_system_path()
       if Config.on_windows?
         return File.expand_path(ENV['PROGRAMDATA'] || ENV['ALLUSERSPROFILE'])
       end
@@ -20,31 +27,55 @@ module Nugrant
       "/etc"
     end
 
+    ##
+    # Return true if we are currently on a Windows platform.
+    #
     def self.on_windows?()
       (RbConfig::CONFIG['host_os'].downcase =~ /mswin|mingw|cygwin/) != nil
     end
 
+    ##
+    # Creates a new config object that is used to configure an instance
+    # of Nugrant::Parameters. See the list of options and how they interact
+    # with Nugrant::Parameters.
+    #
+    # =| Options
+    #  * +:params_filename+ - The filename used to fetch parameters from. This
+    #                         will be appended to various default locations.
+    #                         Location are system, project and current that
+    #                         can be tweaked individually by using the options
+    #                         below.
+    #                           Defaults => ".nuparams"
+    #  * +:params_format+   - The format in which parameters are to be parsed.
+    #                         Presently supporting :yaml and :json.
+    #                           Defaults => :yaml
+    #  * +:current_path+    - The current path has the highest precedence over
+    #                         any other location. It can be be used for many purposes
+    #                         depending on your usage.
+    #                          * A path from where to read project parameters
+    #                          * A path from where to read overriding parameters for a cli tool
+    #                          * A path from where to read user specific settings not to be committed in a VCS
+    #                           Defaults => "./#{@params_filename}"
+    #  * +:user_path+       - The user path is the location where the user
+    #                         parameters should resides. The parameters loaded from this
+    #                         location have the second highest precedence.
+    #                           Defaults => "~/#{@params_filename}"
+    #  * +:user_path+       - The system path is the location where system wide
+    #                         parameters should resides. The parameters loaded from this
+    #                         location have the third highest precedence.
+    #                           Defaults => Default system path depending on OS + @params_filename
+    #
     def initialize(options = {})
-      options.delete_if { |key, value| value == nil }
+      @params_filename = options[:params_filename] || DEFAULT_PARAMS_FILENAME
+      @params_format = options[:params_format] || DEFAULT_PARAMS_FORMAT
 
-      @params_filename = options.fetch(:params_filename, DEFAULT_PARAMS_FILENAME)
-      @params_filetype = options.fetch(:params_filetype, DEFAULT_PARAMS_FILETYPE)
+      raise ArgumentError,
+        "Invalid value for :params_format. \
+        The format [#{@params_format}] is currently not supported." if not [:json, :yaml].include?(@params_format)
 
-      @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}")
+      @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}")
     end
   end
 end

data/lib/nugrant/helper/bag.rb

@@ -1,4 +1,4 @@
-require 'multi_json'
+require 'json'
 require 'yaml'
 
 require 'nugrant/bag'
@@ -6,34 +6,36 @@ require 'nugrant/bag'
 module Nugrant
   module Helper
     module Bag
-      def self.read(filepath, filetype, options = {})
-        data = parse_data(filepath, filetype, options)
+      def self.read(filepath, format, error_handler = nil)
+        data = parse_data(filepath, format, error_handler)
 
         return Nugrant::Bag.new(data)
       end
 
-      def self.parse_data(filepath, filetype, options = {})
+      def self.parse_data(filepath, format, error_handler = nil)
         return if not File.exists?(filepath)
 
-        File.open(filepath, "rb") do |file|
-          parsing_method = "parse_#{filetype}"
-          return send(parsing_method, file.read)
-        end
-      rescue => error
-        if options[:error_handler]
-          # TODO: Implements error handler logic
-          options[:error_handler].handle("Could not parse the user #{filetype} parameters file '#{filepath}': #{error}")
+        begin
+          File.open(filepath, "rb") do |file|
+            parsing_method = "parse_#{format.to_s}"
+            return send(parsing_method, file.read())
+          end
+        rescue => error
+          if error_handler
+            # TODO: Implements error handler logic
+            error_handler.handle("Could not parse the user #{format.to_s} parameters file '#{filepath}': #{error}")
+          end
         end
       end
 
-      def self.parse_json(data_string)
-        MultiJson.load(data_string)
+      def self.parse_json(input)
+        JSON.parse(input)
       end
 
-      def self.parse_yml(data_string)
-        YAML::ENGINE.yamler = 'syck' if (defined?(Syck) || defined?(YAML::Syck)) && defined?(YAML::ENGINE)
+      def self.parse_yaml(input)
+        YAML::ENGINE.yamler= 'syck' if defined?(YAML::ENGINE)
 
-        YAML.load(data_string)
+        YAML.load(input)
       end
     end
   end

data/lib/nugrant/parameters.rb

@@ -3,15 +3,29 @@ require 'nugrant/helper/bag'
 
 module Nugrant
   class Parameters
-    attr_reader :__defaults, :__system, :__user, :__project, :__all
+    attr_reader :__current, :__user, :__system, :__defaults, :__all
 
-    def initialize(config = nil, defaults = nil)
-      @__config = config || Config.new()
+    ##
+    # Create a new parameters object which holds completed
+    # merged values. The following precedence is used to decide
+    # which location has precedence over which location:
+    #
+    #    (Highest)  ------------------ (Lowest)
+    #      current < user < system < defaults
+    #
+    # =| Options
+    #  * +:config+   - A hash that will be passed to Nugrant::Config.new().
+    #                  See Nugrant::Config constructor for options that you can use.
+    #  * +:defaults+ - The default values for the various parameters that will be read. This
+    #                  must be a Hash object.
+    #
+    def initialize(options = {})
+      @__config = Config.new(options[:config])
 
-      @__defaults = defaults || Bag.new()
-      @__system = Helper::Bag.read(@__config.system_params_path, @__config.params_filetype)
-      @__user = Helper::Bag.read(@__config.user_params_path, @__config.params_filetype)
-      @__project = Helper::Bag.read(@__config.project_params_path, @__config.params_filetype)
+      @__current = Helper::Bag.read(@__config.current_path, @__config.params_format)
+      @__user = Helper::Bag.read(@__config.user_path, @__config.params_format)
+      @__system = Helper::Bag.read(@__config.system_path, @__config.params_format)
+      @__defaults = Bag.new(options[:defaults] || {})
 
       __compute_all()
     end
@@ -21,7 +35,7 @@ module Nugrant
     end
 
     def method_missing(method, *args, &block)
-      return @__all[method]
+      return  @__all[method.to_s]
     end
 
     def empty?()
@@ -36,6 +50,15 @@ module Nugrant
       @__all.each(&block)
     end
 
+    ##
+    # Set the new default values for the
+    # various parameters contain by this instance.
+    # This will call __compute_all() to recompute
+    # correct precedences.
+    #
+    # =| Attributes
+    #  * +elements+ - The new default elements
+    #
     def defaults=(elements)
       @__defaults = Bag.new(elements)
 
@@ -43,12 +66,17 @@ module Nugrant
       __compute_all()
     end
 
+    ##
+    # Recompute the correct precedences by merging the various
+    # bag in the right order and return the result as a Nugrant::Bag
+    # object.
+    #
     def __compute_all()
       @__all = Bag.new()
       @__all.__merge!(@__defaults)
       @__all.__merge!(@__system)
       @__all.__merge!(@__user)
-      @__all.__merge!(@__project)
+      @__all.__merge!(@__current)
     end
   end
 end

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

@@ -37,18 +37,18 @@ module Nugrant
               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."
+                 @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
 
@@ -110,7 +110,7 @@ module Nugrant
 
             print_parameters(kind, {
               'config' => {
-                'user' => bag.__to_hash(:string_key => true)
+                'user' => bag.__to_hash()
               }
             })
           end

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

@@ -1,6 +1,4 @@
 require 'nugrant'
-require 'nugrant/vagrant/v1/command/env'
-require 'nugrant/vagrant/v1/command/parameters'
 require 'nugrant/version'
 
 module Nugrant
@@ -17,12 +15,9 @@ module Nugrant
             @argv = @arguments
 
             @subcommands = ::Vagrant::Registry.new()
-            @subcommands.register(:env) do
-              Command::Env
-            end
-
             @subcommands.register(:parameters) do
-              Command::Parameters
+              require File.expand_path("../parameters", __FILE__)
+              Parameters
             end
 
             @show_help = false

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

@@ -1,5 +1,4 @@
 require 'nugrant'
-require 'nugrant/vagrant/errors'
 
 module Nugrant
   module Vagrant
@@ -9,29 +8,21 @@ module Nugrant
           attr_reader :parameters
 
           def initialize()
-            @parameters = Nugrant::Parameters.new()
+            @parameters = Nugrant::Parameters.new({:config => {:params_filename => ".vagrantuser"}})
           end
 
           def [](param_name)
             return @parameters[param_name]
-          rescue KeyError
-            raise Errors::ParameterNotFoundError, :key => param_name
           end
 
           def method_missing(method, *args, &block)
             return @parameters.method_missing(method, *args, &block)
-          rescue KeyError
-            raise Errors::ParameterNotFoundError, :key => method
           end
 
           def each(&block)
             @parameters.each(&block)
           end
 
-          def has?(key)
-            @parameters.has?(key)
-          end
-
           def defaults(parameters)
             @parameters.defaults(parameters)
           end

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

@@ -110,7 +110,7 @@ module Nugrant
 
             print_parameters(kind, {
               'config' => {
-                'user' => bag.__to_hash(:string_key => true)
+                'user' => bag.__to_hash()
               }
             })
           end

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

@@ -1,6 +1,4 @@
 require 'nugrant'
-require 'nugrant/vagrant/v2/command/env'
-require 'nugrant/vagrant/v2/command/parameters'
 require 'nugrant/version'
 
 module Nugrant
@@ -17,12 +15,9 @@ module Nugrant
             @argv = @arguments
 
             @subcommands = ::Vagrant::Registry.new()
-            @subcommands.register(:env) do
-              Command::Env
-            end
-
             @subcommands.register(:parameters) do
-              Command::Parameters
+              require File.expand_path("../parameters", __FILE__)
+              Parameters
             end
 
             @show_help = false

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

@@ -1,5 +1,4 @@
 require 'nugrant'
-require 'nugrant/vagrant/errors'
 
 module Nugrant
   module Vagrant
@@ -9,29 +8,21 @@ module Nugrant
           attr_reader :parameters
 
           def initialize()
-            @parameters = Nugrant::Parameters.new()
+            @parameters = Nugrant::Parameters.new({:config => {:params_filename => ".vagrantuser"}})
           end
 
           def [](param_name)
             return @parameters[param_name]
-          rescue KeyError
-            raise Errors::ParameterNotFoundError, :key => param_name
           end
 
           def method_missing(method, *args, &block)
             return @parameters.method_missing(method, *args, &block)
-          rescue KeyError
-            raise Errors::ParameterNotFoundError, :key => method
           end
 
           def each(&block)
             @parameters.each(&block)
           end
 
-          def has?(key)
-            @parameters.has?(key)
-          end
-
           def defaults(parameters)
             @parameters.defaults(parameters)
           end