patheditor 1.0.2 → 1.0.3

data/Rakefile

@@ -5,7 +5,7 @@ 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.2"
+	s.version = "1.0.3"
 	s.author = "Justin Bailey"
 	s.email = "jgbailey@nospam@gmail.com"
 	
@@ -14,7 +14,7 @@ This gem provides an application, path_editor, which makes it easy to add, remov
 EOS
 
 	s.platform = Gem::Platform::RUBY
-	s.files = FileList["lib/**/*", "*.txt", "Rakefile"].to_a
+	s.files = FileList["lib/**/*", "test/**/*", "*.txt", "Rakefile"].to_a
 
 	s.bindir = "bin"
 	s.executables = ["path_editor"]

data/bin/path_editor

@@ -39,9 +39,10 @@ Adds the given path to the PATH environment variable. If the path already exists
         @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. 
+Removes the given path from the environment variable. Special characters such as "?" and "*" will be treated
+as wildcards, just like at the command line. Be sure to enclose the expression in quotes, or the command prompt will
+attempt to expand them for you. Note also that the command prompt seems to switch "\" characters to "/", so matches
+with those characters will appear odd.
       EOS
 
     option :names => %w(--case-sensitive), :arity => 0,
@@ -67,33 +68,20 @@ Forces changes to occur with confirmation. True by default unless paths are bein
     
     if @clean || @add || @remove
       if @clean
-				nonexistent = []
-				found = WindowsPathArray.new
-				duplicates = []
-				idx = 0 
-        @currPath.paths.each do |p| 
-          pathname = Pathname.new(p).cleanpath
-					if ! pathname.exist? 
-						nonexistent << p  
-					elsif found.include?(pathname)
-						duplicates << idx
-					else
-						found << pathname
+				@currPath.clean do |path, reason|
+					case reason
+						when :dup
+							@hl.say "Removing #{path} (duplicate)" 						
+						when :notfound
+							@hl.say "Removing #{path} (doesn't exist)"						
 					end
-					idx += 1
-        end
-
-				unless duplicates.empty?
-					remove_paths(duplicates) { |p| @hl.say "Removing #{p} (duplicate)" } 
-				end
-
-				unless nonexistent.empty?					
-					remove_paths(nonexistent){ |p| @hl.say "Removing #{p} (doesn't exist)" } 
+					
+					path_removed
 				end
       end
       
       if @add
-        unless @currPath.paths.include? @add
+        unless @currPath.paths.include?(@add)
           @currPath.paths.add(@add)
           @path_updated = true
           @hl.say "Added #{@add} to path." 
@@ -103,20 +91,9 @@ Forces changes to occur with confirmation. True by default unless paths are bein
       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 = []
-          
-          @currPath.paths.each { |p| paths_to_remove << p if exp.match(p) }
-          remove_paths(paths_to_remove) unless paths_to_remove.empty?
-        elsif @currPath.paths.include?(@remove)
-          @hl.say "Removing path #{@remove}"
-          @currPath.paths.remove(@remove) 
-          @path_updated = true
+        @currPath.remove(@remove) do |p| 
+					@hl.say "Removing path #{p}"
+					path_removed
         end
       end
 
@@ -143,30 +120,14 @@ Forces changes to occur with confirmation. True by default unless paths are bein
 		(@automatic_confirm && ! @confirm_disabled) || false
   end
   
-  # Takes an array of paths or indices and removes them from the current path. Yields
-  # each path before deleting it, if a block was provided
-  def remove_paths(paths_to_remove)
-		@paths_removed ||= 0
-		adjust = 0
-    paths_to_remove.each do |p| 
-			if p.is_a?(Fixnum)
-				idx = p - adjust # adjust index based on paths removed so far.
-				yield @currPath.paths[idx] if block_given?
-				@currPath.paths.delete_at(idx)
-			else
-				yield p if block_given?
-				@currPath.paths.delete p
-      end
-      
-			# If more than one path matches and the user did not specify "--no-confirmation", make
-			# sure to enable it here.
-			@path_updated = true
-      @automatic_confirm = true if @paths_removed > 0
-      @paths_removed += 1
-      adjust += 1
-    end
+  # Records that a path was removed
+  def path_removed
+		@path_updated = true
+		# first time through, @paths_removed is false. Automatic confimration
+		# should happen with more than one directory, therefore this will succeed.
+    @automatic_confirm = true if @paths_removed  
+    @paths_removed = true
   end
-  
 end
 
 App.run unless $0 == __FILE__

data/lib/windows_path.rb

@@ -74,5 +74,75 @@ class WindowsPath
   def update
     @system["Item", "Path"] = @paths.join(";")
   end
+	
+	# Cleans the current path of any non-existent or duplicate directories.
+	# If a block is given, yields each directory removed along with a
+	# the symbol :dup or :notfound. 
+	def clean # :yields: path, reason
+		nonexistent = []
+		found = WindowsPathArray.new
+		duplicates = []
+		idx = 0 
+    @paths.each do |p| 
+      pathname = Pathname.new(p).cleanpath
+			if ! pathname.exist? 
+				nonexistent << p  
+			elsif found.include?(pathname)
+				duplicates << idx
+			else
+				found << pathname
+			end
+			idx += 1
+    end
+
+		unless duplicates.empty?
+			remove_paths(duplicates) { |p| yield p, :dup if block_given? } 
+		end
+
+		unless nonexistent.empty?					
+			remove_paths(nonexistent) { |p|  yield p, :notfound if block_given? } 
+		end
+	end
+	
+	# Removes paths matching the path given. If path is regular
+	# expression, it is matched directly. Any other
+	# pattern is treated as a potential shell "glob" 
+	# match, which means "*" and "?" are treated 
+	# specially. 
+	#
+	# In all cases, the path(s) removed are yielded.
+	def remove(pattern) # :yields: path
+		paths_to_remove = []
+		@paths.each do |p|
+			if pattern.is_a?(Regexp)
+				paths_to_remove << p if pattern.match(p)
+			else
+				paths_to_remove << p if File.fnmatch(pattern, p, File::FNM_CASEFOLD | File::FNM_NOESCAPE)
+			end
+		end
+		
+		paths_to_remove.each do |p|
+			yield p if block_given?
+			@paths.delete(p)
+		end
+	end
+
+private
+	
+  def remove_paths(paths_to_remove)
+		adjust = 0
+    paths_to_remove.each do |p| 
+			if p.is_a?(Fixnum)
+				idx = p - adjust # adjust index based on paths removed so far.
+				yield @paths[idx] if block_given?
+				@paths.delete_at(idx)
+			else
+				yield p if block_given?
+				@paths.delete p
+      end
+      
+      adjust += 1
+    end
+  end
 
 end

data/test/test_windows_path.rb

@@ -0,0 +1,128 @@
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + "/../lib" unless $:.include?(File.dirname(__FILE__) + "../lib")
+require 'windows_path'
+
+class WindowsPathTests < Test::Unit::TestCase
+	
+	def setup
+		@path = WindowsPath.new
+	end
+	
+	def test_clean
+		# add some non-existent directories
+		fake = add_fake
+		
+		assert_dir_found fake, "Fake directory not added to current path."
+		@path.clean
+		assert_dir_not_found fake, "Fake directory found in current path after cleaning!"
+	end
+	
+	def test_clean_dups
+		fake = add_fake_dup
+
+		assert_dir_found fake, "Duplicate directory not found in path."
+		assert_dup_found fake, "Did not find the right number of duplicates directories in the path."
+		
+		@path.clean
+		assert_dir_not_found fake, "Duplicate directory found in current path after cleaning!"
+	end
+	
+	def test_clean_and_notfound
+		fake_dup = add_fake_dup
+		fake_not_found = add_fake
+
+		assert_dup_found fake_dup, "Did not find the right number of duplicates directories in the path."
+		assert_dir_found fake_not_found, "Nonexistent directory not found in path."
+
+		@path.clean
+		assert_dir_not_found fake_dup, "Duplicate directory found in current path after cleaning!"
+		assert_dir_not_found fake_not_found, "Nonexistent directory found in current path after cleaning!"
+	end
+	
+	def test_remove_dir
+		fake_dir = add_fake
+		assert_dir_found fake_dir, "Fake directory not found in path."
+		@path.remove fake_dir
+		assert_dir_not_found fake_dir, "Fake directory found in path after removal."
+	end
+	
+	def test_remove_glob
+		fake_dir = add_fake
+		assert_dir_found fake_dir, "Fake directory not found in path."
+		fake_glob = fake_dir.chop << "*"
+		@path.remove fake_glob
+		assert_dir_not_found fake_dir, "Fake directory not removed by glob: #{fake_glob}"
+	end
+	
+	def test_remove_regexp
+		fake_dir = add_fake
+		assert_dir_found fake_dir, "Fake directory not found in path."
+		fake_regex = Regexp.new("^" << fake_dir.gsub('\\', '\\\\\\\\') << "$")
+		@path.remove fake_regex
+		assert_dir_not_found fake_dir, "Fake directory not removed by regex: #{fake_regex}"
+	end
+	
+	def test_remove_case_sensitive_glob
+		# Ensure matches with different case works.
+		fake_dir = add_fake "C:\\program files"
+		fake_glob = "C:\\PROGRAM*"
+		@path.remove fake_glob
+		assert_dir_not_found fake_dir, "Fake directory not removed by glob: #{fake_glob}"
+	end
+
+	def test_remove_glob_two_stars
+		# Test that a glob with wildcards on both ends works
+		fake_dir = add_fake "C:\\program files"
+		fake_glob = "*PROGRAM*"
+		@path.remove fake_glob
+		assert_dir_not_found fake_dir, "Fake directory not removed by glob: #{fake_glob}"
+	end
+
+	def test_remove_glob_single_char
+		# Test that a glob with question mark works
+		fake_dir = add_fake 
+		fake_glob = fake_dir.chop << "?"
+		@path.remove fake_glob
+		assert_dir_not_found fake_dir, "Fake directory not removed by glob: #{fake_glob}"
+	end
+
+	# Makes a directory guarnteed not to exist
+	def make_fake_dir(dir)
+		cnt = 1
+		fake_dir = dir
+		while @path.paths.include? fake_dir
+			fake_dir = dir << cnt
+			cnt += 1
+		end
+		
+		fake_dir
+	end
+
+	# Add a fake path	
+	def add_fake(base = "C:\\foobar")
+		@path.paths << fake = make_fake_dir(base)
+		fake
+	end
+	
+	# Add a duplicated fake path 
+	def add_fake_dup
+		fake = add_fake
+		@path.paths << fake
+		
+		fake
+	end
+	
+	def assert_dir_found(dir, msg)
+		assert @path.paths.include?(dir), msg
+	end
+		
+	def assert_dir_not_found(dir, msg)
+		assert ! @path.paths.include?(dir), msg
+	end
+	
+	def assert_dup_found(dir, msg)
+		cnt = 0
+		@path.paths.each { |p| cnt += 1 if p == dir }
+		assert cnt == 2, msg
+	end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: patheditor
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
-date: 2007-02-07 00:00:00 -08:00
+  version: 1.0.3
+date: 2007-02-12 00:00:00 -08:00
 summary: A simple program to manage the Windows PATH environment variable.
 require_paths: 
 - lib
@@ -30,6 +30,7 @@ authors:
 - Justin Bailey
 files: 
 - lib/windows_path.rb
+- test/test_windows_path.rb
 - README.txt
 - Rakefile
 test_files: []