rautomation 0.8.0 → 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd70f4859a5f1f16541465e836d116265af26eb4
+  data.tar.gz: 7bae3a8bc91207cdfa3e302ffdbde778ead2ac69
+SHA512:
+  metadata.gz: ea5fd4f9d351eec5ffe23f207ab5f6679d861d410adc6fe908902497195c3ce776deff5c1428afd884c9bd8ef62a1f57d11da968bad26e2ca638afaea06dc529
+  data.tar.gz: f9c6a60d917eeef6178a4fdc9f3f68d8cbd04e8ee4d6194130859036d243cb842167a68900cc2ad811659099ca682c08ccfa30763f8aa6d0a1e4a491744e9d1c

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    rautomation (0.7.3)
+    rautomation (0.9.0)
       ffi
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     diff-lcs (1.1.3)
-    ffi (1.1.5-x86-mingw32)
+    ffi (1.7.0-x86-mingw32)
     rake (0.9.2.2)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)

data/History.rdoc

@@ -1,3 +1,20 @@
+== 0.9.0 / 2013-04-22
+
+=== MsUia adapter
+
+  * Add support for :name locator.
+  * Add support for Window#value_control.
+  * Add Table#headers.
+  * Add Table#values.
+  * Control#exists? uses now uia code.
+  * ControlType.Document is also considered as a TextField.
+  * Table#select and Table#selected? use 0-based indexing.
+  * Table#select supports value too. 
+
+=== Win32 adapter
+
+  * Add support for "[", "]" and "'" characters when using Window#send_keys. Fixes #61.
+
 == 0.8.0 / 2012-12-26
 
 === MsUia adapter

data/README.rdoc

@@ -1,9 +1,10 @@
 = RAutomation
+{<img src="https://badge.fury.io/rb/rautomation.png" alt="Gem Version" />}[http://badge.fury.io/rb/rautomation]
 
 * Web: http://www.github.com/jarmo/RAutomation
 * Author: Jarmo Pertman (mailto:jarmo.p[at]gmail.com)
 
-{<img alt='Click here to lend your support to: RAutomation and make a donation at www.pledgie.com !' src='https://www.pledgie.com/campaigns/16196.png?skin_name=chrome' />}[https://www.pledgie.com/campaigns/16196]
+{<img alt='Click here to lend your support to: RAutomation and make a donation at www.pledgie.com !' src='https://pledgie.com/campaigns/16196.png?skin_name=chrome' />}[https://pledgie.com/campaigns/16196]
 
 RAutomation is a small and easy to use library for helping out to automate windows and their controls
 for automated testing.

data/Rakefile

@@ -3,18 +3,31 @@ require 'bundler'
 
 Bundler::GemHelper.install_tasks
 
+def ext_dependencies(name)
+  FileList["ext/#{name}/**/*"].reject { |file| file =~ /\b(Release|Debug)\b/ }
+end
+
+def ms_build(name)
+  name = File.basename(name, File.extname(name))
+  sh "msbuild /property:Configuration=Release ext\\#{name}\\#{name}.sln"
+end
+
 namespace :build do
   build_tasks = [
-    {:name => :uia_dll, :path => "UiaDll"},
-    {:name => :i_accessible_dll, :path => "IAccessibleDLL"},
-    {:name => :windows_forms, :path => "WindowsForms"}
+    {:name => :uia_dll, :path => "UiaDll", :ext => "dll"},
+    {:name => :i_accessible_dll, :path => "IAccessibleDLL", :ext => "dll"},
+    {:name => :windows_forms, :path => "WindowsForms", :ext => "exe"}
   ]
 
   build_tasks.each do |build_task|
-    desc "Build #{build_task[:path]}"
-    task build_task[:name] do
-      sh "msbuild /property:Configuration=Release ext\\#{build_task[:path]}\\#{build_task[:path]}.sln"
+    full_ext_path = "ext/#{build_task[:path]}/Release/#{build_task[:path]}.#{build_task[:ext]}"
+
+    file full_ext_path => ext_dependencies(build_task[:path]) do |t|
+      ms_build t.name
     end
+
+    desc "Build #{build_task[:path]}"
+    task build_task[:name] => full_ext_path
   end
 
   desc "Build all external dependencies"
@@ -51,3 +64,7 @@ require 'yard'
 YARD::Rake::YardocTask.new
 
 task :default => "spec:all"
+
+task :release => "spec:all"
+
+task :install => :build

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/ext/UiaDll/UiaDll/{AutomatedComboBox.cpp → AutomatedSelectList.cpp}

@@ -1,15 +1,26 @@
 #include "StdAfx.h"
-#include "AutomatedComboBox.h"
+#include "AutomatedSelectList.h"
 
-AutomatedComboBox::AutomatedComboBox(const HWND windowHandle)
-{
-	_comboControl = AutomationElement::FromHandle(IntPtr(windowHandle));
+AutomatedSelectList::AutomatedSelectList(const HWND windowHandle) : AutomationControl(windowHandle)
+{ }
+
+AutomatedSelectList::AutomatedSelectList(const FindInformation& findInformation) : AutomationControl(findInformation)
+{ }
+
+array<String^>^ AutomatedSelectList::Selection::get() {
+  auto selectedElements = AsSelectionPattern->Current.GetSelection();
+  auto selections = gcnew array<String^>(selectedElements.Length);
+  auto whichOne = 0;
+  for each(auto element in selectedElements) {
+    selections[whichOne++] = element->Current.Name;
+  }
+  return selections;
 }
 
-bool AutomatedComboBox::SelectByIndex(const int whichItem)
+bool AutomatedSelectList::SelectByIndex(const int whichItem)
 {
 	try {
-	  auto selectionItems = _comboControl->FindAll(System::Windows::Automation::TreeScope::Subtree, SelectionCondition);
+	  auto selectionItems = _control->FindAll(System::Windows::Automation::TreeScope::Subtree, SelectionCondition);
 	  Select(selectionItems[whichItem]);
 	  return true;
 	} catch(Exception^ e) {
@@ -18,13 +29,13 @@ bool AutomatedComboBox::SelectByIndex(const int whichItem)
 	}
 }
 
-bool AutomatedComboBox::SelectByValue(const char* whichItem)
+bool AutomatedSelectList::SelectByValue(const char* whichItem)
 {
 	try {
 	  auto nameCondition = gcnew PropertyCondition(AutomationElement::NameProperty, gcnew String(whichItem));
 	  auto selectionAndNameCondition = gcnew AndCondition(SelectionCondition, nameCondition);
 
-	  Select(_comboControl->FindFirst(System::Windows::Automation::TreeScope::Subtree, selectionAndNameCondition));
+	  Select(_control->FindFirst(System::Windows::Automation::TreeScope::Subtree, selectionAndNameCondition));
 	  return true;
 	} catch(Exception^ e) {
 		Console::WriteLine(e->ToString());
@@ -32,7 +43,7 @@ bool AutomatedComboBox::SelectByValue(const char* whichItem)
 	}
 }
 
-bool AutomatedComboBox::GetValueByIndex(const int whichItem, char* comboValue, const int comboValueSize)
+bool AutomatedSelectList::GetValueByIndex(const int whichItem, char* comboValue, const int comboValueSize)
 {
 	try {
 		auto selectionItem = SelectionItems[whichItem];
@@ -46,7 +57,7 @@ bool AutomatedComboBox::GetValueByIndex(const int whichItem, char* comboValue, c
 	}
 }
 
-int AutomatedComboBox::SelectedIndex::get() {
+int AutomatedSelectList::SelectedIndex::get() {
 	int selectedIndex = 0;
 	for each(AutomationElement^ selectionItem in SelectionItems) {
 	  auto selectionPattern = dynamic_cast<SelectionItemPattern^>(selectionItem->GetCurrentPattern(SelectionItemPattern::Pattern));
@@ -59,7 +70,7 @@ int AutomatedComboBox::SelectedIndex::get() {
 }
 
 
-void AutomatedComboBox::Select(AutomationElement^ itemToSelect)
+void AutomatedSelectList::Select(AutomationElement^ itemToSelect)
 {
 	auto selectionPattern = dynamic_cast<SelectionItemPattern^>(itemToSelect->GetCurrentPattern(SelectionItemPattern::Pattern));
 	selectionPattern->Select();

data/ext/UiaDll/UiaDll/{AutomatedComboBox.h → AutomatedSelectList.h}

@@ -1,14 +1,22 @@
 #pragma once
+#include "AutomationControl.h"
+#include "StringHelper.h"
+
 using namespace System::Windows::Automation;
 
-public ref class AutomatedComboBox
+ref class AutomatedSelectList : public AutomationControl
 {
 public:
-	AutomatedComboBox(const HWND windowHandle);
+	AutomatedSelectList(const HWND windowHandle);
+	AutomatedSelectList(const FindInformation& findInformation);
 	bool SelectByIndex(const int whichItem);
 	bool SelectByValue(const char* whichItem);
 	bool GetValueByIndex(const int whichItem, char* comboValue, const int comboValueSize);
 
+  property array<String^>^ Selection {
+    array<String^>^ get();
+  }
+
 	property int Count {
 		int get() { return SelectionItems->Count; }
 	}
@@ -18,11 +26,16 @@ public:
 	}
 
 private:
-	AutomationElement^	_comboControl;
 	void Select(AutomationElement^ itemToSelect);
 
+	property SelectionPattern^ AsSelectionPattern {
+		SelectionPattern^ get() {
+			return dynamic_cast<SelectionPattern^>(_control->GetCurrentPattern(SelectionPattern::Pattern));
+		}
+	}
+
 	property AutomationElementCollection^ SelectionItems {
-	  AutomationElementCollection^ get() { return _comboControl->FindAll(System::Windows::Automation::TreeScope::Subtree, SelectionCondition); }
+	  AutomationElementCollection^ get() { return _control->FindAll(System::Windows::Automation::TreeScope::Subtree, SelectionCondition); }
 	}
 
 	property PropertyCondition^ SelectionCondition {

data/ext/UiaDll/UiaDll/AutomatedTable.cpp

@@ -1,20 +1,42 @@
 #include "StdAfx.h"
 #include "AutomatedTable.h"
 
-AutomatedTable::AutomatedTable(const HWND windowHandle)
+AutomatedTable::AutomatedTable(const HWND windowHandle) : AutomationControl(windowHandle)
 {
-	_tableControl = AutomationElement::FromHandle(IntPtr(windowHandle));
+	_finder = gcnew AutomationFinder(_control);
 }
 
-int AutomatedTable::RowCount::get()
+AutomatedTable::AutomatedTable(const FindInformation& finderInformation) : AutomationControl(finderInformation)
 {
-	auto tablePattern = dynamic_cast<TablePattern^>(_tableControl->GetCurrentPattern(TablePattern::Pattern));
-	return tablePattern->Current.RowCount;
+	_finder = gcnew AutomationFinder(_control);
+}
+
+int AutomatedTable::GetHeaders(const char* headers[])
+{
+	auto headerItems = _finder->Find(AutomationFinder::IsHeaderItem);
+
+	if( NULL != headers ) {
+		StringHelper::CopyNames(headerItems, headers);
+	}
+
+	return headerItems->Count;
+}
+
+int AutomatedTable::GetValues(const char* values[])
+{
+	auto tableItems = _finder->Find(gcnew OrCondition(AutomationFinder::IsTableItem, AutomationFinder::IsListItem));
+
+	if( NULL != values ) {
+		StringHelper::CopyNames(tableItems, values);
+	}
+
+	return tableItems->Count;
 }
 
-bool AutomatedTable::Exists(const char* whichItem)
+int AutomatedTable::RowCount::get()
 {
-	return Exists(gcnew PropertyCondition(AutomationElement::NameProperty, gcnew String(whichItem)));
+	auto tablePattern = dynamic_cast<TablePattern^>(_control->GetCurrentPattern(TablePattern::Pattern));
+	return tablePattern->Current.RowCount;
 }
 
 bool AutomatedTable::Exists(const int whichItemIndex, const int whichColumnIndex)
@@ -29,22 +51,42 @@ String^ AutomatedTable::ValueAt(const int whichItemIndex, const int whichItemCol
 
 AutomationElement^ AutomatedTable::DataItemAt(const int whichItemIndex, const int whichItemColumn)
 {
-	auto dataItemProperty = gcnew PropertyCondition(AutomationElement::IsTableItemPatternAvailableProperty, true);
 	auto indexProperty = gcnew PropertyCondition(TableItemPattern::RowProperty, whichItemIndex);
 	auto columnProperty = gcnew PropertyCondition(TableItemPattern::ColumnProperty, whichItemColumn);
-	return _tableControl->FindFirst(System::Windows::Automation::TreeScope::Subtree, gcnew AndCondition(dataItemProperty, indexProperty, columnProperty));
+	return _finder->FindFirst(AutomationFinder::IsTableItem, indexProperty, columnProperty);
 }
 
 bool AutomatedTable::Exists(Condition^ condition)
 {
-	auto dataItemProperty = gcnew PropertyCondition(AutomationElement::IsTableItemPatternAvailableProperty, true);
-	return _tableControl->FindAll(System::Windows::Automation::TreeScope::Subtree, gcnew AndCondition(dataItemProperty, condition))->Count > 0;
+	return _finder->Find(AutomationFinder::IsTableItem, condition)->Count > 0;
 }
 
 void AutomatedTable::Select(const int dataItemIndex)
 {
-	auto dataItemProperty = gcnew PropertyCondition(AutomationElement::ControlTypeProperty, ControlType::DataItem);
-	auto dataItem = _tableControl->FindAll(System::Windows::Automation::TreeScope::Subtree, dataItemProperty)[dataItemIndex];
+	try {
+		Select(_finder->Find(AutomationFinder::IsDataItem)[dataItemIndex]);
+	} catch(IndexOutOfRangeException^ e) {
+		throw gcnew ArgumentException(String::Format("Table item at index {0} does not exist", dataItemIndex));
+	}
+}
+
+bool AutomatedTable::IsSelected(const int dataItemIndex) {
+	
+	return AsSelectionItem(_finder->FindAt(dataItemIndex, AutomationFinder::IsSelectionItem))->Current.IsSelected;
+}
+
+void AutomatedTable::Select(const char* dataItemValue)
+{
+	try {
+		auto nameCondition = gcnew PropertyCondition(AutomationElement::NameProperty, gcnew String(dataItemValue));
+		Select(_finder->Find(AutomationFinder::IsDataItem, nameCondition)[0]);
+	} catch(IndexOutOfRangeException^ e) {
+		throw gcnew ArgumentException(String::Format("Table item with the value \"{0}\" was not found", gcnew String(dataItemValue)));
+	}
+}
+
+void AutomatedTable::Select(AutomationElement^ dataItem)
+{
 	auto selectionItemPattern = dynamic_cast<SelectionItemPattern^>(dataItem->GetCurrentPattern(SelectionItemPattern::Pattern));
 	selectionItemPattern->Select();
 }

data/ext/UiaDll/UiaDll/AutomatedTable.h

@@ -1,22 +1,35 @@
 #pragma once
+#include "AutomationControl.h"
+#include "AutomationFinder.h"
+#include "StringHelper.h"
+
 using namespace System::Windows::Automation;
 
-ref class AutomatedTable
+ref class AutomatedTable : AutomationControl
 {
 public:
 	AutomatedTable(const HWND windowHandle);
-	bool Exists(const char* whichItem);
+	AutomatedTable(const FindInformation& finderInformation);
 	bool Exists(const int whichItemIndex, const int whichColumnIndex);
 	String^ ValueAt(const int whichItemIndex, const int whichColumnIndex);
 	void Select(const int dataItemIndex);
+	void Select(const char* dataItemValue);
+	bool IsSelected(const int dataItemIndex);
+	int GetHeaders(const char* headers[]);
+	int GetValues(const char* values[]);
 
 	property int RowCount {
 		int get();
 	}
 
 private:
-	AutomationElement^ _tableControl;
+	AutomationFinder^ _finder;
 	bool Exists(Condition^ condition);
 	AutomationElement^ DataItemAt(const int whichItemIndex, const int whichItemRow);
+	void Select(AutomationElement^ dataItem);
+
+	SelectionItemPattern^ AsSelectionItem(AutomationElement^ automationElement) {
+		return dynamic_cast<SelectionItemPattern^>(automationElement->GetCurrentPattern(SelectionItemPattern::Pattern));
+	}
 };
 

data/ext/UiaDll/UiaDll/AutomationControl.cpp

@@ -0,0 +1,28 @@
+#include "StdAfx.h"
+#include "AutomationControl.h"
+#include "AutomationFinder.h"
+
+AutomationControl::AutomationControl(const HWND windowHandle)
+{
+	_control = AutomationElement::FromHandle(IntPtr(windowHandle));
+}
+
+AutomationControl::AutomationControl(const FindInformation& findInformation)
+{
+	try {
+		auto rootElement = AutomationElement::FromHandle(IntPtr(findInformation.rootWindow));
+		auto finder = gcnew AutomationFinder(rootElement);
+		_control = finder->Find(findInformation);
+	}
+	catch(Exception^ e) {
+		Debug::WriteLine("AutomationControl error:  {0}", e->Message);
+	}
+}
+
+void AutomationControl::Value::set(String^ value) {
+	AsValuePattern->SetValue(value);
+}
+
+String^ AutomationControl::Value::get() {
+	return AsValuePattern->Current.Value;
+}

data/ext/UiaDll/UiaDll/AutomationControl.h

@@ -0,0 +1,56 @@
+#pragma once
+
+using namespace System::Windows::Automation;
+using namespace System::Windows;
+using namespace System::Diagnostics;
+
+ref class AutomationControl
+{
+public:
+	AutomationControl(const HWND windowHandle);
+  AutomationControl(const FindInformation& findInformation);
+
+  property AutomationElement^ Element {
+    AutomationElement^ get() { return _control; }
+  }
+
+	property String^ Name {
+		String^ get() { return _control->Current.Name; }
+	}
+
+	property String^ ClassName {
+		String^ get() { return _control->Current.ClassName; }
+	}
+
+  property Rect BoundingRectangle {
+    Rect get() { return _control->Current.BoundingRectangle; }
+  }
+
+  property System::Windows::Automation::ControlType^ ControlType {
+    System::Windows::Automation::ControlType^ get() { return _control->Current.ControlType; }
+  }
+
+  property int ProcessId {
+    int get() { return _control->Current.ProcessId; }
+  }
+
+	property String^ Value {
+		String^ get();
+		void set(String^ value);
+	}
+
+  property bool Exists {
+	  bool get() { return nullptr != _control; }
+  }
+
+protected:
+	AutomationElement^ _control;
+
+private:
+	property ValuePattern^ AsValuePattern {
+		ValuePattern^ get() {
+			return dynamic_cast<ValuePattern^>(_control->GetCurrentPattern(ValuePattern::Pattern));
+		}
+	}
+};
+