win32-autogui 0.2.0

data/.gitattributes

@@ -0,0 +1 @@
+*.rb diff=ruby

data/.gitignore

@@ -0,0 +1,10 @@
+pkg/*
+*.gem
+.bundle
+coverage
+rdoc
+.yardoc
+rerun.txt
+tags
+tmp/fixtures
+tmp/aruba

data/.yardopts

@@ -0,0 +1,6 @@
+--verbose
+--list-undoc
+-
+LICENSE
+HISTORY.markdown
+VERSION

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in the .gemspec file
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    win32-autogui (0.2.0)
+      win32-clipboard (>= 0.5.2)
+      win32-process (>= 0.6.2)
+      windows-api (>= 0.4.0)
+      windows-pr (>= 1.0.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.2.3)
+      background_process
+      cucumber (~> 0.9.0)
+    background_process (1.2)
+    builder (2.1.2)
+    cucumber (0.9.3)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    json (1.4.6)
+    rake (0.8.7)
+    rdiscount (1.6.5)
+    rspec (1.3.1)
+    term-ansicolor (1.0.5)
+    win32-api (1.4.6)
+    win32-clipboard (0.5.2)
+      windows-pr (>= 1.0.3)
+    win32-process (0.6.2)
+      windows-pr (>= 1.0.5)
+    windows-api (0.4.0)
+      win32-api (>= 1.4.5)
+    windows-pr (1.0.9)
+      win32-api (>= 1.4.5)
+      windows-api (>= 0.3.0)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (>= 0.2.3)
+  bundler (>= 1.0.3)
+  cucumber (>= 0.9.2)
+  rake (>= 0.8.7)
+  rdiscount (>= 1.6.5)
+  rspec (= 1.3.1)
+  win32-autogui!
+  win32-clipboard (>= 0.5.2)
+  win32-process (>= 0.6.2)
+  windows-api (>= 0.4.0)
+  windows-pr (>= 1.0.9)
+  yard (>= 0.6.1)

data/HISTORY.markdown

@@ -0,0 +1,11 @@
+History
+=======
+Most recent changes are at the top
+
+
+Changes
+-------
+
+### 0.2.0 - 11/04/2010 ###
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 GearheadForHire, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,265 @@
+Win32-Autogui
+=============
+
+A Win32 GUI testing framework packaged as a [RubyGem](http://rubygems.org/).
+
+
+Overview
+--------
+Win32-autogui provides a framework to enable GUI application testing 
+with Ruby.  This facilitates integration testing of Windows binaries using 
+Ruby based tools like [RSpec](http://github.com/dchelimsky/rspec) 
+and [Cucumber](http://github.com/aslakhellesoy/cucumber).  Examples of 
+using both these tools are provided with this gem.
+
+
+Quick Start
+-----------
+See [examples/skeleton/README.markdown](examples/skeleton/README.markdown) for 
+a template of the file structure needed for jump-starting GUI testing with 
+the Win32-autogui RubyGem.
+
+
+Example Usage: Driving Calc.exe
+-------------------------------
+
+Using [RSpec](http://github.com/dchelimsky/rspec) to test drive the stock 
+Window's calculator application.  This example is used as Win32-autogui's 
+internal spec. See [spec/auto_gui/application_spec.rb](spec/auto_gui/application_spec.rb).  
+
+A more complete example of testing a Window's Delphi program is presented with 
+source and binaries in [examples/quicknote/](examples/quicknote/).
+
+### Wrap the application to be tested ###
+The first step is to subclass Win32-autogui's application class.
+
+    require 'win32/autogui'
+
+    class Calculator < Autogui::Application
+
+      # initialize with the binary name 'calc' and the window title
+      # 'Calculator' used along with the application pid to find the 
+      # main application window
+      def initialize(options = {})
+        defaults = {
+                     :name => "calc",
+                     :title => "Calculator"
+                   }
+        super defaults.merge(options)
+      end
+
+      # the calculator's results window 
+      def edit_window
+        main_window.children.find {|w| w.window_class == 'Edit'}
+      end
+
+      # About dialog, hotkey (VK_MENU, VK_H, VK_A)
+      def dialog_about
+        Autogui::EnumerateDesktopWindows.new.find do |w| 
+          w.title.match(/About Calculator/) && (w.pid == pid)
+        end
+      end
+
+      # the 'CE' button
+      def clear_entry
+        keystroke(VK_DELETE)
+      end
+
+    end
+
+### Write specs ###
+The following RSpec code describes driving the Windows calculator for testing. 
+Multiple instances running simultaneously are supported.  See "should control
+focus with set_focus."
+
+    require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+    include Autogui::Input
+
+    describe Autogui::Application do
+
+      describe "driving calc.exe" do
+
+        before(:all) do
+          @calculator = Calculator.new
+        end
+
+        after(:all) do
+          @calculator.close(:wait_for_close => true) if @calculator.running?
+          @calculator.should_not be_running
+        end
+
+        it "should start when initialized" do
+          @calculator.should be_running
+        end
+
+        it "should have the title 'Calculator' that matches the main_window title" do
+          @calculator.main_window.title.should == 'Calculator'
+          @calculator.main_window.title.should == @calculator.title
+        end
+
+        it "should have an inspect method showing child window information" do
+          @calculator.inspect.should match(/children=</)
+        end
+
+        it "should calculate '2+2=4' using the keystroke method" do
+          @calculator.set_focus
+          keystroke(VK_2, VK_ADD, VK_2, VK_RETURN) 
+          @calculator.edit_window.text.strip.should == "4."
+        end
+
+        it "should calculate '2+12=14' using the type_in method" do
+          @calculator.set_focus
+          type_in("2+12=")
+          @calculator.edit_window.text.strip.should == "14."
+        end
+
+        it "should control the focus with 'set_focus'" do
+          @calculator.set_focus
+          keystroke(VK_9)
+          @calculator.edit_window.text.strip.should == "9."
+          
+          calculator2 = Calculator.new
+          calculator2.pid.should_not == @calculator.pid
+          calculator2.set_focus
+          keystroke(VK_1, VK_0) 
+          calculator2.edit_window.text.strip.should == "10."
+
+          @calculator.set_focus
+          @calculator.edit_window.text.strip.should == "9."
+
+          calculator2.close(:wait_for_close => true)
+        end
+
+        it "should open and close the 'About Calculator' dialog via (VK_MENU, VK_H, VK_A)" do
+          @calculator.set_focus
+          dialog_about = @calculator.dialog_about
+          dialog_about.should be_nil
+          keystroke(VK_MENU, VK_H, VK_A) 
+          dialog_about = @calculator.dialog_about
+          dialog_about.title.should == "About Calculator"
+          dialog_about.combined_text.should match(/Microsoft . Calculator/)
+          dialog_about.close
+          @calculator.dialog_about.should be_nil
+        end
+
+        describe "clipboard" do
+          before(:each) do
+            @calculator.clear_entry
+            @calculator.clipboard.text = ""
+            @calculator.clipboard.text.should == ""
+          end
+          
+          describe "copy (VK_CONTROL, VK_C)" do
+            it "should copy the edit window" do
+              @calculator.set_focus
+              type_in("3002")
+              @calculator.edit_window.text.strip.should == "3,002."
+              @calculator.edit_window.set_focus
+              keystroke(VK_CONTROL, VK_C) 
+              @calculator.clipboard.text.should == "3002"
+            end
+          end
+
+          describe "paste (VK_CONTROL, VK_V)" do
+            it "should paste into the edit window" do
+              @calculator.edit_window.set_focus
+              @calculator.clipboard.text = "12345"
+              @calculator.edit_window.text.strip.should == "0."
+              keystroke(VK_CONTROL, VK_V) 
+              @calculator.edit_window.text.strip.should == "12,345."
+            end
+          end
+
+        end
+
+      end
+    end
+
+
+System Requirements
+-------------------
+
+Windows OS, version 2000 or higher, testing was done via Cygwin <http://www.cygwin.com/>
+
+
+Dependencies
+------------
+Win32-autogui depends on the following RubyGems
+
+* Windows-api <http://github.com/djberg96/win32-api>
+* Windows-pr  <http://github.com/djberg96/windows-pr>
+* Win32-process <http://github.com/djberg96/win32-process>
+* Win32-clipboard <http://github.com/djberg96/win32-clipboard>
+
+
+Installation
+------------
+Win32-autogui is available on [RubyGems.org](http://rubygems.org/gems/win32-autogui)
+
+    gem install win32-autogui
+
+
+References and Alternative Libraries
+------------------------------------
+
+* Scripted GUI Testing with Ruby by Ian Dees <http://pragprog.com/titles/idgtr/scripted-gui-testing-with-ruby>
+* RAA - win32-guitest <http://raa.ruby-lang.org/project/win32-guitest>
+* Updated win32-guitest <http://rubyforge.org/projects/guitest>
+
+
+Development
+-----------
+Win32-autogui development was jump-started by cloning [BasicGem](http://github.com/robertwahler/basic_gem).
+
+### Dependencies ###
+
+* Bundler for dependency management <http://github.com/carlhuda/bundler>
+* RSpec for unit testing <http://github.com/dchelimsky/rspec>
+* Cucumber for functional testing <http://github.com/aslakhellesoy/cucumber>
+* Aruba for CLI testing <http://github.com/aslakhellesoy/aruba>
+* YARD for documentation generation <http://github.com/lsegal/yard>
+
+### Rake tasks ###
+
+rake -T
+
+    rake build         # Build win32-autogui-0.0.1.gem into the pkg directory
+    rake doc:clean     # Remove generated documenation
+    rake doc:generate  # Generate YARD Documentation
+    rake features      # Run Cucumber features
+    rake install       # Build and install win32-autogui-0.0.1.gem into system gems
+    rake release       # Create tag v0.0.1 and build and push win32-autogui-0.0.1.gem to Rubygems
+    rake spec          # Run specs
+    rake test          # Run specs and features
+
+
+### Autotesting with Watchr ###
+
+[Watchr](http://github.com/mynyml/watchr) provides a flexible alternative to Autotest.  A
+jump start script is provided in spec/watchr.rb.
+
+#### Install watchr ###
+
+    gem install watchr
+
+#### Run watchr ###
+
+    watchr spec/watchr.rb
+
+outputs a menu
+
+    Ctrl-\ for menu, Ctrl-C to quit
+
+Watchr will now watch the files defined in 'spec/watchr.rb' and run RSpec or Cucumber, as appropriate.
+The watchr script provides a simple menu.
+
+Ctrl-\
+
+    MENU: a = all , f = features  s = specs, l = last feature (none), q = quit
+
+
+Copyright
+---------
+
+Copyright (c) 2010 GearheadForHire, LLC. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+# bundler/setup is managing $LOAD_PATH, any gem needed by this Rakefile must 
+# be listed as a development dependency in the gemspec
+
+require 'rubygems'
+require 'bundler/setup' 
+
+Bundler::GemHelper.install_tasks
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path('../win32-autogui.gemspec', __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+require 'spec'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |task|
+  task.cucumber_opts = ["features"]
+end
+
+desc "Run specs and features"
+task :test => [:spec, :features]
+
+task :default => :test
+
+namespace :doc do
+  project_root = File.expand_path(File.dirname(__FILE__))
+  doc_destination = File.join(project_root, 'rdoc')
+
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  YARD::Rake::YardocTask.new(:generate) do |yt|
+    yt.options = ['--markup-provider', 'rdiscount', 
+                  '--output-dir', doc_destination
+                 ] +
+                 gemspec.rdoc_options - ['--line-numbers', '--inline-source']
+  end
+
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r doc_destination if File.exists?(doc_destination)
+  end
+
+end

data/TODO.markdown

@@ -0,0 +1,9 @@
+TODO
+====
+
+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