win_gui 0.1.0

data/book_code/guessing/locknote.rb

@@ -0,0 +1,379 @@
+#---
+# 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'
+require 'ftools'
+require 'set'
+
+
+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
+      
+  DefaultOptions = {
+    :password => 'password',
+    :confirmation => 'password'
+  }
+  
+  EditControl = 'ATL:00434310'
+  
+  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 EditControl
+
+      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
+    delete
+    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]
+  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
+      
+      begin
+        id = LockNote.const_get const_name
+        action = wait ? :send_message : :post_message
+        
+        return send(action, @main_window.handle, WM_COMMAND, 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]
+      
+      if options[:confirmation]
+        keystroke VK_TAB
+        type_in options[: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
+      end
+    end
+  end
+end
+
+
+
+srand
+$seed ||= srand #(1)
+srand $seed
+puts "Using random seed #{$seed}"
+
+class LockNote
+  def paste
+    case rand(3)
+    when 0
+      menu 'Edit', 'Paste'
+      puts 'Pasting from the menu'
+    when 1
+      keystroke VK_CONTROL, ?V
+      puts 'Pasting from a keyboard shortcut'
+    when 2
+      @main_window.click EditControl, :right #(2)
+      type_in 'P'
+      puts 'Pasting from a context menu'
+    end
+  end
+end
+
+
+
+class LockNote
+  @@default_way = :random
+  
+  def self.def_action(name, options, way = nil)
+    define_method name do
+      keys = options.keys.sort {|k| k.to_s}
+
+      way ||= @@default_way #(3)
+      key = case way
+        when nil;     keys.last
+        when :random; keys[rand(keys.size)]
+        else          way
+      end
+
+      action = options[key]
+  
+      case key
+      when :menu
+        menu *action
+        
+        puts "Performing #{name} from the menu bar"
+        
+
+      when :keyboard
+        keystroke *action
+        sleep 0.5
+        puts "Performing #{name} from a keyboard shortcut"
+
+      when :context
+        @main_window.click LockNote::EditControl, :right
+        sleep 0.5
+        type_in action
+        sleep 0.5
+        puts "Performing #{name} from a context menu"
+
+      else
+        raise "Don't know how to use #{key}"
+      end
+    end
+  end
+end
+
+
+
+require 'logger'
+
+class SimpleFormatter < Logger::Formatter #(4)
+  def call(severity, time, progname, msg)
+    msg2str(msg) + "\n"
+  end
+end
+
+$logger = Logger.new STDERR
+$logger.formatter = SimpleFormatter.new #(5)
+
+
+class LockNote
+  @@actions = Set.new
+  
+  def self.def_action(name, options, way = nil)
+    @@actions << name
+
+    define_method name do
+      way ||= @@default_way
+      
+      keys = options.keys.sort_by {|k| k.to_s}
+      key = case way
+        when nil;     keys.last
+        when :random; keys[rand(keys.size)]
+        else          way
+      end
+
+      action = options[key]
+
+      case key
+      when :menu
+        menu *action
+        $logger.info "menu '#{action[0]}', '#{action[1]}'"
+
+      when :keyboard
+        keystroke *action
+        sleep 0.5
+        $logger.info "keystroke " + action.join(', ')
+
+      when :context
+        @main_window.click LockNote::EditControl, :right
+        sleep 0.5
+        type_in action
+        sleep 0.5
+        $logger.info "@main_window.click EditControl, :right"
+        $logger.info "type_in '#{action}'"
+
+      else
+        raise "Don't know how to use #{key}"
+      end
+    end
+  end
+end
+
+class LockNote
+  
+  def_action :paste,
+    :menu => ['Edit', 'Paste', :wait],
+    :keyboard => [VK_CONTROL, ?V],
+    :context => 'p'
+  
+end
+
+class LockNote
+  
+  def_action :undo,
+    :menu => ['Edit', 'Undo', :wait],
+    :keyboard => [VK_CONTROL, ?Z]
+
+  def_action :cut,
+    :menu => ['Edit', 'Cut', :wait],
+    :keyboard => [VK_CONTROL, ?X],
+    :context => 't'
+
+  def_action :copy,
+    :menu => ['Edit', 'Copy', :wait],
+    :keyboard => [VK_CONTROL, ?C],
+    :context => 'c'
+
+  def_action :delete,
+    :keyboard => [VK_BACK],
+    :context => 'd'
+
+  def_action :select_all,
+    :menu => ['Edit', 'Select All', :wait],
+    :keyboard => [VK_CONTROL, ?A],
+    :context => 'a'
+  
+end
+
+class LockNote
+  def_action :find_next,
+    :menu => ['Edit', 'Find Next', :wait],
+    :keyboard => [VK_F3]
+end
+
+class LockNote
+  def random_action
+    raise "LockNote is not running" unless running?
+    choices = @@actions.to_a
+    action = choices[rand(choices.size)]
+    send action
+  end
+  
+  
+  def random_typing
+    num = 1 + rand(50)
+    random_text = (1..num).collect {rand(26) + ?a}.pack 'c*'
+    type_in random_text
+    $logger.info "Typing #{random_text}"
+  end
+  
+  def random_clicking
+    num = 1 + rand(10)
+    num.times do
+      point = nil
+      (rand(2) + 1).times do
+        point = @main_window.click(EditControl, :left, point || :random)
+        $logger.info "Clicking #{point.inspect}"
+      end
+    end
+  end
+  
+  @@actions << :random_typing << :random_clicking
+  
+
+  def random_typing
+    num = 1 + rand(50)
+    random_text = (1..num).collect {rand(26) + ?a}.pack 'c*'
+    type_in random_text
+    $logger.info "type_in '#{random_text}'"
+  end
+  
+  def random_clicking
+    num = 1 + rand(10)
+    num.times do
+      point = nil
+      (rand(2) + 1).times do
+        point = @main_window.click(EditControl, :left, point || :random)
+        $logger.info "@main_window.click EditControl, :left, " + point.inspect
+      end
+    end
+  end
+end

data/book_code/guessing/monkeyshines.rb

@@ -0,0 +1,14 @@
+#---
+# 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 'locknote'
+
+
+note = Note.open
+100.times {note.random_action}
+

data/book_code/guessing/note.rb

@@ -0,0 +1,120 @@
+#---
+# 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 => 'password'
+  }
+  
+  def exit!(with_options = {})
+    options = DefaultOptions.merge with_options
+    
+    @main_window.close
+
+    @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]} #(1)
+
+    new_options = {
+      :password => with_options[:password],
+      :confirmation =>
+        with_options[:confirmation] ||
+        with_options[:password]}                #(2)
+
+    menu 'File', 'Change Password...'
+
+    unlock_password old_options
+    assign_password new_options
+  end
+
+  def save_as(name, with_options = {})
+    options = DefaultOptions.merge with_options #(3)
+    
+    @path = @@app.path_to(name)                 #(4)
+    File.delete @path if File.exists? @path
+    
+    menu 'File', 'Save As...'                   #(5)
+
+    enter_filename @path                        #(6)
+    assign_password 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
+
+  def self.fixture(name)
+    source = @@app.path_to(name + 'Fixture')
+    target = @@app.path_to(name)
+    
+    File.delete target if File.exists? target
+    File.copy source, target
+  end
+
+private
+
+  def enter_filename(path)
+    dialog(@@titles[:file]) do |d| #(8)
+      d.type_in path
+      d.click '_Save'
+    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

data/book_code/guessing/note_spec.rb

@@ -0,0 +1,175 @@
+#---
+# 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'
+    @note.should have_prompted(:for_password)
+  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)
+  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)
+  end
+end
+
+describe 'The password entry prompt' do
+  it_should_behave_like 'a saved document'
+
+  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'
+  
+  it 'preserves and encrypts the contents of the file' do
+    @note.text.should include('Welcome')
+    IO.read(@note.path).should_not include('Welcome')
+  end
+
+  it 'does not require a password on subsequent saves' do
+    @note.text = 'changed'
+    @note.exit! :save_as => 'MyNote'
+    @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
+      @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/guessing/replay.rb

@@ -0,0 +1,21 @@
+#---
+# 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 'LockNote'
+
+EditControl = LockNote::EditControl
+
+Note.open.instance_eval do
+  menu 'Edit', 'Select All'
+  type_in 'asggzwhcbgk'
+  keystroke 17, 90; sleep 0.5
+  @main_window.click EditControl, :left, [370, 253]
+  @main_window.click EditControl, :left, [370, 253]
+  @main_window.click EditControl, :left, [644, 255]
+  # ...
+end

data/book_code/guessing/seed.rb

@@ -0,0 +1,9 @@
+#---
+# 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.
+#---
+$seed = 12345