win_gui 0.2.3 → 0.2.5

data/HISTORY

@@ -17,3 +17,11 @@
 == 0.2.3 / 2010-06-03
 
 * Minor cleanup/refactoring
+
+== 0.2.4 / 2010-06-03
+
+* Unified interface for Window.top_level and Window#child
+
+== 0.2.5 / 2010-06-04
+
+* Code brought to about Book-level quality

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.5

data/lib/win_gui/window.rb

@@ -2,75 +2,75 @@ module WinGui
 
   # This class is a wrapper around window handle
   class Window
-    # Make convenience methods from both WinGui and Win::Gui available as both class and instance methods
-    # Looks a bit circular though...
-#    include WinGui
-#    extend WinGui
 
     def initialize(handle)
       @handle = handle
+#      puts "Window #{handle} created "
+#      p self.class.ancestors
     end
 
     attr_reader :handle
 
-    # Finds top level window by title/class, returns wrapped Window object or nil.
-    # If timeout option given, waits for window to appear within timeout, returns nil if it didn't
-    # Options:
-    # :title:: window title
-    # :class:: window class
-    # :timeout:: timeout (seconds)
-    def self.top_level(opts={})
-      window_title = opts[:title]
-      window_class = opts[:class]
-      timeout = opts[:timeout] # || LOOKUP_TIMEOUT ? # no timeout by default
-
-      if timeout
+    # Looks up window handle using code specified in attached block (either with or without :timeout)
+    # Returns either Window instance (for a found handle) or nil if nothing found
+    # Private method to dry up other window lookup methods
+    # :yields:
+    #
+    def self.lookup_window(opts)
+      # Need this to avoid handle considered local in begin..end block
+      handle = yield
+      if opts[:timeout]
         begin
-          timeout(timeout) do
-            sleep SLEEP_DELAY while (@handle = WinGui.find_window window_class, window_title) == nil
+          timeout(opts[:timeout]) do
+            sleep SLEEP_DELAY until handle = yield
           end
         rescue TimeoutError
           nil
         end
-      else
-        @handle = WinGui.find_window window_class, window_title
       end
-      Window.new(@handle) if @handle
+      raise opts[:raise] if opts[:raise] && !handle
+      Window.new(handle) if handle
     end
 
-    # find child window (control) by title, window class, or control ID:
-    def child(id)
-      result = case id
-        when String
-          by_title = find_window_ex 0, nil, id.gsub('_', '&' )
-          by_class = find_window_ex 0, id, nil
-          by_title ? by_title : by_class
-        when Fixnum
-          get_dlg_item id
-        when nil
-          find_window_ex 0, nil, nil
-        else
-          nil
+    # Find top level window by title/class, returns wrapped Window object or nil.
+    # If timeout option given, waits for window to appear within timeout, returns nil if it didn't
+    # Options:
+    # :title:: window title
+    # :class:: window class
+    # :timeout:: timeout (seconds)
+    def self.top_level(opts={})
+      lookup_window(opts) { WinGui.find_window opts[:class], opts[:title] }
+    end
+
+    # Find DIRECT child window (control) by either control ID or window class/title.
+    def child(opts={})
+      self.class.lookup_window(opts) do
+        opts[:id] ? get_dlg_item(opts[:id]) : find_window_ex(0, opts[:class], opts[:title])
       end
-      raise "Control '#{id}' not found" unless result
-      Window.new result
     end
 
-    # returns array of Windows that are descendants (not only DIRECT children) of a given Window
+    # Return array of Windows that are descendants (not only DIRECT children) of a given Window
     def children
       enum_child_windows.map{|child_handle| Window.new child_handle}
     end
 
-    # emulate click of the control identified by id
-    def click(id)
-      left, top, right, bottom = child(id).get_window_rect
-      center = [(left + right) / 2, (top + bottom) / 2]
-      WinGui.set_cursor_pos *center
-      WinGui.mouse_event WinGui::MOUSEEVENTF_LEFTDOWN, 0, 0, 0, 0
-      WinGui.mouse_event WinGui::MOUSEEVENTF_LEFTUP, 0, 0, 0, 0
+    # Emulate click of the control identified by opts (:id, :title, :class)
+    # Return true if click was presumably successful, false if it failed (control was not found)
+    def click(opts={})
+      control = child(opts)
+      if control
+        left, top, right, bottom = control.get_window_rect
+        center = [(left + right) / 2, (top + bottom) / 2]
+        WinGui.set_cursor_pos *center
+        WinGui.mouse_event WinGui::MOUSEEVENTF_LEFTDOWN, 0, 0, 0, 0
+        WinGui.mouse_event WinGui::MOUSEEVENTF_LEFTUP, 0, 0, 0, 0
+        true
+      else
+        false
+      end
     end
 
-    def wait_for_close(timeout =CLOSE_TIMEOUT )
+    def wait_for_close(timeout=CLOSE_TIMEOUT )
       timeout(timeout) do
         sleep SLEEP_DELAY while window_visible?
       end
@@ -97,7 +97,8 @@ module WinGui
     #   WinGui.function(*args)
     def method_missing(name, *args, &block)
       if WinGui.respond_to? name
-         WinGui.send(name, @handle, *args, &block)
+#        puts "Window #{@handle} calling: #{name} #{@handle} #{args} &#{block}"
+        WinGui.send(name, @handle, *args, &block)
       else
         super
       end

data/lib/win_gui.rb

@@ -1,5 +1,5 @@
-require 'version'
-require 'extension'
+require_relative 'version'
+require_relative 'extension'
 
 module WinGui
 

data/spec/spec_helper.rb

@@ -75,7 +75,10 @@ module WinGuiTest
     while @test_app && find_window(nil, WIN_TITLE)
       @test_app.close
       # Dealing with closing confirmation modal dialog
-      keystroke("N") if Window.top_level( title: "Steganos Locknote", timeout: SLEEP_DELAY*5)
+      if dialog = dialog( title: "Steganos Locknote", timeout: SLEEP_DELAY)
+        dialog.set_foreground_window
+        keystroke("N")
+      end
     end
     @test_app = nil
   end
@@ -87,4 +90,22 @@ module WinGuiTest
     close_test_app
   end
 
+  def with_dialog(type=:close)
+    case type
+      when :close
+        keystroke('A')
+        @app.close
+        title, key = "Steganos Locknote", "N"
+      when :save
+        keystroke(VK_ALT, 'F', 'A')
+        title, key = "Save As", VK_ESCAPE
+    end
+    sleep 0.01 until dialog = Window.top_level(title: title)
+    yield dialog
+    while dialog.window?
+      dialog.set_foreground_window
+      keystroke(key)
+      sleep 0.01
+    end
+  end
 end

data/spec/win_gui/convenience_spec.rb

@@ -7,38 +7,43 @@ module WinGuiTest
     after(:each) { close_test_app }
 
     describe '#dialog' do
-      # Open "Save as" modal dialog
-      before(:each){ keystroke(VK_ALT, 'F', 'A') }
-      # Close modal dialog if it is opened
-      after(:each) { keystroke(VK_ESCAPE) if Window.top_level( title: "Save As", timeout: 0.1) }
-
       it 'returns top-level dialog window with given title if no block attached' do
-        dialog_window = dialog(title: DIALOG_TITLE, timeout: 0.1)
-        dialog_window.should_not == nil
-        dialog_window.should be_a Window
-        dialog_window.text.should == DIALOG_TITLE
-      end
-
-      it 'yields found dialog window to block if block is attached' do
-        dialog(title: DIALOG_TITLE) do |dialog_window|
+        with_dialog(:save) do
+          dialog_window = dialog(title: DIALOG_TITLE, timeout: 0.1)
           dialog_window.should_not == nil
           dialog_window.should be_a Window
           dialog_window.text.should == DIALOG_TITLE
         end
       end
 
+      it 'yields found dialog window to block if block is attached' do
+        with_dialog(:save) do
+          dialog(title: DIALOG_TITLE) do |dialog_window|
+            dialog_window.should_not == nil
+            dialog_window.should be_a Window
+            dialog_window.text.should == DIALOG_TITLE
+          end
+        end
+      end
+
       it 'returns nil if there is no dialog with given title' do
-        dialog(title: IMPOSSIBLE, timeout: 0.1).should == nil
+        with_dialog(:save) do
+          dialog(title: IMPOSSIBLE, timeout: 0.1).should == nil
+        end
       end
 
       it 'yields nil to attached block if no dialog found' do
-        dialog(title: IMPOSSIBLE, timeout: 0.1) do |dialog_window|
-          dialog_window.should == nil
+        with_dialog(:save) do
+          dialog(title: IMPOSSIBLE, timeout: 0.1) do |dialog_window|
+            dialog_window.should == nil
+          end
         end
       end
 
       it 'considers all arguments optional' do
-        use { dialog_window = dialog() }
+        with_dialog(:save) do
+          use { dialog_window = dialog() }
+        end
       end
     end # describe dialog
 
@@ -64,6 +69,5 @@ module WinGuiTest
       end # describe '#type_in'
 
     end # Input methods
-
-  end
+  end # Convenience methods
 end

data/spec/win_gui/window_spec.rb

@@ -85,35 +85,75 @@ module WinGuiTest
         Window.top_level( title: IMPOSSIBLE, timeout: 0.5).should == nil
         (Time.now - start).should be_close 0.5, 0.02
       end
-    end
+
+      it 'raises exception if asked to' do
+        expect{ Window.top_level( title: IMPOSSIBLE, raise: "Horror!")}.to raise_error "Horror!"
+      end
+    end # describe .top_level
 
     describe '#child' do
-      spec { use { @control = @app.child(title_class_id = nil)  }}
+      spec { use { @child = @app.child(title: "Title", class: "Class", id: 0)  }}
 
-      it 'finds any child window(control) if given nil' do
-        @app.child(nil).should_not == nil
+      it 'returns nil immediately if specific child not found' do
+        start = Time.now
+        @app.child( title: IMPOSSIBLE).should == nil
+        (Time.now - start).should be_close 0, 0.02
       end
 
-      it 'finds child window(control) by class' do
-        @app.child(TEXTAREA_CLASS).should_not == nil
+      it 'returns nil after timeout if specific child not found' do
+        start = Time.now
+        @app.child( title: IMPOSSIBLE, timeout: 0.5).should == nil
+        (Time.now - start).should be_close 0.5, 0.02
       end
 
-      it 'finds child window(control) by name' do
-        pending 'Need to find control with short name'
-        @app.child(TEXTAREA_TEXT).should_not == nil
+      it 'finds ANY child window without args' do
+        use { @child = @app.child() }
+        @child.should_not == nil
+        @app.child?(@child.handle).should == true
       end
 
-      it 'finds child window(control) by control ID' do
-        pending 'Need to find some control ID'
-        @app.child(TEXTAREA_ID).should_not == nil
+      it 'finds child window by class and returns it as a Window object (no timeout)' do
+        child = @app.child( class: TEXTAREA_CLASS)
+        child.should_not == nil
+        @app.child?(child.handle).should == true
       end
 
-      it 'raises error if wrong control is given' do
-        expect { @app.child('Impossible Control')}.to raise_error "Control 'Impossible Control' not found"
+      it 'finds child window by class and returns it as a Window object (with timeout)' do
+#        p @app.find_window_ex(0, TEXTAREA_CLASS, nil)
+#        p @app.find_window_ex(0, STATUSBAR_CLASS, nil)
+        child = @app.child( class: TEXTAREA_CLASS, timeout: 0.5)
+        child.should_not == nil
+
+        @app.child?(child.handle).should == true
+        child = @app.child( class: STATUSBAR_CLASS, timeout: 0.5)
+        child.should_not == nil
+        @app.child?(child.handle).should == true
       end
 
-      it 'substitutes & for _ when searching by title ("&Yes" type controls)' # Why?
-    end
+      it 'finds child with specific text and returns it as a Window object' do
+        with_dialog(:save) do |dialog|
+#          @dialog.children.each{|child| puts "#{child.handle}, #{child.class_name}, #{child.window_text}"}
+          child = dialog.child( title: "Cancel")
+          child.should_not == nil
+          dialog.child?(child.handle).should == true
+          child.get_dlg_ctrl_id.should == IDCANCEL
+
+          child = dialog.child( title: "&Save")
+          child.should_not == nil
+          dialog.child?(child.handle).should == true
+          child.get_dlg_ctrl_id.should == IDOK
+        end
+      end
+
+      it 'finds child control with a given ID and returns it as a Window object' do
+        with_dialog(:save) do |dialog|
+          child = dialog.child( id: IDCANCEL)
+          child.should_not == nil
+          dialog.child?(child.handle).should == true
+          child.text.should == "Cancel"
+        end
+      end
+    end # describe child
 
     describe '#children' do
       spec { use { children = @app.children  }}
@@ -126,26 +166,33 @@ module WinGuiTest
         children.each{|child| child?(@app.handle, child.handle).should == true }
         children.last.class_name.should == TEXTAREA_CLASS
       end
+    end # describe #children
 
-#      it 'finds child window(control) by name' do
-#        pending 'Need to find control with short name'
-#        @app.child(TEXTAREA_TEXT).should_not == nil
-#      end
-#
-#      it 'finds child window(control) by control ID' do
-#        pending 'Need to find some control ID'
-#        @app.child(TEXTAREA_ID).should_not == nil
-#      end
-#
-#      it 'raises error if wrong control is given' do
-#        expect { @app.child('Impossible Control')}.to raise_error "Control 'Impossible Control' not found"
-#      end
-#      it 'substitutes & for _ when searching by title ("&Yes" type controls)'
+    describe '#click' do
+      it 'emulates clicking of the control identified by id, returns true' do
+        with_dialog(:save) do |dialog|
+          dialog.click(id: IDCANCEL).should == true
+          sleep 0.5
+          dialog.window?.should == false
+        end
+      end
 
-    end
+      it 'emulates clicking of the control identified by title, returns true' do
+        with_dialog(:save) do |dialog|
+          dialog.click(title: "Cancel").should == true
+          sleep 0.5
+          dialog.window?.should == false
+        end
+      end
 
-    context '#click' do
-      it 'emulates clicking of the control identified by id'
-    end
+      it 'returns false if the specified control was not found' do
+        with_dialog(:save) do |dialog|
+          dialog.click(title: "Shpancel").should == false
+          dialog.click(id: 66).should == false
+          sleep 0.5
+          dialog.window?.should == true
+        end
+      end
+    end # describe #click
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - arvicco
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 +04:00
+date: 2010-06-04 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency