nugrant 1.4.2 → 2.0.0.dev1

data/test/resources/README.md

@@ -4,12 +4,12 @@ that test merge possibilities.
 Naming convetions
 -----------------
 
-The filename used a specific convetion:
+The filename uses a specific convention:
 
     params_*kind*_*level*.[yml|json]
 
-The kind is one of: [`project`|`user`|`system`] and defines which
-responsability they will hold. The order is `project` overrides
+The kind is one of: [`current`|`user`|`system`] and defines which
+responsability they will hold. The order is `current` overrides
 `user` overrides `system`.
 
 Inside file, keys have special meaning. They define how
@@ -19,12 +19,12 @@ to represent each possibilities.
     key = "1.1.1"
 
 Each element represent a specific kind. Read from left to
-right, they are assigned to `project`, `user` and `system`
+right, they are assigned to `current`, `user` and `system`
 respectively.
 
 So,
 
-    `project`   `user`   `system`
+    `current`   `user`   `system`
        1    .  1   .   1
 
 A 1 signify that the file kind *column* will have a key "1.1.1" set
@@ -32,8 +32,8 @@ to value *kind*. A 0 means the key is not set. With this in mind,
 it is easy to reason about the value that will need to be asserted
 for key "1.1.1" on level file *level*.
 
-    # params_project_1.yml file
-    "1.1.1": "project"
+    # params_current_1.yml file
+    "1.1.1": "current"
 
     # params_user_1.yml file
     "1.1.1": "user"
@@ -42,11 +42,11 @@ for key "1.1.1" on level file *level*.
     "1.1.1": "system"
 
     # Value to assert
-    assert("project", parameters.get("1.1.1"))
+    assert("current", parameters.get("1.1.1"))
 
 With the help of params_combinations, it is easy to create test file
 either for other formats or for more level. Copy the all keys expect
-"0.0.0" to the file. Say the file is of kind `project`, then for
-column `project`, each time a one is there, replace `base` by the
-kind (here `project`). The line that still have value base as the
+"0.0.0" to the file. Say the file is of kind `current`, then for
+column `current`, each time a one is there, replace `base` by the
+kind (here `current`). The line that still have value base as the
 value must be deleted.

data/test/resources/{vagrantfiles/v2.fake → Vagrantfile.v2.fake}

@@ -7,11 +7,8 @@ Vagrant.configure("2") do |config|
         'second' => "value2"
     }
   }
-
+  
   config.user.local.each do |name, value|
     puts "Parameters #{name}: #{value}"
   end
-
-  puts "User has local (symbol)" if config.user.has?(:local)
-  puts "User has local (string)" if config.user.has?("local")
 end

data/test/resources/json/params_current_1.json

@@ -0,0 +1,6 @@
+{
+    "1.1.1": "current",
+    "1.1.0": "current",
+    "1.0.1": "current",
+    "1.0.0": "current"
+}

data/test/resources/json/params_current_2.json

@@ -0,0 +1,29 @@
+{
+    "1.1.1": {
+        "1.1.1": "current",
+        "1.1.0": "current",
+        "1.0.1": "current",
+        "1.0.0": "current"
+    },
+
+    "1.1.0": {
+        "1.1.1": "current",
+        "1.1.0": "current",
+        "1.0.1": "current",
+        "1.0.0": "current"
+    },
+
+    "1.0.1": {
+        "1.1.1": "current",
+        "1.1.0": "current",
+        "1.0.1": "current",
+        "1.0.0": "current"
+    },
+
+    "1.0.0": {
+        "1.1.1": "current",
+        "1.1.0": "current",
+        "1.0.1": "current",
+        "1.0.0": "current"
+    }
+}

data/test/resources/yaml/params_current_1.yml

@@ -0,0 +1,4 @@
+"1.1.1": "current"
+"1.1.0": "current"
+"1.0.1": "current"
+"1.0.0": "current"

data/test/resources/yaml/params_current_2.yml

@@ -0,0 +1,23 @@
+"1.1.1":
+    "1.1.1": "current"
+    "1.1.0": "current"
+    "1.0.1": "current"
+    "1.0.0": "current"
+
+"1.1.0":
+    "1.1.1": "current"
+    "1.1.0": "current"
+    "1.0.1": "current"
+    "1.0.0": "current"
+
+"1.0.1":
+    "1.1.1": "current"
+    "1.1.0": "current"
+    "1.0.1": "current"
+    "1.0.0": "current"
+
+"1.0.0":
+    "1.1.1": "current"
+    "1.1.0": "current"
+    "1.0.1": "current"
+    "1.0.0": "current"

metadata

@@ -1,36 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: nugrant
 version: !ruby/object:Gem::Version
-  version: 1.4.2
-  prerelease: 
+  version: 2.0.0.dev1
 platform: ruby
 authors:
 - Matthieu Vachon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,27 +20,10 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 5.0.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 5.0.8
 description: ! "     Nugrant is a library to easily handle parameters that need to
   be\n     injected into an application via different sources (system, user,\n     project,
   defaults).\n\n     Nugrant can also be directly used as a Vagrant plugin. By activating\n
@@ -87,115 +52,126 @@ files:
 - lib/nugrant/bag.rb
 - lib/nugrant/config.rb
 - lib/nugrant/helper/bag.rb
-- lib/nugrant/helper/env/exporter.rb
-- lib/nugrant/helper/env/namer.rb
-- lib/nugrant/helper/stack.rb
 - lib/nugrant/helper/yaml.rb
 - lib/nugrant/parameters.rb
-- lib/nugrant/vagrant/errors.rb
-- lib/nugrant/vagrant/v1/command/env.rb
 - lib/nugrant/vagrant/v1/command/parameters.rb
 - lib/nugrant/vagrant/v1/command/root.rb
 - lib/nugrant/vagrant/v1/config/user.rb
 - lib/nugrant/vagrant/v1/plugin.rb
-- lib/nugrant/vagrant/v2/command/env.rb
 - lib/nugrant/vagrant/v2/command/parameters.rb
 - lib/nugrant/vagrant/v2/command/root.rb
 - lib/nugrant/vagrant/v2/config/user.rb
 - lib/nugrant/vagrant/v2/plugin.rb
 - lib/nugrant/version.rb
 - lib/vagrant_init.rb
-- locales/en.yml
 - nugrant.gemspec
-- test/lib/nugrant/helper/env/test_exporter.rb
-- test/lib/nugrant/helper/test_stack.rb
 - test/lib/nugrant/test_bag.rb
 - test/lib/nugrant/test_config.rb
 - test/lib/nugrant/test_parameters.rb
 - test/resources/.vagrantuser
 - test/resources/README.md
+- test/resources/Vagrantfile.v1.empty
+- test/resources/Vagrantfile.v1.fake
+- test/resources/Vagrantfile.v1.real
+- test/resources/Vagrantfile.v2.empty
+- test/resources/Vagrantfile.v2.fake
+- test/resources/Vagrantfile.v2.real
 - test/resources/json/params_array.json
 - test/resources/json/params_boolean.json
 - test/resources/json/params_combinations.json
+- test/resources/json/params_current_1.json
+- test/resources/json/params_current_2.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
 - test/resources/json/params_system_1.json
 - test/resources/json/params_system_2.json
 - test/resources/json/params_unix_eol.json
 - test/resources/json/params_user_1.json
 - test/resources/json/params_user_2.json
-- test/resources/json/params_user_nil_values.json
 - test/resources/json/params_windows_eol.json
-- test/resources/vagrantfiles/v1.defaults_mixed_string_symbols
-- test/resources/vagrantfiles/v1.defaults_using_string
-- test/resources/vagrantfiles/v1.defaults_using_symbol
-- test/resources/vagrantfiles/v1.empty
-- test/resources/vagrantfiles/v1.fake
-- test/resources/vagrantfiles/v1.missing_parameter
-- test/resources/vagrantfiles/v1.real
-- test/resources/vagrantfiles/v2.defaults_mixed_string_symbols
-- test/resources/vagrantfiles/v2.defaults_null_values_in_vagrantuser
-- test/resources/vagrantfiles/v2.defaults_using_string
-- test/resources/vagrantfiles/v2.defaults_using_symbol
-- test/resources/vagrantfiles/v2.empty
-- test/resources/vagrantfiles/v2.fake
-- test/resources/vagrantfiles/v2.missing_parameter
-- test/resources/vagrantfiles/v2.real
-- test/resources/yml/params_array.yml
-- 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
-- test/resources/yml/params_system_1.yml
-- test/resources/yml/params_system_2.yml
-- test/resources/yml/params_unix_eol.yml
-- test/resources/yml/params_user_1.yml
-- test/resources/yml/params_user_2.yml
-- test/resources/yml/params_user_nil_values.yml
-- test/resources/yml/params_windows_eol.yml
+- test/resources/yaml/params_array.yml
+- test/resources/yaml/params_boolean.yml
+- test/resources/yaml/params_combinations.yml
+- test/resources/yaml/params_current_1.yml
+- test/resources/yaml/params_current_2.yml
+- test/resources/yaml/params_defaults_at_root.yml
+- test/resources/yaml/params_defaults_not_at_root.yml
+- test/resources/yaml/params_empty.yml
+- test/resources/yaml/params_list.yml
+- test/resources/yaml/params_simple.yml
+- test/resources/yaml/params_system_1.yml
+- test/resources/yaml/params_system_2.yml
+- test/resources/yaml/params_unix_eol.yml
+- test/resources/yaml/params_user_1.yml
+- test/resources/yaml/params_user_2.yml
+- test/resources/yaml/params_windows_eol.yml
 homepage: https://github.com/maoueh/nugrant
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -348904095
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -348904095
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.28
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Library to handle user specific parameters from various location.
 test_files:
-- test/lib/nugrant/helper/env/test_exporter.rb
-- test/lib/nugrant/helper/test_stack.rb
 - test/lib/nugrant/test_bag.rb
 - test/lib/nugrant/test_config.rb
 - test/lib/nugrant/test_parameters.rb
+- test/resources/.vagrantuser
+- test/resources/README.md
+- test/resources/Vagrantfile.v1.empty
+- test/resources/Vagrantfile.v1.fake
+- test/resources/Vagrantfile.v1.real
+- test/resources/Vagrantfile.v2.empty
+- test/resources/Vagrantfile.v2.fake
+- test/resources/Vagrantfile.v2.real
+- test/resources/json/params_array.json
+- test/resources/json/params_boolean.json
+- test/resources/json/params_combinations.json
+- test/resources/json/params_current_1.json
+- test/resources/json/params_current_2.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_simple.json
+- test/resources/json/params_system_1.json
+- test/resources/json/params_system_2.json
+- test/resources/json/params_unix_eol.json
+- test/resources/json/params_user_1.json
+- test/resources/json/params_user_2.json
+- test/resources/json/params_windows_eol.json
+- test/resources/yaml/params_array.yml
+- test/resources/yaml/params_boolean.yml
+- test/resources/yaml/params_combinations.yml
+- test/resources/yaml/params_current_1.yml
+- test/resources/yaml/params_current_2.yml
+- test/resources/yaml/params_defaults_at_root.yml
+- test/resources/yaml/params_defaults_not_at_root.yml
+- test/resources/yaml/params_empty.yml
+- test/resources/yaml/params_list.yml
+- test/resources/yaml/params_simple.yml
+- test/resources/yaml/params_system_1.yml
+- test/resources/yaml/params_system_2.yml
+- test/resources/yaml/params_unix_eol.yml
+- test/resources/yaml/params_user_1.yml
+- test/resources/yaml/params_user_2.yml
+- test/resources/yaml/params_windows_eol.yml

data/lib/nugrant/helper/env/exporter.rb

@@ -1,208 +0,0 @@
-require 'shellwords'
-
-require 'nugrant/bag'
-require 'nugrant/helper/env/namer'
-
-module Nugrant
-  module Helper
-    module Env
-      module Exporter
-        @@DEFAULT_AUTOENV_PATH = "./.env"
-        @@DEFAULT_SCRIPT_PATH = "./nugrant2env.sh"
-
-        @@VALID_EXPORTERS = [:autoenv, :script, :terminal]
-
-        ##
-        # Returns true if the exporter name received is a valid
-        # valid export, false otherwise.
-        #
-        # @param exporter The exporter name to check validity
-        #
-        # @return true if exporter is valid, false otherwise.
-        def self.valid?(exporter)
-          @@VALID_EXPORTERS.include?(exporter)
-        end
-
-        ##
-        # Creates an autoenv script containing the commands that are required
-        # to export or unset a bunch of environment variables taken from the
-        # bag.
-        #
-        # @param bag The bag to create the script for.
-        #
-        # @return (side-effect) Creates a script file containing commands
-        #                       to export or unset environment variables for
-        #                       bag.
-        #
-        # Options:
-        #  * :autoenv_path => The path where to write the script, defaults to `./.env`.
-        #  * :escape_value => If true, escape the value to export (or unset), default to true.
-        #  * :io => The io where the command should be written, default to nil which create the autoenv on disk.
-        #  * :namer => The namer used to transform bag segments into variable name, default to Namer::default().
-        #  * :override => If true, variable a exported even when the override an existing env key, default to true.
-        #  * :type => The type of command, default to :export.
-        #
-        def self.autoenv_exporter(bag, options = {})
-          io = options[:io] || (File.open(File.expand_path(options[:autoenv_path] || @@DEFAULT_AUTOENV_PATH), "w"))
-
-          terminal_exporter(bag, options.merge({:io => io}))
-        ensure
-          io.close() if io
-        end
-
-        ##
-        # Creates a bash script containing the commands that are required
-        # to export or unset a bunch of environment variables taken from the
-        # bag.
-        #
-        # @param bag The bag to create the script for.
-        #
-        # @return (side-effect) Creates a script file containing commands
-        #                       to export or unset environment variables for
-        #                       bag.
-        #
-        # Options:
-        #  * :escape_value => If true, escape the value to export (or unset), default to true.
-        #  * :io => The io where the command should be written, default to nil which create the script on disk.
-        #  * :namer => The namer used to transform bag segments into variable name, default to Namer::default().
-        #  * :override => If true, variable a exported even when the override an existing env key, default to true.
-        #  * :script_path => The path where to write the script, defaults to `./nugrant2env.sh`.
-        #  * :type => The type of command, default to :export.
-        #
-        def self.script_exporter(bag, options = {})
-          io = options[:io] || (File.open(File.expand_path(options[:script_path] || @@DEFAULT_SCRIPT_PATH), "w"))
-
-          io.puts("#!/bin/env sh")
-          io.puts()
-
-          terminal_exporter(bag, options.merge({:io => io}))
-        ensure
-          io.close() if io
-        end
-
-        ##
-        # Export to terminal the commands that are required
-        # to export or unset a bunch of environment variables taken from the
-        # bag.
-        #
-        # @param bag The bag to create the script for.
-        #
-        # @return (side-effect) Outputs to io the commands generated.
-        #
-        # Options:
-        #  * :escape_value => If true, escape the value to export (or unset), default to true.
-        #  * :io => The io where the command should be displayed, default to $stdout.
-        #  * :namer => The namer used to transform bag segments into variable name, default to Namer::default().
-        #  * :override => If true, variable a exported even when the override an existing env key, default to true.
-        #  * :type => The type of command, default to :export.
-        #
-        def self.terminal_exporter(bag, options = {})
-          io = options[:io] || $stdout
-          type = options[:type] || :export
-
-          export(bag, options) do |key, value|
-            io.puts(command(type, key, value, options))
-          end
-        end
-
-        ##
-        # Generic function to export a bag. This walk the bag,
-        # for each element, it creates the key using the namer
-        # and then forward the key and value to the block if
-        # the variable does not override an existing environment
-        # variable or if options :override is set to true.
-        #
-        # @param bag The bag to export.
-        #
-        # @return (side-effect) Yields each key and value to a block
-        #
-        # Options:
-        #  * :namer => The namer used to transform bag segments into variable name, default to Namer::default().
-        #  * :override => If true, variable a exported even when the override an existing env key, default to true.
-        #
-        def self.export(bag, options = {})
-          namer = options[:namer] || Env::Namer.default()
-          override = options.fetch(:override, true)
-
-          variables = {}
-          walk_bag(bag) do |segments, key, value|
-            key = namer.call(segments)
-
-            variables[key] = value if override or not ENV[key]
-          end
-
-          variables.sort().each do |key, value|
-            yield key, value
-          end
-        end
-
-        ##
-        # Given a key and a value, return a string representation
-        # of the command type requested. Available types:
-        #
-        #  * :export => A bash compatible export command
-        #  * :unset => A bash compatible export command
-        #
-        def self.command(type, key, value, options = {})
-          # TODO: Replace by a map type => function name
-          case
-          when type == :export
-            export_command(key, value, options)
-          when type == :unset
-            unset_command(key, value, options)
-          end
-        end
-
-        ##
-        # Returns a string representation of the command
-        # that needs to be used on the current platform
-        # to export an environment variable.
-        #
-        # @param key The key of the environment variable to export.
-        #            It cannot be nil.
-        # @param value The value of the environment variable to export
-        #
-        # @return The export command, as a string
-        #
-        # Options:
-        #  * :escape_value (true) => If true, escape the value to export.
-        #
-        def self.export_command(key, value, options = {})
-          value = value.to_s()
-          value = Shellwords.escape(value) if options[:escape_value] == nil || options[:escape_value]
-
-          # TODO: Handle platform differently
-          "export #{key}=#{value}"
-        end
-
-        ##
-        # Returns a string representation of the command
-        # that needs to be used on the current platform
-        # to unset an environment variable.
-        #
-        # @param key The key of the environment variable to export.
-        #            It cannot be nil.
-        #
-        # @return The unset command, as a string
-        #
-        def self.unset_command(key, value, options = {})
-          # TODO: Handle platform differently
-          "unset #{key}"
-        end
-
-        # FIXME: Move this directly into bag class
-        def self.walk_bag(bag, parents = [], &block)
-          commands = []
-
-          bag.each do |key, value|
-            segments = parents + [key]
-            nested_bag = value.kind_of?(Nugrant::Bag)
-
-            walk_bag(value, segments, &block) if nested_bag
-            yield segments, key, value if not nested_bag
-          end
-        end
-      end
-    end
-  end
-end