win32-autogui 0.2.1 → 0.3.0

data/.gitignore

@@ -8,3 +8,4 @@ rerun.txt
 tags
 tmp/fixtures
 tmp/aruba
+autogui.log

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    win32-autogui (0.2.1)
+    win32-autogui (0.3.0)
+      log4r (>= 1.1.9)
       win32-clipboard (>= 0.5.2)
       win32-process (>= 0.6.2)
       windows-api (>= 0.4.0)
@@ -26,6 +27,7 @@ GEM
       json (~> 1.4.6)
       term-ansicolor (~> 1.0.5)
     json (1.4.6)
+    log4r (1.1.9)
     rake (0.8.7)
     rdiscount (1.6.5)
     rspec (1.3.1)
@@ -49,6 +51,7 @@ DEPENDENCIES
   aruba (>= 0.2.3)
   bundler (>= 1.0.3)
   cucumber (>= 0.9.2)
+  log4r (>= 1.1.9)
   rake (>= 0.8.7)
   rdiscount (>= 1.6.5)
   rspec (= 1.3.1)

data/HISTORY.markdown

@@ -6,9 +6,15 @@ Most recent changes are at the top
 Changes
 -------
 
+### 0.3.0 - 11/08/2010 ###
+
+* Added Log4R logging
+* Window.set_focus works first call in IRB
+
 ### 0.2.1 - 11/05/2010 ###
 
 * Added missing "require 'timeout'", fixes issue #1
+* Replaced missing '@calculator' tag required to close down the calculator after running cucumber features
 
 ### 0.2.0 - 11/04/2010 ###
 

data/README.markdown

@@ -46,7 +46,8 @@ The first step is to subclass Win32-autogui's application class.
       def initialize(options = {})
         defaults = {
                      :name => "calc",
-                     :title => "Calculator"
+                     :title => "Calculator",
+                     :logger_filename => "calculator.log"
                    }
         super defaults.merge(options)
       end
@@ -194,6 +195,7 @@ Win32-autogui depends on the following RubyGems
 * Windows-pr  <http://github.com/djberg96/windows-pr>
 * Win32-process <http://github.com/djberg96/win32-process>
 * Win32-clipboard <http://github.com/djberg96/win32-clipboard>
+* Log4r for logging <http://log4r.rubyforge.org/>
 
 
 Installation

data/TODO.markdown

@@ -7,3 +7,4 @@ general
 * (1.0) stop changing $LOAD_PATH in specs and features, modify ENV[] in before and afters
 * (1.0) implement Application.find and add option to not start application automatically, allows driving already running applications
 * (1.0) application class should be a mixin, not classical inheritance 
+* (1.0) "rake release" broken on Windows, create patch to fix Bundler.  For now, 'git tag v0.3.0 && rake build && gem push 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/examples/quicknote/FormMainU.dfm

@@ -39,6 +39,7 @@ object FormMain: TFormMain
     Top = 244
     object ActionFileExit: TAction
       Caption = 'E&xit'
+      ShortCut = 16472
       OnExecute = ActionFileExitExecute
     end
     object ActionHelpAbout: TAction

data/examples/quicknote/spec/quicknote/form_main_spec.rb

@@ -271,4 +271,13 @@
     end
   end
 
+  describe "hotkey (VK_CONTROL, VK_X)" do
+    it "should should exit the program" do
+      @application.main_window.is_window?.should == true
+      keystroke(VK_CONTROL, VK_X) 
+      @application.main_window.is_window?.should == false
+      @application.should_not be_running
+    end
+  end
+
 end

data/lib/win32/autogui.rb

@@ -1,4 +1,5 @@
 # require all files here
+require 'win32/autogui/logging'
 require 'win32/autogui/input'
 require 'win32/autogui/window'
 require 'win32/autogui/application'

data/lib/win32/autogui/application.rb

@@ -40,7 +40,8 @@ def text=(str)
   #     def initialize(options = {})
   #       defaults = {
   #                    :name => "calc",
-  #                    :title => "Calculator"
+  #                    :title => "Calculator",
+  #                    :logger_logfile => 'log/calc.log'
   #                  }
   #       super defaults.merge(options)
   #     end
@@ -65,6 +66,7 @@ class Application
     include Windows::Process           
     include Windows::Synchronize
     include Windows::Handle
+    include Autogui::Logging
 
     # @return [String] the executable name of the application
     attr_accessor :name  
@@ -89,11 +91,30 @@ class Application
     
     # @example initialize an application on the path
     #
-    #   Application.new :name => "calc"  
+    #   app = Application.new :name => "calc"  
+    #
+    # @example initialize with relative DOS path
+    #
+    #   app = Application.new :name => "binaries\\mybinary.exe"  
     #
     # @example initialize with full DOS path
     #
-    #   Application.new :name => "\\windows\\system32\\calc.exe"  
+    #   app = Application.new :name => "\\windows\\system32\\calc.exe"  
+    #
+    # @example initialize with logging to file at the default WARN level  (STDOUT logging is the default)
+    #
+    #   app = Application.new :name => "calc", :logger_logfile => 'log/calc.log' 
+    #
+    # @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
+    #
+    # @example initialize without logging to file and turn it on later
+    #
+    #   include Autogui::Logging
+    #   app = Application.new :name => "calc"
+    #   logger.logfile = 'app.log'
     #
     # @param [Hash] options initialize options
     # @option options [String] :name a valid win32 exe name with optional path
@@ -101,11 +122,13 @@ 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
     #
     def initialize(options = {})
 
       unless options.kind_of?(Hash)
-        raise ArgumentError, 'Initialize expecting options to be a Hash'
+        raise_error ArgumentError, 'Initialize expecting options to be a Hash'
       end
 
       @name = options[:name] || name
@@ -114,8 +137,12 @@ def initialize(options = {})
       @create_process_timeout = options[:create_process_timeout] || 10
       @parameters = options[:parameters]
 
+      # logger setup
+      logger.logfile = options[:logger_logfile] if options[:logger_logfile]
+      logger.level = options[:logger_level] if options[:logger_level]
+
       # sanity checks
-      raise 'Application name not set' unless name 
+      raise_error 'application name not set' unless name 
 
       start
     end
@@ -151,8 +178,8 @@ def start
       CloseHandle(process_handle)
       CloseHandle(thread_handle)
 
-      raise "Start command failed on create_process_timeout" if ret == WAIT_TIMEOUT 
-      raise "Start command failed while waiting for idle input, reason unknown" unless (ret == 0)
+      raise_error "start command failed on create_process_timeout" if ret == WAIT_TIMEOUT 
+      raise_error "start command failed while waiting for idle input, reason unknown" unless (ret == 0)
       @pid
     end
 
@@ -168,6 +195,10 @@ def start
     def main_window
       return @main_window if @main_window
 
+      # pre sanity checks
+      raise_error "calling main_window without a pid, application not initialized properly" unless @pid
+      raise_error "calling main_window without a window title, application not initialized properly" unless @title
+
       timeout(main_window_timeout) do
         begin
           # There may be multiple instances, use title and pid to id our main window
@@ -178,8 +209,8 @@ def main_window
          end until @main_window
       end
 
-      # sanity checks
-      raise "cannot find main_window, check application title" unless @main_window
+      # post sanity checks
+      raise_error "cannot find main_window, check application title" unless @main_window
 
       @main_window
     end
@@ -243,7 +274,30 @@ def clipboard
       @clipboard || Autogui::Clipboard.new
     end
 
-  private
+    private
+
+    # @overload raise_error(exception, message)
+    #   raise and log specific exception with message
+    #   @param [Exception] to raise
+    #   @param [String] message error message to raise
+    #
+    # @overload raise_error(message)
+    #   raise and log generic exception with message
+    #   @param [String] message error message to raise
+    #
+    def raise_error(*args)
+      if args.first.kind_of?(Exception)
+        exception_type = args.shift
+        error_message = args.shift || 'Unknown error'
+      else
+        raise ArgumentError unless args.first.is_a?(String)
+        exception_type = RuntimeError
+        error_message = args.shift || 'Unknown error'
+      end
+
+      logger.error error_message
+      raise  exception_type, error_message
+    end
 
   end
 

data/lib/win32/autogui/logging.rb

@@ -0,0 +1,71 @@
+require 'log4r'
+
+# Open up Log4r and add a simple log accessor for 'logfile'
+#
+# @example allows simple setup
+#
+#   include Autogui::Logging
+#
+#   logger.filename = 'log/autogui.log'
+#   logger.warn "warning message goes to log file"
+#
+module Log4r
+  class Logger
+
+    # @return [String] filename of the logfile
+    def logfile
+      @filename
+    end
+
+    def logfile=(fn)
+      FileOutputter.new(:logfile, :filename => fn, :trunc => true)
+      Outputter[:logfile].formatter = Log4r::PatternFormatter.new(:pattern => "[%5l %d] %M [%t]")
+      add(:logfile)
+    end
+
+  end
+end
+
+module Autogui
+
+  STANDARD_LOGGER = 'standard'
+
+  # wrapper for Log4r gem
+  module Logging
+
+    # 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 
+    # Log4r::Logger accepts in addition to the "logfile" filename.
+    #
+    # @example  simple logging to file setup
+    #
+    #   include Autogui::Logging
+    #
+    #   logger.filename = 'log/autogui.log'
+    #   logger.warn "warning message goes to 'log/autogui.log'" 
+    #
+    #   logger.level = Log4r::DEBUG
+    #   logger.debug "this message goes to 'log/autogui.log'"
+    #
+    def logger
+      init_logger if Log4r::Logger[STANDARD_LOGGER].nil?
+      Log4r::Logger[STANDARD_LOGGER]
+    end
+
+
+    protected
+    
+    # Initialize the logger, defaults to log4r::Warn
+    def init_logger
+      log = Log4r::Logger.new(STANDARD_LOGGER)
+      Log4r::Logger[STANDARD_LOGGER].level = Log4r::WARN
+      Log4r::Logger[STANDARD_LOGGER].trace = true
+
+      Log4r::StderrOutputter.new :console
+      Log4r::Outputter[:console].formatter = Log4r::PatternFormatter.new(:pattern => "[%l] %m")
+      log.add(:console)
+    end
+
+  end
+end

data/lib/win32/autogui/window.rb

@@ -50,6 +50,8 @@ def each
   class Window
     include Windows::Window           # instance methods from windows-pr gem
     include Windows::Window::Message  # PostMessage and constants
+    include Autogui::Logging
+    include Autogui::Input
 
     attr_reader :handle
 
@@ -82,7 +84,7 @@ def close(options={})
       PostMessage(handle, WM_SYSCOMMAND, SC_CLOSE, 0)
       wait_for_close(options) if (options[:wait_for_close] == true) 
     end
-    
+
     # Wait for the window to close
     #
     # @param [Hash] options
@@ -96,7 +98,7 @@ def wait_for_close(options={})
     end
 
     # @return [String] the ANSI Windows ClassName
-    # 
+    #
     def window_class
       buffer = "\0" * 255
       length = GetClassNameA(handle, buffer, buffer.length)
@@ -125,13 +127,31 @@ def is_window?
     end
     
     # Brings the window into the foreground and activates it. 
-    # Keyboard input is directed to the window, and various visual cues 
+    # Keyboard input is directed to the window, and various visual cues
     # are changed for the user.
     #
+    # A process can set the foreground window only if one of the following conditions is true: 
+    #
+    #    * The process is the foreground process.
+    #    * The process was started by the foreground process.
+    #    * The process received the last input event.
+    #    * There is no foreground process.
+    #    * The foreground process is being debugged.
+    #    * The foreground is not locked.
+    #    * The foreground lock time-out has expired.
+    #    * No menus are active. 
+    #
     # @return [Number] nonzero number if sucessful, nil or zero if failed
     #
     def set_focus
-      SetForegroundWindow(handle) if is_window?
+      if is_window?
+        # if current process was the last to receive input, we can be sure that 
+        # SetForegroundWindow will be allowed.  Send the shift key to whatever has
+        # the focus now.  This allows IRB to set_focus.
+        keystroke(VK_SHIFT)
+        ret = SetForegroundWindow(handle)
+        logger.warn("SetForegroundWindow failed") if ret == 0
+      end
     end
 
     # The identifier (pid) of the process that created the window

data/spec/auto_gui/logging_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Autogui::Logging
+
+describe Autogui::Logging do
+  before(:each) do
+    FileUtils.rm_rf(current_dir)
+    @logfile = "autogui.log"
+    create_file(@logfile, "the quick brown fox")
+  end
+  after(:each) do
+    if @application
+      @application.close(:wait_for_close => true) if @application.running?
+      @application.should_not be_running
+    end
+  end
+
+  describe "to file" do
+    it "should truncate the log on create" do
+      get_file_content(@logfile).should == 'the quick brown fox'
+      @application = Calculator.new :logger_logfile => fullpath(@logfile)
+      get_file_content(@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'
+      logger.logfile = fullpath(@logfile)
+      logger.warn "warning message here"
+      get_file_content(@logfile).should match(/warning message here/)
+    end
+
+    it "should log warnings" do
+      @application = Calculator.new :logger_logfile => fullpath(@logfile)
+      get_file_content(@logfile).should == ''
+      logger.warn "warning message here"
+      get_file_content(@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'
+      begin
+        @application = Calculator.new :logger_logfile => fullpath(@logfile), :name => nil
+      rescue
+        # expected exception
+      end
+      get_file_content(@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/)
+    end
+  end
+
+end

data/win32-autogui.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency "windows-pr", ">= 1.0.9"
   s.add_dependency "win32-process", ">= 0.6.2"
   s.add_dependency "win32-clipboard", ">= 0.5.2"
+  s.add_dependency "log4r", ">= 1.1.9"
 
   s.add_development_dependency "bundler", ">= 1.0.3"
   s.add_development_dependency "rspec", "= 1.3.1"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: win32-autogui
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Robert Wahler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 -04:00
+date: 2010-11-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,22 @@ dependencies:
   prerelease: false
 - !ruby/object:Gem::Dependency 
   version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 1
+        - 9
+        version: 1.1.9
+  requirement: *id005
+  type: :runtime
+  name: log4r
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -94,12 +110,12 @@ dependencies:
         - 0
         - 3
         version: 1.0.3
-  requirement: *id005
+  requirement: *id006
   type: :development
   name: bundler
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -110,12 +126,12 @@ dependencies:
         - 3
         - 1
         version: 1.3.1
-  requirement: *id006
+  requirement: *id007
   type: :development
   name: rspec
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -126,12 +142,12 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
-  requirement: *id007
+  requirement: *id008
   type: :development
   name: cucumber
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -142,12 +158,12 @@ dependencies:
         - 2
         - 3
         version: 0.2.3
-  requirement: *id008
+  requirement: *id009
   type: :development
   name: aruba
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -158,12 +174,12 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
-  requirement: *id009
+  requirement: *id010
   type: :development
   name: rake
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -174,12 +190,12 @@ dependencies:
         - 6
         - 1
         version: 0.6.1
-  requirement: *id010
+  requirement: *id011
   type: :development
   name: yard
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -190,7 +206,7 @@ dependencies:
         - 6
         - 5
         version: 1.6.5
-  requirement: *id011
+  requirement: *id012
   type: :development
   name: rdiscount
   prerelease: false
@@ -266,10 +282,12 @@ files:
 - lib/win32/autogui.rb
 - lib/win32/autogui/application.rb
 - lib/win32/autogui/input.rb
+- lib/win32/autogui/logging.rb
 - lib/win32/autogui/window.rb
 - lib/win32/autogui/windows/window.rb
 - spec/applications/calculator.rb
 - spec/auto_gui/application_spec.rb
+- spec/auto_gui/logging_spec.rb
 - spec/basic_gem/basic_gem_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -323,6 +341,7 @@ test_files:
 - features/support/env.rb
 - spec/applications/calculator.rb
 - spec/auto_gui/application_spec.rb
+- spec/auto_gui/logging_spec.rb
 - spec/basic_gem/basic_gem_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb