win32-shortcut 0.2.0 → 0.2.1

data/CHANGES

@@ -1,44 +1,49 @@
-== 0.2.0 - 30-Oct-2006
-* Replaced the C extension code with a pure Ruby version that uses win32ole
-  and Wscript.Shell behind the scenes.
-* The Shortcut#icon_number method was dropped since that property isn't
-  supported by Wscript.Shell.  It was a useless method anyway.
-* The Shortcut#relative_path method was dropped since that property isn't
-  actually supported by a Wsh.Shortcut object, contrary to what the MSDN
-  documentation says.
-* The Shortcut.new method now takes a block, yields self, and automatically
-  ensures that Shortcut#save is called at the end of the block.
-* The Shortcut#hotkey method now takes a human readable string instead of a
-  hex value.
-* The Shortcut#show_cmd method was renamed Shortcut#window_style (though
-  there's an alias for backwards compatability.
-* The Shortcut#window_style accessor now accepts/emits human readable
-  strings as well as constants.
-* Removed the 'doc' directory.  The documentation is now inlined as rdoc
-  and/or in the README file.
-
-== 0.1.4 - 17-Jul-2005
-* Fixed a bug in the Shortcut.open method.  Thanks go to an anonymous user
-  for the spot.
-* Added a test for the Shortcut.open method.
-* Added a Shortcut.open example in the test script.
-* Modified the extconf.rb script to set _WIN32_WINNT macro as needed.
-
-== 0.1.3 - 9-Jun-2005
-* Removed shortcut.rd file.
-* The shortcut.txt file is now rdoc friendly.
-* Now Unicode friendly.
-* Minor test suite tweaks and additions.
-* Minor changes to the example program.
-* Code cleanup.
-
-== 0.1.2 - 1-Mar-2005
-* Moved the 'examples' directory to the toplevel directory.
-* Renamed the sample script to 'shortcut_test.rb'.
-
-== 0.1.1 - 12-Feb-2005
-* Modified the extconf.rb file to be more cygwin/mingw friendly.
-* Modified some documentation to be more rdoc friendly.
-
-== 0.1.0 - 28-Sep-2004
+== 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.
+* Doc updates.
+
+== 0.2.0 - 30-Oct-2006
+* Replaced the C extension code with a pure Ruby version that uses win32ole
+  and Wscript.Shell behind the scenes.
+* The Shortcut#icon_number method was dropped since that property isn't
+  supported by Wscript.Shell.  It was a useless method anyway.
+* The Shortcut#relative_path method was dropped since that property isn't
+  actually supported by a Wsh.Shortcut object, contrary to what the MSDN
+  documentation says.
+* The Shortcut.new method now takes a block, yields self, and automatically
+  ensures that Shortcut#save is called at the end of the block.
+* The Shortcut#hotkey method now takes a human readable string instead of a
+  hex value.
+* The Shortcut#show_cmd method was renamed Shortcut#window_style (though
+  there's an alias for backwards compatability.
+* The Shortcut#window_style accessor now accepts/emits human readable
+  strings as well as constants.
+* Removed the 'doc' directory.  The documentation is now inlined as rdoc
+  and/or in the README file.
+
+== 0.1.4 - 17-Jul-2005
+* Fixed a bug in the Shortcut.open method.  Thanks go to an anonymous user
+  for the spot.
+* Added a test for the Shortcut.open method.
+* Added a Shortcut.open example in the test script.
+* Modified the extconf.rb script to set _WIN32_WINNT macro as needed.
+
+== 0.1.3 - 9-Jun-2005
+* Removed shortcut.rd file.
+* The shortcut.txt file is now rdoc friendly.
+* Now Unicode friendly.
+* Minor test suite tweaks and additions.
+* Minor changes to the example program.
+* Code cleanup.
+
+== 0.1.2 - 1-Mar-2005
+* Moved the 'examples' directory to the toplevel directory.
+* Renamed the sample script to 'shortcut_test.rb'.
+
+== 0.1.1 - 12-Feb-2005
+* Modified the extconf.rb file to be more cygwin/mingw friendly.
+* Modified some documentation to be more rdoc friendly.
+
+== 0.1.0 - 28-Sep-2004
 * Initial release

data/MANIFEST

@@ -1,11 +1,8 @@
-CHANGES
-MANIFEST
-README
-install.rb
-win32-shortcut.gemspec
-
-examples/example_shortcut.rb
-
-lib/win32/shortcut.rb
-
-test/tc_shortcut.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* win32-shortcut.gemspec
+* examples/example_shortcut.rb
+* lib/win32/shortcut.rb
+* test/tc_shortcut.rb

data/README

@@ -3,14 +3,11 @@
 
 == Requirements
    Ruby 1.8.2 or later.
-   The win32ole package (part of the stdlib).
+   The win32ole package (part of the Ruby stdlib).
 
 == Installation
-=== Gem Installation
-   * ruby win32-shortcut.gemspec
-   * gem install win32-shortcut-x.y.z.gem
-=== Standard Installation
-   * ruby install.rb
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gem)
    
 == Synopsis
 	require 'win32/shortcut'
@@ -39,7 +36,7 @@
    "Feature Request".
 	
 == Copyright
-   (C) 2003-2006, Daniel J. Berger, All Rights Reserved
+   (C) 2003-2007, Daniel J. Berger, All Rights Reserved
     
 == License
    Ruby's
@@ -54,7 +51,7 @@
    Win32::Shortcut Perl module, and I copied some of the documentation as
    well.
    
-   The current version is based on a patch by Jano Svitok.
+   The current version (0.2.0 and later) is based on a patch by Jano Svitok.
 	
 == Author(s)
    Daniel J. Berger   

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the win32-shortcut package (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"
+task :install_gem do
+   ruby 'win32-shortcut.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.libs << 'lib'
+   t.warning = true
+   t.test_files = FileList['test/tc*']
+end

data/lib/win32/shortcut.rb

@@ -1,206 +1,206 @@
-require 'win32ole'
-
-module Win32
-   class Shortcut      
-      VERSION = '0.2.0'
-            
-      # Activates and displays a window. If the window is minimized or maximized,
-      # the system restores it to its original size and position. An application
-      # should specify this flag when displaying the window for the first time.
-      # 
-      SHOWNORMAL = 1
-
-      # Activates the window and displays it as a maximized window.
-      # 
-      SHOWMAXIMIZED = 3
-
-      # Displays the window in its minimized state, leaving the currently active
-      # window as active.
-      # 
-      SHOWMINNOACTIVE = 7
-      
-      # 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
-      # until the Shorcut#save method is called.
-      # 
-      def initialize(file)
-         @file  = file
-         @shell = WIN32OLE.new('WScript.Shell')
-         @link  = @shell.CreateShortcut(file)
-         
-         if block_given?
-            begin
-               yield self
-            ensure
-               save
-            end
-         end
-      end
-      
-      # Identical to Shortcut#new except that it will raise an ArgumentError
-      # unless the +file+ already exists.
-      # 
-      def self.open(file)
-         raise ArgumentError, 'shortcut not found' unless File.exists?(file)
-         self.new(file)
-      end
-      
-      # Returns any arguments (i.e. command line options) for the shortcut.
-      # 
-      def arguments
-         @link.Arguments
-      end
-      
-      # Sets the arguments (i.e. command line options) for the shortcut.
-      # 
-      def arguments=(args)
-         @link.Arguments = args
-      end
-      
-      # Returns the description (i.e. comment) for the shortcut.
-      # 
-      def description
-         @link.Description
-      end
-      
-      # Sets the description for the shortcut.
-      # 
-      def description=(desc)
-         @link.Description = desc
-      end
-      
-      # Returns the file name of the shortcut.
-      # 
-      def file
-         @file
-      end
-      
-      # Returns the hotkey (i.e. shortcut key) associated to the shortcut, in
-      # the form of a 2-byte number of which the first byte identifies the
-      # modifiers (Ctrl, Alt, Shift) and the second is the ASCII code of
-      # the character key.
-      # 
-      def hotkey
-         @link.HotKey
-      end
-      
-      # Sets the hotkey for the shortcut.
-      # 
-      def hotkey=(key)
-         @link.HotKey = key
-      end
-      
-      # Returns the name of the file that contain the icon for the shortcut.
-      # In practice this is almost always blank.  YMMV.
-      # 
-      def icon_location
-         @link.IconLocation
-      end
-      
-      # Sets the name of the icon file to be used for the shortcut.
-      # 
-      def icon_location=(location)
-         @link.IconLocation = location
-      end
-      
-      # Returns the target of the shortcut. This is, joined with arguments, the
-      # content of the "Target" field in a Shortcut Properties Dialog Box. The
-      # target name is returned in 8.3 format.
-      # 
-      def path
-         @link.TargetPath
-      end
-      
-      alias target_path path
-      
-      # Sets the target of the shortcut.
-      # 
-      def path=(link_path)
-         @link.TargetPath = link_path
-      end
-      
-      alias target_path= path=
-      
-      # Attempts to automatically resolve a shortcut and returns the resolved path,
-      # or raises an error.  In case no resolution was made, the path is returned
-      # unchanged.
-      # 
-      # Note that the path is automatically updated in the path attribute of the
-      # Shortcut object.
-      # 
-      def resolve
-         @link.FullName
-      end
-      
-      # Returns the type of window style used by a shortcut.  The possible
-      # return values are 'normal', 'maximized', or 'minimized'.
-      #
-      def window_style
-         case @link.WindowStyle
-            when SHOWNORMAL
-               'normal'
-            when SHOWMAXIMIZED
-               'maximized'
-            when SHOWMINNOACTIVE
-               'minimized'
-            else
-               'unknown' # Should never reach here
-         end
-      end
-      
-      # Deprecated.
-      alias show_cmd window_style
-      
-      # Sets the window style to a shortcut.  The +style+ can be one of the
-      # following three constants or equivalent string values:
-      # 
-      # * SHOWNORMAL      or 'normal'
-      # * SHOWMAXIMIZED   or 'maximized'
-      # * SHOWMINNOACTIVE or 'minimized'
-      # 
-      # Please see the documentation for those constants for further details.
-      # 
-      def window_style=(style)
-         valid = [SHOWNORMAL, SHOWMAXIMIZED, SHOWMINNOACTIVE]
-         valid.concat(['normal', 'maximized', 'minimized'])
-         
-         unless valid.include?(style)
-            raise ArgumentError, 'invalid style'
-         end
-         
-         if style.is_a?(String)
-            case style.downcase
-               when 'normal'
-                  style = SHOWNORMAL
-               when 'maximized'
-                  style = SHOWMAXIMIZED
-               when 'minimized'
-                  style = SHOWMINNOACTIVE
-            end
-         end
-   
-         @link.WindowStyle = style
-      end
-      
-      # Deprecated.
-      alias show_cmd= window_style=
-      
-      # Returns directory in which the targeted program will be executed.
-      # Correspond to the "Start in" field of a Shortcut Properties Dialog Box.
-      # 
-      def working_directory
-         @link.WorkingDirectory
-      end
-      
-      # Sets the directory in which the targeted program will be executed.
-      #
-      def working_directory=(directory)
-         @link.WorkingDirectory = directory
-      end
-      
-      def save
-         @link.Save
-      end
-   end
+require 'win32ole'
+
+module Win32
+   class Shortcut      
+      VERSION = '0.2.1'
+            
+      # Activates and displays a window. If the window is minimized or maximized,
+      # the system restores it to its original size and position. An application
+      # should specify this flag when displaying the window for the first time.
+      # 
+      SHOWNORMAL = 1
+
+      # Activates the window and displays it as a maximized window.
+      # 
+      SHOWMAXIMIZED = 3
+
+      # Displays the window in its minimized state, leaving the currently active
+      # window as active.
+      # 
+      SHOWMINNOACTIVE = 7
+      
+      # 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
+      # until the Shorcut#save method is called.
+      # 
+      def initialize(file)
+         @file  = file
+         @shell = WIN32OLE.new('WScript.Shell')
+         @link  = @shell.CreateShortcut(file)
+         
+         if block_given?
+            begin
+               yield self
+            ensure
+               save
+            end
+         end
+      end
+      
+      # Identical to Shortcut#new except that it will raise an ArgumentError
+      # unless the +file+ already exists.
+      # 
+      def self.open(file)
+         raise ArgumentError, 'shortcut not found' unless File.exists?(file)
+         self.new(file)
+      end
+      
+      # Returns any arguments (i.e. command line options) for the shortcut.
+      # 
+      def arguments
+         @link.Arguments
+      end
+      
+      # Sets the arguments (i.e. command line options) for the shortcut.
+      # 
+      def arguments=(args)
+         @link.Arguments = args
+      end
+      
+      # Returns the description (i.e. comment) for the shortcut.
+      # 
+      def description
+         @link.Description
+      end
+      
+      # Sets the description for the shortcut.
+      # 
+      def description=(desc)
+         @link.Description = desc
+      end
+      
+      # Returns the file name of the shortcut.
+      # 
+      def file
+         @file
+      end
+      
+      # Returns the hotkey (i.e. shortcut key) associated to the shortcut, in
+      # the form of a 2-byte number of which the first byte identifies the
+      # modifiers (Ctrl, Alt, Shift) and the second is the ASCII code of
+      # the character key.
+      # 
+      def hotkey
+         @link.HotKey
+      end
+      
+      # Sets the hotkey for the shortcut.
+      # 
+      def hotkey=(key)
+         @link.HotKey = key
+      end
+      
+      # Returns the name of the file that contain the icon for the shortcut.
+      # In practice this is almost always blank.  YMMV.
+      # 
+      def icon_location
+         @link.IconLocation
+      end
+      
+      # Sets the name of the icon file to be used for the shortcut.
+      # 
+      def icon_location=(location)
+         @link.IconLocation = location
+      end
+      
+      # Returns the target of the shortcut. This is, joined with arguments, the
+      # content of the "Target" field in a Shortcut Properties Dialog Box. The
+      # target name is returned in 8.3 format.
+      # 
+      def path
+         @link.TargetPath
+      end
+      
+      alias target_path path
+      
+      # Sets the target of the shortcut.
+      # 
+      def path=(link_path)
+         @link.TargetPath = link_path
+      end
+      
+      alias target_path= path=
+      
+      # Attempts to automatically resolve a shortcut and returns the resolved path,
+      # or raises an error.  In case no resolution was made, the path is returned
+      # unchanged.
+      # 
+      # Note that the path is automatically updated in the path attribute of the
+      # Shortcut object.
+      # 
+      def resolve
+         @link.FullName
+      end
+      
+      # Returns the type of window style used by a shortcut.  The possible
+      # return values are 'normal', 'maximized', or 'minimized'.
+      #
+      def window_style
+         case @link.WindowStyle
+            when SHOWNORMAL
+               'normal'
+            when SHOWMAXIMIZED
+               'maximized'
+            when SHOWMINNOACTIVE
+               'minimized'
+            else
+               'unknown' # Should never reach here
+         end
+      end
+      
+      # Deprecated.
+      alias show_cmd window_style
+      
+      # Sets the window style to a shortcut.  The +style+ can be one of the
+      # following three constants or equivalent string values:
+      # 
+      # * SHOWNORMAL      or 'normal'
+      # * SHOWMAXIMIZED   or 'maximized'
+      # * SHOWMINNOACTIVE or 'minimized'
+      # 
+      # Please see the documentation for those constants for further details.
+      # 
+      def window_style=(style)
+         valid = [SHOWNORMAL, SHOWMAXIMIZED, SHOWMINNOACTIVE]
+         valid.concat(['normal', 'maximized', 'minimized'])
+         
+         unless valid.include?(style)
+            raise ArgumentError, 'invalid style'
+         end
+         
+         if style.is_a?(String)
+            case style.downcase
+               when 'normal'
+                  style = SHOWNORMAL
+               when 'maximized'
+                  style = SHOWMAXIMIZED
+               when 'minimized'
+                  style = SHOWMINNOACTIVE
+            end
+         end
+   
+         @link.WindowStyle = style
+      end
+      
+      # Deprecated.
+      alias show_cmd= window_style=
+      
+      # Returns directory in which the targeted program will be executed.
+      # Correspond to the "Start in" field of a Shortcut Properties Dialog Box.
+      # 
+      def working_directory
+         @link.WorkingDirectory
+      end
+      
+      # Sets the directory in which the targeted program will be executed.
+      #
+      def working_directory=(directory)
+         @link.WorkingDirectory = directory
+      end
+      
+      def save
+         @link.Save
+      end
+   end
 end

data/test/tc_shortcut.rb

@@ -3,10 +3,9 @@
 #
 # 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.
 ##############################################################################
-Dir.chdir('..') if File.basename(Dir.pwd) == 'test'
-$LOAD_PATH.unshift(Dir.pwd + '/lib')
-
 require 'win32/shortcut'
 require 'test/unit'
 include Win32
@@ -18,7 +17,7 @@ class TC_Shortcut < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal('0.2.0', Shortcut::VERSION)
+      assert_equal('0.2.1', Shortcut::VERSION)
    end
   
    def test_arguments

data/win32-shortcut.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "win32-shortcut"
-   gem.version     = "0.2.0"
+   gem.version     = "0.2.1"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
@@ -14,7 +14,7 @@ spec = Gem::Specification.new do |gem|
    gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
    gem.files.reject! { |fn| fn.include? "CVS" }
    gem.require_path = "lib"
-   gem.extra_rdoc_files = ["README", "CHANGES"]
+   gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
 end
 
 if $0 == __FILE__

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: win32-shortcut
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-10-30 00:00:00 -07:00
+  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
@@ -30,12 +30,15 @@ authors:
 - Daniel J. Berger
 files: 
 - lib/win32/shortcut.rb
+- test/CVS
 - test/tc_shortcut.rb
 - CHANGES
+- CVS
 - examples
-- install.rb
+- ext
 - lib
 - MANIFEST
+- Rakefile
 - README
 - test
 - win32-shortcut.gemspec
@@ -46,6 +49,7 @@ rdoc_options: []
 extra_rdoc_files: 
 - README
 - CHANGES
+- MANIFEST
 executables: []
 
 extensions: []

data/install.rb

@@ -1,11 +0,0 @@
-# For those who don't like gems...
-require 'rbconfig'
-require 'ftools'
-include Config
-
-sitelibdir = CONFIG['sitelibdir']
-installdir = sitelibdir + '/win32'
-file = 'lib\win32\shortcut.rb'
-
-Dir.mkdir(installdir) unless File.exists?(installdir)
-File.copy(file, installdir, true)