rumodule 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 629f75332cb09b41f0e24e6244b8af378cd605ee
+  data.tar.gz: 52774f5c22e5612227237808dffd73c995ea5701
+SHA512:
+  metadata.gz: 0e4082e662b81a31c26cde73ff7a65eb085e07c3f3a96ffa0ff6e38dbad2d64f8e1cf24cc0f529eb3ec5cd42552a9411710c0831742a03e7ae65f1c47d282839
+  data.tar.gz: 7d34d9599221ae347db10aa844527e20c9f0f2892d2467dff00b65ee6cc423850422b4e5c6be3e15113806fc9336f9172309275efd69eba34a9700fcf5f1f63a

data/CHANGELOG.rdoc

@@ -0,0 +1,11 @@
+= Version history
+
+[0.0.3] Added tests.
+        Improvements in documentation.
+        Non-inverted module registration list.
+        Fix for unset-set sequence corner case.
+
+[0.0.2] Support for separation of normal and system modules.
+        Support for submodules (added from another module).
+
+[0.0.1] Initial version.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 tero.isannainen@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,218 @@
+
+= Content
+
+* Introduction
+* Command Line Usage
+* Rumodule File Commands
+* Shell Function
+* Environment Setup
+* Summary
+
+
+= Introduction
+
+Rumodule is used to manage shell environment variables by
+adding/removing modules. By adding a module using Rumodule, for
+example the PATH environment variable can be setup so that the
+executable is found.
+
+Modules exist per tool or per tool version. Rumodule makes it easy
+to maintain and provide tool setups between multiple users.
+
+The commands are called User Commands. Modules are called Rumodule
+files and they include Rumodule File Commands.
+
+Rumodule refers to modules through RUMODULE environment
+variable. RUMODULE includes a list of directories where Rumodule
+Files reside.
+
+Rumodule command is not convenient to be used directly. The user
+should setup a shell function which is used to utilize Rumodule.
+Recommended name is "rumo". See: Shell Function.
+
+Supported shells: zsh, sh, bash, fish
+
+
+= Command Line Usage
+
+== Overview
+
+The most common User Commands are: "add" and "rm". "add" adds
+modules content to the shell environment and "rm" removes the same
+content (or its effects).
+
+Execution examples:
+  rumo add my_module
+  rumo rm my_module
+
+Other common commands are "list" and "avail". "list" displays a list
+of loaded modules and "avail" lists all modules found, defined by
+the RUMODULE env variable.
+
+
+== List of User Commands
+
+* add:     add (load) one or many modules
+* sadd:    add (load) one or many system modules
+* rm:      remove (unload) one or many modules
+* srm:     remove (unload) one or many system modules
+* list:    list loaded modules
+* slist:   list loaded system modules
+* which:   display module that would be selected from module directory
+* display: display module content
+* avail:   list all available modules
+* savail:  list all available modules (including system modules)
+* help:    display rumodule commands or module help if module given
+
+
+
+= Rumodule File Commands
+
+== Overview
+
+The Rumodule files include commands to setup a tool for
+usage. Rumodule files are normal Ruby files, except a set of
+Rumodule commands are available in the top namespace. The Rumodule
+File Commands are semantically defined for the "add" command. For
+"rm" they have the opposite meaning.
+
+The most common commands are "setenv", "append_path", and
+"prepend_path".
+
+"append_path" adds an entry to the end of existing env variable (or
+new is created). "prepend_path" adds an entry to the beginning of
+existing env variable. New var is created if it doesn't exist.
+
+New env variable is created with "setenv" command. Existing env
+var can be removed with "unsetenv" command.
+
+Rumodule example:
+  help( "This module is used for tool" )
+  tool_path = ENV['TOOL_PATH']
+  append_path( 'PATH', "#{tool_path}/bin" )
+  add( "tool_setup" )
+
+
+== List of Rumodule File Commands
+
+[ setenv( var, value ) ]
+  Set env var "var" to "value".
+
+[ unsetenv( var ) ]
+  Unset env var "var".
+
+[ append_path( var, value ) ]
+  Append "value" to env var "var".
+
+[ prepend_path( var, value ) ]
+  Prepend "value" to env var "var".
+
+[ remove_path( var, value ) ]
+  Remove "value" from env var "var".
+
+[ pushenv( var, value ) ]
+  Set env var "var" to "value" and save the old value of "var" for
+  future. When module is removed, the old value is returned.
+
+[ prereq( mod ) ]
+  Check that module "mod" is loaded, or abort. It is recommended to
+  check for other modules before performing any other operation
+  within the module command. Otherwise the Shell Function should
+  check for "rumodule" return codes, and prevent shell env changes
+  when aborting.
+
+[ conflict( mod ) ]
+  Check that module "mod" is not loaded, or abort. See "prereq"
+  usage recommendations.
+
+[ is_loaded( mod ) ]
+  Check if module "mod" is loaded.
+
+[ add( mod ) ]
+  Add a module "mod" from Rumodule file.
+
+
+
+= Shell Function
+
+== Overview
+
+Rumodule user must setup a shell function to use Rumodule
+easily. Recommended name for the function is "rumo". The purpose of
+the function is to map user arguments to "rumodule" command and pass
+"rumodule" output to shell for evaluation. This enables the user
+command to change the shell environment variable contents.
+
+NOTE: If you are using a Ruby version which takes a long time to
+load into memory, please consider referencing directly into suitable
+Ruby version in "rumo".
+
+
+== Shell Function examples
+
+Setup "rumo" command for sh, zsh, or bash shells:
+  rumo () {
+      cmd=$1
+      shift
+      if test $# -gt 0; then
+          eval `rumodule -s zsh -c $cmd -m $*`
+      else
+          eval `rumodule -c $cmd`
+      fi
+  }
+
+Setup "rumo" command for fish shell:
+  function rumo
+    if test (count $argv) -gt 1
+      set cmd (rumodule -s fish -c $argv[1] -m $argv[2..-1])
+    else
+      set cmd (rumodule -s fish -c $argv[1])
+    end
+    eval $cmd
+  end
+
+
+= Environment Setup
+
+Rumodule requires the RUMODULE env var to be set to the root
+directory or directories where the Rumodule Files reside.
+
+Lets assume the "$HOME/usr/share/rumodule" directory is used to
+store the modules.
+
+The directory content could be the following:
+  tool1
+  tool2
+  tool3/1.2.3
+       /1.2.6
+  tool4
+  system-
+
+"tool1,2,4" are module files and "tool3" is a subdirectory including
+module files "1.2.3" and "1.2.6". "system-" is a system module file,
+which is visible only with "savail" command. System module files are
+used to separate between compulsory module files vs user selectable.
+
+"tool3" has two versions and it could be referred for example with:
+  rumo add tool3
+  rumo add tool3/1.2.6
+
+If version is left out, Rumodule uses one of the version. The
+selection is performed by first sorting the directory entries and
+then selecting the last.
+
+Usually the user should specify the actual version requested when
+adding the module and when removing the directory is enough.
+
+Rumodule files can be hidden from the system by using the "." prefix
+to filename (as for "ls" shell utility").
+
+
+= Summary
+
+These steps are required to take Rumodule into use:
+
+* Create Rumodule Files to dir.
+* Set RUMODULE env var to dir.
+* Setup rumo Shell Function.
+