win-user32-ruby 0.1.1 → 0.1.3

data/README

@@ -1,3 +1,5 @@
-== WinUser32Ruby
+= WinUser32Ruby
 
-win-user32-ruby is a Ruby wrapper for common user32.dll functions. It will provide the foundation for building a Ruby based automated GUI test suite. The goal is for the user of this library to not have to be a Win32 expert in order to script GUIs.
+==0.1.3
+* Fix Window#get_window-rect to prevent it from out of range values when a window's position is negative
+* Reorganized source to avoid namespace conflicts

data/Rakefile

@@ -13,7 +13,7 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'win-user32-ruby'
-  s.version = '0.1.1'
+  s.version = '0.1.3'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README', 'LICENSE']
   s.summary = 'Ruby wrapper for the user32.dll on Windows.'

data/lib/{system_const.rb → user32/system_const.rb}

@@ -3,7 +3,7 @@
 #
 # Constants related to the Win32 API
 
-module WinAPISys
+module WinUser32Ruby
   WM_MOVE = 0x0003
   WM_SIZE = 0x0005
   WM_ACTIVATE = 0x0006

data/lib/{winapisys.rb → user32/user32_system.rb}

@@ -3,7 +3,7 @@
 #
 # System level function for wrapping the Win32API
 
-module WinAPISys
+module WinUser32Ruby
   require 'win32/api'
   include Win32
   # IMPORTANT: Using Win32 requires some special considerations. Native C
@@ -20,7 +20,7 @@ module WinAPISys
   #
   # See rdoc for win32-api
 
-    require 'system_const'
+  require 'user32/system_const'
   # Defines a bunch of constants from windows.h and winuser.h
 
   # Wrap the API call to functions in 'user32.dll' so we don't have to call

data/lib/win-user32-ruby.rb

@@ -3,12 +3,10 @@
 #
 # Functions for simulating window interactions.
 
-require 'winapisys'
+require 'user32/user32_system'
 require 'timeout'
 
 module WinUser32Ruby
-  include WinAPISys
-
   class Window
     TIMEOUT = 10
     @handle = nil
@@ -18,9 +16,8 @@ module WinUser32Ruby
       @handle = hwnd
     end
 
-    def text
+    # =Class Methods
 
-    end
     # Wrapper for +FindWindow+.
     # +title+:: is the title of the window we are trying to find
     # +class_name+: is the predefined registered control-class name, generally not used
@@ -37,8 +34,22 @@ module WinUser32Ruby
       Window.new wnd
     end
 
+    # Wrapper for +GetForegroundWindow+.
+    # *Returns*:: WinUser32Ruby::Window
+    def self.get_foreground_window
+      b = user32 'GetForegroundWindow', 'V', 'L'
+
+      r = b.call
+
+      sleep 0.5
+      r = Window.new(r)
+    end
+
+    # =Instance Methods
+    
     # Wrapper for +FindWindowEx+.
     # +title+:: is the title of the window we are trying to find
+    # +child+:: handle to _child_ from which to start the search
     # +class_name+: is the predefined registered control-class name, generally not used
     # *Return*:: window handle
     def find_window_ex(title, child = 0, class_name = nil)
@@ -56,8 +67,6 @@ module WinUser32Ruby
     end
 
     # Wrapper for +GetTopWindow+.
-    # +title+:: is the title of the window we are trying to find
-    # +class_name+: is the predefined registered control-class name, generally not used
     # *Return*:: window handle
     def get_top_window
       parent = @handle
@@ -68,22 +77,7 @@ module WinUser32Ruby
       Window.new wnd
     end
 
-    # Wrapper for +GetTopWindow+.
-    # +title+:: is the title of the window we are trying to find
-    # +class_name+: is the predefined registered control-class name, generally not used
-    # *Return*:: window handle
-    def self.get_top_window
-      parent = 0
-      fw= user32 'GetTopWindow', 'L', 'L'
-
-      wnd = timeout(TIMEOUT) {sleep 0.2 while (h = fw.call parent) <= 0; h}
-
-      Window.new wnd
-    end
-
     # Wrapper for +GetWindow+.
-    # +hwnd+:: handle to window on which +cmd+ will be called
-    # +cmd+: command to issue to +hwnd+
     # *Return*:: handle to window according to +cmd+
     def get_next_child
       hwnd, cmd = @handle, GW_CHILD
@@ -93,7 +87,6 @@ module WinUser32Ruby
     end
 
     # Wrapper for +WM_GETTEXT+.
-    # +hwnd+:: handle to the window whose text we want
     # *Return*:: window text
     def get_window_text
       hwnd = @handle
@@ -106,7 +99,6 @@ module WinUser32Ruby
 
 
     # Wrapper for +GetWindowRect+.
-    # +hwnd+:: handle the window whose rectangle we are trying to get
     # *Return*:: [left, top, right, bottom]
     def get_window_rect
       hwnd = @handle
@@ -118,14 +110,18 @@ module WinUser32Ruby
 
       left, top, right, bottom = rect.unpack("L*")
 
-      [left, top, right, bottom]
+      [left, top, right, bottom].map{|e| [e].pack('L').unpack('l').first}
     end
 
+    # Gets the coordinates to the center of this window
+    # *Returns*:: <tt>[x, y]</tt>
     def get_center
       r = get_window_rect
       [(r[0] + r[2]) / 2, (r[1] + r[3]) / 2]
     end
 
+    # Centers cursor on this window
+    # *Returns*:: non-zero on success, zero otherwise
     def cursor_center
       set_cursor_pos(*get_center)
     end
@@ -136,7 +132,7 @@ module WinUser32Ruby
     end
 
     # Wrapper for +BringWindowToTop+.
-    # +hwnd+:: handle to window
+    # *Returns*:: non-zero on success, zero otherwise
     def bring_window_to_top
       hwnd = @handle
       b = user32 'BringWindowToTop', 'L', 'I'
@@ -144,8 +140,7 @@ module WinUser32Ruby
     end
 
     # Wrapper for +SetFocus+.
-    # +hwnd+:: handle to window
-    # *Return*:: window handle
+    # *Returns*:: non-zero on success, zero otherwise
     def set_focus
       hwnd = @handle
       b = user32 'SetFocus', 'L', 'L'
@@ -153,8 +148,7 @@ module WinUser32Ruby
     end
 
     # Wrapper for +SetForegroundWindow+.
-    # +hwnd+:: handle to window
-    # *Return*:: true if successful
+    # *Returns*:: non-zero on success, zero otherwise
     def set_foreground_window
       hwnd = @handle
       b = user32 'SetForegroundWindow', 'L', 'I'
@@ -165,18 +159,8 @@ module WinUser32Ruby
       r
     end
 
-    def self.get_foreground_window
-      b = user32 'GetForegroundWindow', 'V', 'L'
-
-      r = b.call
-
-      sleep 0.5
-      r
-    end
-  
     # Wrapper for +ShowWindow+.
-    # +hwnd+:: handle to window
-    # *Return*:: true if successful
+    # *Returns*:: non-zero on success, zero otherwise
     def show_window
       hwnd = @handle
       b = user32 'ShowWindow', 'LI', 'I'
@@ -184,7 +168,7 @@ module WinUser32Ruby
     end
 
     # Helper to Post Message to close window
-    # +hwnd+:: handle to the window to close
+    # *Returns*:: non-zero on success, zero otherwise
     def exit!
       hwnd = @handle
       send_message hwnd, WM_CLOSE, 0, 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win-user32-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jerry Fernholz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 00:00:00 -07:00
+date: 2009-06-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,10 +35,10 @@ files:
 - LICENSE
 - README
 - Rakefile
-- lib/helpers.rb
-- lib/system_const.rb
+- lib/user32
+- lib/user32/system_const.rb
+- lib/user32/user32_system.rb
 - lib/win-user32-ruby.rb
-- lib/winapisys.rb
 has_rdoc: true
 homepage: 
 post_install_message: 

data/lib/helpers.rb

@@ -1,12 +0,0 @@
-class Object
-	protected
-	def current_method
-	  "#{self.class}::#{caller[0][/`([^']*)'/, 1]}"
-	end
-end
-
-class Numeric
-  def to_hex
-    sprintf("0x%x", self)
-  end
-end