win_gui 0.1.0

data/book_code/guessing/spec_helper.rb

@@ -0,0 +1,69 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+
+require 'rubygems'
+require 'hpricot'
+require 'open-uri'
+
+module RandomHelper
+  def random_paragraph
+    doc = Hpricot open('http://www.lipsum.com/feed/html?amount=1')
+    (doc/"div#lipsum p").inner_html.strip #(1)
+  end
+end
+
+
+describe 'a new document', :shared => true do
+  before do
+    @note = Note.open
+  end
+  
+  after do
+    @note.exit! if @note.running?
+  end
+end
+
+describe 'a saved document', :shared => true do
+  before do
+    Note.fixture 'SavedNote'
+  end
+end
+
+describe 'a reopened document', :shared => true do  
+  before do
+    @note = Note.open 'SavedNote'
+  end
+  
+  after do
+    @note.exit! if @note.running?
+  end
+end  
+
+
+describe 'a searchable document', :shared => true do
+  include RandomHelper #(2)
+
+  before do
+    @example = random_paragraph #(3)       
+    
+    words = @example.split /[^A-Za-z]+/
+    last_cap = words.select {|w| w =~ /^[A-Z]/}.last
+    @term = last_cap[0..1] #(4)
+
+    @first_match = @example.index(/#{@term}/i)
+    @second_match = @first_match ?
+      @example.index(/#{@term}/i, @first_match + 1) :
+      nil
+    @reverse_match = @example.rindex(/#{@term}/i)
+    @word_match = @example.index(/#{@term}\b/i)
+    @case_match = @example.index(/#{@term}/)    
+
+    @note.text = @example
+  end
+end

data/book_code/guessing/windows_gui.rb

@@ -0,0 +1,247 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+require 'Win32API'
+require 'jcode'
+$KCODE = 'U'
+
+class String
+  def snake_case
+    gsub(/([a-z])([A-Z0-9])/, '\1_\2').downcase
+  end
+  
+  def to_keys
+    unless size == 1
+      raise "conversion is for single characters only"
+    end
+    
+    code = unpack('U')[0]
+    
+    case self
+      when '0'..'9'
+        [code - ?0 + 0x30]
+      when 'A'..'Z'
+        [WindowsGui.const_get(:VK_SHIFT), code]
+      when 'a'..'z'
+        [code - ?a + ?A]
+      when ' '
+        [code]
+      when ','
+        [WindowsGui.const_get(:VK_OEM_COMMA)]
+      when '.'
+        [WindowsGui.const_get(:VK_OEM_PERIOD)]
+      when ':'
+        [:VK_SHIFT, :VK_OEM_1].map {|s| WindowsGui.const_get s}
+      when ';'
+        [WindowsGui.const_get(:VK_OEM_1)]
+      when "\\"
+        [WindowsGui.const_get(:VK_OEM_102)]
+      when "\n"
+        [WindowsGui.const_get(:VK_RETURN)]
+      else
+        raise "Can't convert unknown character #{self}"
+    end
+  end  
+end
+
+module WindowsGui
+  def self.def_api(function, parameters, return_value, rename = nil)
+    api = Win32API.new 'user32', function, parameters, return_value
+    define_method(rename || function.snake_case) do |*args|
+      api.call *args
+    end
+  end
+
+  
+  def self.load_symbols(header)
+    File.open(header) do |f|
+      f.grep(/#define\s+(ID\w+)\s+(\w+)/) do
+        name = $1
+        value = (0 == $2.to_i) ? $2.hex : $2.to_i #(1)
+        WindowsGui.const_set name, value          #(2)
+      end
+    end
+  end
+  
+  
+  def_api 'FindWindow',          ['P', 'P'], 'L'
+  def_api 'FindWindowEx',        ['L', 'L', 'P', 'P'], 'L'
+  def_api 'SendMessage',         ['L', 'L', 'L', 'P'], 'L', :send_with_buffer
+  def_api 'SendMessage',         ['L', 'L', 'L', 'L'], 'L'
+  def_api 'PostMessage',         ['L', 'L', 'L', 'L'], 'L'
+  def_api 'keybd_event',         ['I', 'I', 'L', 'L'], 'V'
+  def_api 'GetDlgItem',          ['L', 'L'], 'L' 
+  def_api 'GetWindowRect',       ['L', 'P'], 'I'
+  def_api 'SetCursorPos',        ['L', 'L'], 'I' 
+  def_api 'mouse_event',         ['L', 'L', 'L', 'L', 'L'], 'V'
+  def_api 'IsWindow',            ['L'], 'L'
+  def_api 'IsWindowVisible',     ['L'], 'L'
+  def_api 'SetForegroundWindow', ['L'], 'L'
+  
+  WM_GETTEXT = 0x000D
+  EM_GETSEL = 0x00B0
+  EM_SETSEL = 0x00B1
+    
+  WM_COMMAND = 0x0111 
+  WM_SYSCOMMAND = 0x0112 
+  SC_CLOSE = 0xF060
+  
+  IDOK = 1
+  IDCANCEL = 2
+  IDYES = 6
+  IDNO = 7
+  
+  MOUSEEVENTF_LEFTDOWN = 0x0002 
+  MOUSEEVENTF_LEFTUP = 0x0004
+  MOUSEEVENTF_RIGHTDOWN = 0x0008 
+  MOUSEEVENTF_RIGHTUP = 0x0010
+  
+  KEYEVENTF_KEYDOWN = 0 
+  KEYEVENTF_KEYUP = 2 
+
+  VK_SHIFT = 0x10
+  VK_CONTROL = 0x11
+  VK_MENU = 0x12
+  
+  VK_BACK = 0x08
+  VK_TAB = 0x09
+  VK_RETURN = 0x0D
+  VK_ESCAPE = 0x1B
+  VK_OEM_1 = 0xBA
+  VK_OEM_102 = 0xE2
+  VK_OEM_PERIOD = 0xBE
+  VK_HOME = 0x24 
+  VK_END = 0x23
+  VK_OEM_COMMA = 0xBC
+  VK_DELETE = 0x2E
+  VK_F3 = 0x72
+
+  def keystroke(*keys)
+    return if keys.empty?
+    
+    keybd_event keys.first, 0, KEYEVENTF_KEYDOWN, 0
+    sleep 0.05
+    keystroke *keys[1..-1]
+    sleep 0.05
+    keybd_event keys.first, 0, KEYEVENTF_KEYUP, 0 
+  end
+
+  def type_in(message)
+    message.each_char do |char|
+      keystroke(*char.to_keys)
+    end
+  end
+
+  def wait_for_window(title, seconds = 5)
+    timeout(seconds) do
+      sleep 0.2 while
+        (h = find_window nil, title) <= 0 ||
+        window_text(h) != title
+      h
+    end
+  end
+  
+  class Window
+    include WindowsGui
+    extend WindowsGui
+  
+    attr_reader :handle
+  
+    def initialize(handle)
+      @handle = handle
+    end
+  
+    def close
+      post_message @handle, WM_SYSCOMMAND, SC_CLOSE, 0
+    end
+  
+    def wait_for_close
+      timeout(5) do
+        sleep 0.2 until 0 == is_window_visible(@handle)
+      end
+    end
+  
+    def text(max_length = 2048)
+      buffer = '\0' * max_length
+      length = send_with_buffer @handle, WM_GETTEXT, buffer.length, buffer
+      length == 0 ? '' : buffer[0..length - 1]
+    end
+
+    def child(id)
+      result = case id
+      when String
+        by_title = find_window_ex @handle, 0, nil, id.gsub('_', '&') #(3)
+        by_class = find_window_ex @handle, 0, id, nil
+        by_title > 0 ? by_title : by_class
+      when Fixnum
+        get_dlg_item @handle, id
+      else
+        0
+      end
+    
+      raise "Control '#{id}' not found" if result == 0
+      Window.new result
+    end
+
+    def click(id, which = :left, where = :center)
+      h = child(id).handle
+    
+      rectangle = [0, 0, 0, 0].pack 'LLLL'
+      get_window_rect h, rectangle 
+      left, top, right, bottom = rectangle.unpack 'LLLL'
+
+      point = case where
+      when Array
+        where
+      when :random
+        [left + rand(right - left), top + rand(bottom - top)]
+      else
+        point = [(left + right) / 2, (top + bottom) / 2]
+      end
+      
+      set_cursor_pos *point
+
+      down, up = (:left == which) ?
+        [MOUSEEVENTF_LEFTDOWN, MOUSEEVENTF_LEFTUP] :
+        [MOUSEEVENTF_RIGHTDOWN, MOUSEEVENTF_RIGHTUP]
+
+      mouse_event down, 0, 0, 0, 0 
+      mouse_event up, 0, 0, 0, 0
+      
+      return point      
+    end
+    
+    def self.top_level(title, seconds=10, wnd_class = nil)
+      @handle = timeout(seconds) do
+        loop do
+          h = find_window wnd_class, title
+          break h if h > 0
+          sleep 0.3
+        end
+      end
+
+      Window.new @handle
+    end
+  end
+
+  DialogWndClass = '#32770'
+  def dialog(title, seconds=5)
+    close, dlg = begin
+      sleep 0.25
+      w = Window.top_level(title, seconds, DialogWndClass)
+      Window.set_foreground_window w.handle
+      sleep 0.25
+      
+      [yield(w), w]
+    rescue TimeoutError
+    end
+  
+    dlg.wait_for_close if dlg && close
+    return dlg
+  end
+end

data/book_code/home_stretch/junquenote.rb

@@ -0,0 +1,151 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+require 'swing_gui'
+require 'junquenote_app'
+require 'note'
+
+class JunqueNote < Note
+  @@app = JunqueNote
+  @@titles =
+  {
+    :file => "Input",
+    :exit  => "Quittin' time",
+    :about => "About JunqueNote",    
+    :about_menu  => "About JunqueNote..."
+  }
+  
+  include SwingGui
+  
+  
+  def initialize(name = nil, with_options = {})
+    options = DefaultOptions.merge(with_options)
+
+    @prompted = {}
+    @path = JunqueNote.path_to(name) if name
+    
+    @program = JunqueNoteApp.new
+    @main_window = JFrameOperator.new 'JunqueNote'
+    @edit_window = JTextAreaOperator.new @main_window
+    @menu_bar = JMenuBarOperator.new @main_window
+    
+    if name
+      menu 'File', 'Open...'
+      enter_filename @path, '_Open'
+      unlock_password options
+    end
+    
+    if @prompted[:with_error] || options[:cancel_password]
+      @program = nil
+    end
+  end
+  
+
+  def text
+    @edit_window.text
+  end
+  
+  
+  def text=(message)
+    @edit_window.select_all
+    @edit_window.type_text message
+  end
+  
+
+  
+  def selection
+    first = @edit_window.get_selection_start
+    last = @edit_window.get_selection_end
+    Range.new(first, last - 1)
+  end
+  
+  
+  
+  def go_to(where)
+    case where
+      when :beginning
+        @edit_window.set_caret_position 0
+      when :end
+        @edit_window.set_caret_position text.length
+    end
+  end
+  
+  
+  
+  def find(term, with_options={})
+    command = 'Find...'
+    command = 'Find Exact Case...' if with_options[:exact_case]
+    command = 'Reverse ' + command if :back == with_options[:direction]
+
+    menu 'Edit', command
+
+    dialog('Input') do |d|
+      d.type_in term
+      d.click 'OK'
+    end
+  end
+  
+  
+  
+  def running?
+    @main_window && @main_window.visible
+  end
+  
+
+  
+  def menu(name, item, wait = false)
+    action = wait ? :push_menu : :push_menu_no_block
+    @menu_bar.send action,  name + '|' + item, '|'
+  end
+  
+  
+  def select_all
+    @edit_window.select_all
+  end
+  
+  def self.path_to(name)
+    name + '.junque'
+  end
+
+private
+  
+
+  def enter_password(with_options = {})
+    options = DefaultOptions.merge with_options
+
+    @prompted[:for_password] = single_password_entry \
+      options[:password], options[:cancel_password]
+    
+    confirmation =
+      options[:confirmation] == true ?
+      options[:password] :
+      options[:confirmation]    
+    
+    if @prompted[:for_password] && confirmation
+      single_password_entry confirmation, false
+    end
+  end
+
+  def single_password_entry(password, cancel)
+    dialog('Input') do |d|
+      d.type_in password
+      d.click(cancel ? 'Cancel' : 'OK')
+    end
+  end
+  
+  
+  
+  def watch_for_error
+    if @prompted[:for_password]
+      @prompted[:with_error] = dialog('Oops') do |d|
+        d.click 'OK'
+      end
+    end
+  end
+  
+end

data/book_code/home_stretch/locknote.rb

@@ -0,0 +1,180 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+require 'windows_gui'
+require 'note'
+
+
+class LockNote < Note
+  include WindowsGui
+
+  @@app = LockNote
+  @@titles =
+  {
+    :file => 'Save As',
+    :exit  => 'Steganos LockNote',
+    :about => 'About Steganos LockNote...',
+    :about_menu  => 'About',
+    :dialog => 'Steganos LockNote'
+  }
+  
+  
+  BasePath = "C:\\LockNote"
+  WindowsGui.load_symbols "#{BasePath}\\src\\resource.h"
+  WindowsGui.load_symbols "#{BasePath}\\src\\atlres.h"
+  ID_HELP_ABOUT = ID_APP_ABOUT  
+  ID_FILE_EXIT = ID_APP_EXIT
+  
+      
+  
+  def initialize(name = 'LockNote', with_options = {})
+    options = DefaultOptions.merge(with_options)
+    
+    @prompted = {}
+    @path = LockNote.path_to(name)
+    
+    system 'start "" "' + @path + '"'
+    unlock_password options
+    
+    if @prompted[:with_error] || options[:cancel_password]
+      @main_window = Window.new 0
+      sleep 1.0
+    else
+      @main_window = Window.top_level "#{name} - Steganos LockNote"
+      @edit_window = @main_window.child "ATL:00434310"
+
+      set_foreground_window @main_window.handle
+    end
+  end
+  
+  
+  def select_all
+    keystroke VK_CONTROL, ?A
+  end
+  
+  def text
+    @edit_window.text
+  end
+  
+  
+  def text=(new_text)
+    select_all
+    keystroke VK_BACK
+    type_in new_text
+  end
+  
+
+  
+  def selection
+    result = send_message @edit_window.handle, EM_GETSEL, 0, 0
+    bounds = [result].pack('L').unpack('SS')
+    bounds[0]...bounds[1] #(1)
+  end
+  
+  
+  
+  def go_to(where)
+    case where
+      when :beginning
+        keystroke VK_CONTROL, VK_HOME
+      when :end
+        keystroke VK_CONTROL, VK_END
+    end
+  end
+  
+  
+  
+  WholeWord = 0x0410
+  ExactCase = 0x0411
+  SearchUp  = 0x0420
+  
+  def find(term, with_options={})
+    menu 'Edit', 'Find...'
+
+    appeared = dialog('Find') do |d|
+      type_in term
+      
+      d.click WholeWord if with_options[:whole_word]
+      d.click ExactCase if with_options[:exact_case]
+      d.click SearchUp if :back == with_options[:direction]
+      
+      d.click IDOK
+      d.click IDCANCEL
+    end
+    
+    raise 'Find dialog did not appear' unless appeared
+  end
+  
+  
+  
+  def running?
+    @main_window.handle != 0 && is_window(@main_window.handle) != 0
+  end
+  
+  
+  
+  def menu(name, item, wait = false)
+    multiple_words = /[.]/
+    single_word = /[ .]/
+    
+    [multiple_words, single_word].each do |pattern|
+      words = item.gsub(pattern, '').split
+      const_name = ['ID', name, *words].join('_').upcase
+      msg = WM_COMMAND
+      
+      begin
+        id = LockNote.const_get const_name
+        action = wait ? :send_message : :post_message
+        
+        return send(action, @main_window.handle, msg, id, 0)
+      rescue NameError
+      end
+    end
+  end
+  
+
+  def self.path_to(name)
+    "#{BasePath}\\#{name}.exe"
+  end  
+
+private
+
+  
+  def enter_password(with_options = {})
+    options = DefaultOptions.merge with_options
+
+    @prompted[:for_password] = dialog(@@titles[:dialog]) do |d|
+      type_in options[:password]
+
+      confirmation =
+        options[:confirmation] == true ?
+        options[:password] :
+        options[:confirmation]    
+      
+      if confirmation
+        keystroke VK_TAB
+        type_in confirmation
+      end
+          
+      d.click options[:cancel_password] ? IDCANCEL : IDOK
+    end
+  end
+  
+  
+  
+  ErrorIcon = 0x0014
+  
+  def watch_for_error
+    if @prompted[:for_password]
+      @prompted[:with_error] = dialog(@@titles[:dialog]) do |d|
+        d.click IDCANCEL if get_dlg_item(d.handle, ErrorIcon) > 0 #(2)
+      end
+    end
+  end
+  
+end