rdp-rautomation 0.6.3.1

data/ext/WindowsForms/src/WindowsForms/WindowsForms/WindowsForms.csproj

@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">x86</Platform>
+    <ProductVersion>8.0.30703</ProductVersion>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{79C33EDA-58C4-41EF-93DC-BA679895BD43}</ProjectGuid>
+    <OutputType>WinExe</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>WindowsForms</RootNamespace>
+    <AssemblyName>WindowsForms</AssemblyName>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
+    <TargetFrameworkProfile>Client</TargetFrameworkProfile>
+    <FileAlignment>512</FileAlignment>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
+    <PlatformTarget>x86</PlatformTarget>
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
+    <PlatformTarget>x86</PlatformTarget>
+    <DebugType>pdbonly</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="System" />
+    <Reference Include="System.Core" />
+    <Reference Include="System.Xml.Linq" />
+    <Reference Include="System.Data.DataSetExtensions" />
+    <Reference Include="Microsoft.CSharp" />
+    <Reference Include="System.Data" />
+    <Reference Include="System.Deployment" />
+    <Reference Include="System.Drawing" />
+    <Reference Include="System.Windows.Forms" />
+    <Reference Include="System.Xml" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="AboutBox.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="AboutBox.Designer.cs">
+      <DependentUpon>AboutBox.cs</DependentUpon>
+    </Compile>
+    <Compile Include="DataEntryForm.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="DataEntryForm.Designer.cs">
+      <DependentUpon>DataEntryForm.cs</DependentUpon>
+    </Compile>
+    <Compile Include="SimpleElementsForm.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="SimpleElementsForm.Designer.cs">
+      <DependentUpon>SimpleElementsForm.cs</DependentUpon>
+    </Compile>
+    <Compile Include="PersonForm.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="PersonForm.Designer.cs">
+      <DependentUpon>PersonForm.cs</DependentUpon>
+    </Compile>
+    <Compile Include="MainFormWindow.cs">
+      <SubType>Form</SubType>
+    </Compile>
+    <Compile Include="MainFormWindow.Designer.cs">
+      <DependentUpon>MainFormWindow.cs</DependentUpon>
+    </Compile>
+    <Compile Include="Program.cs" />
+    <Compile Include="Properties\AssemblyInfo.cs" />
+    <EmbeddedResource Include="AboutBox.resx">
+      <DependentUpon>AboutBox.cs</DependentUpon>
+    </EmbeddedResource>
+    <EmbeddedResource Include="DataEntryForm.resx">
+      <DependentUpon>DataEntryForm.cs</DependentUpon>
+    </EmbeddedResource>
+    <EmbeddedResource Include="SimpleElementsForm.resx">
+      <DependentUpon>SimpleElementsForm.cs</DependentUpon>
+    </EmbeddedResource>
+    <EmbeddedResource Include="PersonForm.resx">
+      <DependentUpon>PersonForm.cs</DependentUpon>
+    </EmbeddedResource>
+    <EmbeddedResource Include="MainFormWindow.resx">
+      <DependentUpon>MainFormWindow.cs</DependentUpon>
+    </EmbeddedResource>
+    <EmbeddedResource Include="Properties\Resources.resx">
+      <Generator>ResXFileCodeGenerator</Generator>
+      <LastGenOutput>Resources.Designer.cs</LastGenOutput>
+      <SubType>Designer</SubType>
+    </EmbeddedResource>
+    <Compile Include="Properties\Resources.Designer.cs">
+      <AutoGen>True</AutoGen>
+      <DependentUpon>Resources.resx</DependentUpon>
+    </Compile>
+    <None Include="Properties\Settings.settings">
+      <Generator>SettingsSingleFileGenerator</Generator>
+      <LastGenOutput>Settings.Designer.cs</LastGenOutput>
+    </None>
+    <Compile Include="Properties\Settings.Designer.cs">
+      <AutoGen>True</AutoGen>
+      <DependentUpon>Settings.settings</DependentUpon>
+      <DesignTimeSharedInput>True</DesignTimeSharedInput>
+    </Compile>
+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
+  -->
+</Project>

data/lib/rautomation.rb

@@ -0,0 +1,6 @@
+require "rautomation/wait_helper"
+require "rautomation/adapter/helper"
+require "rautomation/button"
+require "rautomation/text_field"
+require "rautomation/element_collections"
+require "rautomation/window"

data/lib/rautomation/adapter/autoit.rb

@@ -0,0 +1,5 @@
+require "win32ole"
+require File.dirname(__FILE__) + "/autoit/locators"
+require File.dirname(__FILE__) + "/autoit/button"
+require File.dirname(__FILE__) + "/autoit/text_field"
+require File.dirname(__FILE__) + "/autoit/window"

data/lib/rautomation/adapter/autoit/button.rb

@@ -0,0 +1,59 @@
+module RAutomation
+  module Adapter
+    module Autoit
+      class Button
+        include WaitHelper
+        include Locators
+        
+        # Default locators used for searching buttons.
+        DEFAULT_LOCATORS = {:class => /button/i}
+
+        # @private
+        # Special-cased locators
+        LOCATORS = {
+                [:class, Regexp] => :regexpclass,
+                :index => :instance,
+                :value => :text
+        }
+
+        # Creates the button object.
+        # @note this method is not meant to be accessed directly, but only through {RAutomation::Window#button}!
+        # @param [RAutomation::Window] window this button belongs to.
+        # @param [Hash] locators for searching the button.
+        # @option locators [String, Regexp] :value Value (text) of the button
+        # @option locators [String, Regexp] :class Internal class name of the button
+        # @option locators [String, Fixnum] :id Internal ID of the button
+        # @option locators [String, Fixnum] :index 0-based index to specify n-th button if all other criteria match
+        # @see RAutomation::Window#button
+        def initialize(window, locators)
+          @window = window
+          extract(locators)
+        end
+
+        # @see RAutomation::Button#click
+        def click
+          clicked = false
+          wait_until do
+            @window.activate
+            @window.active? &&
+                    Window.autoit.ControlFocus(@window.locator_hwnd, "", @autoit_locators) == 1 &&
+                    Window.autoit.ControlClick(@window.locator_hwnd, "", @autoit_locators) == 1 &&
+                    clicked = true # is clicked at least once
+
+            block_given? ? yield : clicked && !exists?
+          end
+        end
+
+        # @see RAutomation::Button#value
+        def value
+          Window.autoit.ControlGetText(@window.locator_hwnd, "", @autoit_locators)
+        end
+
+        # @see RAutomation::Button#exists?
+        def exists?
+          not Window.autoit.ControlGetHandle(@window.locator_hwnd, "", @autoit_locators).empty?
+        end
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/autoit/locators.rb

@@ -0,0 +1,22 @@
+module RAutomation
+  module Adapter
+    module Autoit
+      # @private
+      module Locators
+
+        private
+
+        def extract(locators)
+          locators = self.class::DEFAULT_LOCATORS.merge(locators) if self.class.const_defined?(:DEFAULT_LOCATORS)
+          @locators = locators
+          @autoit_locators = "[#{@locators.map do |locator, value|
+            locator_key = self.class::LOCATORS[locator] || self.class::LOCATORS[[locator, value.class]]
+            value = value.to_i + 1 if locator == :index # use 0-based indexing
+            value = value.to_s(16) if locator == :hwnd
+            "#{(locator_key || locator)}:#{value}"
+          end.join(";")}]"
+        end
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/autoit/text_field.rb

@@ -0,0 +1,61 @@
+module RAutomation
+  module Adapter
+    module Autoit
+      class TextField
+        include WaitHelper
+        include Locators
+
+        # Default locators used for searching text fields.
+        DEFAULT_LOCATORS = {:class => /edit/i}
+
+        # @private
+        # Special-cased locators
+        LOCATORS = {
+                [:class, Regexp] => :regexpclass,
+                :index => :instance,
+                :value => :text
+        }
+
+        # Creates the text field object.
+        # @note this method is not meant to be accessed directly, but only through {RAutomation::Window#text_field}!
+        # @param [RAutomation::Window] window this text field belongs to.
+        # @param [Hash] locators for searching the text field.
+        # @option locators [String, Regexp] :class Internal class name of the text field
+        # @option locators [String, Regexp] :value Value (text) of the text field
+        # @option locators [String, Fixnum] :id Internal ID of the text field
+        # @option locators [String, Fixnum] :index 0-based index to specify n-th text field if all other criteria match
+        # @see RAutomation::Window#text_field
+        def initialize(window, locators)
+          @window = window
+          extract(locators)
+        end
+
+        # @see RAutomation::TextField#set
+        def set(text)
+          wait_until do
+            @window.activate
+            @window.active? &&
+                    Window.autoit.ControlFocus(@window.locator_hwnd, "", @autoit_locators) == 1 &&
+                    Window.autoit.ControlSetText(@window.locator_hwnd, "", @autoit_locators, text) == 1 &&
+                    value == text
+          end
+        end
+
+        # @see RAutomation::TextField#clear
+        def clear
+          set ""
+        end
+
+        # @see RAutomation::TextField#value
+        def value
+          Window.autoit.ControlGetText(@window.locator_hwnd, "", @autoit_locators)
+        end
+
+        # @see RAutomation::TextField#exists?
+        def exists?
+          not Window.autoit.ControlGetHandle(@window.locator_hwnd, "", @autoit_locators).empty?
+        end
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/autoit/window.rb

@@ -0,0 +1,184 @@
+module RAutomation
+  module Adapter
+    module Autoit
+      class Window
+        include WaitHelper
+        include Locators
+
+        class << self
+          # @private
+          def autoit
+            @@autoit
+          end
+
+          # @private
+          def load_autoit
+            @@autoit = WIN32OLE.new('AutoItX3.Control')
+          rescue WIN32OLERuntimeError
+            dll = File.dirname(__FILE__) + "/../../../../ext/AutoItX/AutoItX3.dll"
+            system("regsvr32.exe /s #{dll.gsub('/', '\\')}")
+            @@autoit = WIN32OLE.new('AutoItX3.Control')
+          end
+        end
+
+        load_autoit
+        @@autoit.AutoItSetOption("WinWaitDelay", 350)
+
+        # Locators of the window.
+        attr_reader :locators
+
+        # @private
+        # Special-cased locators
+        LOCATORS = {
+          [:title, Regexp] => :regexptitle,
+          :index => :instance,
+          :hwnd => :handle
+        }
+
+        # Creates the window object.
+        # @note this method is not meant to be accessed directly, but only through {RAutomation::Window#initialize}!
+        # @param [Hash] locators for searching the window.
+        # @option locators [String, Regexp] :title Title of the window
+        # @option locators [String, Regexp] :text Visible text of the window
+        # @option locators [String, Regexp] :class Internal class name of the window
+        # @option locators [String, Fixnum] :hwnd Window handle in decimal format
+        # @option locators [String, Fixnum] :index 0-based index to specify n-th window if all other criteria match
+        # @see RAutomation::Window#initialize
+        def initialize(locators)
+          @hwnd = locators[:hwnd]
+          @locator_index = locators.delete(:index) if locators[:index] && locators.size == 1
+          @locator_pid = locators.delete(:pid).to_i if locators[:pid]
+          @locator_text = locators.delete(:text)
+          extract(locators)
+        end
+
+        # Retrieves handle of the window.
+        # @note Searches only for visible windows.
+        # @see RAutomation::Window#hwnd
+        def hwnd
+          @hwnd ||= begin
+                      locators = @autoit_locators
+                      if @locator_index || @locator_pid
+                        # @todo Come up with some better solution for this case
+                        locators = "[regexptitle:]" # match all, needed for the case when only :index or :pid is used
+                      end
+                      windows = @@autoit.WinList(locators, @locator_text).pop.compact.
+                        map {|handle| self.class.new(:hwnd => handle.hex)}
+                      windows.delete_if {|window| !window.visible?}
+                      
+                      if @locator_pid
+                        window = windows.find {|win| win.pid == @locator_pid} 
+                      else
+                        window = windows[@locator_index || 0]
+                      end
+                      window ? window.hwnd : nil
+                    end
+        end
+
+        # @see RAutomation::Window#pid
+        def pid
+          @@autoit.WinGetProcess(locator_hwnd).to_i
+        end
+
+        # @see RAutomation::Window#title
+        def title
+          @@autoit.WinGetTitle(locator_hwnd)
+        end
+
+        # @see RAutomation::Window#activate
+        def activate
+          @@autoit.WinWait(locator_hwnd, "", 1)
+          @@autoit.WinActivate(locator_hwnd)
+          sleep 1
+        end
+
+        # @see RAutomation::Window#active?
+        def active?
+          @@autoit.WinActive(locator_hwnd) == 1
+        end
+
+        # @see RAutomation::Window#text
+        def text
+          @@autoit.WinGetText(locator_hwnd)
+        end
+
+        # @see RAutomation::Window#exists?
+        def exists?
+          @@autoit.WinExists(locator_hwnd) == 1
+        end
+
+        # @see RAutomation::Window#visible?
+        def visible?
+          @@autoit.WinGetState(locator_hwnd) & 2 == 2
+        end
+
+        # @see RAutomation::Window#maximize
+        def maximize
+          @@autoit.WinSetState(locator_hwnd, "", @@autoit.SW_MAXIMIZE)
+          sleep 1
+        end
+
+        # @see RAutomation::Window#minimize
+        def minimize
+          @@autoit.WinSetState(locator_hwnd, "", @@autoit.SW_MINIMIZE)
+          sleep 1
+        end
+
+        # @see RAutomation::Window#minimized?
+        def minimized?
+          @@autoit.WinGetState(locator_hwnd) & 16 == 16
+        end
+
+        # @see RAutomation::Window#restore
+        def restore
+          @@autoit.WinSetState(locator_hwnd, "", @@autoit.SW_RESTORE)
+          sleep 1
+        end
+
+        # Activates the window and sends keys to it.
+        #
+        # Refer to AutoIt documentation at http://www.autoitscript.com/autoit3/docs/appendix/SendKeys.htm
+        # for keys syntax.
+        # @see RAutomation::Window#send_keys
+        def send_keys(keys)
+          wait_until do
+            activate
+            active?
+          end
+          @@autoit.Send(keys)
+        end
+
+        # @see RAutomation::Window#close
+        def close
+          @@autoit.WinClose(locator_hwnd)
+          @@autoit.WinKill(locator_hwnd)
+        end
+
+        # @see Button#initialize
+        # @see RAutomation::Window#button
+        def button(locator)
+          Button.new(self, locator)
+        end
+
+        # @see TextField#initialize
+        # @see RAutomation::Window#text_field
+        def text_field(locator)
+          TextField.new(self, locator)
+        end
+
+        # Redirects all method calls not part of the public API to the AutoIt directly.
+        # @example execute AutoIt's WinGetTitle function:
+        #   RAutomation::Window.new(:hwnd => 123456).WinGetTitle(...)
+        # @see RAutomation::Window#method_missing
+        def method_missing(name, *args)
+          @@autoit.send(name, *args)
+        end
+
+        # @private
+        def locator_hwnd
+          "[HANDLE:#{hwnd.to_i.to_s(16)}]"
+        end
+      end
+    end
+  end
+end