muto 0.0.2 → 0.0.3

data/README.textile

@@ -1,17 +1,14 @@
 h1. Overview
 
-Muto is a lightweight little ruby/vbs/bat script that will allow you switch to another version of Ruby while also allowing you to alter Windows Environment
-variables at the same time. You can do this with Muto without having to reload your command prompt/shell and all gem paths associated with the chosen
-version of ruby are automatically updated as you switch versions.
+Muto is a lightweight little ruby/vbs/bat script that will allow you switch to another version of Ruby while also allowing you to alter multiple other Windows Environment variables at the same time. You can do this with Muto without having to reload your command prompt/shell and all gem paths associated with the chosen version of ruby are automatically updated as you switch versions.
+
+*As a precautionary measure when using muto, make a backup of your Windows PATH environment variable before using this gem*
 
 h2. Why I put this together..
 
-Firstly, I'm not trying to take anything from Pik, check it out first if you haven't already, there's a thousand things you can do with it and it might be
-better suited to what your needs are: https://github.com/vertiginous/pik
+Firstly, I'm not trying to take anything from Pik, check it out first if you haven't already, there's a thousand things you can do with it and it might be better suited to what your needs are: https://github.com/vertiginous/pik
 
-I put Muto together because I needed to also frequently change a few environment variables every time I changed my version of ruby and I just got sick
-of having to do it all the time and then having to reload my command prompt as well just to pick up the changes. Also I needed to be able to switch
-ruby versions and persist the change to another version of Ruby across my entire Windows environment.
+I put Muto together because I needed to also frequently change a few environment variables every time I changed my version of ruby and I just got sick of having to do it all the time and then having to reload my command prompt as well just to pick up the changes. Also I needed to be able to switch ruby versions and persist the change to another version of Ruby across my entire Windows environment.
 
 h2. Example Usage
 
@@ -22,8 +19,9 @@ muto
   =>Expected format:  muto [ruby_version]
   =>
   =>Available Versions are:
-  =>  186  ruby 1.8.6 (2007-09-24 patchlevel 111) [i386-mswin32]
-  =>  192  ruby 1.9.2p180 (2011-02-18) [i386-mingw32]
+  =>  186     - ruby 1.8.6 (2007-09-24 patchlevel 111) [i386-mswin32]
+  =>  187     - ruby 1.8.7 (2011-06-30 patchlevel 352) [i386-mingw32]
+  =>  rhodes  - ruby 1.9.3p125 (2012-02-16) [i386-mingw32]
   =>
   =>Currently using:
   =>ruby 1.8.6 (2007-09-24 patchlevel 111) [i386-mswin32]
@@ -33,28 +31,26 @@ ruby -v
 echo %JAVA_HOME%
   =>C:\Program Files\Java\jre5
 
-muto 192
+muto 187
   =>System updated. Now using:
-  =>ruby 1.9.2p180 (2011-02-18) [i386-mingw32]
+  =>ruby 1.8.7 (2011-06-30 patchlevel 352) [i386-mingw32]
 
 ruby -v
-  =>ruby 1.9.2p180 (2011-02-18) [i386-mingw32]
+  =>ruby 1.8.7 (2011-06-30 patchlevel 352) [i386-mingw32]
 echo %JAVA_HOME%
   =>C:\Program Files\Java\jre7
 </pre>
 
 h2. How Muto works..
 
-Muto works by using an executable .bat file to call a ruby script which will alter your systems environment variables and send an environment changed
-signal to your Windows environment. It'll then finish by calling a basic vb script to update the shell you're working in so that you won't need to
-restart your command prompt.
+Muto works by using an executable .bat file to call a ruby script which will alter your systems environment variables and send an environment changed signal to your Windows environment. It'll then finish by calling a basic vb script to update the shell you're working in so that you won't need to restart your command prompt/shell window.
 
 The actual muto gem is not really a gem at all.. It's just basically a wrapper to help copy the muto scripts to your machine somewhere.
 
 
 h2. Setup/Config
 
-Use a normal Windows MRI version of Ruby to install Muto.
+*Use a normal Windows MRI version of Ruby to install Muto*
 <pre>gem install muto</pre>
 
 From the command line, change into a directory where you want to keep the scripts and run: extract_muto
@@ -73,12 +69,17 @@ extract_muto
 
 h3. ruby_versions.yml
 
-As well as being able to switch to other versions of Ruby in your Windows environment, you can also define other User Environment Variables to change at
-the same time. Muto switches versions of Ruby by just regex-ing out the ruby bin folder out of your Windows PATH variable and replacing it with the new
-version you choose. This way none of the other paths in your environments PATH variable are altered.
+As well as being able to switch to other versions of Ruby in your Windows environment, you can also define other User Environment Variables to change at the same time. Muto switches versions of Ruby by just regex-ing out the ruby bin folder out of your Windows PATH variable and replacing it with the new version you choose. This way none of the other paths in your environments PATH variable are altered.
+
+The User Environment Variables are set completely differently! The values you give them are the full values used to define the variable so if there is an existing variable already defined in your User Environment variables then it will be overwritten with the new value.
+
+*ADD A 'HOME' ENVIRONMENT VARIABLE FOR EACH VERSION OF RUBY!!*
+Ruby will install and run just fine without a 'HOME' environment variable, however you'll likely run into problems with rubygems while installing gems if you do not setup a 'HOME' environment variable for each separate version of ruby you install. I usually just create an empty directory within the ruby folder I'm using and then just add a 'HOME' environment variable to my 'ruby_versions.yml' file like in the following example.
 
-The User Environment Variables are set completely differently! The values you give them are the full values used to define the variable so if there is an
-existing variable already defined in your User Environment variables then it will be overwritten with the new value.
+*To add multiple items to your windows PATH environment variable when switching*
+Inside my windows PATH environment variable I've manually added an ==%ADD_TO_PATH%== environment variable so that it looks something like this:
+PATH: C;\path\to\stuff\etc; ==%ADD_TO_PATH%==
+In the following example, when switching to my "rhodes" environment I want to add a heap of stuff to my windows PATH environment variable that I don't want to be in the PATH when using ruby 186 or 192. In these cases I use a tilde '~' character or a semicolon ';' which will just change the value of the ==%ADD_TO_PATH%== variable to a semicolon and adding nothing to the PATH when I switch between versions.
 
 <pre>
 # ruby_versions.yml example
@@ -88,12 +89,23 @@ ruby_versions:
     shortcut: 186
     bin_folder: C:\ruby\bin
     user_env_variables:
+      home: C:\ruby\home
       java_home: C:\Program Files\Java\jre5
-  ruby_192:
-    shortcut: 192
-    bin_folder: C:\ruby192\bin
+      add_to_path: ~
+  ruby_187:
+    shortcut: 187
+    bin_folder: C:\ruby187\bin
+    user_env_variables:
+      home: C:\ruby187\home
+      java_home: C:\Program Files\Java\jre7
+      add_to_path: ~
+  rhodes_193:
+    shortcut: rhodes
+    bin_folder: C:\RhodesSuite2.2.1.13\ruby\bin
     user_env_variables:
+      home: C:\RhodesSuite2.2.1.13\ruby\home
       java_home: C:\Program Files\Java\jre7
+      add_to_path: C:\RhodesSuite2.2.1.13\redis-2.4.0;C:\RhodesSuite2.2.1.13\ruby\bin;C:\RhodesSuite2.2.1.13\devkit\bin;C:\RhodesSuite2.2.1.13\devkit\mingw\bin;C:\RhodesSuite2.2.1.13\make-3.81\bin;C:\Program Files (x86)\nodejs\;
 
 </pre>
 
@@ -102,7 +114,7 @@ h2. License
 
 MIT License
 
-Copyright (C) 2011 by Lucas Hills
+Copyright (C) 2013 by Lucas Hills
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/deploy_scripts/muto.bat

@@ -1,18 +1,17 @@
 @ECHO OFF
 
 
-
+:: This bat script is what is actually executed when you run 'muto' from the command line
+::
 C:\ruby\bin\ruby.exe %~dp0\muto.rb %* 2> NUL
 
 
-:: The following 2 lines allow you to not have to reset your command line in order to pick up
-:: the new Environment Variables
-
+:: The following 2 lines allow you to not have to reinitialise your command prompt window
+:: in order to pick up the new Environment Variables
 reset_command_line.vbs
 call "%TEMP%\reset_command_line.bat"
 
 
-
 :: The end of this script just outputs the now current version of Ruby being used by your system
 :: Using 2> NUL just means that if the ruby/jruby command doesn't exist, the error message won't be output
 :: to the command line.

data/lib/deploy_scripts/muto.rb

@@ -1,5 +1,5 @@
 
-begin; require 'rubygems'; rescue; end
+require 'rubygems'
 require 'win32/registry'
 require 'Win32API'
 require 'yaml'
@@ -8,147 +8,155 @@ HWND_BROADCAST = 0xffff
 WM_SETTINGCHANGE = 0x001A
 SMTO_ABORTIFHUNG = 2
 
-class Muto
+module Muto
 
-  def initialize
-    @commands = []
-    @ruby_versions = []
-    @all_bin_paths = []
+  class Muto
 
-    @versions_yml = YAML.load(IO.read(File.join(File.dirname(__FILE__), 'ruby_versions.yml')))
+    def initialize
+      @commands = []
+      @ruby_versions = []
+      @all_bin_paths = []
+      yml_path = File.expand_path('ruby_versions.yml', File.dirname(__FILE__))
 
-    if @versions_yml['ruby_versions'].nil?
-      puts "There aren't any version of Ruby defined in your ruby_versions.yml yet"
-      puts "Update #{File.expand_path(File.join(File.dirname(__FILE__), "ruby_versions.yml")).to_s.gsub(/\//, '\\')} first and try again"
-      puts "\nCurrently using:"
-      exit!
-    else
+      begin
+        @versions_yml = YAML.load_file(yml_path)
+      rescue Exception => msg
+        puts "An Exception occurred while trying to parse your yml file: #{yml_path}"
+        raise msg
+      end
 
-      @versions_yml['ruby_versions'].each do |key, val|
-        @ruby_versions << @versions_yml['ruby_versions'][key]['shortcut'].to_s
-        @all_bin_paths << @versions_yml['ruby_versions'][key]['bin_folder']
 
-        begin
-          exe_name = (@versions_yml['ruby_versions'][key]['exe_name']) ? @versions_yml['ruby_versions'][key]['exe_name'] : 'ruby.exe'
-          ruby_exe = File.expand_path(File.join(@versions_yml['ruby_versions'][key]['bin_folder'], exe_name))
-          ruby_version = `"#{ruby_exe}" -v`
-
-          if File.exist?(ruby_exe)
-            add_version(:"#{@versions_yml['ruby_versions'][key]['shortcut'].to_s}", ruby_version)
-          else
-            puts "File does not exist: #{ruby_exe.to_s}"
+      if @versions_yml['ruby_versions'].nil?
+        puts "There aren't any version of Ruby defined in your ruby_versions.yml yet"
+        puts "Update #{File.expand_path(File.join(File.dirname(__FILE__), "ruby_versions.yml")).to_s.gsub(/\//, '\\')} first and try again"
+        puts "\nCurrently using:"
+        exit!
+      else
+
+        @versions_yml['ruby_versions'].each do |key, val|
+          @ruby_versions << @versions_yml['ruby_versions'][key]['shortcut'].to_s
+          #Convert the following paths to ruby paths so that they can be escaped more easily later on
+          @all_bin_paths << File.expand_path(@versions_yml['ruby_versions'][key]['bin_folder'])
+
+          begin
+            exe_name = (@versions_yml['ruby_versions'][key]['exe_name']) ? @versions_yml['ruby_versions'][key]['exe_name'] : 'ruby.exe'
+            ruby_exe = File.expand_path(File.join(@versions_yml['ruby_versions'][key]['bin_folder'], exe_name))
+            ruby_version = `"#{ruby_exe}" -v`
+
+            if File.exist?(ruby_exe)
+              add_version(:"#{@versions_yml['ruby_versions'][key]['shortcut'].to_s}", ruby_version)
+            else
+              puts "File does not exist: #{ruby_exe.to_s}"
+            end
+
+          rescue
+            puts "Error: File does not exist: #{ruby_exe.to_s}"
           end
 
-        rescue
-          puts "Error: File does not exist: #{ruby_exe.to_s}"
         end
-
       end
-
-
     end
 
-  end
-
-  def add_version(name, description, hidden=false)
-    @commands << { :name => name, :desc => description, :hidden => hidden }
-  end
+    def add_version(name, description, hidden=false)
+      @commands << { :name => name, :desc => description, :hidden => hidden }
+    end
 
-  def run
-    if ARGV.empty?
-      help
-    else
-      begin
-        version = ARGV.shift.to_s
-      rescue
-        puts "Unknown Version"
+    def run
+      if ARGV.empty?
         help
-      end
+      else
+        begin
+          version = ARGV.shift.to_s
+        rescue
+          puts "Unknown Version"
+          help
+        end
 
-      if @ruby_versions.include?(version)
-        @versions_yml['ruby_versions'].each do |key, val|
-          update_user_path_variable(key.to_s) if @versions_yml['ruby_versions'][key]['shortcut'].to_s == version
+        if @ruby_versions.include?(version)
+          @versions_yml['ruby_versions'].each do |key, val|
+            update_user_path_variable(key.to_s) if @versions_yml['ruby_versions'][key]['shortcut'].to_s == version
+          end
+        else
+          puts "Unknown Version"
+          help
         end
-      else
-        puts "Unknown Version"
-        help
       end
     end
-  end
 
-  def help
-    puts "\nExpected format:  muto [ruby_version]"
-    puts "\nAvailable Versions are:"
-    @commands.each do |command|
-      puts "   #{command[:name]} \t - #{command[:desc]}" unless command[:hidden]
-    end
+    def help
+      puts "\nExpected format:  muto [ruby_version]"
+      puts "\nAvailable Versions are:"
+      @commands.each do |command|
+        puts "  #{command[:name]}#{command[:name].to_s.length <= 4 ? "\t\t" : "\t"}- #{command[:desc]}" unless command[:hidden]
+      end
 
-    # The bat file muto.bat will always output the current version of Ruby being
-    # used by your system, so just adding this to make it read nice
-    puts "\nCurrently using:"
-  end
+      # The bat file muto.bat will always output the current version of Ruby being
+      # used by your system, so just adding this to make it read nice
+      puts "\nCurrently using:"
+    end
 
 
-  def broadcast_WM_SETTINGCHANGE_signal
-    # After setting a new environment variable, a 'WM_SETTINGCHANGE' signal needs to be broadcast to windows
-    # so that you won't need to log off and log back on again for the new settings to be propagated.
-    # The following uses the Win32API module to send the signal
-    #
-    # For more info read up here: http://msdn.microsoft.com/en-us/library/windows/desktop/ms725497%28v=vs.85%29.aspx
-    #
+    def broadcast_WM_SETTINGCHANGE_signal
+      # After setting a new environment variable, a 'WM_SETTINGCHANGE' signal needs to be broadcast to windows
+      # so that you won't need to log off and log back on again for the new settings to be propagated.
+      # The following uses the Win32API module to send the signal
+      #
+      # For more info read up here: http://msdn.microsoft.com/en-us/library/windows/desktop/ms725497%28v=vs.85%29.aspx
+      #
 
-    call_timeout_function = Win32API.new('user32', 'SendMessageTimeout', 'LLLPLLP', 'L')
-    result = 0
-    call_timeout_function.call(HWND_BROADCAST, WM_SETTINGCHANGE, 0, 'Environment', SMTO_ABORTIFHUNG, 5000, result)
+      call_timeout_function = Win32API.new('user32', 'SendMessageTimeout', 'LLLPLLP', 'L')
+      result = 0
+      call_timeout_function.call(HWND_BROADCAST, WM_SETTINGCHANGE, 0, 'Environment', SMTO_ABORTIFHUNG, 5000, result)
 
 
-    # The muto.bat script will finish up by outputting the current version or Ruby being used on your system
-    # This next line is just sugar
-    puts "\nSystem updated. Now using:"
-  end
+      # The muto.bat script will finish up by outputting the current version or Ruby being used on your system
+      # This next line is just sugar
+      puts "\nSystem updated. Now using:"
+    end
 
-  def update_user_path_variable(versions_yml_key)
+    def update_user_path_variable(versions_yml_key)
 
-    begin
-      reg_key, path_env_var = Win32::Registry::HKEY_CURRENT_USER.open('Environment').read('PATH')
-    rescue
-      user_path_env_not_set_properly_msg
-      exit!
-    end
+      begin
+        reg_key, path_env_var = Win32::Registry::HKEY_CURRENT_USER.open('Environment').read('PATH')
+      rescue
+        user_path_env_not_set_properly_msg
+        exit!
+      end
 
-    #TODO - Fix regex to support all variants of path names
-    @all_bin_paths.each do |bin_path|
-      path_env_var.gsub!(bin_path, @versions_yml['ruby_versions'][versions_yml_key]['bin_folder'].to_s)
-    end
+      @all_bin_paths.each do |bin_path|
+        escapedPath = Regexp.new(bin_path.gsub(/\//, "\\\\\\\\"), Regexp::IGNORECASE)
+        path_env_var.gsub!(escapedPath, @versions_yml['ruby_versions'][versions_yml_key]['bin_folder'].to_s)
+      end
 
-    Win32::Registry::HKEY_CURRENT_USER.open('Environment', Win32::Registry::KEY_WRITE) do |reg|
-      reg['PATH'] = path_env_var
-    end
+      Win32::Registry::HKEY_CURRENT_USER.open('Environment', Win32::Registry::KEY_WRITE) do |reg|
+        reg['PATH'] = path_env_var
+      end
 
-    if @versions_yml['ruby_versions'][versions_yml_key]['user_env_variables']
-      @versions_yml['ruby_versions'][versions_yml_key]['user_env_variables'].each do |key, val|
-        Win32::Registry::HKEY_CURRENT_USER.open('Environment', Win32::Registry::KEY_WRITE) do |reg|
-          reg[key.upcase] = val
+      if @versions_yml['ruby_versions'][versions_yml_key]['user_env_variables']
+        @versions_yml['ruby_versions'][versions_yml_key]['user_env_variables'].each do |key, val|
+          Win32::Registry::HKEY_CURRENT_USER.open('Environment', Win32::Registry::KEY_WRITE) do |reg|
+            reg[key.upcase] = val.nil? ? ";" : val
+          end
         end
       end
-    end
 
-    broadcast_WM_SETTINGCHANGE_signal
-  end
+      broadcast_WM_SETTINGCHANGE_signal
+    end
 
-private
+  private
 
-  def user_path_env_not_set_properly_msg
-    puts "\nThere are no User environment variables named PATH defined, most likely your
-          \nruby version is defined on your System PATH environment variable. Muto can
-          \nonly modify User environment variables, not system environment variables.
-          \nSwitch your path to ruby over to a User environment variable and you
-          \nshould be good to go :)"
-    puts "\nSystem did not update! Still using:"
+    def user_path_env_not_set_properly_msg
+      puts "\nThere are no User environment variables named PATH defined, most likely your
+            \nruby version is defined on your System PATH environment variable. Muto can
+            \nonly modify User environment variables, not system environment variables.
+            \nSwitch your path to ruby over to a User environment variable and you
+            \nshould be good to go :)"
+      puts "\nSystem did not update! Still using:"
+    end
   end
 end
 
-if __FILE__ == $0
-  s = Muto.new
+#if __FILE__ == $0
+  s = Muto::Muto.new
   s.run
-end
+#end

data/lib/deploy_scripts/ruby_versions.yml

@@ -1,19 +1,27 @@
+
 ruby_versions:
+#  Example Usage:
+#
 #  ruby_186:
 #    shortcut: 186
-#    bin_folder: C:\ruby\bin
-#  ruby_192:
-#    shortcut: 192
-#    bin_folder: C:\ruby192\bin
-#  jruby_164_jre6:
-#    shortcut: jr_j6
-#    bin_folder: C:\jruby-1.6.4\bin
-#    exe_name: jruby.exe
+#    bin_folder: C:\ruby186\bin
 #    user_env_variables:
-#      java_home: C:\Program Files\Java\jre6
-#  jruby_164_jre7:
-#    shortcut: jr_j7
-#    bin_folder: C:\jruby-1.6.4\bin
-#    exe_name: jruby.exe
-#    user_env_variables:
-#      java_home: C:\Program Files\Java\jre7
+#      home: C:\ruby186\home
+#      java_home: C:\Program Files\Java\jre5
+#      add_to_path: ~
+#
+#  ruby_187:
+#   shortcut: 187
+#   bin_folder: C:\ruby187\bin
+#   user_env_variables:
+#     home: C:\ruby187\home
+#     java_home: C:\Program Files\Java\jre7
+#     add_to_path: ~
+#
+#  rhodes_193:
+#   shortcut: rhodes
+#   bin_folder: C:\RhodesSuite2.2.1.13\ruby\bin
+#   user_env_variables:
+#     home: C:\RhodesSuite2.2.1.13\ruby\home
+#     java_home: C:\Program Files\Java\jre7
+#     add_to_path: C:\RhodesSuite2.2.1.13\redis-2.4.0;C:\RhodesSuite2.2.1.13\ruby\bin;C:\RhodesSuite2.2.1.13\devkit\bin;C:\RhodesSuite2.2.1.13\devkit\mingw\bin;C:\RhodesSuite2.2.1.13\make-3.81\bin;C:\Program Files (x86)\nodejs\;

data/lib/muto/version.rb

@@ -1,4 +1,3 @@
 module Muto
-  VERSION = "0.0.2"
-
+  VERSION = "0.0.3"
 end

metadata

@@ -1,26 +1,33 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: muto
-version: !ruby/object:Gem::Version
-  version: 0.0.2
+version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
-authors:
+authors: 
 - Lucas Hills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-13 00:00:00.000000000Z
+
+date: 2013-01-23 00:00:00 Z
 dependencies: []
-description: Set up different Windows Ruby environments and switch between them on
-  the command line
-email:
+
+description: Set up different Windows Ruby environments and switch between them on the command line
+email: 
 - lucas@lucashills.com
-executables:
+executables: 
 - extract_muto
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.textile
-files:
+files: 
 - Rakefile
 - Gemfile
 - README.textile
@@ -34,49 +41,49 @@ files:
 - lib/muto.rb
 homepage: https://github.com/2potatocakes/muto
 licenses: []
-post_install_message: ! '
 
+post_install_message: |
+  
   ========================================================================
-
   Muto installed!
-
   ------------------------------------------------------------------------
-
   This gem is basically just a wrapper to make deployment easier. Delete
-
-  the gem after you''ve deployed the scripts if you want. To extract the
-
-  scripts, cd into a directory where you''d like to keep them and from the
-
+  the gem after you've deployed the scripts if you want. To extract the
+  scripts, cd into a directory where you'd like to keep them and from the
   command line run:
-
-
+  
   extract_muto
-
-
+  
   ========================================================================
 
-'
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: I got sick of manually having to change windows environment variables and
-  versions of ruby in the control panel
+summary: I got sick of manually having to change windows environment variables and versions of ruby in the control panel
 test_files: []
+