patheditor 1.0.0

data/README.txt

@@ -0,0 +1,74 @@
+= PathEditor
+
+Anyone who's had to change their Windows PATH environment variable more than once in a week knows it's a frustrating and error prone process.
+
+This command line utility intends to fix that. It allows you to view, add, or remove paths from the PATH variable. It will also clean the variable of directorries that no longer exist. It's even smart enough to expand system variables such as %SystemRoot% when cleaning the path.
+
+When the path is modified, all system processes are notified immediately. Not all programs will respond to the notification, but the current shell and future shells opened from the Start | Run box will. 
+
+= Usage
+
+For help, just type
+
+  path_editor --help
+  
+To list the current path settings, just run the program without any arguments:
+
+  path_editor
+
+== Adding a Path
+
+To add a directory to the path:
+
+  path_editor --add "full path" --no-test
+
+Note, because of the way the Windows shell works, if you wish to add a path with a trailing slash, you must use a double slash at the end:
+
+  path_editor --add "c:\program files\\" --no-test
+  
+If the path already given already exists, it will not be added again.
+
+== Removing a path
+
+To remove a directory from the path:
+
+  path_editor --remove "full path"
+  
+Limited regular expressions can be used - essentially "*" or "?", like filename wild cards. If more than one path matches the expression given, you will be asked for confirmation before the path variable is updated.
+
+== Cleaning the Path
+
+To clean your path:
+
+  path_editor --clean
+  
+This process will remove directories which no longer exist, and will remove any duplicate directories from the path. 
+
+= Acknowledgements
+
+Of course, my thanks to Matz for creating Ruby. What a joy it is to program in. I'm also indebted to the fine coders of the "commandline" and "highline" libraries. Finally, my thanks to the King of Kings, Jesus Christ, for the gift of this life. Amen.
+
+= LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Justin Bailey
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+	s.name = "patheditor"
+	s.summary = "A simple program to manage the Windows PATH environment variable."
+	s.version = "1.0.0"
+	s.author = "Justin Bailey"
+	s.email = "jgbailey@nospam@gmail.com"
+	
+	s.description = <<EOS
+This gem provides an application, path_editor, which makes it easy to add, remove, display or clean up the Windows PATH environment variable.  
+EOS
+
+	s.platform = Gem::Platform::RUBY
+	s.files = FileList["lib/**/*", "*.txt", "Rakefile"].to_a
+
+	s.bindir = "bin"
+	s.executables = ["path_editor"]
+	s.require_path = "lib"
+
+	s.has_rdoc = true
+	s.extra_rdoc_files = ["README.txt"]
+	s.rdoc_options << '--title' << 'PathEditor -- A PATH environment variable editor' <<
+                       '--main' << 'README.txt' <<
+                       '--line-numbers'
+
+	s.add_dependency("highline", ">= 1.2.3")
+	s.add_dependency("commandline", ">= 0.7.10")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end

data/bin/path_editor

@@ -0,0 +1,141 @@
+# A simple application for editing the environment's path information.
+require 'rubygems'
+require 'highline'
+require 'commandline'
+require 'pathname'
+
+$: << (Pathname.new(__FILE__).dirname + '..\lib') unless $:.include?(Pathname.new(__FILE__).dirname + '..\lib')
+require 'windows_path'
+
+class App < CommandLine::Application
+  def initialize
+    synopsis "[[-c, --clean] [-a, --add PATH] [r, --remove EXPR]] [--case-sensitive] [-n, --no-confirmation] [-h, --help]"
+    short_description <<-EOS
+With no arguments, displays the current path, broken into separate entries. Arguments allow directories to be added to or removed from the path. The path can also be cleaned of directories which no longer exist."
+    EOS
+    
+    long_description <<-EOS
+A script for manipulating the environment's PATH variable. Editing this variable is a huge pain in Windows - this script aims to make it easier.    
+    EOS
+    
+    option :names => %w(-c --clean), :arity => 0, 
+      :opt_found => proc { |opt, user_option, opt_args|
+        @clean = true
+      },
+      :opt_description => <<-EOS
+Cleans directories which no longer exist from the path, and removes any duplicate directories.
+      EOS
+
+    option :names => %w(-a --add), :arity => 1, :arg_description => "path", 
+      :opt_found => proc { |opt, user_option, opt_args|
+        @add = Pathname.new opt_args.first
+      },
+      :opt_description => <<-EOS
+Adds the given path to the PATH environment variable. If the path already exists (in the exact form given), it will not be added.
+      EOS
+
+    option :names => %w(-r --remove), :arity => 1, :arg_description => "expression",
+      :opt_found => proc { |opt, user_option, opt_args|
+        @remove = opt_args.first
+      },
+      :opt_description => <<-EOS
+Removes the given path from the environment variable. If characters such as "*" or "?" appear in the path, it will be treated as a regular expression, and any back slashes should be escaped (i.e. "C:\\Program Files\\*" vs "C:\Program Files").
+
+When a non-regular expression is given, the path must match exactly to be removed. 
+      EOS
+
+    option :names => %w(--case-sensitive), :arity => 0,
+      :opt_found => proc { |opt, user_option, opt_args|
+        @case_sensitive = true
+      },
+      :opt_description => <<-EOS
+Makes path comparisons case-sensitive if present. Path comparisons are case-insensitive otherwise.
+      EOS
+      
+    option :names => %w(-n --no-confirmation), :arity => 0,
+      :opt_found => proc { @confirm_disabled = true},
+      :opt_description => <<-EOS
+Forces changes to occur with confirmation. True by default unless paths are being removed with a regular expression and more than one path is matched - then it is false. This is intended to prevent the accidental remove of all paths or a similar disaster.
+      EOS
+      
+      option :debug, :help
+  end
+
+  def main
+    @hl = HighLine.new
+    @paths = WindowsPath.new
+    
+    if @clean || @add || @remove
+      if @clean
+				paths_to_remove = []
+        @paths.each { |p| paths_to_remove << p unless Pathname.new(p).exist? }
+        remove_paths(paths_to_remove) unless paths_to_remove.empty?
+      end
+      
+      if @add
+        unless @paths.include? @add
+          @paths.add(@add)
+          @path_updated = true
+          @hl.say "Added #{@add} to path." 
+        else
+          @hl.say "#{@add} not added because it already exists in the path."
+        end
+      end
+      
+      if @remove
+        # See if @remove looks like a regular expression
+        if @remove.index("*") || @remove.index("?")
+          # File glob "*" not quite the same as reg ex "*" - need to add "." character
+          # to make sure any and all characters following are matched
+          @remove = @remove.gsub('\\', '\\\\\\\\').gsub("*", ".*").gsub("?", ".")
+          exp = @case_sensitive ? Regexp.new("^#{@remove}$") : Regexp.new("^#{@remove}$", Regexp::IGNORECASE)
+          paths_to_remove = []
+          
+          @paths.each { |p| paths_to_remove << p if exp.match(p) }
+          remove_paths(paths_to_remove) unless paths_to_remove.empty?
+        elsif @paths.include?(@remove)
+          @hl.say "Removing path #{@remove}"
+          @paths.remove(@remove) 
+          @path_updated = true
+        end
+      end
+
+      if @path_updated
+        if confirmation_needed? 
+					@paths.update if @hl.agree("Would you like to commit the changes made? [Yn] ", true)
+        else
+          @paths.update
+        end
+      end
+    else
+      # Print path
+      @hl.say "Current path entries:" 
+      @paths.each { |p| @hl.say "\t#{p}" } 
+    end
+  rescue 
+    puts "Exception: #{$!.message}"
+    puts $!.backtrace.join("\n")
+  end
+  
+  def confirmation_needed?
+		# No need to confirm if either the user specified no confirmation explicitly, or
+		# the automatic confirmation never got set.
+		(@automatic_confirm && ! @confirm_disabled) || false
+  end
+  
+  def remove_paths(paths_to_remove)
+		cnt = 0
+    paths_to_remove.each do |p| 
+      @hl.say "Removing #{p}"
+      @paths.remove p
+      @path_updated = true
+      # If more than one path matches and the user did not specify "--no-confirmation", make
+      # sure to enable it here.
+      @automatic_confirm = true if cnt > 0
+      cnt += 1
+    end
+  end
+  
+end
+
+App.run unless $0 == __FILE__

data/lib/windows_path.rb

@@ -0,0 +1,74 @@
+require 'win32ole'
+
+# Manages access to and updating of windows path setting. Also manages
+# enumerating paths available, and checking if a given path exists. 
+class WindowsPath
+  include Enumerable
+  FILE_SEPARATOR = File::ALT_SEPARATOR
+
+  def initialize
+    @shell = WIN32OLE.new("WScript.Shell")
+    @system = @shell.Environment("System")
+    @paths = []
+    @paths = @system.Item("Path").split(";").collect { |p| p.strip }
+  end
+  
+  def expand_vars(val)
+    while m = val.match(/%.*?%/)
+      val = val.gsub(m[0], @shell.ExpandEnvironmentStrings(m[0]))
+    end
+    
+    val
+  end
+
+  def add(p)
+    @paths << p.to_s unless self.include?(p)
+  end
+
+  alias_method :<<, :add
+  
+  def remove(r)
+    # Find all paths that match and delete them.
+    @paths = @paths.delete_if { |p| compare_paths(r, p) }
+  end
+  
+  # Update any changes 
+  def update
+    @system["Item", "Path"] = @paths.join(";")
+  end
+  
+  def each
+    @paths.each { |p| yield expand_vars(p) }
+  end  
+
+  def compare_paths(left, right)
+    left = expand_vars(left.to_s).downcase
+    right = expand_vars(right.to_s).downcase
+    
+    if left == right 
+      true
+    else
+      left_sep = left.length > 1 && left.rindex(FILE_SEPARATOR) == left.length - 1 
+      right_sep = right.length > 1 && right.rindex(FILE_SEPARATOR) == right.length - 1
+      
+      if ! left_sep && right_sep 
+        left == right[0, right.length - 1]
+      elsif left_sep && ! right_sep 
+        left[0, left.length - 1] == right 
+      else
+        false
+      end
+    end
+  end
+    
+  def include?(path)
+    # Compare paths case-insensitive, and also checking
+    # trailing separators (so c:\program files == c:\program files\)
+    @paths.any? { |p| compare_paths(path, p) }
+  end
+  
+  def inspect
+    @paths.inspect
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: patheditor
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-02-05 00:00:00 -08:00
+summary: A simple program to manage the Windows PATH environment variable.
+require_paths: 
+- lib
+email: jgbailey@nospam@gmail.com
+homepage: 
+rubyforge_project: 
+description: This gem provides an application, path_editor, which makes it easy to add, remove, display or clean up the Windows PATH environment variable.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Justin Bailey
+files: 
+- lib/windows_path.rb
+- README.txt
+- Rakefile
+test_files: []
+
+rdoc_options: 
+- --title
+- PathEditor -- A PATH environment variable editor
+- --main
+- README.txt
+- --line-numbers
+extra_rdoc_files: 
+- README.txt
+executables: 
+- path_editor
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: commandline
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.10
+    version: