rautomation 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d60457345affb72ade2ec56f93991a918cb39cd8
-  data.tar.gz: d136c890f577984d093d2831aa6f19559a54a271
+  metadata.gz: 748478d3036c775c96382a911bccd9e8253ef1ac
+  data.tar.gz: e7bf598b813dd955fcbea0c2d50f143159a06380
 SHA512:
-  metadata.gz: 562a850a9175f49764a49927a6dd86666afc248065a1c9cee6e4ba739702f613777f71fbb354074b071af979b60399d4d59abe61ed3ce283bc4e188f43b3d7ca
-  data.tar.gz: a26f7646d7b025c58584906fc9808bd0eeca4321f3b3caf53f2a8fd4ab8e02b2fc50cb8b69976e6dbfb6e0438226aeaac30ba61ef584a7bfc9fa699b79490484
+  metadata.gz: b391f11900769761f78426e9ba26029b08cad3e2c68723ab32cf64026611697db96e6dfdefb93e875ecc21045ba24005b56ddfc53b56e4e7215ea389b1e8d256
+  data.tar.gz: 623f4f71ac5c00c18524a1bb151a5b80e2a86a3745253f6887ba85ff929acb70f1eec5662acc86b469895ffde75b64811cdfd973528ec64a900fd5ef7bd7a2c0

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    rautomation (0.9.1)
+    rautomation (0.9.2)
       ffi
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.1.3)
-    ffi (1.7.0-x86-mingw32)
+    ffi (1.8.1-x86-mingw32)
     rake (0.9.2.2)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
@@ -18,7 +18,7 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    yard (0.8.3)
+    yard (0.8.6.1)
 
 PLATFORMS
   x86-mingw32

data/History.rdoc

@@ -1,6 +1,23 @@
-== 0.9.1
+== 0.9.2 / 2013-05-19
+
+=== Win32 adapter
+
+  * Window#send_keys supports now :dash, :slash and :backslash. Closes #64.
 
 === MsUia adapter
+
+  * Ability to get and set the text of a multi-line text control that only supports the TextPattern.
+  * Add some caching to speed up locating controls.
+  * Fix issue #67 that happens when clicking on controls.
+
+=== AutoIt adapter
+
+  * Add deprecation warning.
+
+== 0.9.1 / 2013-04-26
+
+=== MsUia adapter
+
   * Ability to interact with controls that do not have native window handles (for example WPF applications).
 
 == 0.9.0 / 2013-04-22

data/Rakefile

@@ -37,7 +37,7 @@ end
 task :build => "build:all"
 
 namespace :spec do
-  adapters = %w[win_32 autoit ms_uia]
+  adapters = %w[win_32 ms_uia]
 
   adapters.each do |adapter|
     desc "Run RSpec code examples against #{adapter} adapter"

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.9.2

data/ext/UiaDll/UiaDll/AutomatedText.cpp

@@ -0,0 +1,22 @@
+#include "StdAfx.h"
+#include "AutomatedText.h"
+
+String^ AutomatedText::Text::get() {
+  if( IsValuePattern ) {
+    return Value;
+  } else {
+    return AsTextPattern->DocumentRange->GetText(-1);
+  }
+}
+
+void AutomatedText::Text::set(String^ value) {
+  if( IsValuePattern ) {
+    Value = value;
+  } else {
+    _control->SetFocus();
+    SendKeys::SendWait("^{HOME}");   // Move to start of control
+    SendKeys::SendWait("^+{END}");   // Select everything
+    SendKeys::SendWait("{DEL}");     // Delete selection
+    SendKeys::SendWait(value);
+  }
+}

data/ext/UiaDll/UiaDll/AutomatedText.h

@@ -0,0 +1,26 @@
+#pragma once
+
+#include "automationcontrol.h"
+
+using namespace System::Windows::Automation;
+using namespace System::Windows::Forms;
+
+ref class AutomatedText : public AutomationControl
+{
+public:
+  AutomatedText(const HWND windowHandle) : AutomationControl(windowHandle) {}
+  AutomatedText(const FindInformation& finderInformation) : AutomationControl(finderInformation) {}
+
+  property String^ Text {
+    String^ get();
+    void set(String^ value);
+  }
+
+private:
+	property TextPattern^ AsTextPattern {
+		TextPattern^ get() {
+			return dynamic_cast<TextPattern^>(_control->GetCurrentPattern(TextPattern::Pattern));
+		}
+	}
+};
+

data/ext/UiaDll/UiaDll/AutomationClicker.cpp

@@ -1,14 +1,21 @@
 #include "StdAfx.h"
 #include "AutomationClicker.h"
 
-void AutomationClicker::Click() {
-	if( CanInvoke() ) {
-		return Invoke();
-	} else if( CanToggle() ) {
-		return Toggle();
-	} else if( CanSelect() ) {
-		return Select();
-	}
+bool AutomationClicker::Click() {
+  try {
+    if( CanInvoke() ) {
+      Invoke();
+    } else if( CanToggle() ) {
+      Toggle();
+    } else if( CanSelect() ) {
+      Select();
+    }
+
+    return true;
+  } catch(Exception^ e) {
+    Console::WriteLine("AutomationClicker::Click - {0}", e->Message);
+    return false;
+  }
 
 	throw gcnew Exception(gcnew String("AutomationElement did not support the InvokePattern, TogglePattern or the SelectionItemPattern"));
 }

data/ext/UiaDll/UiaDll/AutomationClicker.h

@@ -10,7 +10,7 @@ ref class AutomationClicker : AutomationControl
 public:
   AutomationClicker(const HWND windowHandle) : AutomationControl(windowHandle) {}
   AutomationClicker(const FindInformation& findInformation) : AutomationControl(findInformation) {}
-	void Click();
+	bool Click();
 	void MouseClick();
 
 private:

data/ext/UiaDll/UiaDll/AutomationControl.cpp

@@ -25,4 +25,12 @@ void AutomationControl::Value::set(String^ value) {
 
 String^ AutomationControl::Value::get() {
 	return AsValuePattern->Current.Value;
+}
+
+bool AutomationControl::IsValuePattern::get() {
+  try {
+    return nullptr != AsValuePattern;
+  } catch(Exception^ e) {
+    return false;
+  }
 }

data/ext/UiaDll/UiaDll/AutomationControl.h

@@ -51,6 +51,10 @@ public:
 	  bool get() { return nullptr != _control; }
   }
 
+  property bool IsValuePattern {
+    bool get();
+  }
+
 protected:
 	AutomationElement^ _control;
 

data/ext/UiaDll/UiaDll/TextMethods.cpp

@@ -0,0 +1,23 @@
+#include "stdafx.h"
+#include "AutomatedText.h"
+#include "StringHelper.h"
+
+extern "C" {
+  __declspec ( dllexport ) void Text_GetValue(const FindInformation& findInformation, char* theValue, const int maximumLength) {
+    try {
+      auto control = gcnew AutomatedText(findInformation);
+      StringHelper::CopyToUnmanagedString(control->Text, theValue, maximumLength);
+    } catch(Exception^ e) {
+      Console::WriteLine("Text_GetValue:  {0}", e->Message);
+    }
+  }
+
+  __declspec ( dllexport ) void Text_SetValue(const FindInformation& findInformation, const char* theValue) {
+    try {
+      auto control = gcnew AutomatedText(findInformation);
+      control->Text = gcnew String(theValue);
+    } catch(Exception^ e) {
+      Console::WriteLine("Text_SetValue:  {0}", e->Message);
+    }
+  }
+}

data/ext/UiaDll/UiaDll/UiaDll.cpp

@@ -19,6 +19,11 @@ extern "C" {
     return automationElement->Exists;
   }
 
+  __declspec ( dllexport ) int NativeWindowHandle(const FindInformation& findInformation) { 
+    auto automationElement = gcnew AutomationControl(findInformation);
+    return automationElement->Exists ? automationElement->Element->Current.NativeWindowHandle : 0;
+  }
+
   __declspec ( dllexport ) int BoundingRectangle(const FindInformation& findInformation, long *rectangle) {
     try {
       auto automationElement = gcnew AutomationControl(findInformation);
@@ -312,13 +317,14 @@ extern "C" {
     return 1;
   }
 
-  __declspec ( dllexport ) void RA_Click(const FindInformation& findInformation, char* errorInfo, const int errorInfoSize) {
+  __declspec ( dllexport ) bool RA_Click(const FindInformation& findInformation, char* errorInfo, const int errorInfoSize) {
     try {
       auto automationClicker = gcnew AutomationClicker(findInformation);
-      automationClicker->Click();
+      return automationClicker->Click();
     } catch(Exception^ e) {
       if( errorInfo ) {
         StringHelper::CopyToUnmanagedString(e->ToString(), errorInfo, errorInfoSize);
+        return false;
       }
     }
   }

data/ext/UiaDll/UiaDll/UiaDll.vcxproj

@@ -92,6 +92,7 @@
     <ClInclude Include="Stdafx.h" />
     <ClInclude Include="StringHelper.h" />
     <ClInclude Include="targetver.h" />
+    <ClInclude Include="AutomatedText.h" />
     <ClInclude Include="Toggle.h" />
     <ClInclude Include="UiaDll.h" />
   </ItemGroup>
@@ -116,6 +117,8 @@
     <ClCompile Include="StringHelper.cpp" />
     <ClCompile Include="StringMethods.cpp" />
     <ClCompile Include="TableMethods.cpp" />
+    <ClCompile Include="AutomatedText.cpp" />
+    <ClCompile Include="TextMethods.cpp" />
     <ClCompile Include="Toggle.cpp" />
     <ClCompile Include="UiaDll.cpp" />
   </ItemGroup>

data/ext/UiaDll/UiaDll/UiaDll.vcxproj.filters

@@ -49,6 +49,12 @@
     <Filter Include="Header Files\Control">
       <UniqueIdentifier>{90616ecb-ce19-48d6-88ac-a38a46e42687}</UniqueIdentifier>
     </Filter>
+    <Filter Include="Source Files\Text">
+      <UniqueIdentifier>{15a04b2b-04c7-44f4-8fdb-d83019eb3917}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="Header Files\Text">
+      <UniqueIdentifier>{3b3c2b83-e423-4619-991a-ffd7f324ae62}</UniqueIdentifier>
+    </Filter>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="UiaDll.h">
@@ -96,6 +102,9 @@
     <ClInclude Include="SelectionItem.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="AutomatedText.h">
+      <Filter>Header Files\Text</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="UiaDll.cpp">
@@ -155,6 +164,12 @@
     <ClCompile Include="SelectionItem.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="TextMethods.cpp">
+      <Filter>Source Files\Text</Filter>
+    </ClCompile>
+    <ClCompile Include="AutomatedText.cpp">
+      <Filter>Source Files\Text</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="ReadMe.txt" />

data/lib/rautomation/adapter/autoit.rb

@@ -1,3 +1,5 @@
+Kernel.warn "[WARN] RAutomation AutoIt adapter is DEPRECATED and will be removed in the future!"
+
 require "win32ole"
 require File.dirname(__FILE__) + "/autoit/locators"
 require File.dirname(__FILE__) + "/autoit/button"

data/lib/rautomation/adapter/ms_uia/control.rb

@@ -19,6 +19,11 @@ module RAutomation
           extract(locators)
         end
 
+        def cached_hwnd
+          @cached_hwnd ||= UiaDll::cached_hwnd(UiaDll::SearchCriteria.from_locator(@window.hwnd, @locators))
+          @cached_hwnd == 0 ? nil : @cached_hwnd
+        end
+
         #todo - replace with UIA version
         def hwnd
           Functions.control_hwnd(@window.hwnd, @locators)
@@ -26,10 +31,11 @@ module RAutomation
 
         def search_information
           info = UiaDll::SearchCriteria.from_locator(@window.hwnd, @locators)
-          if info.how == 0
+          if info.how == 0 || cached_hwnd
             info.how = :hwnd
-            info.data = hwnd
+            info.data = cached_hwnd || hwnd
           end
+
           info
         end
 

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

@@ -12,7 +12,7 @@ module RAutomation
         # @see RAutomation::TextField#set
         def set(text)
           raise "Cannot set value on a disabled text field" if disabled?
-          UiaDll::set_control_value(search_information, text)
+          UiaDll::set_text(search_information, text)
         end
 
         # @see RAutomation::TextField#clear
@@ -24,7 +24,7 @@ module RAutomation
         #todo - replace with UIA version
         # @see RAutomation::TextField#value
         def value
-          UiaDll::get_control_value(search_information)
+          UiaDll::get_text(search_information)
         end
 
         def exist?

data/lib/rautomation/adapter/ms_uia/uia_dll.rb

@@ -102,10 +102,13 @@ module RAutomation
         ffi_convention :stdcall
 
         # Generic Control methods
+        attach_function :cached_hwnd, :NativeWindowHandle, [SearchCriteria.by_ref], :long
         attach_function :ElementExists, [SearchCriteria.by_ref], :bool
         attach_function :process_id, :ProcessId, [SearchCriteria.by_ref], :int
         attach_function :Control_GetValue, [SearchCriteria.by_ref, :pointer, :int], :void
         attach_function :set_control_value, :Control_SetValue, [SearchCriteria.by_ref, :string], :void
+        attach_function :Text_GetValue, [SearchCriteria.by_ref, :pointer, :int], :void
+        attach_function :set_text, :Text_SetValue, [SearchCriteria.by_ref, :string], :void
         attach_function :BoundingRectangle, [SearchCriteria.by_ref, :pointer], :int
         attach_function :current_control_type, :ControlType, [SearchCriteria.by_ref], :int
         attach_function :Name, [SearchCriteria.by_ref, :pointer, :int], :void
@@ -130,6 +133,10 @@ module RAutomation
           string_from(:Control_GetValue, search_information)
         end
 
+        def self.get_text(search_information)
+          string_from(:Text_GetValue, search_information)
+        end
+
         def self.name(search_information)
           string_from(:Name, search_information)
         end
@@ -260,7 +267,7 @@ module RAutomation
         attach_function :collapse_by_index, :RA_CollapseItemByIndex,
                         [SearchCriteria.by_ref, :int], :void
         attach_function :RA_Click,
-                        [SearchCriteria.by_ref, :pointer, :int], :void
+                        [SearchCriteria.by_ref, :pointer, :int], :bool
         attach_function :control_mouse_click, :RA_PointAndClick,
                         [:long, :pointer, :int], :void
 
@@ -286,10 +293,10 @@ module RAutomation
 
         def self.can_throw(method, *args)
           string_buffer = FFI::MemoryPointer.new :char, 1024
-          send method, *(args << string_buffer << 1024)
+          result = send method, *(args << string_buffer << 1024)
           error_info = string_buffer.read_string
           raise error_info unless error_info.empty?
-          true
+          result
         end
       end
     end

data/lib/rautomation/adapter/win_32/keys.rb

@@ -68,6 +68,9 @@ module RAutomation
           :f10           => 0x79,
           :f11           => 0x7A,
           :f12           => 0x7B,
+          :dash          => 0xBD,
+          :slash         => 0x6F,
+          :backslash     => 0xDC
         }            
 
         SPECIAL_KEYS = {

data/spec/adapter/ms_uia/control_spec.rb

@@ -1,6 +1,5 @@
 require "spec_helper"
 
-
 describe "MsUia::Control", :if => SpecHelper.adapter == :ms_uia do
 
   it "control coordinates", :special => false do
@@ -25,4 +24,45 @@ describe "MsUia::Control", :if => SpecHelper.adapter == :ms_uia do
     control.control_class.should =~ /WindowsForms10.BUTTON.app.0.2bf8098_r1[0-9]_ad1/
   end
 
+  context RAutomation::Adapter::MsUia::UiaDll::SearchCriteria, :pure_unit => true do
+    let(:window) { double('RAutomation Window').as_null_object }
+    let(:locator) { {:id => 'someId'} }
+    let(:control) { RAutomation::Adapter::MsUia::Control.new(window, locator) }
+    let(:old_style_control) { RAutomation::Adapter::MsUia::Control.new(window, :class => 'someClass') }
+    let(:expect_a_handle) { RAutomation::Adapter::MsUia::UiaDll.should_receive(:cached_hwnd).once.and_return(456) }
+    let(:expect_no_handle) { RAutomation::Adapter::MsUia::UiaDll.should_receive(:cached_hwnd).once.and_return(0) }
+    subject { control.search_information }
+
+    before(:each) do
+      window.should_receive(:hwnd).at_least(:once).and_return(123)
+      RAutomation::Adapter::MsUia::Functions.stub(:control_hwnd)
+    end
+
+    it "uses the cached window handle if it has one" do
+      expect_a_handle
+      subject.how.should eq(:hwnd)
+      subject.data.should eq(456)
+    end
+
+    it "only asks for the window handle once" do
+      expect_a_handle
+      2.times { control.search_information }
+    end
+
+    it "uses the locator specified when no window handle is present" do
+      expect_no_handle
+      subject.how.should eq(:id)
+      subject.data.should eq('someId')
+    end
+
+    it "tries the old way of locating the window handle if no UIA locator is provided" do
+      expect_no_handle
+      RAutomation::Adapter::MsUia::Functions.should_receive(:control_hwnd).with(window.hwnd, :index => 0, :class => 'someClass').and_return(789)
+      old_info = old_style_control.search_information
+      old_info.how.should eq(:hwnd)
+      old_info.data.should eq(789)
+    end
+
+  end
+
 end

data/spec/adapter/ms_uia/text_field_spec.rb

@@ -28,4 +28,16 @@ describe "MsUia::TextField", :if => SpecHelper.adapter == :ms_uia do
     main_form.text_field(:id => "multiLineTextField").should exist
   end
 
+  it "can set the value of a multi line text field" do
+    text_field = main_form.text_field(:id => "multiLineTextField")
+
+    # initial
+    text_field.set "some dater'"
+    text_field.value.should eq("some dater'")
+
+    # overwrite
+    text_field.set "overwrite with this dater'"
+    text_field.value.should eq("overwrite with this dater'")
+  end
+
 end

data/spec/spec_helper.rb

@@ -109,8 +109,10 @@ RSpec.configure do |config|
   config.before(:each) do
     RAutomation::Window.wait_timeout = 15
 
-    @pid1 = IO.popen(SpecHelper::DATA[:window1]).pid
-    RAutomation::WaitHelper.wait_until {RAutomation::Window.new(:pid => @pid1).present?}
+    unless example.metadata[:pure_unit]
+      @pid1 = IO.popen(SpecHelper::DATA[:window1]).pid
+      RAutomation::WaitHelper.wait_until { RAutomation::Window.new(:pid => @pid1).present? }
+    end
   end
 
   config.after(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rautomation
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Jarmo Pertman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-26 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -111,6 +111,8 @@ files:
 - ext/UiaDll/UiaDll/AutomatedSelectList.h
 - ext/UiaDll/UiaDll/AutomatedTable.cpp
 - ext/UiaDll/UiaDll/AutomatedTable.h
+- ext/UiaDll/UiaDll/AutomatedText.cpp
+- ext/UiaDll/UiaDll/AutomatedText.h
 - ext/UiaDll/UiaDll/AutomationClicker.cpp
 - ext/UiaDll/UiaDll/AutomationClicker.h
 - ext/UiaDll/UiaDll/AutomationControl.cpp
@@ -131,6 +133,7 @@ files:
 - ext/UiaDll/UiaDll/StringHelper.h
 - ext/UiaDll/UiaDll/StringMethods.cpp
 - ext/UiaDll/UiaDll/TableMethods.cpp
+- ext/UiaDll/UiaDll/TextMethods.cpp
 - ext/UiaDll/UiaDll/Toggle.cpp
 - ext/UiaDll/UiaDll/Toggle.h
 - ext/UiaDll/UiaDll/ToggleStateHelper.h