win32-autogui 0.3.0 → 0.4.0

data/examples/skeleton/lib/myapp.rb

@@ -4,8 +4,15 @@
 
 class Myapp < Autogui::Application
 
-  def initialize(name=APPNAME, options = {:title=> "MyApp"})
-    super name, options
+  def initialize(options = {})
+    # relative path to app using Windows style path
+    @name ="exe\\myapp.exe"  
+    defaults = {
+                 :title=> "MyApp -", 
+                 :parameters => '--nosplash', 
+                 :main_window_timeout => 20
+               }
+    super defaults.merge(options)
   end
 
   def edit_window
@@ -16,22 +23,22 @@ def status_bar
     main_window.children.find {|w| w.window_class == 'TStatusBar'}
   end
 
-  def dialog_about
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def dialog_about(options={})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/About MyApp/) && (w.pid == pid)
     end
   end
 
-  def message_dialog_confirm
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def message_dialog_confirm(options={})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/Confirm/) && (w.pid == pid)
     end
   end
 
   # Title and class are the same as dialog_overwrite_confirm
   # Use child windows to differentiate
-  def dialog_overwrite_confirm
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def dialog_overwrite_confirm(options={})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/^Text File Save$/) && 
         (w.pid == pid) && 
         (w.window_class == "#32770") &&
@@ -40,8 +47,8 @@ def dialog_overwrite_confirm
   end
 
   # title and class are the same as dialog_overwrite_confirm
-  def file_save_as_dialog
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def file_save_as_dialog(options={})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/Text File Save/) && 
         (w.pid == pid) &&
         (w.window_class == "#32770") &&
@@ -49,14 +56,14 @@ def file_save_as_dialog
     end
   end
 
-  def file_open_dialog
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def file_open_dialog(options={})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/Text File Open/) && (w.pid == pid)
     end
   end
 
-  def error_dialog
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def error_dialog(options={})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/^MyApp$/) && (w.pid == pid) && (w.window_class == "#32770")
     end
   end

data/examples/skeleton/spec/myapp/form_about_spec.rb

@@ -1,6 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 include Autogui::Input
+include Autogui::Logging
 
 describe "FormAbout" do
 
@@ -41,10 +42,10 @@
     @dialog_about.title.should == "About MyApp"
   end
 
-  it "should have an 'Ok' button" do
+  it "should have an 'OK' button" do
     button = @dialog_about.children.find {|w| w.window_class == 'TButton'}
     button.should_not be_nil
-    button.text.should match(/Ok/)
+    button.text.should match(/^OK$/)
   end
 
 end

data/examples/skeleton/spec/myapp/form_main_spec.rb

@@ -1,22 +1,22 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 include Autogui::Input
+include Autogui::Logging
+
+logger.level = Autogui::Logging::DEBUG
 
 describe "FormMain" do
   before(:all) do
-    @debug = false
-    @verbose = true
     @application = Myapp.new
     FileUtils.rm_rf(current_dir)
-    puts "FormMain before(:all)" if @debug
-    puts "application:\n#{@application.inspect}\n" if @debug && @verbose
-    puts "application.combined_text:\n #{@application.combined_text}\n" if @debug && @verbose
+    #logger.debug "FormMain before(:all)" 
+    #logger.debug "application:\n#{@application.inspect}\n" 
+    #logger.debug "application.combined_text:\n #{@application.combined_text}\n" 
   end
   before(:each) do
     @application = Myapp.new unless @application.running?
     @application.should be_running
     @application.set_focus
-    puts "FormMain before(:each)" if @debug
   end
   after(:all) do
     if @application.running?
@@ -25,14 +25,12 @@
       @application.close(:wait_for_close => true)
       @application.should_not be_running
     end
-    puts "FormMain after(:all)" if @debug
   end
   after(:each) do
     if @application.running?
       keystroke(VK_N) if @application.message_dialog_confirm || @application.dialog_overwrite_confirm
       keystroke(VK_ESCAPE) if @application.error_dialog
     end
-    puts "FormMain after(:each)" if @debug
   end
 
   describe "after startup" do

data/examples/skeleton/spec/spec_helper.rb

@@ -10,15 +10,22 @@
 require 'spec/autorun'
 require 'aruba/api'
 
-# aruba helper, returns full path to files in the aruba tmp folder
+# aruba helpers
+#
+# @return full path to files in the aruba tmp folder
 def fullpath(filename)
   path = File.expand_path(File.join(current_dir, filename))
-  path = `cygpath -w #{path}`.chomp if path.match(/^\/cygdrive/)  # cygwin?
+  if path.match(/^\/cygdrive/)
+    # match /cygdrive/c/path/to and return c:\\path\\to
+    path = `cygpath -w #{path}`.chomp
+  elsif path.match(/.\:/)
+    # match c:/path/to and return c:\\path\\to
+    path = path.gsub(/\//, '\\')
+  end
   path
 end
-
-# return the contents of "filename" in the aruba tmp folder
-def get_file_content(filename)
+# @return the contents of "filename" in the aruba tmp folder
+def get_file_contents(filename)
   in_current_dir do
     IO.read(filename)
   end

data/lib/win32/autogui.rb

@@ -19,7 +19,7 @@ def self.version
     end
   end
 
-  # @return False (nil) or True (Integer)
+  # @return (Boolean) false (nil) or True (Integer)
   def self.win32?
     RUBY_PLATFORM =~ /mingw|mswin|cygwin/i
   end

data/lib/win32/autogui/application.rb

@@ -108,7 +108,7 @@ class Application
     # @example initialize with logging to file at DEBUG level
     #
     #   include Autogui::Logging
-    #   app = Application.new :name => "calc", :logger_logfile => 'log/calc.log', :logger.level => Log4r::DEBUG
+    #   app = Application.new :name => "calc", :logger_logfile => 'log/calc.log', :logger.level => Autogui::Logging::DEBUG
     #
     # @example initialize without logging to file and turn it on later
     #
@@ -122,8 +122,8 @@ class Application
     # @option options [Number] :parameters command line parameters used by Process.create
     # @option options [Number] :create_process_timeout (10) timeout in seconds to wait for the create_process to return 
     # @option options [Number] :main_window_timeout (10) timeout in seconds to wait for main_window to appear
-    # @option options [String] :logger_logfile (nil) initialize Log4r::Logger's output filename
-    # @option options [String] :logger_level (Log4r::WARN) initialize Log4r::Logger's initial level
+    # @option options [String] :logger_logfile (nil) initialize logger's output filename
+    # @option options [String] :logger_level (Autogui::Logging::WARN) initialize logger's initial level
     #
     def initialize(options = {})
 
@@ -206,7 +206,7 @@ def main_window
             w.title.match(title) && w.pid == pid 
           end
           sleep 0.1 
-         end until @main_window
+        end until @main_window
       end
 
       # post sanity checks

data/lib/win32/autogui/logging.rb

@@ -18,9 +18,15 @@ def logfile
     end
 
     def logfile=(fn)
-      FileOutputter.new(:logfile, :filename => fn, :trunc => true)
-      Outputter[:logfile].formatter = Log4r::PatternFormatter.new(:pattern => "[%5l %d] %M [%t]")
-      add(:logfile)
+      if fn == nil
+        puts "removing log to file"
+        remove(:logfile) if @filename
+      else
+        FileOutputter.new(:logfile, :filename => fn, :trunc => true)
+        Outputter[:logfile].formatter = Log4r::PatternFormatter.new(:pattern => "[%5l %d] %M [%t]")
+        add(:logfile)
+      end
+      @filename = fn
     end
 
   end
@@ -28,11 +34,19 @@ def logfile=(fn)
 
 module Autogui
 
-  STANDARD_LOGGER = 'standard'
-
   # wrapper for Log4r gem
   module Logging
 
+    # Redefine logging levels so that they can be accessed before
+    # the logger is initialized at the expense of flexibility.
+    DEBUG = 1
+    INFO = 2
+    WARN = 3
+    ERROR = 4
+    FATAL = 5
+
+    STANDARD_LOGGER = 'standard'
+
     # Logging mixin allows simple logging setup
     # to STDOUT and optionally, to one filename.  Logger is a wrapper
     # for Log4r::Logger it accepts any methods that 
@@ -45,7 +59,7 @@ module Logging
     #   logger.filename = 'log/autogui.log'
     #   logger.warn "warning message goes to 'log/autogui.log'" 
     #
-    #   logger.level = Log4r::DEBUG
+    #   logger.level = Autogui::Logging::DEBUG
     #   logger.debug "this message goes to 'log/autogui.log'"
     #
     def logger
@@ -59,7 +73,17 @@ def logger
     # Initialize the logger, defaults to log4r::Warn
     def init_logger
       log = Log4r::Logger.new(STANDARD_LOGGER)
-      Log4r::Logger[STANDARD_LOGGER].level = Log4r::WARN
+
+      # sanity checks since we defined log4r's dynamic levels statically
+      unless (Log4r::DEBUG == DEBUG) && 
+             (Log4r::INFO == INFO) && 
+             (Log4r::WARN == WARN) && 
+             (Log4r::ERROR == ERROR) && 
+             (Log4r::FATAL == FATAL) 
+        raise "Logger levels do not match Log4r levels, levels may have been customized"
+      end
+
+      Log4r::Logger[STANDARD_LOGGER].level = WARN
       Log4r::Logger[STANDARD_LOGGER].trace = true
 
       Log4r::StderrOutputter.new :console

data/lib/win32/autogui/window.rb

@@ -1,10 +1,13 @@
 require 'timeout'
 require 'windows/window'
 require 'windows/window/message'
+require 'windows/window/classes'
 require 'win32/autogui/windows/window'
 
 module Autogui
 
+  class FindTimeout < Timeout::Error; end
+
   # Enumerate desktop child windows
   #
   # Start at the desktop and work down through all the child windows
@@ -12,6 +15,35 @@ module Autogui
   class EnumerateDesktopWindows
     include Enumerable
     include Windows::Window
+    include Autogui::Logging
+
+    # @return [Number] timeout (0) in seconds
+    attr_accessor :timeout
+
+    # @option options [Number] :timeout (0) maximum seconds to continue enumerating windows
+    def initialize(options ={})
+      @timeout = options[:timeout] || 0
+    end
+
+    # redefine Enumerable's find to continue looping until a timeout reached
+    def find(ifnone = nil)
+      return to_enum :find, ifnone unless block_given?
+
+      begin
+        Timeout.timeout(timeout, FindTimeout) do
+          begin
+            each { |o| return o if yield(o) }
+            sleep 0.2 unless (timeout == 0)
+            #logger.debug "find looping" unless (timeout == 0)
+          end until (timeout == 0)
+        end
+      rescue FindTimeout
+        logger.warn "EnumerateDesktopWindows.find timeout"
+        nil
+      end
+
+      ifnone.call if ifnone
+    end
 
     def each
       child_after = 0
@@ -50,6 +82,7 @@ def each
   class Window
     include Windows::Window           # instance methods from windows-pr gem
     include Windows::Window::Message  # PostMessage and constants
+    include Windows::Window::Classes  # GetClassName
     include Autogui::Logging
     include Autogui::Input
 
@@ -97,11 +130,11 @@ def wait_for_close(options={})
       end
     end
 
-    # @return [String] the ANSI Windows ClassName
+    # @return [String] the Windows ClassName
     #
     def window_class
       buffer = "\0" * 255
-      length = GetClassNameA(handle, buffer, buffer.length)
+      length = GetClassName(handle, buffer, buffer.length)
       length == 0 ? '' : buffer[0..length - 1]
     end
 

data/lib/win32/autogui/windows/window.rb

@@ -16,7 +16,6 @@ module Window
     API.new('IsWindow', 'L', 'I', 'user32')
     API.new('SetForegroundWindow', 'L', 'I', 'user32')
     API.new('SendMessageA', 'LIIP', 'I', 'user32')
-    API.new('GetClassNameA', 'LPI', 'I', 'user32')
 
   end
 end

data/spec/applications/calculator.rb

@@ -8,7 +8,8 @@ class Calculator < Autogui::Application
   def initialize(options = {})
     defaults = {
                  :name => "calc",
-                 :title => "Calculator"
+                 :title => "Calculator",
+                 :logger_level => Autogui::Logging::DEBUG
                }
     super defaults.merge(options)
   end
@@ -19,12 +20,12 @@ def edit_window
   end
 
   # About dialog, hotkey (VK_MENU, VK_H, VK_A)
-  def dialog_about
-    Autogui::EnumerateDesktopWindows.new.find do |w| 
+  def dialog_about(options = {})
+    Autogui::EnumerateDesktopWindows.new(options).find do |w| 
       w.title.match(/About Calculator/) && (w.pid == pid)
     end
   end
-
+  
   # the 'CE' button
   def clear_entry
     set_focus

data/spec/auto_gui/application_spec.rb

@@ -1,6 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 include Autogui::Input
+include Autogui::Logging
 
 describe Autogui::Application do
 
@@ -109,7 +110,7 @@
         it "should copy the edit window" do
           @calculator.set_focus
           type_in("3002")
-          @calculator.edit_window.text.strip.should == "3,002."
+          @calculator.edit_window.text.strip.should match(/3,?002\./)
           @calculator.edit_window.set_focus
           keystroke(VK_CONTROL, VK_C) 
           @calculator.clipboard.text.should == "3002"
@@ -122,7 +123,7 @@
           @calculator.clipboard.text = "12345"
           @calculator.edit_window.text.strip.should == "0."
           keystroke(VK_CONTROL, VK_V) 
-          @calculator.edit_window.text.strip.should == "12,345."
+          @calculator.edit_window.text.strip.should match(/12,?345\./)
         end
       end
 

data/spec/auto_gui/logging_spec.rb

@@ -3,6 +3,10 @@
 include Autogui::Logging
 
 describe Autogui::Logging do
+  before(:all) do
+    # quiet console output, we are only testing the file output
+    logger.remove(:console)
+  end
   before(:each) do
     FileUtils.rm_rf(current_dir)
     @logfile = "autogui.log"
@@ -13,50 +17,63 @@
       @application.close(:wait_for_close => true) if @application.running?
       @application.should_not be_running
     end
+    logger.remove(:logfile)
+  end
+  after(:all) do
+    logger.add(:console)
   end
 
   describe "to file" do
+
     it "should truncate the log on create" do
-      get_file_content(@logfile).should == 'the quick brown fox'
+      get_file_contents(@logfile).should == 'the quick brown fox'
       @application = Calculator.new :logger_logfile => fullpath(@logfile)
-      get_file_content(@logfile).should == ''
+      get_file_contents(@logfile).should == ''
     end
 
     it "should not log unless 'logger.logfile' is set" do
       @application = Calculator.new 
-      get_file_content(@logfile).should == 'the quick brown fox'
-      logger.warn "warning message here"
-      get_file_content(@logfile).should == 'the quick brown fox'
+      get_file_contents(@logfile).should == 'the quick brown fox'
+      logger.warn "warning message 0"
+      get_file_contents(@logfile).should == 'the quick brown fox'
       logger.logfile = fullpath(@logfile)
-      logger.warn "warning message here"
-      get_file_content(@logfile).should match(/warning message here/)
+      logger.warn "warning message 1"
+      get_file_contents(@logfile).should match(/warning message 1/)
+      logger.logfile = nil
+      logger.warn "warning message 2"
+      get_file_contents(@logfile).should_not match(/warning message 2/)
     end
 
     it "should log warnings" do
       @application = Calculator.new :logger_logfile => fullpath(@logfile)
-      get_file_content(@logfile).should == ''
+      get_file_contents(@logfile).should == ''
       logger.warn "warning message here"
-      get_file_content(@logfile).should match(/warning message here/)
+      get_file_contents(@logfile).should match(/warning message here/)
     end
 
     it "should log application raised exceptions via 'application.raise_error'" do
-      get_file_content(@logfile).should == 'the quick brown fox'
+      get_file_contents(@logfile).should == 'the quick brown fox'
       begin
         @application = Calculator.new :logger_logfile => fullpath(@logfile), :name => nil
       rescue
-        # expected exception
       end
-      get_file_content(@logfile).should match(/application name not set/)
+      get_file_contents(@logfile).should match(/application name not set/)
     end
 
     it "should log debug messages when debug level set" do
       @application = Calculator.new :logger_logfile => fullpath(@logfile)
-      get_file_content(@logfile).should == ''
-      logger.debug "debug message here"
-      get_file_content(@logfile).should_not match(/debug message here/)
-      logger.level = Log4r::DEBUG
-      logger.debug "debug message here"
-      get_file_content(@logfile).should match(/debug message here/)
+      level_save = logger.level
+      begin
+        logger.level = Autogui::Logging::WARN
+        get_file_contents(@logfile).should == ''
+        logger.debug "debug message here 1"
+        get_file_contents(@logfile).should_not match(/debug message here 1/)
+        logger.level = Autogui::Logging::DEBUG
+        logger.debug "debug message here 2"
+        get_file_contents(@logfile).should match(/debug message here 2/)
+      ensure
+        logger.level = level_save
+      end
     end
   end