au3 0.1.0

data/lib/HISTORY.rdoc

@@ -0,0 +1,19 @@
+=History of au3
+Important changes are marked <b>bold</b>. 
+==0.1.0
+* <b>Changed the API to use win32-api now instead of a C extension</b>
+* <b>Added wide, wide!, normal and normal! to Ruby's String class</b>
+* Added the AutoItX3::AU3_Function class
+* <b>Added a block form to set_opt and opt that resets the options after executing the code block</b>
+* <b>Added an optional third parameter to AutoItX3.get_pixel_color for returning hexadecimal strings</b>
+* Changed the default value of the second parameter of send_keys from 0 to false, according to Ruby's style
+* Changed the return value of run_as_set to nil instead of true
+* Added Window.functions and Window.functions= to avoid multiple AU3_Function objects for different instances of Window
+* <b>Added Window#valid? as an alias for Window#exists?</b>
+* Changed the return value of Control#click to nil instead of true
+* Changed the return value of Control#disable to nil instead of true
+* Changed the return value of Control#enable to nil instead of true
+* Changed the return value of Control#focus to nil instead of true
+* Changed the return value of Control#hide to nil instead of true
+* Changed the return value of Control#move to nil instead of true
+* Added Control.from_control to allow Controls to be transformed into a subclass

data/lib/README.rdoc

@@ -0,0 +1,71 @@
+=au3
+<tt>.au3</tt> is the usual file extension for {AutoIt version 3}[http://www.autoitscript.com/autoit3/index.shtml] 
+scripts. That this library uses it as its name, tells a lot about 
+its features. Basically, the +au3+ library can do everything 
+you can do with the <tt>.au3</tt> files: 
+* Automate the mouse
+* Automate the keyboard
+* Manipulate Windows
+* etc. 
+However, there a a few exceptions, since +au3+ doesn't use 
+the AutoIt v3 interpreter behind the scenes. Instead, +au3+ is wrapped 
+around the DLL interface of AutoIt3, known as AutoItX3. 
+==DLL problems: So to use this
+As said, au3 is wrapped around AutoItX3. To get au3 working, you have 
+to have the file "AutoItX3.dll" somewhere in your PATH. The simplest way 
+to get this is just to download AutoIt from http://www.autoitscript.com 
+and copy the AutoItX3.dll file (I don't guarantee for the 64-bit version) 
+from the AutoItX subdirectory into the directory your script resides in. 
+Or, if you don't want to copy the file over and over again, put it in your Ruby's 
+bin directory. If you want to deploy your program, the final recipient need not 
+to have AutoIt installed - it's enough if you just include the AutoItX3.dll in your 
+application (and make sure you've read the AutoItX3 license - it's quite short). 
+==Usage
+The majority of +au3+'s methods is bundled the AutoItX3 module 
+and accessable via it's module methods. In order to get them, 
+just require +au3+: 
+  require "au3"
+  
+  AutoItX3.move_mouse(100, 100)
+The window-related methods are put together in the 
+AutoItX3::Window class. That allows you to create 
+Rubyish Window objects rather than using the procedural 
+function interface of AutoItX3. You needn't have to require them 
+extra. 
+  require "au3"
+  
+  window = AutoItX3::Window.new("au3") #The beginning of a window's title is enough
+  window.close
+Version 3 of AutoIt is known for its capabilities of direct 
+interaction with a window's controls. You will find this methods 
+wrapped in the AutoItX3::Control class. 
+  require "au3"
+  
+  #Run notepad
+  AutoItX3.run("notepad.exe")
+  #Wait for the window to exist
+  AutoItX3::Window.wait("Un") #The start of the title is enough to find it
+  #Get a reference to it
+  window = AutoItX3::Window.new("Un")
+  #Bring it to the front
+  window.activate
+  #Get the text control
+  edit = window.focused_control
+  #Set the text. You should also have a look on the AutoItX3.send_keys method.
+  edit.text = "ABCDEFG"
+===Don't know where to start?
+Have a look at the documentation of the AutoItX3 module. 
++au3+ is well documented and even if you don't find something 
+useful, you may just want to play around with it. ;-)
+==Copyright
+  Copyright © 2009 Marvin Gülker
+  Licensed under the same terms as Ruby (see http://www.ruby-lang.org/en/LICENSE.txt )
+    Initia in potestate nostra sunt, de eventu fortuna iudicat. 
+==License
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of Ruby's license. 
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 
+    Ruby's license for more details. 

data/lib/au3.rb

@@ -0,0 +1,2 @@
+#Encoding: UTF-8
+require_relative("AutoItX3/au3.rb")

data/test/test_clipboard.rb

@@ -0,0 +1,19 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3" 
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class ClipboardTest < Test::Unit::TestCase
+  
+  def test_clipboard
+    AutoItX3.cliptext = "HDGDL"
+    assert_equal("HDGDL", AutoItX3.cliptext)
+  end
+  
+end

data/test/test_ini.rb

@@ -0,0 +1,48 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class IniTest < Test::Unit::TestCase
+  
+  TEST_INI =<<EOF
+[Section1]
+key1=val1
+[Section2]
+key1=val2
+EOF
+  
+  INI_NAME = "test.ini"
+  
+  def self.startup
+    File.open(INI_NAME, "w"){|f| f.write(TEST_INI)}
+  end
+  
+  def test_read
+    assert_equal("val1", AutoItX3.read_ini_entry(INI_NAME, "Section1", "key1", ""))
+    assert_equal("val2", AutoItX3.read_ini_entry(INI_NAME, "Section2", "key1", ""))
+    assert_equal("XXX", AutoItX3.read_ini_entry(INI_NAME, "Section3", "key1", "XXX"))
+  end
+  
+  def test_write
+    AutoItX3.write_ini_entry(INI_NAME, "NewSection", "key", "aValue")
+    assert_equal("aValue", AutoItX3.read_ini_entry(INI_NAME, "NewSection", "key", ""))
+  end
+  
+  def test_delete
+    AutoItX3.write_ini_entry(INI_NAME, "ASection", "key", "aValue")
+    AutoItX3.delete_ini_entry(INI_NAME, "ASection", "key")
+    assert_equal("XXX", AutoItX3.read_ini_entry(INI_NAME, "ASection", "key", "XXX"))
+  end
+  
+  def self.shutdown
+    File.delete(INI_NAME)
+  end
+  
+end

data/test/test_keyboard.rb

@@ -0,0 +1,61 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class KeyboardTest < Test::Unit::TestCase
+  
+  TEXT1 = "abc"
+  TEXT2 = "One with\nNewline"
+  TEXT3 = "With{TAB}tab"
+  
+  def setup
+    @pid = AutoItX3.run("notepad", "", AutoItX3::Window::SW_MAXIMIZE)
+    sleep 2
+    AutoItX3.mouse_click(150, 150)
+  end
+  
+  def teardown
+    AutoItX3.kill_process(@pid)
+    sleep 1
+  end
+  
+  def copy_all
+    AutoItX3.send_keys("^a")
+    AutoItX3.msleep(200)
+    AutoItX3.send_keys("^c")
+    AutoItX3.msleep(200)
+  end
+  
+  def delete_all
+    AutoItX3.send_keys("^a")
+    AutoItX3.msleep(200)
+    AutoItX3.send_keys("{BS}")
+    AutoItX3.msleep(200)
+  end
+  
+  def test_send
+    AutoItX3.send_keys(TEXT1)
+    copy_all
+    assert_equal(TEXT1, AutoItX3.cliptext)
+    delete_all
+    AutoItX3.send_keys(TEXT2)
+    copy_all
+    assert_equal(TEXT2, AutoItX3.cliptext)
+    delete_all
+    AutoItX3.send_keys(TEXT3)
+    copy_all
+    assert_equal(TEXT3.sub("{TAB}", "\t"), AutoItX3.cliptext)
+    delete_all
+    AutoItX3.send_keys(TEXT3, true)
+    copy_all
+    assert_equal(TEXT3, AutoItX3.cliptext)
+  end
+  
+end

data/test/test_mouse.rb

@@ -0,0 +1,43 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class MouseTest < Test::Unit::TestCase
+  
+  THREADS = []
+  
+  def self.shutdown
+    THREADS.each{|t| t.join}
+  end
+  
+  def test_cursor_id
+    pid = AutoItX3.run("notepad", "", AutoItX3::Window::SW_MAXIMIZE)
+    AutoItX3.move_mouse(150, 150)
+    THREADS << Thread.new{sleep 1;AutoItX3.kill_process(pid)}
+    assert_equal(AutoItX3::IBEAM_CURSOR, AutoItX3.cursor_id)
+  end
+  
+  def test_move_curpos
+    AutoItX3.move_mouse(23, 74)
+    assert_equal([23, 74], AutoItX3.cursor_pos)
+  end
+  
+  def test_click
+    pid = AutoItX3.run("notepad", "", AutoItX3::Window::SW_MAXIMIZE)
+    AutoItX3.mouse_click(1000000, 5) #End of screen
+    THREADS << Thread.new{sleep 1;AutoItX3.kill_process(pid)}
+  end
+  
+  def test_tooltip
+    assert_nil(AutoItX3.tooltip("Google is watching you!"))
+    sleep 1
+  end
+  
+end

data/test/test_process.rb

@@ -0,0 +1,50 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class ProcessTest < Test::Unit::TestCase
+  
+  DUMMY_PROG =<<EOF
+#Encoding: Windows-1252
+loop{sleep 1}
+EOF
+  
+  def self.startup
+    AutoItX3.opt("WinTitleMatchMode", 2)
+  end
+  
+  def test_exists
+    assert_equal($$, AutoItX3.process_exists?($$))
+  end
+  
+  def test_kill
+    File.open("dummy.rb", "w"){|f| f.write(DUMMY_PROG)}
+    pid = AutoItX3.run("ruby dummy.rb")
+    sleep 1
+    assert_equal(pid, AutoItX3.process_exists?(pid))
+    AutoItX3.kill_process(pid)
+    sleep 1
+    assert_equal(false, AutoItX3.process_exists?(pid))
+    File.delete("dummy.rb")
+  end
+  
+  def test_wait
+    pid = AutoItX3.run("mspaint")
+    assert(AutoItX3.wait_for_process("mspaint.exe", 5))
+    sleep 1
+    AutoItX3.kill_process(pid)
+    assert(AutoItX3.wait_for_process_close("mspaint.exe", 2))
+  end
+  
+  def test_run_and_wait
+    assert_raises(AutoItX3::Au3Error){AutoItX3.run_and_wait("dir gibtsnich")}
+  end
+  
+end

data/test/test_tray.rb

@@ -0,0 +1,29 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class CDTrayTest < Test::Unit::TestCase
+  
+  TEST_TRAY = "E:"
+  
+  def test_open
+    assert(AutoItX3.open_cd_tray(TEST_TRAY))
+  end
+  
+  def test_close
+    AutoItX3.open_cd_tray(TEST_TRAY)
+    if !AutoItX3.close_cd_tray(TEST_TRAY)
+      notify "Could not close your CD tray. Are you running on a laptop?"
+    else
+      assert(true)
+    end
+  end
+  
+end

data/test/test_window.rb

@@ -0,0 +1,104 @@
+#Encoding: Windows-1252
+#This file is part of au3. 
+#Copyright (c) 2009 Marvin G�lker
+begin
+  require_relative "../lib/au3"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+end
+require "test/unit"
+
+class WindowTest < Test::Unit::TestCase
+  
+  THREADS = []
+  
+  def self.startup
+    AutoItX3.opt("WinTitleMatchMode", 2)
+  end
+  
+  def self.shutdown
+    THREADS.each{|t| t.join}
+  end
+  
+  def setup
+    @pid = AutoItX3.run("mspaint")
+    AutoItX3::Window.wait("Paint")
+    @win = AutoItX3::Window.new("Paint")
+  end
+  
+  def teardown
+    @win.kill
+  end
+  
+  def test_exists
+    assert_true(AutoItX3::Window.exists?(@win.title))
+  end
+  
+  def test_activate
+    pid = AutoItX3.run("calc")
+    THREADS << Thread.new{sleep 3; AutoItX3.kill_process(pid)}
+    sleep 1
+    assert_equal(false, @win.active?)
+    @win.activate
+    sleep 1
+    assert_true(@win.active?)
+  end
+  
+  def test_states
+    @win.state = AutoItX3::Window::SW_MINIMIZE
+    sleep 1
+    assert_true(@win.minimized?)
+    @win.state = AutoItX3::Window::SW_RESTORE
+    sleep 1
+    assert_equal(false, @win.minimized?)
+    @win.state = AutoItX3::Window::SW_MAXIMIZE
+    sleep 1
+    assert_true(@win.maximized?)
+  end
+  
+  def test_move_and_resize
+    @win.move(37, 45, 200, 200)
+    sleep 1
+    assert_equal([37, 45], @win.rect[0..1])
+    @win.move(0, 0, 420, 450)
+    sleep 1
+    assert_equal([0, 0, 420, 450], @win.rect)
+  end
+  
+  def test_pid
+    assert_equal(@pid, @win.pid)
+  end
+  
+  def test_statusbar_text
+    assert_compare(0, "<", @win.statusbar_text.size)
+  end
+  
+  def test_text
+    assert_compare(0, "<", @win.text.size)
+  end
+  
+  def test_title
+    assert_match(/Paint/, @win.title)
+  end
+  
+  def test_to_i
+    assert_equal(@win.handle.to_i(16), @win.to_i)
+  end
+  
+  def test_transparency
+    assert_equal(100, @win.transparency = 100)
+    sleep 1
+  end
+  
+  def test_visible
+    assert_true(@win.visible?)
+  end
+  
+  def test_close
+    @win.close
+    assert_true(@win.wait_not_active)
+    assert_true(@win.wait_close)
+  end
+  
+end