win_gui 0.1.0

data/book_code/home_stretch/note.rb

@@ -0,0 +1,144 @@
+#---
+# 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.
+#---
+class Note
+  attr_reader :path  
+  
+  @@app = nil
+  @@titles = {}
+  
+  def self.open(*args)
+    @@app.new *args
+  end
+    
+  
+  DefaultOptions = {
+    :password => 'password',
+    :confirmation => true
+  }
+
+  def save_as(name, with_options = {})
+    options = DefaultOptions.merge with_options #(1)
+    
+    @path = @@app.path_to(name)                 #(2)
+    File.delete @path if File.exist? @path
+    
+    menu 'File', 'Save As...'                   #(3)
+
+    enter_filename @path                        #(4)
+    assign_password options
+  end
+  
+  
+  
+  
+  def exit!(with_options = {})
+    options = DefaultOptions.merge with_options
+    
+    menu 'File', 'Exit'
+
+    @prompted[:to_confirm_exit] = dialog(@@titles[:exit]) do |d|
+      d.click(options[:save_as] ? '_Yes' : '_No')
+    end
+      
+    if options[:save_as]
+      path = @@app.path_to options[:save_as]
+      enter_filename path
+      assign_password options
+    end
+  end
+  
+
+  
+  def change_password(with_options = {})
+    old_options = {
+      :password => with_options[:old_password]} #(5)
+
+    new_options = {
+      :password => with_options[:password],
+      :confirmation =>
+        with_options[:confirmation] ||
+        with_options[:password]}                #(6)
+
+    menu 'File', 'Change Password...'
+
+    unlock_password old_options
+    assign_password new_options
+  end
+  
+
+  def about
+    menu 'Help', @@titles[:about_menu]
+    
+    @prompted[:with_help_text] = dialog(@@titles[:about]) do |d|
+      d.click '_OK'
+    end
+  end
+  
+  
+  [:undo, :cut, :copy, :paste, :find_next].each do |method|
+    item = method.to_s.split('_').collect {|m| m.capitalize}.join(' ')
+    define_method(method) {menu 'Edit', item, :wait} #(7)
+  end
+  
+  
+  
+  def has_prompted?(kind)
+    @prompted[kind]
+  end
+  
+
+private
+
+  
+  def enter_filename(path, approval = '_Save')
+    dialog(@@titles[:file]) do |d| #(8)
+      d.type_in path
+      d.click approval
+    end
+  end
+  
+
+  
+  def unlock_password(with_options = {})
+    options = DefaultOptions.merge with_options
+    options[:confirmation] = false #(9)
+
+    enter_password options
+    watch_for_error
+  end
+  
+
+  
+  def assign_password(with_options = {})
+    options = DefaultOptions.merge with_options
+
+    enter_password options
+    watch_for_error
+    
+    if @prompted[:with_error]
+      enter_password :cancel_password => true #(10)
+    end
+  end
+  
+end
+
+
+
+require 'fileutils'
+
+class Note
+  def self.fixture(name)
+    source = @@app.path_to(name + 'Fixture')
+    target = @@app.path_to(name)
+  
+    FileUtils.rm target if File.exist? target
+    FileUtils.copy source, target
+  end
+end
+

data/book_code/home_stretch/note_spec.rb

@@ -0,0 +1,191 @@
+#---
+# 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 'spec_helper'
+
+describe 'The main window' do
+  it_should_behave_like 'a new document'
+  
+  it 'launches with a welcome message' do
+    @note.text.should include('Welcome')
+  end
+  
+  it 'exits without a prompt if nothing has changed' do
+    @note.exit!
+    @note.should_not have_prompted(:to_confirm_exit)
+  end
+  
+  it 'prompts before exiting if the document has changed' do
+    @note.text = 'changed'
+    @note.exit!
+    @note.should have_prompted(:to_confirm_exit)
+  end
+  
+  it 'offers information about the program' do
+    @note.about
+    @note.should have_prompted(:with_help_text)
+  end  
+end
+
+
+describe 'Saving a document for the first time' do
+  it_should_behave_like 'a new document'
+  
+  it 'requires a password' do
+    @note.save_as 'MyNote'                    #(1)
+    @note.should have_prompted(:for_password) #(2)
+  end
+end
+
+
+
+describe 'The password assignment prompt' do
+  it_should_behave_like 'a new document'
+  
+  it 'ignores the new password if cancelled' do
+    @note.text = 'changed'
+    @note.save_as 'MyNote', :cancel_password => true
+    @note.exit!
+    @note.should have_prompted(:to_confirm_exit) #(3)
+  end
+  
+  it 'ignores an unconfirmed password' do
+    @note.text = 'changed'
+    @note.save_as 'SavedNote', :confirmation => 'mismatch'
+    @note.should have_prompted(:with_error)
+    @note.exit!
+    @note.should have_prompted(:to_confirm_exit) #(4)
+  end
+end
+
+
+
+describe 'The password entry prompt' do
+  it_should_behave_like 'a saved document' #(5)
+
+  it 'ignores the password if cancelled' do
+    note = Note.open 'SavedNote', :cancel_password => true
+    note.should_not be_running
+  end
+  
+  it 'exits with an error message for an invalid password' do
+    note = Note.open 'SavedNote', :password => 'invalid'
+    note.should_not be_running
+    note.should have_prompted(:with_error)
+  end
+end
+
+
+
+describe 'A previously saved document' do
+  it_should_behave_like 'a saved document'
+  it_should_behave_like 'a reopened document' #(6)
+
+  it 'preserves and encrypts the contents of the file' do
+    @note.text.should include('Welcome')
+    IO.read(@note.path).should_not include('Welcome') #(7)
+  end
+
+  it 'does not require a password on subsequent saves' do
+    @note.text = 'changed'
+    @note.exit! :save_as => 'MyNote' #(8)
+    @note.should_not have_prompted(:for_password)
+  end
+
+  
+  it 'supports changing the password' do
+    @note.change_password \
+      :old_password => 'password',
+      :password => 'new'
+    @note.exit!
+    
+    @note = Note.open 'SavedNote', :password => 'new'
+    @note.should_not have_prompted(:with_error)
+    @note.should be_running
+  end
+  
+end
+
+
+
+describe 'The editor' do
+  it_should_behave_like 'a new document'
+
+  it 'supports multiple levels of undo' do
+    @note.text = 'abc'
+    
+    @note.undo
+    @note.text.should == 'ab'
+
+    @note.undo
+    @note.text.should == 'a'
+  end
+  
+  it 'supports copying and pasting text' do
+    @note.text = 'itchy'
+    @note.select_all
+    @note.copy
+    @note.text.should == 'itchy'
+    
+    @note.text = 'scratchy'
+    @note.select_all
+    @note.paste
+    @note.text.should == 'itchy'
+  end
+  
+  
+  it 'supports cutting and pasting text' do
+    @note.text = 'pineapple'
+    @note.select_all
+    @note.cut
+    @note.text.should be_empty
+    
+    @note.text = 'mango'
+    @note.select_all
+    @note.paste
+    @note.text.should == 'pineapple'
+  end
+  
+end
+
+
+
+describe 'The Find window' do
+  it_should_behave_like 'a new document'
+  it_should_behave_like 'a searchable document'
+  
+  it 'supports searching forward' do
+    @note.go_to :beginning
+    @note.find @term
+    @note.selection.begin.should == @first_match
+
+    @note.find_next
+    @note.selection.begin.should == @second_match
+  end
+  
+  it 'supports searching backward' do
+    @note.go_to :end
+    @note.find @term, :direction => :back
+    @note.selection.begin.should == @reverse_match
+  end
+  
+  it 'can restrict its search to whole words' do
+    pending 'on hold' do #(9)
+      @note.go_to :beginning
+      @note.find @term, :whole_word => true
+      @note.selection.begin.should == @word_match
+    end
+  end
+  
+  it 'can restrict its search to exact case matches' do
+    @note.go_to :beginning
+    @note.find @term, :exact_case => true
+    @note.selection.begin.should == @case_match   
+  end
+end
+

data/book_code/home_stretch/spec_helper.rb

@@ -0,0 +1,55 @@
+#---
+# 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.
+#---
+
+describe 'a new document', :shared => true do #(1)
+  before do                                   #(2)
+    @note = Note.open
+  end
+  
+  after do                                    #(3)
+    @note.exit! if @note.running?             #(4)
+  end
+end
+
+
+
+describe 'a saved document', :shared => true do
+  before do
+    Note.fixture 'SavedNote'                  #(5)
+  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
+  before do
+    @example = 'The longest island is Isabel Island.'
+    @term = 'Is'
+
+    @first_match = @example.index(/Is/i)
+    @second_match = @example.index(/Is/i, @first_match + 1)
+    @reverse_match = @example.rindex(/Is/i)
+    @word_match = @example.index(/Is\b/i)
+    @case_match = @example.index(/Is/)    
+
+    @note.text = @example
+  end
+end

data/book_code/home_stretch/swing_gui.rb

@@ -0,0 +1,50 @@
+#---
+# 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 'java'
+require 'jemmy.jar'
+
+include_class 'org.netbeans.jemmy.JemmyProperties'
+include_class 'org.netbeans.jemmy.TestOut'
+
+JemmyProperties.set_current_output TestOut.get_null_output
+
+%w(Frame TextArea MenuBar Dialog Button TextField).each do |o|
+  include_class "org.netbeans.jemmy.operators.J#{o}Operator"
+end
+
+
+class JDialogOperator
+  def click(title)
+    b = JButtonOperator.new self, title.delete('_')
+    b.push
+  end
+  
+  def type_in(message)
+    e = JTextFieldOperator.new self
+    e.type_text message
+  end
+end
+
+
+
+module SwingGui
+  def dialog(title, seconds=3)
+    JemmyProperties.set_current_timeout \
+      'DialogWaiter.WaitDialogTimeout', seconds * 1000
+    
+    begin
+      d = JDialogOperator.new title
+      yield d #(1)
+      d.wait_closed
+      
+      true
+    rescue NativeException
+    end
+  end
+end

data/book_code/home_stretch/windows_gui.rb

@@ -0,0 +1,232 @@
+#---
+# 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'
+
+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
+    
+    ascii = unpack('C')[0]
+    
+    case self
+      when '0'..'9'
+        [ascii - ?0 + 0x30]
+      when 'A'..'Z'
+        [WindowsGui.const_get(:VK_SHIFT), ascii]
+      when 'a'..'z'
+        [ascii - ?a + ?A]
+      when ' '
+        [ascii]
+      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_102)]
+      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'
+  
+
+  
+  # Windows messages - general
+  WM_COMMAND = 0x0111 
+  WM_SYSCOMMAND = 0x0112 
+  SC_CLOSE = 0xF060
+
+  # Windows messages - text
+  WM_GETTEXT = 0x000D
+  EM_GETSEL = 0x00B0
+  EM_SETSEL = 0x00B1
+    
+  # Commonly-used control IDs
+  IDOK = 1
+  IDCANCEL = 2
+  IDYES = 6
+  IDNO = 7
+  
+  # Mouse and keyboard flags
+  MOUSEEVENTF_LEFTDOWN = 0x0002 
+  MOUSEEVENTF_LEFTUP = 0x0004
+  KEYEVENTF_KEYDOWN = 0 
+  KEYEVENTF_KEYUP = 2 
+
+  # Modifier keys
+  VK_SHIFT = 0x10
+  VK_CONTROL = 0x11
+  VK_MENU = 0x12       # Alt
+  
+  # Commonly-used keys
+  VK_BACK = 0x08
+  VK_TAB = 0x09
+  VK_RETURN = 0x0D
+  VK_ESCAPE = 0x1B
+  VK_OEM_1 = 0xBA       # semicolon (US)
+  VK_OEM_102 = 0xE2     # backslash (US)
+  VK_OEM_PERIOD = 0xBE
+  VK_HOME = 0x24 
+  VK_END = 0x23
+  VK_OEM_COMMA = 0xBC
+  
+
+  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.scan(/./m) 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)
+      h = child(id).handle
+    
+      rectangle = [0, 0, 0, 0].pack 'LLLL'
+      get_window_rect h, rectangle 
+      left, top, right, bottom = rectangle.unpack 'LLLL'
+
+      center = [(left + right) / 2, (top + bottom) / 2]
+      set_cursor_pos *center
+
+      mouse_event MOUSEEVENTF_LEFTDOWN, 0, 0, 0, 0 
+      mouse_event MOUSEEVENTF_LEFTUP, 0, 0, 0, 0      
+    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/junquenote/exports.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+#---
+# 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.
+#---
+export PATH=/opt/jruby/bin:$PATH

data/book_code/junquenote/jruby_mac.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+#---
+# 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.
+#---
+/usr/bin/env jruby -J-Dapple.laf.useScreenMenuBar=true -J-Xdock:name=JunqueNote $*