windows-api 0.2.3 → 0.2.4

data/CHANGES

@@ -1,3 +1,14 @@
+= 0.2.4 - 18-Jul-2008
+* Eliminated unnecessary LoadLibrary() attempts for functions that explicitly
+  end with an 'A' or 'W', and all MSVCRT functions, since they have no 'A'
+  or 'W' equivalent.
+* Replaced all of the attr_reader's with a delegation scheme using Forwardable.
+  All Win32::API functions now delegate to the internally stored Win32::API
+  object instead of reimplementing them. This change also fixed a bug where
+  the effective_function_name method did not work properly.
+* Added more tests, and fixed one assertion that was wrong (the prototype).
+* Some documentation additions.
+
 = 0.2.3 - 26-Apr-2008
 * Improved API.auto_constant and API.auto_method handling for functions that
   start with a lower case character or an underscore.
@@ -19,4 +30,4 @@
 * Fixed a void parameter bug.
 
 = 0.1.0 - 24-May-2007
-* Initial release
+* Initial release

data/MANIFEST

@@ -4,4 +4,4 @@
 * Rakefile
 * windows-api.gemspec
 * lib/windows/api.rb
-* test/tc_windows_api.rb
+* test/test_windows_api.rb

data/Rakefile

@@ -20,8 +20,6 @@ task :install_gem do
 end
 
 Rake::TestTask.new do |test|
-   test.libs << 'lib'
    test.warning = true
    test.verbose = true
-   test.test_files = FileList['test/tc*']
 end

data/lib/windows/api.rb

@@ -1,8 +1,11 @@
 require 'win32/api'
 require 'rbconfig'
+require 'forwardable'
 include Config
 
+# The Windows module serves as a namespace only
 module Windows
+
    # With Microsoft Visual C++ 8 and later users should use the associated
    # DLL instead of msvcrt directly, if possible.
    if CONFIG['host_os'].split('_')[1]
@@ -17,13 +20,23 @@ module Windows
       MSVCRT_DLL = 'msvcrt'
    end
 
+   # Wrapper around the Win32::API class
    class API
-      VERSION = '0.2.3'
+      extend Forwardable
+
+      # The version of this library
+      VERSION = '0.2.4'
       
+      # Error typically raised if any of the Windows::API methods fail
       class Error < RuntimeError; end
+
+      # The methods from Win32::API are delegated to the appropriate object
+      def_delegators(:@api, :function_name, :dll_name, :prototype)
+      def_delegators(:@api, :return_type, :effective_function_name)
       
       private
       
+      # Verbose data types that can be used instead of single letters
       DATA_TYPES = {
          'ATOM'         => 'I',
          'BOOL'         => 'B',
@@ -275,11 +288,7 @@ module Windows
          @auto_unicode = bool
       end
 
-      attr_reader :function_name
-      attr_reader :dll_name
-      attr_reader :prototype
-      attr_reader :return_type
-      
+
       # call-seq:
       #    API.new(func, proto='V', rtype='L', dll='kernel32')
       # 
@@ -335,20 +344,24 @@ module Windows
          api_w = nil
          
          # If the auto_unicode option is set, and the func is not already
-         # an explicit ANSI or Unicode function name, generate Win32::API
+         # an explicit ANSI or Wide function name, generate Win32::API
          # objects for those functions as well. Ignore errors because not
-         # all functions have explicit ANSI or Unicode equivalents.
+         # all functions have explicit ANSI or Wide character implementations.
+         #
+         # This entire bit of logic is skipped if the DLL is msvcrt, since
+         # msvcrt functions never have explicit ANSI or Wide character
+         # versions.
          # 
-         if Windows::API.auto_unicode
+         if Windows::API.auto_unicode && dll.downcase != 'msvcrt'
             begin
-               if func[-1].chr != 'A'
+               unless ['A', 'W'].include?(func[-1].chr)
                   api_a = Win32::API.new("#{func}A", proto, rtype, dll)
                end
             rescue RuntimeError
             end
-         
+
             begin
-               if func[-1].chr != 'W'
+               unless ['W', 'A'].include?(func[-1].chr)
                   api_w = Win32::API.new("#{func}W", proto, rtype, dll)
                end
             rescue RuntimeError
@@ -478,7 +491,7 @@ module Windows
       def call(*args)
          @api.call(*args)
       end
-      
+
       private
       
       # Get a module's namespace. This is basically the equivalent of

data/test/{tc_windows_api.rb → test_windows_api.rb}

@@ -1,5 +1,5 @@
 ############################################################################
-# tc_windows_api.rb
+# test_windows_api.rb
 # 
 # Test case for the Windows::API class. You should run this as Rake task,
 # i.e. 'rake test', instead of running it directly.
@@ -36,11 +36,11 @@ module Windows
       API.auto_namespace = 'Windows::Baz'
       API.auto_constant  = true
       API.auto_method    = true
-      API.auto_unicode   = false
 
-      API.new('strstr', 'PP', 'P', 'msvcrt')
-      API.new('_umask', 'I', 'I', 'msvcrt')
-      API.new('waveOutGetNumDevs', 'V', 'I', 'winmm')
+      $strstr = API.new('strstr', 'PP', 'P', 'msvcrt')
+      $umask  = API.new('_umask', 'I', 'I', 'msvcrt')
+      $wave   = API.new('waveOutGetNumDevs', 'V', 'I', 'winmm')
+      $read   = API.new('ReadDirectoryChangesW', 'LPLILPPP', 'B') # No ANSI equivalent
    end
 end
 
@@ -55,7 +55,7 @@ class TC_Windows_API < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.3', API::VERSION)
+      assert_equal('0.2.4', API::VERSION)
    end
    
    def test_full_data_types
@@ -75,6 +75,12 @@ class TC_Windows_API < Test::Unit::TestCase
       assert_not_nil(Windows::Baz::WaveOutGetNumDevs)
    end
 
+   def test_explicit_wide_function_only
+      assert_not_nil(Windows::Baz::ReadDirectoryChangesW)
+      assert_equal(false, Windows::Baz.constants.include?('ReadDirectoryChanges'))
+      assert_equal(false, Windows::Baz.constants.include?('ReadDirectoryChangesA'))
+   end
+
    def test_lower_case_auto_methods
       assert_respond_to(self, :strstr)
       assert_respond_to(self, :umask)
@@ -126,13 +132,21 @@ class TC_Windows_API < Test::Unit::TestCase
    
    def test_prototype
       assert_respond_to($test_method, :prototype)
-      assert_equal('PP', $test_method.prototype)
+      assert_equal(['P', 'P'], $test_method.prototype)
    end
    
    def test_return_type
       assert_respond_to($test_method, :return_type)
       assert_equal('L', $test_method.return_type)
    end
+
+   def test_effective_function_name
+      assert_respond_to($test_method, :effective_function_name)
+      assert_equal('GetCurrentDirectoryA', $test_method.effective_function_name)
+      assert_equal('strstr', $strstr.effective_function_name)
+      assert_equal('waveOutGetNumDevs', $wave.effective_function_name)
+      assert_equal('ReadDirectoryChangesW', $read.effective_function_name)
+   end
    
    def teardown
       @buf = nil

data/windows-api.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "windows-api"
-   gem.version     = "0.2.3"
+   gem.version     = "0.2.4"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
@@ -10,7 +10,7 @@ spec = Gem::Specification.new do |gem|
    gem.platform    = Gem::Platform::RUBY
    gem.summary     = "An easier way to create methods using Win32API"
    gem.description = "An easier way to create methods using Win32API"
-   gem.test_file   = "test/tc_windows_api.rb"
+   gem.test_file   = "test/test_windows_api.rb"
    gem.has_rdoc    = true
    gem.files       = Dir["lib/windows/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
    gem.files.reject! { |fn| fn.include? "CVS" }

data/windows-api.gemspec~

@@ -0,0 +1,25 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |gem|
+   gem.name        = "windows-api"
+   gem.version     = "0.2.4"
+   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 easier way to create methods using Win32API"
+   gem.description = "An easier way to create methods using Win32API"
+   gem.test_file   = "test/tc_windows_api.rb"
+   gem.has_rdoc    = true
+   gem.files       = Dir["lib/windows/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
+   gem.files.reject! { |fn| fn.include? "CVS" }
+   gem.require_path = "lib"
+   gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
+   gem.add_dependency("win32-api", ">= 1.0.5")
+end
+
+if $0 == __FILE__
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: windows-api
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-26 00:00:00 -06:00
+date: 2008-07-19 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: win32-api
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -34,7 +35,7 @@ extra_rdoc_files:
 files: 
 - lib/windows/api.rb
 - test/CVS
-- test/tc_windows_api.rb
+- test/test_windows_api.rb
 - CHANGES
 - CVS
 - lib
@@ -43,6 +44,7 @@ files:
 - README
 - test
 - windows-api.gemspec
+- windows-api.gemspec~
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
 post_install_message: 
@@ -65,9 +67,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: An easier way to create methods using Win32API
 test_files: 
-- test/tc_windows_api.rb
+- test/test_windows_api.rb