win_gui 0.2.10 → 0.2.12

data/HISTORY

@@ -45,3 +45,11 @@
 == 0.2.10 / 2010-06-04
 
 * Window#child now searches all descendant windows with :indirect option
+
+== 0.2.11 / 2010-06-18
+
+* App::find/launch operational
+
+== 0.2.12 / 2010-06-18
+
+* Test_app class changed to App from Window

data/VERSION

@@ -1 +1 @@
-0.2.10
+0.2.12

data/lib/win_gui/application.rb

@@ -0,0 +1,82 @@
+module WinGui
+
+  # This class is a wrapper around Windows App
+  class App
+    LAUNCH_TIMEOUT = 0.2
+
+    attr_accessor :main_window # Main App window (top level)
+
+    def initialize(window_or_handle)
+      @main_window = case window_or_handle
+        when Window
+          window_or_handle
+        when Integer
+          Window.new window_or_handle
+        else
+          raise WinGui::Errors::InitError, "Unable to create App from #{window_or_handle.inspect}"
+      end
+    end
+
+    def close
+      @main_window.close
+    end
+    alias_method :exit, :close
+
+    class << self
+      # Finds already launched Application. Either title or class for main window is obligatory.
+      # Returns nil if no such Application found.
+      # Options:
+      # :title:: main window title
+      # :class:: main window class
+      # :timeout:: timeout (seconds) finding main window
+      # :raise:: raise this exception instead of returning nil if nothing found
+      #
+      def find(opts)
+        main_window = Window.top_level(opts)
+#        raise WinGui::Errors::InitError, "Unable to find App with #{opts.inspect}" unless main_window
+        main_window ? new(main_window) : nil
+      end
+
+      # Launch new Application. Expects executable path and options to find main Window.
+      # Options:
+      # :path/:app_path:: path to App's executable file
+      # :dir/:cd:: change to this dir before launching App
+      # :title:: main window title
+      # :class:: main window class
+      # :timeout:: timeout (seconds) finding main window
+      # :raise:: raise this exception instead of returning nil if launched app window not found
+      #
+      def launch(opts)
+        app_path = opts.delete(:path) || opts.delete(:app_path)
+        dir_path = opts.delete(:dir) || opts.delete(:cd)
+
+        launch_app app_path, dir_path
+
+        defaults = {timeout: LAUNCH_TIMEOUT,
+                    raise: WinGui::Errors::InitError.new("Unable to launch App with #{opts.inspect}")}
+        find(defaults.merge opts)
+      end
+
+      private
+      
+      def cygwin?
+        RUBY_PLATFORM =~ /cygwin/
+      end
+
+      def launch_app(app_path, dir_path)
+
+        raise WinGui::Errors::InitError, "Unable to launch #{app_path.inspect}" unless File.exists? app_path.to_s
+        command = cygwin? ? "cmd /c start `cygpath -w #{app_path}`" : "start #{app_path.to_s.gsub(/\//, "\\")}"
+
+        if dir_path
+          raise WinGui::Errors::InitError, "Unable to change to #{dir_path.inspect}" unless File.exists? dir_path.to_s
+          command = "cd #{cygwin? ? dir_path : dir_path.to_s.gsub(/\//, "\\")} && #{command}"
+        end
+
+        # Launch App in a separate window
+        system command  # TODO: make sure only valid commands are fed into system
+      end
+
+    end
+  end
+end

data/lib/win_gui/convenience.rb

@@ -25,7 +25,7 @@ module WinGui
 
   # Finds top-level dialog window by title and yields found dialog window to attached block.
   # We work with dialog window in a block, and then we wait for it to close before proceeding.
-  # That is, unless your block returns nil, in which case dialog is ignored and method immediately returns nil.
+  # That is, unless your block returns nil, in which case dialog is ignored (and method immediately returns nil?).
   # If no block is given, method just returns found dialog window (or nil if dialog is not found).
   # Options:
   # :title:: dialog title

data/lib/win_gui/window.rb

@@ -41,7 +41,8 @@ module WinGui
       lookup_window(opts) { WinGui.find_window opts[:class], opts[:title] }
     end
 
-    # Finds DIRECT child window (control) by either control ID or window class/title.
+    # Finds child window (control) by either control ID or window class/title.
+    # By default, only direct children are searched.
     # Options:
     # :id:: integer control id (such as IDOK, IDCANCEL, etc)
     # :title:: window title
@@ -158,13 +159,13 @@ module WinGui
     #   window.visible?
     # This API is much more Ruby-like compared to:
     #   visible?(window.handle)
-    # Of course, if we unvoke WinGui function that DOESN'T accept handle as a first arg this way, we are screwed.
+    # Of course, if we invoke WinGui function that DOESN'T accept handle as a first arg this way, we are screwed.
     # Call such functions only like this:
     #   WinGui.function(*args)
     # TODO: Such setup is problematic if WinGui is included into Window ancestor chain.
-    # TODO: in this case, all WinGui functions become available as instance methods, and method_missing never fires.
-    # TODO: it may be a better solution to explicitly define all needed instance methods.
-    # TODO: instead of showing off cool meta-programming skillz.
+    # TODO: In this case, all WinGui functions become available as instance methods, and method_missing never fires.
+    # TODO: It may be a better solution to explicitly define all needed instance methods,
+    # TODO: instead of showing off cool meta-programming skillz. ;-)
     #
     def method_missing(name, *args, &block)
       if WinGui.respond_to? name

data/lib/win_gui.rb

@@ -18,6 +18,11 @@ module WinGui
       Pathname.glob(name.to_s).sort.each {|rb| require rb}
     end
   end
+
+  module Errors                             # :nodoc:
+    class InitError < RuntimeError          # :nodoc:
+    end
+  end
 end  # module WinGui
 
 # Require all ruby source files located under directory lib/win_gui

data/spec/spec_helper.rb

@@ -30,14 +30,9 @@ module WinGuiTest
   KEY_DELAY = 0.001
   SLEEP_DELAY = 0.01
   APP_PATH = File.join(File.dirname(__FILE__), "../misc/locknote/LockNote.exe" )
-  APP_START = RUBY_PLATFORM =~ /cygwin/ ? "cmd /c start `cygpath -w #{APP_PATH}`" : "start #{APP_PATH}"
-  #          'start "" "' + APP_PATH + '"'
   DIALOG_TITLE = "Save As"
   WIN_TITLE = 'LockNote - Steganos LockNote'
   WIN_CLASS = 'ATL:00434098'
-  WIN_RECT = [710, 400, 1210, 800]
-  MAX_RECT = [-4, -4, 1924, 1204]  # on my 1920x1200 display
-  MIN_RECT = [-32000, -32000, -31840, -31976]
   TEXTAREA_CLASS = 'ATL:00434310'
   STATUSBAR_CLASS = 'msctls_statusbar32'
   IMPOSSIBLE = 'Impossible'
@@ -61,18 +56,12 @@ module WinGuiTest
   end
 
   def launch_test_app
-    system APP_START
-    @test_app = Window.top_level( title: WIN_TITLE, timeout: 10)
-
-    def @test_app.textarea #define singleton method retrieving app's text area
-      Window.new WinGui::find_window_ex(self.handle, 0, TEXTAREA_CLASS, nil)
-    end
-
-    @test_app
+    #system APP_START
+    @test_app = App.launch( path: APP_PATH, title: WIN_TITLE, timeout: 1)
   end
 
   def close_test_app
-    while @test_app && find_window(nil, WIN_TITLE)
+      while @test_app && @test_app.main_window.window?
       @test_app.close
       # Dealing with closing confirmation modal dialog
       if dialog = dialog( title: "Steganos Locknote", timeout: SLEEP_DELAY)
@@ -85,8 +74,7 @@ module WinGuiTest
 
   # Creates test app object and yields it back to the block
   def test_app
-    test_app = launch_test_app
-    yield test_app
+    yield launch_test_app
     close_test_app
   end
 

data/spec/win_gui/application_spec.rb

@@ -0,0 +1,105 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper" )
+
+module WinGuiTest
+
+  describe App do
+    after(:each) do     # Reliably closes launched app window (without calling close_test_app)
+      app = App.find(title: WIN_TITLE)
+      app.exit if app
+    end
+
+    context 'initializing' do
+      context '::new' do
+        before(:each) { launch_test_app }
+        after(:each){ close_test_app }
+
+        it 'wraps new App around existing Window' do
+          window = Window.top_level(title: WIN_TITLE)
+          @app = App.new(window)
+          @app.should be_an App
+          @app.main_window.should == window
+        end
+
+        it 'wraps new App around active window handle (of top-level Window)' do
+          window = Window.top_level(title: WIN_TITLE)
+          @app = App.new(window.handle)
+          @app.should be_an App
+          @app.main_window.handle.should == window.handle
+        end
+
+        it 'raises error trying to create App with wrong init args' do
+          expect{ App.new() }.to raise_error ArgumentError, /wrong number of arguments/
+          [[nil], 1.2, {title: WIN_TITLE}].each do |args|
+            expect{ App.new(*args) }.to raise_error WinGui::Errors::InitError
+          end
+        end
+      end
+
+      context '::find' do
+        before(:each) { launch_test_app }
+        after(:each){ close_test_app }
+
+        it 'finds already launched App given valid Window info' do
+          use{ @app = App.find(title: WIN_TITLE) }
+          @app.should be_an App
+        end
+
+        it 'returns nil if asked to find App with invalid Window info' do
+          App.find(title: IMPOSSIBLE).should == nil
+        end
+
+        it 'raises error only if asked to find App with invalid Window info and :raise option is set' do
+          expect{ App.find(title: IMPOSSIBLE, raise: WinGui::Errors::InitError) }.
+                  to raise_error WinGui::Errors::InitError
+        end
+      end
+
+      context '::launch' do
+
+        it 'launches new App given valid path and Window info' do
+          use{ @app = App.launch(path: APP_PATH, title: WIN_TITLE) }
+          @app.should be_an App
+        end
+
+        it 'raises error if asked to launch App with invalid path' do
+          expect{ App.launch(path: IMPOSSIBLE, title: WIN_TITLE) }.
+                  to raise_error WinGui::Errors::InitError, /Unable to launch "Impossible"/
+        end
+
+        it 'raises error if asked to launch App with invalid Window info' do
+          expect{ App.launch(path: APP_PATH, title: IMPOSSIBLE) }.
+                  to raise_error WinGui::Errors::InitError, /Unable to launch App with .*?:title=>"Impossible"/
+        end
+
+      end
+
+      context 'properties:' do
+        before(:each) { @app = App.launch(path: APP_PATH, title: WIN_TITLE) }
+        after(:each) { @app.close }
+
+        it 'main_window' do
+          @app.main_window.should be_a Window
+          @app.main_window.title.should == WIN_TITLE
+        end
+      end
+    end
+
+    context 'manipulating' do
+      before(:each) {@app = App.launch(path: APP_PATH, title: WIN_TITLE)}
+
+      it 'exits App gracefully' do
+        @app.exit
+        sleep SLEEP_DELAY # needed to ensure window had enough time to close down
+        @app.main_window.visible?.should == false
+        @app.main_window.window?.should == false
+      end
+
+      it 'closes App gracefully' do
+        @app.close
+        sleep SLEEP_DELAY # needed to ensure window had enough time to close down
+        @app.main_window.visible?.should == false
+        @app.main_window.window?.should == false
+      end
+    end
+  end
+end

data/spec/win_gui/convenience_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper" )
 module WinGuiTest
 
   describe 'Convenience methods' do
-    before(:each){ @app = launch_test_app }
+    before(:each){ @win = launch_test_app.main_window }
     after(:each) { close_test_app }
 
     describe '#dialog' do
@@ -54,9 +54,10 @@ module WinGuiTest
         it 'emulates combinations of keys pressed (Ctrl+Alt+P+M, etc)' do
           keystroke(VK_CONTROL, 'A')
           keystroke(VK_SPACE)
-          @app.textarea.text.should.should == ' '
+          textarea = @win.child(class: TEXTAREA_CLASS)
+          textarea.text.should.should == ' '
           keystroke('1', '2', 'A', 'B'.ord)
-          @app.textarea.text.should.should == ' 12ab'
+          textarea.text.should.should == ' 12ab'
         end
       end # describe '#keystroke'
 
@@ -64,7 +65,8 @@ module WinGuiTest
         it 'types text message into the window holding the focus' do
           text = '1234 abcdefg'
           type_in(text)
-          @app.textarea.text.should =~ Regexp.new(text)
+          textarea = @win.child(class: TEXTAREA_CLASS)
+          textarea.text.should =~ Regexp.new(text)
         end
       end # describe '#type_in'
 

data/spec/win_gui/window_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper" )
 module WinGuiTest
 
   describe Window do
-    before(:each) { @app = launch_test_app }
+    before(:each) { @win = launch_test_app.main_window }
     after(:each){ close_test_app }
 
     context 'initializing' do
@@ -15,33 +15,33 @@ module WinGuiTest
 
     context 'manipulating' do
       it 'closes when asked nicely' do
-        @app.close
+        @win.close
         sleep SLEEP_DELAY # needed to ensure window had enough time to close down
         find_window(nil, WIN_TITLE).should == nil
       end
 
       it 'waits for window to disappear (NB: this happens before handle is released!)' do
         start = Time.now
-        @app.close
-        @app.wait_for_close
+        @win.close
+        @win.wait_for_close
         (Time.now - start).should be <= CLOSE_TIMEOUT
-        window_visible?(@app.handle).should be false
-        window?(@app.handle).should be false
+        window_visible?(@win.handle).should be false
+        window?(@win.handle).should be false
       end
     end
 
     context 'handle-related WinGui functions as instance methods' do
       it 'calls all WinGui functions as instance methods (with handle as implicit first argument)' do
-        @app.window?.should == true
-        @app.visible?.should == true
-        @app.foreground?.should == true
-        @app.maximized?.should == false
-        @app.maximized?.should == false
-        @app.child?(any_handle).should == false
-
-        @app.window_rect.should be_an Array
-        @app.window_thread_process_id.should be_an Array
-        @app.enum_child_windows.should be_an Array
+        @win.window?.should == true
+        @win.visible?.should == true
+        @win.foreground?.should == true
+        @win.maximized?.should == false
+        @win.minimized?.should == false
+        @win.child?(any_handle).should == false
+
+        @win.window_rect.should be_an Array
+        @win.window_thread_process_id.should be_an Array
+        @win.enum_child_windows.should be_an Array
       end
    end
 
@@ -52,52 +52,52 @@ module WinGuiTest
       end
 
       it 'has class_name and text/title properties (derived from WinGui function calls)' do
-        @app.class_name.should == WIN_CLASS
+        @win.class_name.should == WIN_CLASS
         # text propery accessed by sending WM_GETTEXT directly to window (convenience method in WinGui)
-        @app.text.should == WIN_TITLE
+        @win.text.should == WIN_TITLE
         # window_text propery accessed via GetWindowText
-        @app.window_text.should == WIN_TITLE
+        @win.window_text.should == WIN_TITLE
         # title property is just an alias for window_text
-        @app.title.should == WIN_TITLE
+        @win.title.should == WIN_TITLE
       end
 
       it 'has thread and process properties derived from get_window_thread_process_id' do
-        thread = @app.thread
-        process = @app.process
-        [thread, process].should == get_window_thread_process_id(@app.handle)
+        thread = @win.thread
+        process = @win.process
+        [thread, process].should == get_window_thread_process_id(@win.handle)
       end
 
       it 'has id property that only makes sense for controls' do
-        use{ @app.id } 
+        use{ @win.id }
       end
     end
 
-    describe '.top_level' do
+    describe '::top_level' do
       it 'finds top-level window by title and wraps it in a Window object' do
-        win = Window.top_level( title: WIN_TITLE, timeout: 1)
-        win.handle.should == @app.handle
+        window = Window.top_level( title: WIN_TITLE, timeout: 1)
+        window.handle.should == @win.handle
       end
 
       it 'finds top-level window by class and wraps it in a Window object' do
-        win = Window.top_level( class: WIN_CLASS, timeout: 1)
-        win.handle.should == @app.handle
+        window = Window.top_level( class: WIN_CLASS, timeout: 1)
+        window.handle.should == @win.handle
       end
 
       it 'finds ANY top-level window without args and wraps it in a Window object' do
-        use { @win = Window.top_level() }
-        Window.should === @win
+        use { @window = Window.top_level() }
+        @window.should be_a Window
       end
 
       it 'returns nil immediately if top-level window with given title not found' do
         start = Time.now
         Window.top_level( title: IMPOSSIBLE).should == nil
-        (Time.now - start).should be_close 0, 0.02
+        (Time.now - start).should be_close 0, 0.03
       end
 
       it 'returns nil after timeout if top-level window with given title not found' do
         start = Time.now
-        Window.top_level( title: IMPOSSIBLE, timeout: 0.5).should == nil
-        (Time.now - start).should be_close 0.5, 0.02
+        Window.top_level( title: IMPOSSIBLE, timeout: 0.3).should == nil
+        (Time.now - start).should be_close 0.3, 0.03
       end
 
       it 'raises exception if asked to' do
@@ -106,42 +106,40 @@ module WinGuiTest
     end # describe .top_level
 
     describe '#child' do
-      spec { use { @child = @app.child(title: "Title", class: "Class", id: 0)  }}
+      spec { use { @child = @win.child(title: "Title", class: "Class", id: 0)  }}
 
       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
+        @win.child( title: IMPOSSIBLE).should == nil
+        (Time.now - start).should be_close 0, 0.03
       end
 
       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
+        @win.child( title: IMPOSSIBLE, timeout: 0.5).should == nil
+        (Time.now - start).should be_close 0.5, 0.03
       end
 
       it 'finds ANY child window without args' do
-        use { @child = @app.child() }
+        use { @child = @win.child() }
         @child.should_not == nil
-        @app.child?(@child.handle).should == true
+        @win.child?(@child.handle).should == true
       end
 
       it 'finds child window by class and returns it as a Window object (no timeout)' do
-        child = @app.child( class: TEXTAREA_CLASS)
+        child = @win.child( class: TEXTAREA_CLASS)
         child.should_not == nil
-        @app.child?(child.handle).should == true
+        @win.child?(child.handle).should == true
       end
 
       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 = @win.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)
+        @win.child?(child.handle).should == true
+        child = @win.child( class: STATUSBAR_CLASS, timeout: 0.5)
         child.should_not == nil
-        @app.child?(child.handle).should == true
+        @win.child?(child.handle).should == true
       end
 
       it 'finds child with specific text and returns it as a Window object' do
@@ -169,19 +167,19 @@ module WinGuiTest
 
       context 'indirect child' do
         it 'returns nil if specified child not found' do
-          @app.child( title: IMPOSSIBLE, indirect: true).should == nil
+          @win.child( title: IMPOSSIBLE, indirect: true).should == nil
         end
 
         it 'finds ANY child window without other args' do
-          use { @child = @app.child(indirect: true) }
+          use { @child = @win.child(indirect: true) }
           @child.should_not == nil
-          @app.child?(@child.handle).should == true
+          @win.child?(@child.handle).should == true
         end
 
         it 'finds child window by class' do
-          child = @app.child( class: TEXTAREA_CLASS, indirect: true)
+          child = @win.child( class: TEXTAREA_CLASS, indirect: true)
           child.should_not == nil
-          @app.child?(child.handle).should == true
+          @win.child?(child.handle).should == true
         end
 
         it 'finds child with specific text' do
@@ -210,26 +208,19 @@ module WinGuiTest
     end # describe child
 
     describe '#children' do
-      spec { use { children = @app.children  }}
+      spec { use { children = @win.children  }}
 
       it 'returns an array of Windows that are descendants (not only DIRECT children) of a given Window' do
-        children = @app.children
+        children = @win.children
         children.should be_a_kind_of Array
         children.should_not be_empty
         children.should have(2).elements
-        children.each{|child| child?(@app.handle, child.handle).should == true }
+        children.each{|child| child?(@win.handle, child.handle).should == true }
         children.last.class_name.should == TEXTAREA_CLASS
       end
     end # describe #children
 
     describe '#click' do
-#      it 'tests' do
-#        with_dialog(:save) do |dialog|
-#          dialog.children.each{|child| puts "#{child.handle}, #{child.class_name}, #{child.window_text}, #{dialog.child?(child.handle)}"}
-#          true.should == false
-#        end
-#      end
-
       it 'emulates left click of the control identified by id, returns click coords' do
         with_dialog(:save) do |dialog|
           point = dialog.click(id: IDCANCEL)

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: win_gui
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 2
-  - 10
-  version: 0.2.10
+  - 12
+  version: 0.2.12
 platform: ruby
 authors: 
 - arvicco
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-04 00:00:00 +04:00
+date: 2010-10-02 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -35,9 +38,11 @@ dependencies:
   name: cucumber
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -47,9 +52,11 @@ dependencies:
   name: win
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 0
         - 3
@@ -70,12 +77,14 @@ extra_rdoc_files:
 files: 
 - lib/extension.rb
 - lib/version.rb
+- lib/win_gui/application.rb
 - lib/win_gui/convenience.rb
 - lib/win_gui/window.rb
 - lib/win_gui.rb
 - spec/extension_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/win_gui/application_spec.rb
 - spec/win_gui/convenience_spec.rb
 - spec/win_gui/window_spec.rb
 - features/step_definitions/win_gui_steps.rb
@@ -108,23 +117,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ""
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Abstractions/wrappers around GUI-related Win32 API functions
@@ -132,5 +145,6 @@ test_files:
 - spec/extension_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/win_gui/application_spec.rb
 - spec/win_gui/convenience_spec.rb
 - spec/win_gui/window_spec.rb