win32-shortcut 0.2.1 → 0.2.2

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.2.2 - 10-Jul-2008
+* Fixed a bug where creating folder shortcuts would fail if forward slashes
+  were used. All forward slashes are now converted to backslashes internally.
+  Thanks go to Ajay Sprewell for the spot.
+* Some documentation, test and gemspec updates.
+
 == 0.2.1 - 29-Jul-2007
 * Added a Rakefile with tasks for installation and testing.
 * Removed the install.rb file, since the Rakefile now handles installation.

data/MANIFEST

@@ -5,4 +5,4 @@
 * win32-shortcut.gemspec
 * examples/example_shortcut.rb
 * lib/win32/shortcut.rb
-* test/tc_shortcut.rb
+* test/test_shortcut.rb

data/README

@@ -3,7 +3,7 @@
 
 == Requirements
    Ruby 1.8.2 or later.
-   The win32ole package (part of the Ruby stdlib).
+   The win32ole library (part of the Ruby standard library).
 
 == Installation
    rake test (optional)
@@ -13,15 +13,15 @@
 	require 'win32/shortcut'
    include Win32
 	
-   Shortcut.new('c:\test.lnk') do |s|
-      s.description = "test link"
-      s.path = "c:\\winnt\\notepad.exe"
-      s.show_cmd = Shortcut::SHOWNORMAL
-      s.working_directory = "C:\\"
+   Shortcut.new('c:/test.lnk') do |s|
+      s.description       = 'test link'
+      s.path              = 'c:/winnt/notepad.exe'
+      s.show_cmd          = Shortcut::SHOWNORMAL
+      s.working_directory = 'C:/'
    end
    
 == Notes
-   This code uses win32ole + wscript behind the scenes.  The original C code
+   This code uses win32ole + wscript behind the scenes. The original C code
    is not distributed as part of the release, but is still retained in the
    CVS repository under the 'ext' directory should anyone ever need it.
 
@@ -32,11 +32,13 @@
    http://rubyforge.org/projects/win32utils.
 	
 == Future Plans
-   Ideas welcome.  Please submit them on the project page as a
-   "Feature Request".
+   None at this time.
+   
+   Ideas welcome. Please submit them on the project page as
+   a "Feature Request".
 	
 == Copyright
-   (C) 2003-2007, Daniel J. Berger, All Rights Reserved
+   (C) 2003-2008, Daniel J. Berger, All Rights Reserved
     
 == License
    Ruby's

data/Rakefile

@@ -1,14 +1,14 @@
 require 'rake'
 require 'rake/testtask'
 
-desc "Install the win32-shortcut package (non-gem)"
+desc "Install the win32-shortcut library (non-gem)"
 task :install do
    dest = File.join(Config::CONFIG['sitelibdir'], 'win32')
    Dir.mkdir(dest) unless File.exists? dest
    cp 'lib/win32/shortcut.rb', dest, :verbose => true
 end
 
-desc "Install the win32-shortcut package as a gem"
+desc "Install the win32-shortcut library as a gem"
 task :install_gem do
    ruby 'win32-shortcut.gemspec'
    file = Dir["*.gem"].first
@@ -16,7 +16,6 @@ task :install_gem do
 end
 
 Rake::TestTask.new do |t|
-   t.libs << 'lib'
    t.warning = true
-   t.test_files = FileList['test/tc*']
+   t.verbose = true
 end

data/lib/win32/shortcut.rb

@@ -1,8 +1,11 @@
 require 'win32ole'
 
+# The Win32 module serves as a namespace only.
 module Win32
-   class Shortcut      
-      VERSION = '0.2.1'
+   # The Shortcut class encapsulates an MS Windows shortcut.
+   class Shortcut
+      # The version of this library      
+      VERSION = '0.2.2'
             
       # Activates and displays a window. If the window is minimized or maximized,
       # the system restores it to its original size and position. An application
@@ -19,15 +22,27 @@ module Win32
       # 
       SHOWMINNOACTIVE = 7
       
-      # Creates and returns a Shortcut object.  In block form it yields +self+
+      # Creates and returns a Shortcut object. In block form it yields +self+
       # and automatically ensures that Shortcut#save is called at the end of
-      # the block.  In non-block form it does not actually create the shortcut
+      # the block. In non-block form it does not actually create the shortcut
       # until the Shorcut#save method is called.
+      #
+      # Examples:
+      #
+      #   # Create a shortcut called 'test' to a file in non-block form.
+      #   s = Shortcut.new('test.lnk')
+      #   s.target_path = 'C:/Documents and Settings/john/some_file.txt'
+      #   s.save
+      #
+      #   # Create a shortcut called 'test2' to a folder in block form.
+      #   Shortcut.new('test2.lnk') do |sc|
+      #      sc.target_path = 'C:/Documents and Settings/john/some_dir'
+      #   end
       # 
       def initialize(file)
-         @file  = file
+         @file  = file.tr('/', "\\")
          @shell = WIN32OLE.new('WScript.Shell')
-         @link  = @shell.CreateShortcut(file)
+         @link  = @shell.CreateShortcut(@file)
          
          if block_given?
             begin
@@ -101,7 +116,7 @@ module Win32
       # Sets the name of the icon file to be used for the shortcut.
       # 
       def icon_location=(location)
-         @link.IconLocation = location
+         @link.IconLocation = location.tr('/', "\\")
       end
       
       # Returns the target of the shortcut. This is, joined with arguments, the
@@ -115,9 +130,12 @@ module Win32
       alias target_path path
       
       # Sets the target of the shortcut.
-      # 
+      #--
+      # Forward slashes are converted to backslashes to ensure folder
+      # shortcuts work properly.
+      #
       def path=(link_path)
-         @link.TargetPath = link_path
+         @link.TargetPath = link_path.tr('/', "\\")
       end
       
       alias target_path= path=
@@ -196,11 +214,13 @@ module Win32
       # Sets the directory in which the targeted program will be executed.
       #
       def working_directory=(directory)
-         @link.WorkingDirectory = directory
+         @link.WorkingDirectory = directory.tr('/', "\\")
       end
       
+      # Saves (creates) the link object in the current directory.
+      #
       def save
          @link.Save
       end
    end
-end
+end

data/test/test_shortcut.rb

@@ -0,0 +1,113 @@
+##############################################################################
+# tc_shortcut.rb
+#
+# Test suite for the win32-shortcut package.  This will temporarily create
+# a link to Notepad in the current directory, which should be automatically
+# deleted by this test suite.
+# 
+# You should run this test case via the 'rake test' task.
+##############################################################################
+require 'win32/shortcut'
+require 'test/unit'
+include Win32
+
+class TC_Shortcut < Test::Unit::TestCase
+   def setup
+      @link = File.join(Dir.pwd, 'test.lnk')
+      @sc = Shortcut.new(@link)
+   end
+   
+   def test_version
+      assert_equal('0.2.2', Shortcut::VERSION)
+   end
+  
+   def test_arguments
+      assert_respond_to(@sc, :arguments)
+      assert_respond_to(@sc, :arguments=)
+      assert_nothing_raised{ @sc.arguments }
+      assert_nothing_raised{ @sc.arguments = '-v' }
+   end
+    
+   def test_description
+      assert_respond_to(@sc, :description)
+      assert_respond_to(@sc, :description=)
+      assert_nothing_raised{ @sc.description }
+      assert_nothing_raised{ @sc.description = "test link" }
+   end
+  
+   def test_file
+      assert_respond_to(@sc, :file)
+      assert_nothing_raised{ @sc.file }
+   end
+   
+   # TODO: Figure out why hotkey assignment fails here. It works fine in
+   # the example program.
+   #  
+   def test_hotkey
+      assert_respond_to(@sc, :hotkey)
+      assert_respond_to(@sc, :hotkey=)
+      assert_nothing_raised{ @sc.hotkey }
+      #assert_nothing_raised{ @sc.hotkey = "CTRL-SHIFT-F" }
+   end
+   
+   def test_icon_location
+      assert_respond_to(@sc, :icon_location)
+      assert_respond_to(@sc, :icon_location=)
+      assert_nothing_raised{ @sc.icon_location }
+      assert_nothing_raised{ @sc.icon_location = "notepad.exe"}
+   end
+ 
+   def test_path
+      assert_respond_to(@sc, :path)
+      assert_respond_to(@sc, :path=)
+      assert_nothing_raised{ @sc.path }
+      assert_nothing_raised{ @sc.path = 'c:\winnt\notepad.exe' }
+   end
+   
+   def test_open
+      shortcut = Shortcut.new(@link)
+      shortcut.save
+      
+      assert_respond_to(Shortcut, :open)
+      assert_nothing_raised{ Shortcut.open(@link) }
+   end
+   
+   def test_open_expected_errors
+      assert_raise(ArgumentError){ Shortcut.open('bogus') }
+   end   
+
+   def test_resolve
+      assert_respond_to(@sc, :resolve)
+   end
+   
+   def test_save
+      assert_respond_to(@sc, :save)
+      assert_nothing_raised{ @sc.save }
+      assert_equal(true, File.exists?(@link))
+   end
+   
+   def test_window_style
+      assert_respond_to(@sc, :window_style)
+      assert_respond_to(@sc, :window_style=)
+      assert_nothing_raised{ @sc.window_style }
+      assert_nothing_raised{ @sc.window_style = Shortcut::SHOWNORMAL }
+   end
+   
+   def test_working_directory
+      assert_respond_to(@sc, :working_directory)
+      assert_respond_to(@sc, :working_directory=)
+      assert_nothing_raised{ @sc.working_directory }
+      assert_nothing_raised{ @sc.working_directory = "c:\\" }
+   end
+   
+   def test_constants
+      assert_not_nil(Shortcut::SHOWNORMAL)
+      assert_not_nil(Shortcut::SHOWMINNOACTIVE)
+      assert_not_nil(Shortcut::SHOWMAXIMIZED)
+   end
+   
+   def teardown
+      @sc = nil
+      File.delete(@link) if File.exists?(@link)
+   end
+end

data/win32-shortcut.gemspec

@@ -2,14 +2,15 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "win32-shortcut"
-   gem.version     = "0.2.1"
+   gem.version     = "0.2.2"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
+   gem.rubyforge_project = "win32utils"
    gem.platform    = Gem::Platform::RUBY
    gem.summary     = "An interface for creating or modifying Windows shortcuts."
    gem.description = "An interface for creating or modifying Windows shortcuts."
-   gem.test_file   = "test/tc_shortcut.rb"
+   gem.test_file   = "test/test_shortcut.rb"
    gem.has_rdoc    = true
    gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
    gem.files.reject! { |fn| fn.include? "CVS" }

metadata

@@ -1,60 +1,66 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: win32-shortcut
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-07-29 00:00:00 -06:00
-summary: An interface for creating or modifying Windows shortcuts.
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: 
-description: An interface for creating or modifying Windows shortcuts.
-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: 
+  version: 0.2.2
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-10 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: An interface for creating or modifying Windows shortcuts.
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
 files: 
 - lib/win32/shortcut.rb
 - test/CVS
-- test/tc_shortcut.rb
+- test/test_shortcut.rb
 - CHANGES
 - CVS
 - examples
-- ext
 - lib
 - MANIFEST
 - Rakefile
 - README
 - test
 - win32-shortcut.gemspec
-test_files: 
-- test/tc_shortcut.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- CHANGES
-- MANIFEST
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: win32utils
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An interface for creating or modifying Windows shortcuts.
+test_files: 
+- test/test_shortcut.rb

data/test/tc_shortcut.rb

@@ -1,108 +0,0 @@
-##############################################################################
-# tc_shortcut.rb
-#
-# Test suite for the win32-shortcut package.  This will temporarily create
-# a link to Notepad on C:\, which should be automatically deleted.
-# 
-# You should run this test case via the 'rake test' task.
-##############################################################################
-require 'win32/shortcut'
-require 'test/unit'
-include Win32
-
-class TC_Shortcut < Test::Unit::TestCase
-   def setup
-      @link = Dir.pwd + '/test.lnk'
-      @s = Shortcut.new(@link)
-   end
-   
-   def test_version
-      assert_equal('0.2.1', Shortcut::VERSION)
-   end
-  
-   def test_arguments
-      assert_respond_to(@s, :arguments)
-      assert_respond_to(@s, :arguments=)
-      assert_nothing_raised{ @s.arguments }
-      assert_nothing_raised{ @s.arguments = '-v' }
-   end
-    
-   def test_description
-      assert_respond_to(@s, :description)
-      assert_respond_to(@s, :description=)
-      assert_nothing_raised{ @s.description }
-      assert_nothing_raised{ @s.description = "test link" }
-   end
-  
-   def test_file
-      assert_respond_to(@s, :file)
-      assert_nothing_raised{ @s.file }
-   end
-   
-   # TODO: Figure out why hotkey assignment fails here.  It works fine inthe
-   # example program.
-   #  
-   def test_hotkey
-      assert_respond_to(@s, :hotkey)
-      assert_respond_to(@s, :hotkey=)
-      assert_nothing_raised{ @s.hotkey }
-      #assert_nothing_raised{ @s.hotkey = "CTRL-SHIFT-F" }
-   end
-   
-   def test_icon_location
-      assert_respond_to(@s, :icon_location)
-      assert_respond_to(@s, :icon_location=)
-      assert_nothing_raised{ @s.icon_location }
-      assert_nothing_raised{ @s.icon_location = "notepad.exe"}
-   end
- 
-   def test_path
-      assert_respond_to(@s, :path)
-      assert_respond_to(@s, :path=)
-      assert_nothing_raised{ @s.path }
-      assert_nothing_raised{ @s.path = 'c:\winnt\notepad.exe' }
-   end
-   
-   def test_open
-      shortcut = Shortcut.new(@link)
-      shortcut.save
-      
-      assert_respond_to(Shortcut, :open)
-      assert_nothing_raised{ Shortcut.open(@link) }
-   end   
-
-   def test_resolve
-      assert_respond_to(@s, :resolve)
-   end
-   
-   def test_save
-      assert_respond_to(@s, :save)
-      assert_nothing_raised{ @s.save }
-      assert_equal(true, File.exists?(@link))
-   end
-   
-   def test_window_style
-      assert_respond_to(@s, :window_style)
-      assert_respond_to(@s, :window_style=)
-      assert_nothing_raised{ @s.window_style }
-      assert_nothing_raised{ @s.window_style = Shortcut::SHOWNORMAL }
-   end
-   
-   def test_working_directory
-      assert_respond_to(@s, :working_directory)
-      assert_respond_to(@s, :working_directory=)
-      assert_nothing_raised{ @s.working_directory }
-      assert_nothing_raised{ @s.working_directory = "c:\\" }
-   end
-   
-   def test_constants
-      assert_not_nil(Shortcut::SHOWNORMAL)
-      assert_not_nil(Shortcut::SHOWMINNOACTIVE)
-      assert_not_nil(Shortcut::SHOWMAXIMIZED)
-   end
-   
-   def teardown
-      @s = nil
-      File.delete(@link) if File.exists?(@link)
-   end
-end