win32-shortcut 0.2.3 → 0.2.4

data/CHANGES

@@ -1,3 +1,6 @@
+== 0.2.4 - 18-Mar-2012
+* Refactored and updated the Rakefile and gemspec.
+
 == 0.2.3 - 6-Aug-2009
 * License changed to Artistic 2.0.
 * Some gemspec updates, including license and description.

data/README

@@ -1,60 +1,52 @@
 == Description
-   This is an interface for creating and/or modifying Windows shortcuts.
-
-== Requirements
-   Ruby 1.8.2 or later.
-   The win32ole library (part of the Ruby standard library).
+  This is an interface for creating and/or modifying Windows shortcuts.
 
 == Installation
-   rake test (optional)
-   rake install (non-gem) or rake install_gem (gem)
+  gem install win32-shortcut
    
 == Synopsis
 	require 'win32/shortcut'
-   include Win32
+  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:/'
-   end
+  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
-   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.
+  This code uses win32ole + wscript behind the scenes.
 
 == Known Bugs
-   None known.
+  None known.
 	
-   Please report any bugs on the project page at
-   http://rubyforge.org/projects/win32utils.
+  Please report any bugs on the project page at
+  https://github.com/djberg96/win32-shortcut
 	
 == Future Plans
-   None at this time.
+  None at this time.
    
-   Ideas welcome. Please submit them on the project page as
-   a "Feature Request".
+  Ideas welcome. Please submit them on the project page.
 	
 == Copyright
-   (C) 2003-2008, Daniel J. Berger, All Rights Reserved
+  (C) 2003-2012, Daniel J. Berger, All Rights Reserved
     
 == License
-   Ruby's
+  Artistic 2.0
     
 == Warranty
-   This package is provided "as is" and without any express or
-   implied warranties, including, without limitation, the implied
-   warranties of merchantability and fitness for a particular purpose.
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
 	
 == Acknowledgements
-   The original win32-shortcut package was largely based on Aldo Calpini's
-   Win32::Shortcut Perl module, and I copied some of the documentation as
-   well.
+  The original win32-shortcut package was largely based on Aldo Calpini's
+  Win32::Shortcut Perl module, and I copied some of the documentation as
+  well.
    
-   The current version (0.2.0 and later) 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   
-   Park Heesob
+== Authors
+  Daniel J. Berger   
+  Park Heesob

data/Rakefile

@@ -1,21 +1,27 @@
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
 
-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
+CLEAN.include("**/*.gem")
+
+namespace :gem do
+  desc "Create theh win32-shortcut gem" 
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-shortcut.gemspec'))
+    Gem::Builder.new(spec).build
+  end
 
-desc "Install the win32-shortcut library as a gem"
-task :install_gem do
-   ruby 'win32-shortcut.gemspec'
-   file = Dir["*.gem"].first
-   sh "gem install #{file}"
+  desc "Install the win32-shortcut gem"
+  task :install => [:create] do
+    ruby 'win32-shortcut.gemspec'
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
 end
 
 Rake::TestTask.new do |t|
-   t.warning = true
-   t.verbose = true
+  t.warning = true
+  t.verbose = true
 end
+
+task :default => :test

data/lib/win32/shortcut.rb

@@ -2,225 +2,225 @@ require 'win32ole'
 
 # The Win32 module serves as a namespace only.
 module Win32
-   # The Shortcut class encapsulates an MS Windows shortcut.
-   class Shortcut
-      # The version of this library      
-      VERSION = '0.2.3'
-            
-      # 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.
-      #
-      # 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.tr('/', "\\")
-         @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.tr('/', "\\")
-      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.
-      #--
-      # Forward slashes are converted to backslashes to ensure folder
-      # shortcuts work properly.
-      #
-      def path=(link_path)
-         @link.TargetPath = link_path.tr('/', "\\")
-      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.tr('/', "\\")
+  # The Shortcut class encapsulates an MS Windows shortcut.
+  class Shortcut
+    # The version of this library
+    VERSION = '0.2.4'
+
+    # 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.
+    #
+    # 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.tr('/', "\\")
+      @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.tr('/', "\\")
+    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.
+    #--
+    # Forward slashes are converted to backslashes to ensure folder
+    # shortcuts work properly.
+    #
+    def path=(link_path)
+      @link.TargetPath = link_path.tr('/', "\\")
+    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
-      
-      # Saves (creates) the link object in the current directory.
-      #
-      def save
-         @link.Save
+
+      if style.is_a?(String)
+        case style.downcase
+          when 'normal'
+            style = SHOWNORMAL
+          when 'maximized'
+            style = SHOWMAXIMIZED
+          when 'minimized'
+            style = SHOWMINNOACTIVE
+        end
       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.tr('/', "\\")
+    end
+
+    # Saves (creates) the link object in the current directory.
+    #
+    def save
+      @link.Save
+    end
+  end
 end

data/win32-shortcut.gemspec

@@ -1,25 +1,21 @@
 require 'rubygems'
 
-spec = Gem::Specification.new do |gem|
-   gem.name      = 'win32-shortcut'
-   gem.version   = '0.2.3'
-   gem.author    = 'Daniel J. Berger'
-   gem.license   = 'Artistic 2.0'
-   gem.email     = 'djberg96@gmail.com'
-   gem.homepage  = 'http://www.rubyforge.org/projects/win32utils'
-   gem.platform  = Gem::Platform::RUBY
-   gem.summary   = 'An interface for creating or modifying Windows shortcuts.'
-   gem.test_file = 'test/test_shortcut.rb'
-   gem.has_rdoc  = true
-   gem.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
+Gem::Specification.new do |spec|
+  spec.name      = 'win32-shortcut'
+  spec.version   = '0.2.4'
+  spec.author    = 'Daniel J. Berger'
+  spec.license   = 'Artistic 2.0'
+  spec.email     = 'djberg96@gmail.com'
+  spec.homepage  = 'http://www.rubyforge.org/projects/win32utils'
+  spec.summary   = 'An interface for creating or modifying Windows shortcuts.'
+  spec.test_file = 'test/test_shortcut.rb'
+  spec.files     = Dir['**/*'].reject{ |f| f.include?('git') }
 
-   gem.rubyforge_project = 'win32utils'
-   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+  spec.rubyforge_project = 'win32utils'
+  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
 
-   gem.description = <<-EOF
-      The win32-shortcut library provides an interface for creating new
-      Windows shortcuts or querying information about existing shortcuts.
-   EOF
+  spec.description = <<-EOF
+    The win32-shortcut library provides an interface for creating new
+    Windows shortcuts or querying information about existing shortcuts.
+  EOF
 end
-
-Gem::Builder.new(spec).build

metadata

@@ -1,29 +1,26 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: win32-shortcut
-version: !ruby/object:Gem::Version 
-  version: 0.2.3
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-08-06 00:00:00 -06:00
-default_executable: 
+date: 2012-03-18 00:00:00.000000000 Z
 dependencies: []
-
-description: "      The win32-shortcut library provides an interface for creating new\n      Windows shortcuts or querying information about existing shortcuts.\n"
+description: ! "    The win32-shortcut library provides an interface for creating
+  new\n    Windows shortcuts or querying information about existing shortcuts.\n"
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - CHANGES
 - MANIFEST
-files: 
+files:
 - CHANGES
 - examples/example_shortcut.rb
 - lib/win32/shortcut.rb
@@ -32,33 +29,30 @@ files:
 - README
 - test/test_shortcut.rb
 - win32-shortcut.gemspec
-has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
-licenses: 
+licenses:
 - Artistic 2.0
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: win32utils
-rubygems_version: 1.3.4
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: An interface for creating or modifying Windows shortcuts.
-test_files: 
+test_files:
 - test/test_shortcut.rb