nugrant 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 594ada270cb4d38006f96f005f07a7bf52070c7c
-  data.tar.gz: df8bbf721f95ab7bc5e07d290bbe318e9ddea76b
+  metadata.gz: 16c6ab3c8e5e927d721709d9ef50c994386f71be
+  data.tar.gz: 5b07b32caedb79df6a879906c302a1512baaccaa
 SHA512:
-  metadata.gz: 887c68d6713d574f9c8f4f434c66dc0be2557883d785d6113968154e941781079c83dbf5779df13e6156ae2d74d1700ba73e54a354a441de2101757495935a1a
-  data.tar.gz: 2b86a84fe78a5ccc32da82f995124f03de6d2ea8b4c95434de685f05053671ab3b304eb9f5512761cdfc78f88a7fc018901b68ffda7d602f5c5f5766e10a366c
+  metadata.gz: 008a2bf813159fd4676e722658aa817589284092d437269501b7316aea71c927cecb5268935b9614b3c6ef152324c2a9e880216670fbe4afc95e77d762abe5c0
+  data.tar.gz: 159c9c629ae3e3db4c6ecbf79754a4108a1fb5e5df51109d33908e1f893c1413d7dbfd40530623cd70c14089fe4cc412f2b1cc427bd04325ada59fe56b984bf8

data/.gitignore

@@ -17,6 +17,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea
 
 test/resources/vagrantfiles/Vagrantfile
 test/resources/vagrantfiles/.vagrantuser

data/.travis.yml

@@ -4,3 +4,6 @@ rvm:
   - "1.9.3"
   - "2.0.0"
   - "2.1.0"
+
+before_install:
+  - gem install bundler -v '= 1.6.7'

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# 2.1.0 (November 1st, 2014)
+
+ * Added possibility to specify the script path where to generate
+   the environment commands (export/unset) when using the
+   `vagrant user env` command.
+
+* Added possibility to automatically export variables on vagrant provision.
+  This can be used by specifying `config.user.auto_export = <format>` in
+  your Vagrantfile where <format> can be one of:
+
+   * `false` => No auto export (default value).
+   * `:autoenv` => Export to [autoenv](https://github.com/kennethreitz/autoenv) script format.
+   * `:script` => Export to a bash script file.
+   * `[:autoenv, :script]` => export both format.
+
+  The default generated script path is "./nugrant2env.sh". You can change
+  the default script name by specifying the configuration key `config.user.auto_export_script_path`
+  in your Vagrantfile:
+
+      config.user.auto_export_script_path = "./script/example.sh"
+
+  Contributed by [@ruifil](https://github.com/ruifil).
+
 # 2.0.2 (July 13th, 2014)
 
  * Fixed a bug when using some vagrant commands. The code to retrieve

data/CONTRIBUTORS.md

@@ -0,0 +1,5 @@
+# Contributors
+
+Thanks for this people who contributed some code to Nugrant:
+
+  * Rui Filipe Da Cunha Alves ([@ruifil](https://github.com/ruifil))

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Matthieu Vachon
+Copyright (c) 2012-2014 Matthieu Vachon
 
 MIT License
 

data/README.md

@@ -438,8 +438,8 @@ Usage:
 ##### Env
 
 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.
+stored in your `.vagrantuser` from environment variables: this is
+exactly what this section is meant to show you.
 
 By using one of the three methods below, you will be able to export
 (but also unset) environment variables from your current
@@ -458,10 +458,6 @@ export command:
 
     export DB_USER=root
 
-And the unset command:
-
-    unset DB_USER
-
 The value are escaped so it is possible to define value containing
 spaces for example.
 
@@ -473,9 +469,13 @@ would be overwritten by an export command.
 Add flag `-h` (or `--help`) for description of the command and a
 list of available options.
 
+It's possible to export variables automatically on when Vagrant
+provision your VM. Refer to [Automatic Exporting section](#automatic-exporting)
+for more information.
+
 ###### Method #1
 
-If you plan to use frequently this feature, our best suggestion
+If you plan to frequently use this feature, our best suggestion
 is to create a little bash script that will simply delegates
 to the real command. By having a bash script that calls the
 command, you will be able to easily export environment variables
@@ -546,6 +546,39 @@ available in your environment.
 Using `vagrant user env -u --format autoenv` will instead generate
 the autoenv file that will unset the environment variables.
 
+#### Automatic Exporting
+
+Running the right command each time variables change can be repetive
+for nothing. Why not let the computer do the hard work for us, they
+have been created for this after all.
+
+You can achieve this using the `config.user.auto_export` parameter.
+Defaulting to `false`, you can use it to export the variables
+to your desired format. When set to a valid value, each time
+vagrant will provision your VM, Nugrant will automatically
+export variables for your.
+
+Use the following configuration to export to [autoenv](https://github.com/kennethreitz/autoenv)
+script format.
+
+    config.user.auto_export = :autoenv
+
+Use the following configuration to export to bash script.
+
+    config.user.auto_export = :script
+
+You can also pass an array of formats if you would like to export to
+multiple formats at the same time.
+
+    config.user.auto_export = [:autoenv, :script]
+
+
+The default filename for bash script (i.e. when using `:script` value) is
+`./nugrant2env.sh`. You can control this by using parameter
+`config.user.auto_export_script_path`:
+
+    config.user.auto_export_script_path = "./script/env.sh"
+
 ### Library
 
 Using Nugrant as a library to handle parameters from various

data/lib/nugrant/config.rb

@@ -5,16 +5,17 @@ module Nugrant
     DEFAULT_ARRAY_MERGE_STRATEGY = :replace
     DEFAULT_PARAMS_FILENAME = ".nuparams"
     DEFAULT_PARAMS_FORMAT = :yaml
+    DEFAULT_AUTO_EXPORT = false
 
     SUPPORTED_ARRAY_MERGE_STRATEGIES = [:concat, :extend, :replace]
     SUPPORTED_PARAMS_FORMATS = [:json, :yaml]
 
     attr_reader :params_filename, :params_format,
                 :current_path, :user_path, :system_path,
-                :array_merge_strategy,
+                :array_merge_strategy, :auto_export, :auto_export_script_path,
                 :key_error, :parse_error
 
-    attr_writer :array_merge_strategy
+    attr_writer :array_merge_strategy, :auto_export, :auto_export_script_path
 
     ##
     # Convenience method to easily accept either a hash that will
@@ -127,10 +128,14 @@ module Nugrant
     #                       the error object, that deal with the error. If the callable does not
     #                       raise an exception, the result of it's execution is returned.
     #                         Defaults => A callable that returns the empty hash.
+    #  * +:auto_export+               - Automatically export configuration to the specified format :autoenv or :script
+    #  * +:auto_export_script_path+   - The path where to write the export script, defaults to "./nugrant2env.sh"
     #
     def initialize(options = {})
       @params_filename = options[:params_filename] || DEFAULT_PARAMS_FILENAME
       @params_format = options[:params_format] || DEFAULT_PARAMS_FORMAT
+      @auto_export = options[:auto_export] || DEFAULT_AUTO_EXPORT
+      @auto_export_script_path = options[:auto_export_script_path] || false # use default
 
       @current_path = Config.fixup_path(options[:current_path], ".", @params_filename)
       @user_path = Config.fixup_path(options[:user_path], Config.default_user_path(), @params_filename)

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

@@ -7,10 +7,10 @@ module Nugrant
   module Helper
     module Env
       module Exporter
-        @@DEFAULT_AUTOENV_PATH = "./.env"
-        @@DEFAULT_SCRIPT_PATH = "./nugrant2env.sh"
+        DEFAULT_AUTOENV_PATH = "./.env"
+        DEFAULT_SCRIPT_PATH = "./nugrant2env.sh"
 
-        @@VALID_EXPORTERS = [:autoenv, :script, :terminal]
+        VALID_EXPORTERS = [:autoenv, :script, :terminal]
 
         ##
         # Returns true if the exporter name received is a valid
@@ -20,7 +20,7 @@ module Nugrant
         #
         # @return true if exporter is valid, false otherwise.
         def self.valid?(exporter)
-          @@VALID_EXPORTERS.include?(exporter)
+          VALID_EXPORTERS.include?(exporter)
         end
 
         ##
@@ -43,7 +43,7 @@ module Nugrant
         #  * :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"))
+          io = options[:io] || (File.open(File.expand_path(options[:autoenv_path] || DEFAULT_AUTOENV_PATH), "w"))
 
           terminal_exporter(bag, options.merge({:io => io}))
         ensure
@@ -70,7 +70,7 @@ module Nugrant
         #  * :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 = options[:io] || (File.open(File.expand_path(options[:script_path] || DEFAULT_SCRIPT_PATH), "w"))
 
           io.puts("#!/bin/env sh")
           io.puts()

data/lib/nugrant/mixin/parameters.rb

@@ -48,6 +48,14 @@ module Nugrant
         @__config.array_merge_strategy
       end
 
+      def auto_export
+        @__config.auto_export
+      end
+
+      def auto_export_script_path
+        @__config.auto_export_script_path
+      end
+
       ##
       # Change the current array merge strategy for this parameters.
       #
@@ -61,6 +69,14 @@ module Nugrant
         compute_all!()
       end
 
+      def auto_export=(auto_export)
+        @__config.auto_export = auto_export
+      end
+
+      def auto_export_script_path=(path)
+        @__config.auto_export_script_path = path
+      end
+
       def defaults()
         @__defaults
       end

data/lib/nugrant/vagrant/v2/action.rb

@@ -0,0 +1,17 @@
+require 'nugrant/vagrant/v2/action/auto_export'
+
+module Nugrant
+  module Vagrant
+    module V2
+      module Action
+        class << self
+          def auto_export
+            @auto_export ||= ::Vagrant::Action::Builder.new.tap do |builder|
+              builder.use Nugrant::Vagrant::V2::Action::AutoExport
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nugrant/vagrant/v2/action/auto_export.rb

@@ -0,0 +1,45 @@
+require 'nugrant'
+require 'nugrant/helper/env/exporter'
+require 'nugrant/parameters'
+
+EnvExporter = Nugrant::Helper::Env::Exporter
+
+module Nugrant
+  module Vagrant
+    module V2
+      module Action
+        class AutoExport
+          def initialize(app, env)
+            @app = app
+            @config = env[:machine].env.vagrantfile.config
+          end
+
+          def call(env)
+            return @app.call(env) if not @config.user.auto_export
+
+            options = {
+              :type => :export,
+              :script_path => @config.user.auto_export_script_path
+            }
+
+            Array(@config.user.auto_export).each do |exporter|
+              if exporter == :terminal or not EnvExporter.valid?(exporter)
+                env[:ui].warn("ERROR: Invalid config.user.auto_export value '#{format}'", :prefix => false)
+                next
+              end
+
+              env[:ui].info("Configuration exported '#{format}'", :prefix => false)
+
+              case
+              when format == :script
+                EnvExporter.script_exporter(@config.user.__all, options)
+              when format == :autoenv
+                EnvExporter.autoenv_exporter(@config.user.__all, options)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ module Nugrant
 
             @unset = false
             @format = :terminal
+            @script_path = false
             @show_help = false
           end
 
@@ -43,15 +44,19 @@ module Nugrant
               parser.separator "Available options:"
               parser.separator ""
 
-              parser.on("-u", "--[no-]unset", "Generates commands needed to unset environment variables, default false") do |unset|
-                @unset = unset
+              parser.on("-u", "--unset", "Generates commands needed to unset environment variables, default false") do
+                @unset = true
               end
 
               parser.on("-f", "--format FORMAT", "Determines in what format variables are output, default to terminal") do |format|
                  @format = format.to_sym()
               end
 
-              parser.on("-h", "--help", "Print this help") do
+              parser.on("-s", "--script-path PATH", "Specifies path of the generated bash script, default to #{EnvExporter::DEFAULT_SCRIPT_PATH}") do |path|
+                 @script_path = path
+              end
+
+              parser.on("-h", "--help", "Prints this help") do
                 @show_help = true
               end
             end
@@ -87,7 +92,10 @@ module Nugrant
 
               bag = parameters.__all
 
-              options = {:type => @unset ? :unset : :export}
+              options = {
+                :type => @unset ? :unset : :export,
+                :script_path => @script_path
+              }
 
               case
               when @format == :script

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

@@ -29,7 +29,7 @@ module Nugrant
               parser.separator "Available options:"
               parser.separator ""
 
-              parser.on("-h", "--help", "Print this help") do
+              parser.on("-h", "--help", "Prints this help") do
                 @show_help = true
               end
 

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

@@ -24,7 +24,7 @@ module Nugrant
               parser.separator "Available options:"
               parser.separator ""
 
-              parser.on("-h", "--help", "Print this help") do
+              parser.on("-h", "--help", "Prints this help") do
                 @show_help = true
               end
 

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

@@ -43,11 +43,11 @@ module Nugrant
               parser.banner = "Usage: vagrant user [-h] [-v] <subcommand> [<args>]"
 
               parser.separator ""
-              parser.on("-h", "--help", "Print this help") do
+              parser.on("-h", "--help", "Prints this help") do
                 @show_help = true
               end
 
-              parser.on("-v", "--version", "Print plugin version and exit.") do
+              parser.on("-v", "--version", "Prints plugin version and exit.") do
                 @show_version = true
               end
 

data/lib/nugrant/vagrant/v2/plugin.rb

@@ -1,3 +1,4 @@
+require 'nugrant/vagrant/v2/action'
 
 module Nugrant
   module Vagrant
@@ -8,6 +9,16 @@ module Nugrant
           Plugin to define and use user specific parameters from various location inside your Vagrantfile.
         DESC
 
+        class << self
+          def provision(hook)
+            hook.before(::Vagrant::Action::Builtin::Provision, Nugrant::Vagrant::V2::Action.auto_export)
+          end
+        end
+
+        action_hook(:nugrant_provision, :machine_action_up, &method(:provision))
+        action_hook(:nugrant_provision, :machine_action_reload, &method(:provision))
+        action_hook(:nugrant_provision, :machine_action_provision, &method(:provision))
+
         command "user" do
           require_relative "command/root"
           Command::Root
@@ -21,4 +32,3 @@ module Nugrant
     end
   end
 end
-

data/lib/nugrant/version.rb

@@ -1,3 +1,3 @@
 module Nugrant
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nugrant
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Matthieu Vachon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -46,7 +46,7 @@ files:
 - .project
 - .travis.yml
 - CHANGELOG.md
-- DEVELOPMENT.md
+- CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -63,6 +63,8 @@ files:
 - lib/nugrant/mixin/parameters.rb
 - lib/nugrant/parameters.rb
 - lib/nugrant/vagrant/errors.rb
+- lib/nugrant/vagrant/v2/action.rb
+- lib/nugrant/vagrant/v2/action/auto_export.rb
 - lib/nugrant/vagrant/v2/command/env.rb
 - lib/nugrant/vagrant/v2/command/parameters.rb
 - lib/nugrant/vagrant/v2/command/restricted_keys.rb
@@ -145,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Library to handle user specific parameters from various location.

data/DEVELOPMENT.md

@@ -1,34 +0,0 @@
-# Nugrant [![Build Status](https://travis-ci.org/maoueh/nugrant.png)](https://travis-ci.org/maoueh/nugrant)
-
-Since at first I wanted to have support for plugin api V1 and V2 in the same
-codebase without having to switch between branches, development is a bit
-more complicated than usual.
-
-As many other ruby projects, Nugrant use `bundler` to manage its dependencies.
-However, as not many ruby projects, Nugrant supports two incompatible version
-of Vagrant.
-
-For this reason, the `Gemfile` used by `bundler` is conditional to an
-environment variable. The environment used is `VAGRANT_PLUGIN_VERSION`.
-When it is set, it can take the value `v1` or `v2` which is the plugin
-version you want to test. By default, if the environment variable is
-not set, `v2` is the default.
-
-## Develop Nugrant for Vagrant api v1
-
-To do this, you will need to set and environment variable
-`VAGRANT_PLUGIN_VERSION` to `v1` prior to calling bundle
-install, like this:
-
-    VAGRANT_PLUGIN_VERSION="v1" bundle install
-
-This will instruct `bundler` to setup Vagrant `1.0.z`, which
-at the time of talking, is `1.0.7`.
-
-## Develop Nugrant for Vagrant api v2
-
-You can simply install the dependencies normally by doing:
-
-    bundle install
-
-