nugrant 0.0.11 → 0.0.12

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 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
+ * An option has been added to see user parameters
+ * An option has been added to see project parameters
+
 # 0.0.11
 
 * Updated README file for installation via rubygems.org

data/README.md

@@ -1,4 +1,4 @@
-# Nugrant
+# Nugrant [![Build Status](https://travis-ci.org/maoueh/nugrant.png)](https://travis-ci.org/maoueh/nugrant)
 
 Vagrant plugin that brings user specific configuration
 options. It will enable a `.vagrantuser` at different

data/lib/nugrant.rb

@@ -3,6 +3,11 @@ require 'nugrant/config'
 require 'nugrant/parameter_bag'
 require 'nugrant/parameters'
 
+unless defined?(KeyError)
+  class KeyError < IndexError
+  end
+end
+
 module Nugrant
   def self.create_parameters(options)
     config = Nugrant::Config.new(options)

data/lib/nugrant/helper/yaml.rb

@@ -0,0 +1,19 @@
+module Nugrant
+  module Helper
+    class Yaml
+      def self.format(string, options = {})
+        lines =  string.send(string.respond_to?(:lines) ? :lines : :to_s).to_a
+        lines = lines.drop(1)
+
+        if options[:indent]
+          indent_text = " " * options[:indent]
+          lines = lines.map do |line|
+            indent_text + line
+          end
+        end
+
+        return lines.join("")
+      end
+    end
+  end
+end

data/lib/nugrant/parameters.rb

@@ -55,24 +55,29 @@ module Nugrant
     end
 
     def load_parameters_file(file_path)
-      if not File.exists?(file_path)
-        return nil
+      data = parse(file_path)
+      if data == nil || !data.kind_of?(Hash)
+        return
       end
 
+      restricted_key = has_restricted_keys?(data)
+      if restricted_key
+        raise ArgumentError, "The key '#{restricted_key}' has restricted usage and cannot be defined"
+      end
+
+      return data
+    end
+
+    def parse(file_path)
+      return if not File.exists?(file_path)
+
       begin
         File.open(file_path, "rb") do |file|
           parsing_method = "parse_#{@config.params_filetype}"
-          result = send(parsing_method, file.read)
-
-          restricted_key = has_restricted_keys?(result)
-          if restricted_key
-            raise ArgumentError, "The key '#{restricted_key}' has restricted usage and cannot be defined"
-          end
-
-          return result
+          return send(parsing_method, file.read)
         end
       rescue => error
-        raise RuntimeError, "Could not parse the user #{@config.params_filetype} parameters file '#{file_path}': #{error}"
+        # TODO: log this message "Could not parse the user #{@config.params_filetype} parameters file '#{file_path}': #{error}"
       end
     end
 

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

@@ -0,0 +1,125 @@
+require 'nugrant'
+require 'nugrant/helper/yaml'
+
+module Nugrant
+  module Vagrant
+    module Command
+      class Parameters < ::Vagrant::Command::Base
+        def initialize(arguments, environment)
+          super(arguments, environment)
+
+          @show_help = false
+          @show_system = false
+          @show_user = false
+          @show_project = false
+        end
+
+        def create_parser()
+          return OptionParser.new do |parser|
+            parser.banner = "Usage: vagrant user parameters [<options>]"
+            parser.separator ""
+
+            parser.separator "Available options:"
+            parser.separator ""
+
+            parser.on("-h", "--help", "Print this help") do
+              @show_help = true
+            end
+
+            parser.on("-s", "--system", "Show only system parameters") do
+              @show_system = true
+            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."
+
+            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
+
+        def execute
+          parser = create_parser()
+          arguments = parse_options(parser)
+
+          return help(parser) if @show_help
+
+          system() if @show_system
+          user() if @show_user
+          project() if @show_project
+
+          all() if !@show_system && !@show_user && !@show_project
+
+          return 0
+        end
+
+        def help(parser)
+          @env.ui.info(parser.help, :prefix => false)
+        end
+
+        def system()
+          parameters = Nugrant::Parameters.new()
+
+          print_header("System")
+          print_parameters(parameters.get_system_params())
+        end
+
+        def user()
+          parameters = Nugrant::Parameters.new()
+
+          print_header("User")
+          print_parameters(parameters.get_user_params())
+        end
+
+        def project()
+          parameters = Nugrant::Parameters.new()
+
+          print_header("Project")
+          print_parameters(parameters.get_project_params())
+        end
+
+        def all()
+          parameters = Nugrant::Parameters.new()
+
+          print_parameters(parameters.get_params())
+        end
+
+        def print_header(kind)
+          @env.ui.info("#{kind.capitalize} parameters", :prefix => false)
+          @env.ui.info("-----------------------------------------------", :prefix => false)
+        end
+
+        def print_parameters(parameters)
+          if !parameters || parameters.empty?()
+            @env.ui.info(" Empty", :prefix => false)
+            @env.ui.info("", :prefix => false)
+            return
+          end
+
+          data = {
+            'config' => {
+              'user' => parameters
+            }
+          }
+
+          string = Nugrant::Helper::Yaml.format(data.to_yaml)
+          @env.ui.info(string, :prefix => false)
+          @env.ui.info("", :prefix => false)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require 'nugrant'
+
+module Nugrant
+  module Vagrant
+    module Command
+      class Root < ::Vagrant::Command::Base
+        def initialize(arguments, environment)
+          super(arguments, environment)
+
+          @arguments, @subcommand, @subarguments = split_main_and_subcommand(arguments)
+
+          # Change super class available arguments to main ones only
+          @argv = @arguments
+
+          @subcommands = ::Vagrant::Registry.new()
+          @subcommands.register(:parameters) do
+            require File.expand_path("../parameters", __FILE__)
+            Parameters
+          end
+
+          @show_help = false
+          @show_version = false
+        end
+
+        def create_parser()
+          return OptionParser.new do |parser|
+            parser.banner = "Usage: vagrant user [-h] [-v] <command> [<args>]"
+
+            parser.separator ""
+            parser.on("-h", "--help", "Print this help") do
+              @show_help = true
+            end
+
+            parser.on("-v", "--version", "Print plugin version and exit.") do
+              @show_version = true
+            end
+
+            parser.separator ""
+            parser.separator "Available subcommands:"
+
+            keys = []
+            @subcommands.each { |key, value| keys << key.to_s }
+
+            keys.sort.each do |key|
+              parser.separator "     #{key}"
+            end
+
+            parser.separator ""
+            parser.separator "For help on any individual command run `vagrant user COMMAND -h`"
+          end
+        end
+
+        def execute
+          parser = create_parser()
+          arguments = parse_options(parser)
+
+          return version() if @show_version
+          return help(parser) if @show_help
+
+          command_class = @subcommands.get(@subcommand.to_sym) if @subcommand
+          return help(parser) if !command_class || !@subcommand
+
+          @logger.debug("Invoking nugrant command class: #{command_class} #{@subarguments.inspect}")
+
+          command_class.new(@subarguments, @env).execute
+        end
+
+        def help(parser)
+          @env.ui.info(parser.help, :prefix => false)
+        end
+
+        def version()
+          @env.ui.info("Nugrant version #{Nugrant::VERSION}", :prefix => false)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'nugrant'
+
+module Nugrant
+  module Vagrant
+    module Config
+      class User < ::Vagrant::Config::Base
+        def initialize()
+          @parameters = Nugrant::Parameters.new()
+        end
+
+        def [](param_name)
+          return @parameters[param_name]
+        end
+
+        def method_missing(method, *args, &block)
+          return @parameters.method_missing(method, *args, &block)
+        end
+
+        def defaults(parameters)
+          @parameters.defaults(parameters)
+        end
+
+        def defaults=(parameters)
+          @parameters.defaults=(parameters)
+        end
+      end
+    end
+  end
+end

data/lib/nugrant/version.rb

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

data/lib/vagrant_init.rb

@@ -1,7 +1,7 @@
 # This module will initialize the vagrant plugin
-require 'nugrant/vagrant/user_command'
-require 'nugrant/vagrant/user_parameters'
+require 'nugrant/vagrant/command/root'
+require 'nugrant/vagrant/config/user'
 
 # Plugin bootstrap
-Vagrant.commands.register(:user) { Nugrant::Vagrant::UserCommand }
-Vagrant.config_keys.register(:user) { Nugrant::Vagrant::UserParameters }
+Vagrant.commands.register(:user) { Nugrant::Vagrant::Command::Root }
+Vagrant.config_keys.register(:user) { Nugrant::Vagrant::Config::User }

data/test/lib/nugrant/test_parameters.rb

@@ -166,14 +166,14 @@ class Nugrant::TestParameters < Test::Unit::TestCase
 
   def test_restricted_defaults_usage()
     filetypes.each do |params_filetype|
-      assert_raise(RuntimeError) do
+      assert_raise(ArgumentError) do
         results = create_parameters(params_filetype, "params_defaults_at_root", invalid_path, invalid_path)
         puts("Results: #{results.inspect} (Should have thrown!)")
       end
     end
 
     filetypes.each do |params_filetype|
-      assert_raise(RuntimeError) do
+      assert_raise(ArgumentError) do
         results = create_parameters(params_filetype, "params_defaults_not_at_root", invalid_path, invalid_path)
         puts("Results: #{results.inspect} (Should have thrown!)")
       end
@@ -195,6 +195,26 @@ class Nugrant::TestParameters < Test::Unit::TestCase
     end
   end
 
+  def test_empty_file()
+    filetypes.each do |params_filetype|
+      parameters = create_parameters(params_filetype, "params_empty", invalid_path, invalid_path)
+      parameters.defaults({"test" => "value"})
+
+      assert_equal("value", parameters.test)
+    end
+  end
+
+  def test_file_not_hash()
+    ["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"})
+
+        assert_equal("value", parameters.test)
+      end
+    end
+  end
+
   def filetypes()
     @@PARAMS_FILETYPES
   end

data/test/resources/Vagrantfile

@@ -2,4 +2,7 @@ Vagrant::Config.run do |config|
   config.user.defaults = {
     "test" => "value"
   }
+
+  puts config.user.repository.personal
+  puts config.user.test
 end

data/test/resources/json/params_boolean.json

@@ -0,0 +1 @@
+false

data/test/resources/json/params_list.json

@@ -0,0 +1 @@
+["value", "second"]

data/test/resources/yml/params_boolean.yml

@@ -0,0 +1 @@
+true

data/test/resources/yml/params_list.yml

@@ -0,0 +1,2 @@
+- first
+- second

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nugrant
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -74,6 +74,7 @@ files:
 - .gitattributes
 - .gitignore
 - .project
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -81,10 +82,12 @@ files:
 - Rakefile
 - lib/nugrant.rb
 - lib/nugrant/config.rb
+- lib/nugrant/helper/yaml.rb
 - lib/nugrant/parameter_bag.rb
 - lib/nugrant/parameters.rb
-- lib/nugrant/vagrant/user_command.rb
-- lib/nugrant/vagrant/user_parameters.rb
+- lib/nugrant/vagrant/command/parameters.rb
+- lib/nugrant/vagrant/command/root.rb
+- lib/nugrant/vagrant/config/user.rb
 - lib/nugrant/version.rb
 - lib/vagrant_init.rb
 - nugrant.gemspec
@@ -94,9 +97,12 @@ files:
 - test/resources/.vagrantuser
 - test/resources/README.md
 - test/resources/Vagrantfile
+- test/resources/json/params_boolean.json
 - test/resources/json/params_combinations.json
 - test/resources/json/params_defaults_at_root.json
 - test/resources/json/params_defaults_not_at_root.json
+- test/resources/json/params_empty.json
+- test/resources/json/params_list.json
 - test/resources/json/params_project_1.json
 - test/resources/json/params_project_2.json
 - test/resources/json/params_simple.json
@@ -106,9 +112,12 @@ files:
 - test/resources/json/params_user_1.json
 - test/resources/json/params_user_2.json
 - test/resources/json/params_windows_eol.json
+- test/resources/yml/params_boolean.yml
 - test/resources/yml/params_combinations.yml
 - test/resources/yml/params_defaults_at_root.yml
 - test/resources/yml/params_defaults_not_at_root.yml
+- test/resources/yml/params_empty.yml
+- test/resources/yml/params_list.yml
 - test/resources/yml/params_project_1.yml
 - test/resources/yml/params_project_2.yml
 - test/resources/yml/params_simple.yml
@@ -130,12 +139,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -519440520645182635
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -519440520645182635
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -149,9 +164,12 @@ test_files:
 - test/resources/.vagrantuser
 - test/resources/README.md
 - test/resources/Vagrantfile
+- test/resources/json/params_boolean.json
 - test/resources/json/params_combinations.json
 - test/resources/json/params_defaults_at_root.json
 - test/resources/json/params_defaults_not_at_root.json
+- test/resources/json/params_empty.json
+- test/resources/json/params_list.json
 - test/resources/json/params_project_1.json
 - test/resources/json/params_project_2.json
 - test/resources/json/params_simple.json
@@ -161,9 +179,12 @@ test_files:
 - test/resources/json/params_user_1.json
 - test/resources/json/params_user_2.json
 - test/resources/json/params_windows_eol.json
+- test/resources/yml/params_boolean.yml
 - test/resources/yml/params_combinations.yml
 - test/resources/yml/params_defaults_at_root.yml
 - test/resources/yml/params_defaults_not_at_root.yml
+- test/resources/yml/params_empty.yml
+- test/resources/yml/params_list.yml
 - test/resources/yml/params_project_1.yml
 - test/resources/yml/params_project_2.yml
 - test/resources/yml/params_simple.yml

data/lib/nugrant/vagrant/user_command.rb

@@ -1,86 +0,0 @@
-require 'nugrant'
-
-module Nugrant
-  module Vagrant
-    class UserCommand < ::Vagrant::Command::Base
-      HANDLED_SUBCOMMANDS = [
-        "parameters",
-      ]
-
-      def initialize(arguments, environment)
-        super(arguments, environment)
-
-        @parameters = Nugrant::Parameters.new()
-        @options_parser = initialize_parsers()
-
-        @print_help = false
-      end
-
-      def initialize_parsers()
-        parser = OptionParser.new
-
-        parser.banner = "Usage: vagrant user subcommand [options]"
-
-        parser.on("-h", "--help", "Print this help") do
-          @print_help
-        end
-
-        parser.separator ""
-        parser.separator "Available subcommands:"
-
-        HANDLED_SUBCOMMANDS.each do |subcommand|
-          parser.separator "     #{subcommand}"
-        end
-
-        return parser
-      end
-
-      def execute()
-        subcommands = parse_options(@options_parser)
-        if not subcommands
-          subcommands = ["parameters"]
-        end
-
-        subcommands = validate_subcommands(subcommands)
-        if not subcommands
-          safe_puts(@options_parser.help())
-          return
-        end
-
-        # At this point, subcommands are valid
-        subcommands.each do |subcommand|
-          execute_subcommand(subcommand)
-        end
-      end
-
-      def execute_subcommand(subcommand)
-        send(:parameters)
-      end
-
-      def parameters()
-        parameters = {
-          'config' => {
-            'user' => @parameters.get_params()
-          }
-        }
-
-        safe_puts(parameters.to_yaml(:Separator => ""))
-      end
-
-      def handled_subcommand?(subcommand)
-        return HANDLED_SUBCOMMANDS.find_index(subcommand)
-      end
-
-      def validate_subcommands(subcommands)
-        subcommands.each do |subcommand|
-          if not handled_subcommand?(subcommand)
-            puts "Unknown subcommand [#{subcommand}]."
-            return nil
-          end
-        end
-
-        return subcommands
-      end
-    end
-  end
-end

data/lib/nugrant/vagrant/user_parameters.rb

@@ -1,27 +0,0 @@
-require 'nugrant'
-
-module Nugrant
-  module Vagrant
-    class UserParameters < ::Vagrant::Config::Base
-      def initialize()
-        @parameters = Nugrant::Parameters.new()
-      end
-
-      def [](param_name)
-        return @parameters[param_name]
-      end
-
-      def method_missing(method, *args, &block)
-        return @parameters.method_missing(method, *args, &block)
-      end
-
-      def defaults(parameters)
-        @parameters.defaults(parameters)
-      end
-
-      def defaults=(parameters)
-        @parameters.defaults=(parameters)
-      end
-    end
-  end
-end