nugrant 1.4.2 → 2.0.0.dev1

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

@@ -1,47 +0,0 @@
-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/helper/stack.rb

@@ -1,86 +0,0 @@
-module Nugrant
-  module Helper
-    class Stack
-      @@DEFAULT_MATCHER = /^(.+):([0-9]+)/
-
-      def self.fetch_error_region(stack, options = {})
-        entry = find_entry(stack, options)
-        location = extract_error_location(entry, options)
-
-        return (options[:unknown] || "Unknown") if not location[:file] and not location[:line]
-        return location[:file] if not location[:line]
-
-        fetch_error_region_from_location(location, options)
-      end
-
-      def self.fetch_error_region_from_location(location, options = {})
-        prefix = options[:prefix] || "   "
-        width = options[:width] || 4
-        file = File.new(location[:file], "r")
-        line = location[:line]
-
-        index = 0
-
-        lines = []
-        while (line_string = file.gets())
-          index += 1
-          next if (line - index).abs > width
-
-          line_prefix = "#{prefix}#{index}:"
-          line_prefix += (line == index ? ">>   " : "     ")
-
-          lines << "#{line_prefix}#{line_string}"
-        end
-
-        lines.join().chomp()
-      rescue
-        return (options[:unknown] || "Unknown") if not location[:file] and not location[:line]
-        return location[:file] if not location[:line]
-
-        "#{location[:file]}:#{location[:line]}"
-      ensure
-        file.close() if file
-      end
-
-      ##
-      # Search a stack list (as simple string array) for the first
-      # entry that match the +:matcher+.
-      #
-      def self.find_entry(stack, options = {})
-        matcher = options[:matcher] || @@DEFAULT_MATCHER
-
-        stack.find do |entry|
-          entry =~ matcher
-        end
-      end
-
-      ##
-      # Extract error location information from a stack entry using the
-      # matcher received in arguments.
-      #
-      # The usual stack entry format is:
-      #   > /home/users/joe/work/lib/ruby.rb:4:Error message
-      #
-      # This function will extract the file and line information from
-      # the stack entry using the matcher. The matcher is expected to
-      # have two groups, the first for the file and the second for
-      # line.
-      #
-      # The results is returned in form of a hash with two keys, +:file+
-      # for the file information and +:line+ for the line information.
-      #
-      # If the matcher matched zero group, return +{:file => nil, :line => nil}+.
-      # If the matcher matched one group, return +{:file => file, :line => nil}+.
-      # If the matcher matched two groups, return +{:file => file, :line => line}+.
-      #
-      def self.extract_error_location(entry, options = {})
-        matcher = options[:matcher] || @@DEFAULT_MATCHER
-
-        result = matcher.match(entry)
-        captures = result ? result.captures : []
-
-        {:file => captures[0], :line => captures[1] ? captures[1].to_i() : nil}
-      end
-    end
-  end
-end

data/lib/nugrant/vagrant/errors.rb

@@ -1,27 +0,0 @@
-require 'vagrant/errors'
-
-require 'nugrant/helper/stack'
-
-module Nugrant
-  module Vagrant
-    module Errors
-      class NugrantVagrantError < ::Vagrant::Errors::VagrantError
-        error_namespace("nugrant.vagrant.errors")
-      end
-
-      class ParameterNotFoundError < NugrantVagrantError
-        error_key(:parameter_not_found)
-
-        def initialize(options = nil, *args)
-          super({:context => compute_context()}.merge(options || {}), *args)
-        end
-
-        def compute_context()
-          Helper::Stack.fetch_error_region(caller(), {
-            :matcher => /(.+Vagrantfile):([0-9]+)/
-          })
-        end
-      end
-    end
-  end
-end

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

@@ -1,107 +0,0 @@
-require 'nugrant'
-require 'nugrant/helper/env/exporter'
-require 'nugrant/parameters'
-
-module Nugrant
-  module Vagrant
-    module V1
-      module Command
-        class Env < ::Vagrant::Command::Base
-          def initialize(arguments, environment)
-            super(arguments, environment)
-
-            @unset = false
-            @script = false
-            @format = :terminal
-            @show_help = false
-          end
-
-          def create_parser()
-            return OptionParser.new do |parser|
-              parser.banner = "Usage: vagrant user env [<options>]"
-              parser.separator ""
-
-              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. 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:"
-              parser.separator ""
-
-              parser.on("-u", "--[no-]unset", "Generates commands needed to unset environment variables, default false") do |unset|
-                @unset = unset
-              end
-
-              parser.on("-s", "--[no-]script", "Generates a bash script instead of simply showing command, default false") do |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
-                @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
-
-          def execute
-            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'")
-            with_target_vms(arguments) do |vm|
-              config = vm.config.user
-              parameters = config ? config.parameters : Nugrant::Parameters.new()
-              bag = parameters.__all
-
-              options = {:type => @unset ? :unset : :export}
-
-              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
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,107 +0,0 @@
-require 'nugrant'
-require 'nugrant/helper/env/exporter'
-require 'nugrant/parameters'
-
-module Nugrant
-  module Vagrant
-    module V2
-      module Command
-        class Env < ::Vagrant.plugin("2", :command)
-          def initialize(arguments, environment)
-            super(arguments, environment)
-
-            @unset = false
-            @script = false
-            @format = :terminal
-            @show_help = false
-          end
-
-          def create_parser()
-            return OptionParser.new do |parser|
-              parser.banner = "Usage: vagrant user env [<options>]"
-              parser.separator ""
-
-              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. 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:"
-              parser.separator ""
-
-              parser.on("-u", "--[no-]unset", "Generates commands needed to unset environment variables, default false") do |unset|
-                @unset = unset
-              end
-
-              parser.on("-s", "--[no-]script", "Generates a bash script instead of simply showing command, default false") do |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
-                @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
-
-          def execute
-            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'")
-            with_target_vms(arguments) do |vm|
-              config = vm.config.user
-              parameters = config ? config.parameters : Nugrant::Parameters.new()
-              bag = parameters.__all
-
-              options = {:type => @unset ? :unset : :export}
-
-              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
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/locales/en.yml

@@ -1,13 +0,0 @@
-en:
-  nugrant:
-    vagrant:
-      errors:
-        parameter_not_found: |-
-          Nugrant: Parameter '%{key}' was not found, is it defined in
-          your .vagrantuser file? Here where we think the error
-          could be in your Vagrantfile:
-
-          %{context}
-
-          If you think it should be found, don't hesitate to fill an
-          issue @ https://github.com/maoueh/nugrant/issues.

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

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