uia 0.3.1 → 0.3.2

data/ChangeLog

@@ -1,3 +1,8 @@
+=== Version 0.3.2 / 2014-05-13
+*   Enhancements
+    *   added #with method to extend an Element based on ControlPatterns
+        *   Uia::ControlPatterns::MenuItems can select a menu item by name or path
+
 === Version 0.3.1 / 2014-05-07
 *   Enhancements
     *   added Table#row_at method

data/ext/UiaDll/UIA.Helper/Element.cs

@@ -167,6 +167,11 @@ namespace UIA.Helper
             return NullOr(AutomationElement.FromHandle(windowHandle));
         }
 
+        public Element MenuItem(string name)
+        {
+            return FindFirst(TreeScope.Subtree, new AndCondition(name.NameCondition(), ControlType.MenuItem.Condition()));
+        }
+
         public static Element ByRuntimeId(int[] runtimeId)
         {
             return FindFirst(new PropertyCondition(AutomationElement.RuntimeIdProperty, runtimeId), TreeScope.Descendants);

data/ext/UiaDll/UIA.Helper/Extensions.cs

@@ -35,6 +35,11 @@ namespace UIA.Helper
             return new PropertyCondition(AutomationElement.NameProperty, name);
         }
 
+        public static Condition Condition(this ControlType controlType)
+        {
+            return new PropertyCondition(AutomationElement.ControlTypeProperty, controlType);
+        }
+
         public static int PropertyId(this string propertyName)
         {
             var automationField = typeof(AutomationElement).GetField(propertyName);

data/ext/UiaDll/UiaDll/MenuItemMethods.cpp

@@ -0,0 +1,27 @@
+#include "Stdafx.h"
+
+extern "C" {
+  void SelectMenuItemPath(ElementInformationPtr element, char* errorInfo, const int errorInfoLength, list<const char*>& items) {
+    try {
+      auto current = ElementFrom(element);
+
+      for(auto item = items.begin(); item != items.end(); ++item) {
+        auto name = gcnew String(*item);
+
+        current = current->MenuItem(name);
+        if( nullptr == current) {
+          throw gcnew Exception(String::Format("the menu item \"{0}\" was not found", name));
+        }
+
+        current->As<InvokePattern^>(InvokePattern::Pattern)->Invoke();
+      }
+    } catch(Exception^ e) {
+      StringHelper::CopyToUnmanagedString(e->Message, errorInfo, errorInfoLength);
+    }
+  }
+
+  __declspec(dllexport) void MenuItem_SelectPath(ElementInformationPtr element, char* errorInfo, const int errorInfoLength, const int n, const char* arg0, ...) {
+    GRAB_VARARGS(menuItems, const char*, n);
+    SelectMenuItemPath(element, errorInfo, errorInfoLength, menuItems);
+  }
+}

data/ext/UiaDll/UiaDll/UiaDll.vcxproj

@@ -95,6 +95,7 @@
     <ClCompile Include="ElementMethods.cpp" />
     <ClCompile Include="ExpandCollapseMethods.cpp" />
     <ClCompile Include="InvokePatternMethods.cpp" />
+    <ClCompile Include="MenuItemMethods.cpp" />
     <ClCompile Include="MouseMethods.cpp" />
     <ClCompile Include="RangeValueMethods.cpp" />
     <ClCompile Include="SelectionItemMethods.cpp" />

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

@@ -16,6 +16,9 @@
     <Filter Include="Source Files\Patterns">
       <UniqueIdentifier>{a1dddb33-e832-4b83-b6d7-46462084fad2}</UniqueIdentifier>
     </Filter>
+    <Filter Include="Source Files\ControlTypes">
+      <UniqueIdentifier>{f17fb0d5-c4d9-44ae-9cf3-518f4f70839d}</UniqueIdentifier>
+    </Filter>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="Stdafx.h">
@@ -98,5 +101,8 @@
     <ClCompile Include="ConditionMethods.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="MenuItemMethods.cpp">
+      <Filter>Source Files\ControlTypes</Filter>
+    </ClCompile>
   </ItemGroup>
 </Project>

data/lib/core_ext/module.rb

@@ -0,0 +1,7 @@
+class Module
+  def const_get_path(path)
+    path.split('::').reduce(self) do |m, current|
+      m.const_get current.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/core_ext/symbol.rb

@@ -9,9 +9,11 @@ class Symbol
 
   # :selection_item => Uia::Patterns::SelectionItem
   def to_pattern_const
-    "Uia::Patterns::#{self.to_s.capitalize}".split('::').reduce(Object) do |m, current|
-      m.const_get current.split('_').map(&:capitalize).join
-    end
+    Uia::Patterns.const_get_path "#{self.capitalize}"
+  end
+
+  def to_control_type
+    Uia::ControlTypes.const_get_path "#{self.capitalize}"
   end
 
   def to_control_type_const

data/lib/uia/control_types/menu_item.rb

@@ -0,0 +1,10 @@
+module Uia
+  module ControlTypes
+    module MenuItems
+      def select_menu_path(*path)
+        Library.select_menu_path @element, *path
+      end
+      alias_method :select_menu_item, :select_menu_path
+    end
+  end
+end

data/lib/uia/element.rb

@@ -91,6 +91,10 @@ module Uia
       extend pattern.to_pattern_const
     end
 
+    def with(control_types)
+      extend control_types.to_control_type
+    end
+
     def patterns
       @element.pattern_ids.map { |id| Library::Constants::Patterns.find(@default) { |_, v| v == id }.first }
     end

data/lib/uia/library.rb

@@ -75,12 +75,10 @@ module Uia
     attach_function :Condition_ControlType, [:int, :varargs], SearchCondition.by_ref
 
     def self.pattern_condition(*patterns)
-      string_buffer = FFI::MemoryPointer.new :char, 1024
-      pattern_strings = patterns.flatten.map(&:to_pattern_available_property)
-      result = Condition_Pattern string_buffer, 1024, pattern_strings.count, *pattern_strings.to_var_args(:string)
-      error_info = string_buffer.read_string
-      raise error_info unless error_info.empty?
-      result
+      try_catch do |s, n|
+        pattern_strings = patterns.flatten.map(&:to_pattern_available_property)
+        Condition_Pattern s, n, pattern_strings.count, *pattern_strings.to_var_args(:string)
+      end
     end
 
     def self.control_type_condition(*control_types)
@@ -153,6 +151,12 @@ module Uia
       p.read_string
     end
 
+    # MenuItem methods
+    attach_function :MenuItem_SelectPath, [:pointer, :pointer, :int, :int, :varargs], :void
+    def self.select_menu_path(element, *path)
+      try_catch {|s, n| MenuItem_SelectPath element, s, n, path.count, *path.to_var_args(:string) }
+    end
+
     def self.find_by_runtime_id(id)
       p = FFI::MemoryPointer.new :int, id.count
       p.write_array_of_int(id)
@@ -160,35 +164,33 @@ module Uia
       Uia::Element.new(result) unless result.empty?
     end
 
-    def self.can_throw(method, *args)
+    def self.try_catch(&block)
       string_buffer = FFI::MemoryPointer.new :char, 1024
-      result = send method, *(args << string_buffer << 1024)
+      result = block.call(string_buffer, 1024)
       error_info = string_buffer.read_string
       raise error_info unless error_info.empty?
       result
     end
 
+    def self.can_throw(method, *args)
+      try_catch {|s, n| send method, *(args << s << n) }
+    end
+
     def self.find_first(element, scope, *conditions)
-      string_buffer = FFI::MemoryPointer.new :char, 1024
-      result = FindFirst element, scope, string_buffer, 1024, conditions.count, *conditions.to_var_args(:pointer)
-      error_info = string_buffer.read_string
-      raise error_info unless error_info.empty?
+      result = try_catch {|s, n| FindFirst element, scope, s, n, conditions.count, *conditions.to_var_args(:pointer) }
       Uia::Element.new(result) unless result.empty?
     end
 
     def self.find_all(element, scope, *conditions)
       elements_pointer = FFI::MemoryPointer.new :pointer
-      string_buffer = FFI::MemoryPointer.new :char, 1024
-      result = FindAll element, elements_pointer, scope, string_buffer, 1024, conditions.count, *conditions.to_var_args(:pointer)
-      error_info = string_buffer.read_string
-      raise error_info unless error_info.empty?
+      result = try_catch {|s, n| FindAll element, elements_pointer, scope, s, n, conditions.count, *conditions.to_var_args(:pointer) }
       result.times.collect do |which_element|
         pointer = elements_pointer.read_pointer + which_element * ManagedElementStruct.size
         Uia::Element.new(ManagedElementStruct.new(pointer))
       end
     end
 
-  rescue LoadError => e
+  rescue LoadError
     raise LoadError, 'You must install the Visual Studio 2012 C++ Runtime Environment to use the Uia gem (http://www.microsoft.com/en-us/download/details.aspx?id=30679)'
   end
 end

data/lib/uia/version.rb

@@ -1,3 +1,3 @@
 module Uia
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/uia.rb

@@ -6,6 +6,7 @@ require 'uia/finder'
 require 'uia/element'
 
 require_rel 'uia/patterns'
+require_rel 'uia/control_types'
 require_rel 'core_ext'
 
 module Uia

data/spec/uia/control_types/menu_item_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Uia::ControlTypes::MenuItems do
+  Given(:main)  { Uia.find_element(title: 'MainFormWindow').with(:menu_items) }
+
+  after(:each) do
+    about = Uia.find_element(title: 'About')
+    about.send_keys [:alt, :f4] if about
+  end
+
+  context 'selecting individually' do
+    When { main.select_menu_item 'About' }
+    Then { Uia.find_element(title: 'About') != nil }
+  end
+
+  context 'selecting a path' do
+    context 'valid' do
+      When { main.select_menu_path 'File', 'Roundabout Way', 'To', 'About' }
+      Then { Uia.find_element(title: 'About') != nil }
+    end
+
+    context 'invalid' do
+      Given(:bad_path) { main.select_menu_path 'File', 'Roundabout Way', 'To', 'Something Not There' }
+      Then { expect { bad_path }.to raise_error(RuntimeError, /Something Not There/) }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uia
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -172,6 +172,7 @@ files:
 - ext/UiaDll/UiaDll/ElementStructures.h
 - ext/UiaDll/UiaDll/ExpandCollapseMethods.cpp
 - ext/UiaDll/UiaDll/InvokePatternMethods.cpp
+- ext/UiaDll/UiaDll/MenuItemMethods.cpp
 - ext/UiaDll/UiaDll/MouseMethods.cpp
 - ext/UiaDll/UiaDll/PatternInformationStructures.h
 - ext/UiaDll/UiaDll/RangeValueMethods.cpp
@@ -194,9 +195,11 @@ files:
 - ext/UiaDll/UiaDll/WindowMethods.cpp
 - ext/UiaDll/UiaDll/app.rc
 - lib/core_ext/array.rb
+- lib/core_ext/module.rb
 - lib/core_ext/string.rb
 - lib/core_ext/symbol.rb
 - lib/uia.rb
+- lib/uia/control_types/menu_item.rb
 - lib/uia/element.rb
 - lib/uia/finder.rb
 - lib/uia/keys.rb
@@ -225,6 +228,7 @@ files:
 - spec/app/WindowsForms.exe
 - spec/core_ext/symbol_spec.rb
 - spec/spec_helper.rb
+- spec/uia/control_types/menu_item_spec.rb
 - spec/uia/element_spec.rb
 - spec/uia/keys_spec.rb
 - spec/uia/patterns/expand_collapse_spec.rb
@@ -257,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 471307667
+      hash: 59019763
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -266,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 471307667
+      hash: 59019763
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.28
@@ -279,6 +283,7 @@ test_files:
 - spec/app/WindowsForms.exe
 - spec/core_ext/symbol_spec.rb
 - spec/spec_helper.rb
+- spec/uia/control_types/menu_item_spec.rb
 - spec/uia/element_spec.rb
 - spec/uia/keys_spec.rb
 - spec/uia/patterns/expand_collapse_spec.rb