nugrant 1.3.0 → 1.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjUxMDRmNWQ5NTE4OWRjYWNiNzJlMzIxMTc1NWI2ZmI3MDBiZGUxOQ==
+    MmY5YWM2MTBjZTAwOTUzY2NhMjMxZTdiZTA5ODBmZTI4NmE4MzllOQ==
   data.tar.gz: !binary |-
-    NGY1MzI0ZTQ3NjVmNjBhMmViYzA0OWUwMDJjMDM1MDI2MWZlNGY1Mw==
+    YzE5NTViNDE0Y2E0YzQyNTM5NWIwYmZmMzU2YTUyMjVjMmIyZjc0Ng==
 SHA512:
   metadata.gz: !binary |-
-    YTE0NzgxZWM4YzcxODQ1MzA2ZmE1NTEyYTBkMjAyM2VhZjJiYmJlYzAxNzk2
-    NWVkYzQ0NWM4MGU1MDQ4ZWIzNDAxMGI3NWM2MDYzYWNkZTMzZmNhMTBlMzYy
-    OTAxYjQ5MmExNDBmOTk0YjJmNmNkNjliOTc3OGM4NTg5YjY0MWU=
+    NDU4ZWQxY2ZiZmZjOTNjNWEwYzAzNzBkNTAxMmI5ZDk2OGExMWNkMGQyYjJi
+    Y2IwNjA2YWQyZDcxMjYyMzQ5ZWY0NzJhZGI0OGI5Y2M3MGIzNmEwMDE0OGIx
+    MzZjMzUzNjYwZWMyMWFmM2U1NmRmODY3M2Y0ZTY2YzYxNzAwMzA=
   data.tar.gz: !binary |-
-    NDIyMTA5ZDM1OTg1NDMwNTc4MDY0MGEzMTI2MWM1YWZkZTE3ZjM0NDQyNWMx
-    NDUyZTNiMmE3ZmYxYmQ2OTk1YTI2Mzc2NThlZDhjZGY0ODJjMWZmMGViNTgx
-    ZGU0Y2E5Y2I5NzJlNmVmMWQxN2Q0MWIyMWQ0NWU3ODIxNDY0YzU=
+    ZTQxNDYzYWNiMWExYzM4N2RlOThmMjYzNjEzNGJhNDYxMDliOWU4MmFjNWYx
+    NjFlNDk1M2E3ZTE4ZWY1YzM5MWM0YzExMDlkZGYyMjAyYmRkZDc2OTdhYjA0
+    ZmVkOTVkYTBhZTc5NjFkNjk1NWNlMjQ4Y2QxN2E4N2EwY2UxMmU=

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.4.0 (November 28th, 2013)
+
+* Adding support to export to an [autoenv](https://github.com/kennethreitz/autoenv)
+  file. See [GH-13](https://github.com/maoueh/nugrant/issues/13).
+
+* Deprecated usage of `-s, --script` option for command
+  `vagrant user env`. This was replaced by the more generic
+  and extensible `-f, --format FORMAT` option. The
+  `-s, --script` option will be removed in 2.0.
+
 # 1.3.0 (November 19th, 2013)
 
 * Now using [minitest](https://github.com/seattlerb/minitest) as our

data/README.md

@@ -27,7 +27,7 @@ If you would like to use Nugrant as a library, simply reference
 it as a dependency of your application. Probably by adding it to
 your `Gemfile` or your `.gemspec` file.
 
-    "nugrant", "~> 1.3"
+    "nugrant", "~> 1.4"
 
 ### Vagrant
 
@@ -316,7 +316,7 @@ Sometimes, you would like to have acces to the different values
 stored in your `.vagrantuser` from environment variables. This
 command is meant is exactly for this.
 
-By using one of the two methods below, you will be able to export
+By using one of the three methods below, you will be able to export
 (but also unset) environment variables from your current
 parameters as seen by Nugrant.
 
@@ -359,11 +359,9 @@ by sourcing the script.
 Create a file named `nugrant2env` somewhere accessible from
 the `$PATH` variable with the following content:
 
-    ```bash
     #!/bin/env sh
 
     $(vagrant user env "$@")
-    ```
 
 This script will simply delegates to the `vagrant user env`
 command and pass all arguments it receives to it. The
@@ -391,17 +389,38 @@ to:
 Use the command to generate a base script in the current
 directory that you will then source:
 
-    vagrant user env -s
+    vagrant user env --format script
 
 This will generate a script called `nugrant2env.sh` into the
 current directory. You then simply source this script:
 
     . nugrant2env.sh
 
-Using vagrant user env -s -u will instead generate the bash
-script that will unset the enviornment variables. Don't forget
+Using `vagrant user env -u --format script` will instead generate the bash
+script that will unset the environment variables. Don't forget
 to source it to unset variables.
 
+##### Method #3
+
+Use the command to generate an [autoenv](https://github.com/kennethreitz/autoenv)
+file in the current directory. By using the [autoenv] project, anytime you
+will enter the project directory via the `cd` command, variables
+exported found in the `.env` file generated will be exported to
+your environment.
+
+    vagrant user env --format autoenv
+
+This will generate a file called `.env` in the
+current directory. You then simply change to the directory
+where the `.env` file was generated to made exported variables
+available in your environment.
+
+    cd ..
+    cd <project_dir>
+
+Using `vagrant user env -u --format autoenv` will instead generate
+the autoenv file that will unset the environment variables.
+
 ## Contributing
 
 You can contribute by filling issues when something goes

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

@@ -0,0 +1,208 @@
+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

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

@@ -0,0 +1,47 @@
+module Nugrant
+  module Helper
+    module Env
+      ##
+      # A namer is a lambda taking as argument an array of segments
+      # that should return a string representation of those segments.
+      # How the segments are transformed to a string is up to the
+      # namer. By using various namer, we can change how a bag key
+      # is transformed into and environment variable name. This is
+      # like the strategy pattern.
+      #
+      module Namer
+
+        ##
+        # Returns the default namer, which join segments together
+        # using a character and upcase the result.
+        #
+        # @param `char` The character used to join segments together, default to `"_"`.
+        #
+        # @return A lambda that will simply joins segment using the `char` argument
+        #         and upcase the result.
+        #
+        def self.default(char = "_")
+          lambda do |segments|
+            segments.join(char).upcase()
+          end
+        end
+
+        ##
+        # Returns the prefix namer, which add a prefix to segments
+        # and delegate its work to another namer.
+        #
+        # @param prefix The prefix to add to segments.
+        # @param delegate_namer A namer that will be used to transform the prefixed segments.
+        #
+        # @return A lambda that will simply add prefix to segments and will call
+        #         the delegate_namer with those new segments.
+        #
+        def self.prefix(prefix, delegate_namer)
+          lambda do |segments|
+            delegate_namer.call([prefix] + segments)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 require 'nugrant'
-require 'nugrant/helper/env'
+require 'nugrant/helper/env/exporter'
+require 'nugrant/parameters'
 
 module Nugrant
   module Vagrant
@@ -11,6 +12,7 @@ module Nugrant
 
             @unset = false
             @script = false
+            @format = :terminal
             @show_help = false
           end
 
@@ -21,7 +23,19 @@ module Nugrant
 
               parser.separator "Outputs the commands that should be executed to export\n" +
                                "the various parameter as environment variables. By default,\n" +
-                               "existing ones are overridden."
+                               "existing ones are overridden. The --format argument can be used\n" +
+                               "to choose in which format the variables should be displayed.\n" +
+                               "Changing the format will also change where they are displayed.\n"
+              parser.separator ""
+              parser.separator "The `-s, --script` option is deprecated and will be removed in\n" +
+                               "version 2.0. Use `--format script` instead."
+              parser.separator ""
+
+              parser.separator "Available formats:"
+              parser.separator "  autoenv  => Write commands to a file named `.env` in the current directory.\n" +
+                               "               See https://github.com/kennethreitz/autoenv for more info."
+              parser.separator "  terminal => Display commands to terminal so they can be sourced."
+              parser.separator "  script   => Write commands to a bash script named `nugrant2env.sh` so it can be sourced."
               parser.separator ""
 
               parser.separator "Available options:"
@@ -32,7 +46,11 @@ module Nugrant
               end
 
               parser.on("-s", "--[no-]script", "Generates a bash script instead of simply showing command, default false") do |script|
-                 @script = script
+                @script = script
+              end
+
+              parser.on("-f", "--format FORMAT", "Determines in what format variables are outputted, default to terminal") do |format|
+                @format = format.to_sym()
               end
 
               parser.on("-h", "--help", "Print this help") do
@@ -41,6 +59,15 @@ module Nugrant
             end
           end
 
+          def error(message, parser)
+            @env.ui.info("ERROR: #{message}", :prefix => false)
+            @env.ui.info("", :prefix => false)
+
+            help(parser)
+
+            return 1
+          end
+
           def help(parser)
             @env.ui.info(parser.help, :prefix => false)
           end
@@ -49,6 +76,7 @@ module Nugrant
             parser = create_parser()
             arguments = parse_options(parser)
 
+            return error("Invalid format value '#{@format}'", parser) if not Helper::Env::Exporter.valid?(@format)
             return help(parser) if @show_help
 
             @logger.debug("Nugrant 'Env'")
@@ -59,8 +87,14 @@ module Nugrant
 
               options = {:type => @unset ? :unset : :export}
 
-              Helper::Env.write_commands(bag, options) if not @script
-              Helper::Env.write_script(bag, options) if @script
+              case
+              when @script || @format == :script
+                Helper::Env::Exporter.script_exporter(bag, options)
+              when @format == :autoenv
+                Helper::Env::Exporter.autoenv_exporter(bag, options)
+              else
+                Helper::Env::Exporter.terminal_exporter(bag, options)
+              end
 
               # No need to execute for the other VMs
               return 0

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

@@ -1,5 +1,6 @@
 require 'nugrant'
-require 'nugrant/helper/env'
+require 'nugrant/helper/env/exporter'
+require 'nugrant/parameters'
 
 module Nugrant
   module Vagrant
@@ -11,6 +12,7 @@ module Nugrant
 
             @unset = false
             @script = false
+            @format = :terminal
             @show_help = false
           end
 
@@ -21,7 +23,19 @@ module Nugrant
 
               parser.separator "Outputs the commands that should be executed to export\n" +
                                "the various parameter as environment variables. By default,\n" +
-                               "existing ones are overridden."
+                               "existing ones are overridden. The --format argument can be used\n" +
+                               "to choose in which format the variables should be displayed.\n" +
+                               "Changing the format will also change where they are displayed.\n"
+              parser.separator ""
+              parser.separator "The `-s, --script` option is deprecated and will be removed in\n" +
+                               "version 2.0. Use `--format script` instead."
+              parser.separator ""
+
+              parser.separator "Available formats:"
+              parser.separator "  autoenv  => Write commands to a file named `.env` in the current directory.\n" +
+                               "               See https://github.com/kennethreitz/autoenv for more info."
+              parser.separator "  terminal => Display commands to terminal so they can be sourced."
+              parser.separator "  script   => Write commands to a bash script named `nugrant2env.sh` so it can be sourced."
               parser.separator ""
 
               parser.separator "Available options:"
@@ -35,12 +49,25 @@ module Nugrant
                  @script = script
               end
 
+              parser.on("-f", "--format FORMAT", "Determines in what format variables are outputted, default to terminal") do |format|
+                 @format = format.to_sym()
+              end
+
               parser.on("-h", "--help", "Print this help") do
                 @show_help = true
               end
             end
           end
 
+          def error(message, parser)
+            @env.ui.info("ERROR: #{message}", :prefix => false)
+            @env.ui.info("", :prefix => false)
+
+            help(parser)
+
+            return 1
+          end
+
           def help(parser)
             @env.ui.info(parser.help, :prefix => false)
           end
@@ -49,6 +76,7 @@ module Nugrant
             parser = create_parser()
             arguments = parse_options(parser)
 
+            return error("Invalid format value '#{@format}'", parser) if not Helper::Env::Exporter.valid?(@format)
             return help(parser) if @show_help
 
             @logger.debug("Nugrant 'Env'")
@@ -59,8 +87,14 @@ module Nugrant
 
               options = {:type => @unset ? :unset : :export}
 
-              Helper::Env.write_commands(bag, options) if not @script
-              Helper::Env.write_script(bag, options) if @script
+              case
+              when @script || @format == :script
+                Helper::Env::Exporter.script_exporter(bag, options)
+              when @format == :autoenv
+                Helper::Env::Exporter.autoenv_exporter(bag, options)
+              else
+                Helper::Env::Exporter.terminal_exporter(bag, options)
+              end
 
               # No need to execute for the other VMs
               return 0

data/lib/nugrant/version.rb

@@ -1,3 +1,3 @@
 module Nugrant
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/test/lib/nugrant/helper/env/test_exporter.rb

@@ -0,0 +1,238 @@
+require 'minitest/autorun'
+
+require 'nugrant/bag'
+require 'nugrant/helper/env/exporter'
+
+module Nugrant
+  module Helper
+    module Env
+      class TestExporter < ::Minitest::Test
+        def create_bag(parameters)
+          return Nugrant::Bag.new(parameters)
+        end
+
+        def assert_export(expected, key, value, options = {})
+          actual = Env::Exporter.command(:export, key, value, options)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_unset(expected, key, options = {})
+          actual = Env::Exporter.command(:unset, key, options)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_autoenv_exporter(expected, bag, options = {})
+          io = StringIO.new()
+          Env::Exporter.autoenv_exporter(bag, options.merge({:io => io}))
+
+          actual = io.string().split(/\r?\n/)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_script_exporter(expected, bag, options = {})
+          io = StringIO.new()
+          Env::Exporter.script_exporter(bag, options.merge({:io => io}))
+
+          actual = io.string().split(/\r?\n/)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_terminal_exporter(expected, bag, options = {})
+          io = StringIO.new()
+          Env::Exporter.terminal_exporter(bag, options.merge({:io => io}))
+
+          actual = io.string().split(/\r?\n/)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_unset_commands(expected, bag, options = {})
+          actual = Env::Exporter.unset_commands(bag, options)
+
+          assert_equal(expected, actual)
+        end
+
+        def test_valid_exporter
+          assert_equal(true, Env::Exporter.valid?(:autoenv))
+          assert_equal(true, Env::Exporter.valid?(:script))
+          assert_equal(true, Env::Exporter.valid?(:terminal))
+          assert_equal(false, Env::Exporter.valid?(:foreman))
+        end
+
+        def test_export_command
+          assert_export("export TEST=\\\"running\\ with\\ space\\\"", "TEST", "\"running with space\"")
+          assert_export("export TEST=running with space", "TEST", "running with space", :escape_value => false)
+        end
+
+        def test_unset_command
+          assert_unset("unset TEST", "TEST")
+        end
+
+        def test_terminal_exporter_export
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first with space",
+                :second => "\"second\\"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          stub_env(:existing => "exist", :EXISTING => "exist") do
+            assert_terminal_exporter([
+              "export EXISTING=downcase",
+              "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
+              "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
+              "export LEVEL1_THIRD=third",
+            ], bag)
+
+            assert_terminal_exporter([
+              "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
+              "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
+              "export LEVEL1_THIRD=third",
+            ], bag, :override => false)
+
+            assert_terminal_exporter([
+              "export EXISTING=downcase",
+              "export LEVEL1_LEVEL2_FIRST=first with space",
+              "export LEVEL1_LEVEL2_SECOND=\"second\\",
+              "export LEVEL1_THIRD=third",
+            ], bag, :type => :export, :override => true, :escape_value => false)
+
+            default_namer = Env::Namer.default(".")
+            prefix_namer = Env::Namer.prefix("CONFIG", default_namer)
+
+            assert_terminal_exporter([
+              "export CONFIG.EXISTING=downcase",
+              "export CONFIG.LEVEL1.LEVEL2.FIRST=first with space",
+              "export CONFIG.LEVEL1.LEVEL2.SECOND=\"second\\",
+              "export CONFIG.LEVEL1.THIRD=third",
+            ], bag, :override => true, :escape_value => false, :namer => prefix_namer)
+          end
+        end
+
+        def test_terminal_exporter_unset
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first",
+                :second => "second"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          stub_env(:existing => "exist", :EXISTING => "exist") do
+            assert_terminal_exporter([
+              "unset EXISTING",
+              "unset LEVEL1_LEVEL2_FIRST",
+              "unset LEVEL1_LEVEL2_SECOND",
+              "unset LEVEL1_THIRD",
+            ], bag, :type => :unset)
+
+            assert_terminal_exporter([
+              "unset LEVEL1_LEVEL2_FIRST",
+              "unset LEVEL1_LEVEL2_SECOND",
+              "unset LEVEL1_THIRD",
+            ], bag, :override => false, :type => :unset)
+
+            default_namer = Env::Namer.default(".")
+            prefix_namer = Env::Namer.prefix("CONFIG", default_namer)
+
+            assert_terminal_exporter([
+              "unset CONFIG.EXISTING",
+              "unset CONFIG.LEVEL1.LEVEL2.FIRST",
+              "unset CONFIG.LEVEL1.LEVEL2.SECOND",
+              "unset CONFIG.LEVEL1.THIRD",
+            ], bag, :override => true, :namer => prefix_namer, :type => :unset)
+          end
+        end
+
+        def test_autoenv_exporter
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first",
+                :second => "second"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          assert_autoenv_exporter([
+            "export EXISTING=downcase",
+            "export LEVEL1_LEVEL2_FIRST=first",
+            "export LEVEL1_LEVEL2_SECOND=second",
+            "export LEVEL1_THIRD=third",
+          ], bag, :type => :export)
+
+          assert_autoenv_exporter([
+            "unset EXISTING",
+            "unset LEVEL1_LEVEL2_FIRST",
+            "unset LEVEL1_LEVEL2_SECOND",
+            "unset LEVEL1_THIRD",
+          ], bag, :type => :unset)
+        end
+
+        def test_script_exporter
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first",
+                :second => "second"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          assert_script_exporter([
+            "#!/bin/env sh",
+            "",
+            "export EXISTING=downcase",
+            "export LEVEL1_LEVEL2_FIRST=first",
+            "export LEVEL1_LEVEL2_SECOND=second",
+            "export LEVEL1_THIRD=third",
+          ], bag, :type => :export)
+
+          assert_script_exporter([
+            "#!/bin/env sh",
+            "",
+            "unset EXISTING",
+            "unset LEVEL1_LEVEL2_FIRST",
+            "unset LEVEL1_LEVEL2_SECOND",
+            "unset LEVEL1_THIRD",
+          ], bag, :type => :unset)
+        end
+
+        def replace_env(variables)
+          ENV.clear()
+
+          variables = Hash[variables.map do |name, value|
+            [name.to_s, value]
+          end]
+
+          ENV.update(variables)
+        end
+
+        def stub_env(new = {})
+          old = ENV.to_hash()
+
+          replace_env(new)
+          yield
+
+        ensure
+          replace_env(old)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nugrant
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Matthieu Vachon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -80,7 +80,8 @@ files:
 - lib/nugrant/bag.rb
 - lib/nugrant/config.rb
 - lib/nugrant/helper/bag.rb
-- lib/nugrant/helper/env.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
@@ -99,7 +100,7 @@ files:
 - lib/vagrant_init.rb
 - locales/en.yml
 - nugrant.gemspec
-- test/lib/nugrant/helper/test_env.rb
+- 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
@@ -179,7 +180,7 @@ signing_key:
 specification_version: 4
 summary: Library to handle user specific parameters from various location.
 test_files:
-- test/lib/nugrant/helper/test_env.rb
+- 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

data/lib/nugrant/helper/env.rb

@@ -1,232 +0,0 @@
-require 'shellwords'
-
-module Nugrant
-  module Helper
-    class Env
-
-      @@DEFAULT_SCRIPT_PATH = "./nugrant2env.sh"
-
-      ##
-      # Notes on `namer`
-      #
-      # A namer is a lambda taking as argument an array of segments
-      # that should return a string representation of those segments.
-      # How the segments are transformed to a string is up to the
-      # namer. By using various namer, we can change how a bag key
-      # is transformed into and environment variable name. This is
-      # like the strategy pattern.
-      #
-
-      ##
-      # Returns the default namer, which join segments together
-      # using a character and upcase the result.
-      #
-      # @param `char` The character used to join segments together, default to `"_"`.
-      #
-      # @return A lambda that will simply joins segment using the `char` argument
-      #         and upcase the result.
-      #
-      def self.default_namer(char = "_")
-        lambda do |segments|
-          segments.join(char).upcase()
-        end
-      end
-
-      ##
-      # Returns the prefix namer, which add a prefix to segments
-      # and delegate its work to another namer.
-      #
-      # @param prefix The prefix to add to segments.
-      # @param delegate_namer A namer that will be used to transform the prefixed segments.
-      #
-      # @return A lambda that will simply add prefix to segments and will call
-      #         the delegate_namer with those new segments.
-      #
-      def self.prefix_namer(prefix, delegate_namer)
-        lambda do |segments|
-          delegate_namer.call([prefix] + segments)
-        end
-      end
-
-      def self.commands(type, bag, options = {})
-        # TODO: Replace by a map type => function name
-        case
-        when type == :export
-          export_commands(bag, options)
-        when type == :unset
-          unset_commands(bag, options)
-        end
-      end
-
-      ##
-      # Generate the list of export commands that must be
-      # executed so each bag variables is export to an
-      # environment variables
-      #
-      # @param bag The bag to export to environment variables
-      #
-      # @return A list of commands that can be used to
-      #         export the bag to environment variables.
-      #
-      # Options:
-      #  * :escape_value (true) => If true, escape the value to export.
-      #
-      #  * :namer (nil) => A block taking as options the full path of
-      #                    an export variable key and return what
-      #                    the name the should be exported.
-      #
-      # * :override (true) => If true, an export command will be put
-      #                       in the list even if it already exist in
-      #                       the ENV array.
-      #
-      def self.export_commands(bag, options = {})
-        namer = options[:namer] || default_namer()
-        override = options.fetch(:override, true)
-
-        commands = []
-        walk_bag(bag) do |segments, key, value|
-          key = namer.call(segments)
-
-          commands << export_command(key, value, options) if override or not ENV[key]
-        end
-
-        commands
-      end
-
-      ##
-      # Generate the list of unset commands that must be
-      # executed so each bag variables is unset from the
-      # environment variables
-      #
-      # @param bag The bag to unset environment variables
-      #
-      # @return A list of commands that can be used to
-      #         unset the bag from environment variables.
-      #
-      # Options:
-      #  * :namer (nil) => A block taking as options the full path of
-      #                    an export variable key and return what
-      #                    the name the should be exported.
-      #
-      # * :override (true) => If true, an export command will be put
-      #                       in the list even if it already exist in
-      #                       the ENV array.
-      #
-      def self.unset_commands(bag, options = {})
-        namer = options[:namer] || default_namer()
-        override = options.fetch(:override, true)
-
-        commands = []
-        walk_bag(bag) do |segments, key, value|
-          key = namer.call(segments)
-
-          commands << unset_command(key, value, options) if override or not ENV[key]
-        end
-
-        commands
-      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
-
-      ##
-      # 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:
-      #  * :type => The type of command, default to :export
-      #  * :script_path => The path where to write the script, defaults to `./nugrant2env.sh`.
-      #  * See commands, export_commands and unset_commands for further options.
-      #
-      def self.write_script(bag, options = {})
-        file = File.open(File.expand_path(options[:script_path] || @@DEFAULT_SCRIPT_PATH), "w")
-
-        file.puts("#!/bin/env sh")
-        file.puts()
-
-        write_commands(bag, options, file)
-      ensure
-        file.close() if file
-      end
-
-      ##
-      # Creates a bash script containing the commands that are required
-      # to export or unset a bunch of environment variables taken from the
-      # bag.
-      #
-      # The
-      #
-      # @param bag The bag to create the script for.
-      # @param io The io where to output the commands, defaults to $stdout.
-      #
-      # @return (side-effect) Outputs to io the commands generated.
-      #
-      # Options:
-      #  * :type => The type of command, default to :export
-      #  * See commands, export_commands and unset_commands for further options.
-      #
-      def self.write_commands(bag, options = {}, io = $stdout)
-        commands = commands(options[:type] || :export, bag, options)
-
-        commands.each do |command|
-          io.puts(command)
-        end
-      end
-
-      private
-
-      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

data/test/lib/nugrant/helper/test_env.rb

@@ -1,150 +0,0 @@
-require 'minitest/autorun'
-
-require 'nugrant/bag'
-require 'nugrant/helper/env'
-
-module Nugrant
-  module Helper
-    class TestEnv < ::Minitest::Test
-      def create_bag(parameters)
-        return Nugrant::Bag.new(parameters)
-      end
-
-      def assert_export(expected, key, value, options = {})
-        actual = Helper::Env.export_command(key, value, options)
-
-        assert_equal(expected, actual)
-      end
-
-      def assert_unset(expected, key, options = {})
-        actual = Helper::Env.unset_command(key, options)
-
-        assert_equal(expected, actual)
-      end
-
-      def assert_export_commands(expected, bag, options = {})
-        actual = Helper::Env.export_commands(bag, options)
-
-        assert_equal(expected.sort!(), actual.sort!())
-      end
-
-      def assert_unset_commands(expected, bag, options = {})
-        actual = Helper::Env.unset_commands(bag, options)
-
-        assert_equal(expected, actual)
-      end
-
-      def test_export_command
-        assert_export("export TEST=\\\"running\\ with\\ space\\\"", "TEST", "\"running with space\"")
-        assert_export("export TEST=running with space", "TEST", "running with space", :escape_value => false)
-      end
-
-      def test_export_commands
-        bag = create_bag({
-          :existing => "downcase",
-          :level1 => {
-            :level2 => {
-              :first => "first with space",
-              :second => "\"second\\"
-            },
-            :third => "third"
-          }
-        })
-
-        stub_env(:existing => "exist", :EXISTING => "exist") do
-          assert_export_commands([
-            "export EXISTING=downcase",
-            "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
-            "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
-            "export LEVEL1_THIRD=third",
-          ], bag)
-
-          assert_export_commands([
-            "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
-            "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
-            "export LEVEL1_THIRD=third",
-          ], bag, :override => false)
-
-          assert_export_commands([
-            "export EXISTING=downcase",
-            "export LEVEL1_LEVEL2_FIRST=first with space",
-            "export LEVEL1_LEVEL2_SECOND=\"second\\",
-            "export LEVEL1_THIRD=third",
-          ], bag, :override => true, :escape_value => false)
-
-          default_namer = Helper::Env.default_namer(".")
-          prefix_namer = Helper::Env.prefix_namer("CONFIG", default_namer)
-
-          assert_export_commands([
-            "export CONFIG.EXISTING=downcase",
-            "export CONFIG.LEVEL1.LEVEL2.FIRST=first with space",
-            "export CONFIG.LEVEL1.LEVEL2.SECOND=\"second\\",
-            "export CONFIG.LEVEL1.THIRD=third",
-          ], bag, :override => true, :escape_value => false, :namer => prefix_namer)
-        end
-      end
-
-      def test_unset_command
-        assert_unset("unset TEST", "TEST")
-      end
-
-      def test_unset_commands
-        bag = create_bag({
-          :existing => "downcase",
-          :level1 => {
-            :level2 => {
-              :first => "first",
-              :second => "second"
-            },
-            :third => "third"
-          }
-        })
-
-        stub_env(:existing => "exist", :EXISTING => "exist") do
-          assert_unset_commands([
-            "unset EXISTING",
-            "unset LEVEL1_LEVEL2_FIRST",
-            "unset LEVEL1_LEVEL2_SECOND",
-            "unset LEVEL1_THIRD",
-          ], bag)
-
-          assert_unset_commands([
-            "unset LEVEL1_LEVEL2_FIRST",
-            "unset LEVEL1_LEVEL2_SECOND",
-            "unset LEVEL1_THIRD",
-          ], bag, :override => false)
-
-          default_namer = Helper::Env.default_namer(".")
-          prefix_namer = Helper::Env.prefix_namer("CONFIG", default_namer)
-
-          assert_unset_commands([
-            "unset CONFIG.EXISTING",
-            "unset CONFIG.LEVEL1.LEVEL2.FIRST",
-            "unset CONFIG.LEVEL1.LEVEL2.SECOND",
-            "unset CONFIG.LEVEL1.THIRD",
-          ], bag, :override => true, :namer => prefix_namer)
-        end
-      end
-
-      def replace_env(variables)
-        ENV.clear()
-
-        variables = Hash[variables.map do |name, value|
-          [name.to_s, value]
-        end]
-
-        ENV.update(variables)
-      end
-
-      def stub_env(new = {})
-        old = ENV.to_hash()
-
-        replace_env(new)
-        yield
-
-      ensure
-        replace_env(old)
-      end
-    end
-  end
-end