AXElements 0.7.5 → 0.7.6

data/lib/accessibility/core.rb

@@ -98,13 +98,13 @@ module Accessibility::Core
   def attribute name
     ptr = Pointer.new :id
     case code = AXUIElementCopyAttributeValue(self, name, ptr)
-    when 0               then ptr.value.to_ruby
-    when KAXErrorNoValue then nil
-    when KAXErrorInvalidUIElement
+    when 0
+      ptr.value.to_ruby
+    when KAXErrorNoValue, KAXErrorAttributeUnsupported,
+         KAXErrorFailure, KAXErrorInvalidUIElement then
       name == KAXChildrenAttribute ? [] : nil
-    when KAXErrorFailure
-      name == KAXChildrenAttribute ? [] : handle_error(code, name)
-    else handle_error code, name
+    else
+      handle_error code, name
     end
   end
 
@@ -177,10 +177,13 @@ module Accessibility::Core
   def size_of name
     ptr = Pointer.new :long_long
     case code = AXUIElementGetAttributeValueCount(self, name, ptr)
-    when 0                                                  then ptr.value
+    when 0
+      ptr.value
     when KAXErrorFailure, KAXErrorAttributeUnsupported,
-      KAXErrorInvalidUIElement                              then 0
-    else handle_error code, name
+         KAXErrorNoValue, KAXErrorInvalidUIElement
+      0
+    else
+      handle_error code, name
     end
   end
 
@@ -196,9 +199,13 @@ module Accessibility::Core
   def writable? name
     ptr = Pointer.new :bool
     case code = AXUIElementIsAttributeSettable(self, name, ptr)
-    when 0                        then ptr.value
-    when KAXErrorInvalidUIElement then false
-    else handle_error code, name
+    when 0
+      ptr.value
+    when KAXErrorFailure, KAXErrorAttributeUnsupported,
+         KAXErrorNoValue, KAXErrorInvalidUIElement
+      false
+    else
+      handle_error code, name
     end
   end
 
@@ -223,8 +230,11 @@ module Accessibility::Core
   # @param [String] name an attribute constant
   def set name, value
     code = AXUIElementSetAttributeValue(self, name, value.to_ax)
-    return value if code.zero?
-    handle_error code, name, value
+    if code.zero?
+      value
+    else
+      handle_error code, name, value
+    end
   end
 
 
@@ -270,12 +280,15 @@ module Accessibility::Core
   # @param [String] attr an attribute constant
   # @param [Object] param
   def attribute name, for_parameter: param
-    ptr   = Pointer.new :id
-    param = param.to_ax
-    case code = AXUIElementCopyParameterizedAttributeValue(self,name,param,ptr)
-    when 0                                         then ptr.value.to_ruby
-    when KAXErrorNoValue, KAXErrorInvalidUIElement then nil
-    else handle_error code, name, param
+    ptr = Pointer.new :id
+    case code = AXUIElementCopyParameterizedAttributeValue(self, name, param.to_ax, ptr)
+    when 0
+      ptr.value.to_ruby
+    when KAXErrorFailure, KAXErrorAttributeUnsupported,
+         KAXErrorNoValue, KAXErrorInvalidUIElement
+      nil
+    else
+      handle_error code, name, param
     end
   end
 
@@ -318,8 +331,11 @@ module Accessibility::Core
   # @return [Boolean]
   def perform action
     code = AXUIElementPerformAction(self, action)
-    return true if code.zero?
-    handle_error code, action
+    if code.zero?
+      true
+    else
+      handle_error code, action
+    end
   end
 
   ##
@@ -398,9 +414,14 @@ module Accessibility::Core
   def element_at point
     ptr = Pointer.new ELEMENT
     case code = AXUIElementCopyElementAtPosition(self, *point.to_point, ptr)
-    when 0                                  then ptr.value
-    when KAXErrorNoValue                    then nil
-    else handle_error code, point, nil, nil
+    when 0
+      ptr.value
+    when KAXErrorNoValue
+      nil
+    when KAXErrorInvalidUIElement
+      system_wide.element_at point unless self == system_wide
+    else
+      handle_error code, point, nil, nil
     end
   end
 
@@ -453,9 +474,11 @@ module Accessibility::Core
     raise ArgumentError, 'A callback is required' unless block_given?
     ptr      = Pointer.new OBSERVER
     callback = proc { |obsrvr, sender, notif, ctx| yield obsrvr, sender, notif }
-    case code = AXObserverCreate(pid, callback, ptr)
-    when 0 then ptr.value
-    else handle_error code, callback
+    code = AXObserverCreate(pid, callback, ptr)
+    if code.zero?
+      ptr.value
+    else
+      handle_error code, callback
     end
   end
 
@@ -540,12 +563,14 @@ module Accessibility::Core
   # @return [Fixnum]
   def pid
     @pid ||= (
-      ptr  = Pointer.new :int
+      ptr = Pointer.new :int
       case code = AXUIElementGetPid(self, ptr)
-      when 0 then ptr.value
+      when 0
+        ptr.value
       when KAXErrorInvalidUIElement
         self == system_wide ? 0 : handle_error(code)
-      else handle_error code
+      else
+        handle_error code
       end
       )
   end
@@ -889,9 +914,3 @@ class CGPoint
   # @return [CGPoint]
   def to_point; self end
 end
-
-##
-# Cached reference to the system wide object.
-#
-# @return [AXUIElementRef]
-SYSTEMWIDE = AXUIElementCreateSystemWide()

data/lib/accessibility/dsl.rb

@@ -210,7 +210,7 @@ module Accessibility::DSL
   #
   # @param [AX::Element]
   def set_focus_to element
-    element.set(:focused, true) if element.respond_to? :focused?
+    element.set(:focused, true) if element.respond_to? :focused
   end
   alias_method :set_focus, :set_focus_to
 
@@ -243,7 +243,7 @@ module Accessibility::DSL
   # @return [nil] do not rely on a return value
   def set element, change
     if element.respond_to? :focused
-      if element.attribute_writable? :focused
+      if element.writable? :focused
         element.set :focused, true
       end
     end

data/lib/accessibility/factory.rb

@@ -66,16 +66,11 @@ module Accessibility::Factory
   # @param [AXUIElementRef]
   # @return [AX::Element]
   def process_element ref
-    role  = TRANSLATOR.unprefix ref.role
-    attrs = ref.attributes
-    klass = if attrs.include? KAXSubroleAttribute
-              subrole = ref.subrole
-              # Some objects claim to have a subrole but return nil
-              if subrole
-                class_for TRANSLATOR.unprefix(subrole), and: role
-              else
-                class_for role
-              end
+    role = TRANSLATOR.unprefix ref.role
+
+    # Some objects claim to have a subrole but return nil
+    klass = if subrole = ref.subrole
+              class_for TRANSLATOR.unprefix(subrole), and: role
             else
               class_for role
             end
@@ -87,9 +82,9 @@ module Accessibility::Factory
   #
   # @return [Array]
   def process_array vals
-    return vals if vals.empty?
-    return vals if CFGetTypeID(vals.first) != REF_TYPE
-    return vals.map { |val| process_element val }
+    (vals.empty? && vals)                         ||
+    (CFGetTypeID(vals.first) != REF_TYPE && vals) ||
+    vals.map { |val| process_element val }
   end
 
   ##
@@ -137,7 +132,7 @@ module Accessibility::Factory
 
   ##
   # Create a new class in the {AX} namesapce that has the given
-  # `superklass` as the superclass..
+  # `superklass` as the superclass.
   #
   # @param [#to_s] name
   # @param [#to_s] superklass

data/lib/accessibility/pp_inspector.rb

@@ -18,7 +18,6 @@ module Accessibility::PPInspector
   #
   # @return [String]
   def pp_identifier
-    # @todo Break this method up into chunks
     # @note use, or lack of use, of #inspect is intentional for visual effect
 
     if attributes.include? :value

data/lib/accessibility/version.rb

@@ -1,6 +1,6 @@
 module Accessibility
   # @return [String]
-  VERSION   = '0.7.5'
+  VERSION   = '0.7.6'
 
   # @return [String]
   CODE_NAME = 'Clefairy'

data/lib/ax/application.rb

@@ -9,6 +9,13 @@ require 'accessibility/string'
 class AX::Application < AX::Element
   include Accessibility::String
 
+  ##
+  # @private
+  # Cached reference to the system wide object.
+  #
+  # @return [AXUIElementRef]
+  SYSTEMWIDE = AXUIElementCreateSystemWide()
+
   ##
   # Overridden so that we can also cache the `NSRunningApplication`
   # instance for this object.
@@ -81,7 +88,7 @@ class AX::Application < AX::Element
   # Overridden to handle the {Accessibility::Language#set_focus} case.
   #
   # (see AX::Element#set:to:)
-  def set attr, to: value
+  def set attr, value
     case attr
     when :focused
       perform(value ? :unhide : :hide)

data/lib/ax/element.rb

@@ -17,6 +17,7 @@ class AX::Element
   include Accessibility::PPInspector
   include Accessibility::Factory
 
+
   # @param [AXUIElementRef]
   def initialize ref
     @ref = ref
@@ -34,7 +35,7 @@ class AX::Element
   #
   # @return [Array<Symbol>]
   def attributes
-    @attributes ||= TRANSLATOR.rubyize @ref.attributes
+    @attrs ||= TRANSLATOR.rubyize @ref.attributes
   end
 
   ##
@@ -49,14 +50,15 @@ class AX::Element
   #
   # @param [#to_sym]
   def attribute name
-    if rattr = lookup(name, @ref.attributes)
+    if rattr = TRANSLATOR.lookup(name, @ref.attributes)
       process @ref.attribute(rattr)
     end
   end
 
   ##
-  # Needed to override inherited `NSObject#description`. If you want a
-  # description of the object then you should use {#inspect} instead.
+  # Needed to override inherited `NSObject#description` as some
+  # elements have a `description` attribute. If you want a description
+  # of the object then you should use {#inspect} instead.
   def description
     attribute :description
   end
@@ -75,7 +77,7 @@ class AX::Element
   # @param [#to_sym]
   # @return [Number]
   def size_of attr
-    if rattr = lookup(attr, @ref.attributes)
+    if rattr = TRANSLATOR.lookup(attr, @ref.attributes)
       @ref.size_of rattr
     else
       0
@@ -105,7 +107,7 @@ class AX::Element
   #
   # @param [#to_sym]
   def writable? attr
-    if rattr = lookup(attr, @ref.attributes)
+    if rattr = TRANSLATOR.lookup(attr, @ref.attributes)
       @ref.writable? rattr
     else
       false
@@ -127,9 +129,7 @@ class AX::Element
       raise NoMethodError, "#{attr} is read-only for #{inspect}"
     end
     value = value.relative_to(@ref.value.size) if value.kind_of? Range
-    rattr = lookup(attr, @ref.attributes)
-    @ref.set rattr, value
-    value
+    @ref.set TRANSLATOR.lookup(attr, @ref.attributes), value
   end
 
 
@@ -146,7 +146,7 @@ class AX::Element
   #
   # @return [Array<Symbol>]
   def parameterized_attributes
-    TRANSLATOR.rubyize @ref.parameterized_attributes
+    @param_attrs ||= TRANSLATOR.rubyize @ref.parameterized_attributes
   end
 
   ##
@@ -158,7 +158,7 @@ class AX::Element
   #
   # @param [#to_sym]
   def attribute attr, for_parameter: param
-    if rattr = lookup(attr, @ref.parameterized_attributes)
+    if rattr = TRANSLATOR.lookup(attr, @ref.parameterized_attributes)
       param = param.relative_to(@ref.value.size) if value.kind_of? Range
       process @ref.attribute(rattr, for_parameter: param)
     end
@@ -178,7 +178,7 @@ class AX::Element
   #
   # @return [Array<Symbol>]
   def actions
-    TRANSLATOR.rubyize @ref.actions
+    @actions ||= TRANSLATOR.rubyize @ref.actions
   end
 
   ##
@@ -191,12 +191,13 @@ class AX::Element
   #
   # @example
   #
-  #   button.perform :press # => true
+  #   button.perform :press    # => true
+  #   button.perform :make_pie # => false
   #
   # @param [#to_sym]
   # @return [Boolean] true if successful
   def perform action
-    if raction = lookup(action, @ref.actions)
+    if raction = TRANSLATOR.lookup(action, @ref.actions)
       @ref.perform raction
     else
       false
@@ -226,7 +227,7 @@ class AX::Element
     tree      = Accessibility::Enumerators::BreadthFirst.new(self)
 
     if TRANSLATOR.singularize(kind) == kind
-      tree.find { |element| qualifier.qualifies? element }
+      tree.find     { |element| qualifier.qualifies? element }
     else
       tree.find_all { |element| qualifier.qualifies? element }
     end
@@ -300,16 +301,18 @@ class AX::Element
     if method[-1] == EQUALS
       return set(method.chomp(EQUALS), args.first)
 
-    elsif attr = lookup(method, @ref.attributes)
-      return process @ref.attribute(attr)
+    elsif attributes.include? method
+      return attribute method
 
-    elsif attr = lookup(method, @ref.parameterized_attributes)
-      return process @ref.attribute(attr, for_parameter: args.first)
+    elsif parameterized_attributes.include? method
+      return attribute method, for_parameter: args.first
 
-    elsif @ref.attributes.include? KAXChildrenAttribute
-      result = search method, *args, &block
-      return result unless result.blank?
-      raise Accessibility::SearchFailure.new(self, method, args.first)
+    elsif attributes.include? :children
+      if (result = search method, *args, &block).blank?
+        raise Accessibility::SearchFailure.new(self, method, args.first)
+      else
+        return result
+      end
 
     else
       super
@@ -416,8 +419,8 @@ class AX::Element
   # Overriden to respond properly with regards to dynamic attribute
   # lookups, but will return false for potential implicit searches.
   def respond_to? name
-    lookup(name.chomp(EQUALS), @ref.attributes)               ||
-    lookup(name,               @ref.parameterized_attributes) ||
+    attributes.include?(name)               ||
+    parameterized_attributes.include?(name) ||
     super
   end
 
@@ -486,11 +489,6 @@ class AX::Element
   # @return [String]
   EQUALS = '='
 
-  def lookup key, values
-    value = TRANSLATOR.lookup key, values
-    return value if values.include? value
-  end
-
   def notif_callback_for
     # we are ignoring the context pointer since this is OO
     Proc.new do |observer, sender, notif, _|

data/test/integration/accessibility/test_dsl.rb

@@ -59,6 +59,22 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
     assert_equal app, dsl.app_with_pid(PID)
   end
 
+  def test_set_focus_to
+    assert dsl.set_focus_to app
+    assert dsl.set_focus    app
+    assert dsl.set_focus_to app.main_window.search_field
+    assert dsl.set_focus    app.main_window.search_field
+  end
+
+  def test_set
+    expected = 'Octocat is not Hello Kitty!'
+    field    = app.main_window.search_field
+    dsl.set field, expected
+    assert_equal expected, field.value
+  ensure
+    field.set :value, '' if field
+  end
+
   def test_typing_human_string
     try_typing "A sentence, with punctuation and num8ers. LOL!\tA 'quoted' string--then some @#*$."
   end

data/test/integration/ax/test_application.rb

@@ -17,12 +17,12 @@ class TestAXApplication < MiniTest::Unit::TestCase
   end
 
   def test_can_set_focus_and_blur_app # lol, blur
-    assert app.set :focused, to: false
+    assert app.set :focused, false
     refute app.active?
     refute app.attribute :focused
     refute app.attribute :focused?
 
-    assert app.set :focused, to: true
+    assert app.set :focused, true
     assert app.active?
     assert app.attribute :focused
     assert app.attribute :focused?
@@ -32,10 +32,10 @@ class TestAXApplication < MiniTest::Unit::TestCase
   end
 
   def test_can_hide_and_unhide_app
-    assert app.set :hidden, to: true
+    assert app.set :hidden, true
     assert app.hidden?
 
-    assert app.set :hidden, to: false
+    assert app.set :hidden, false
     refute app.hidden?
 
     assert app.perform :hide
@@ -48,6 +48,10 @@ class TestAXApplication < MiniTest::Unit::TestCase
     running_app.activateWithOptions NSApplicationActivateIgnoringOtherApps
   end
 
+  def test_set_calls_super
+    assert app.set(:enhanced_user_interface, true)
+  end
+
   def test_element_at_point
     button = app.main_window.close_button
     assert_equal button, app.element_at_point(button)

data/test/integration/ax/test_element.rb

@@ -39,8 +39,4 @@ class TestAXElement < MiniTest::Unit::TestCase
     box.set :value, '' if box
   end
 
-  #  @todo test setting selected text
-  #  def test_setting
-  #  end
-
 end

data/test/sanity/accessibility/test_core.rb

@@ -70,7 +70,7 @@ class TestAccessibilityCore < MiniTest::Unit::TestCase
     assert_equal 10..19,              window.attribute("AXPie"            )
   end
 
-  def test_attribute_is_nil_when_no_value
+  def test_attribute_when_no_value
     assert_nil window.attribute(KAXGrowAreaAttribute)
   end
 
@@ -79,8 +79,8 @@ class TestAccessibilityCore < MiniTest::Unit::TestCase
     assert_empty invalid_ref.attribute(KAXChildrenAttribute)
   end
 
-  def test_attribute_handles_errors
-    assert_raises(ArgumentError) { REF.attribute 'MADEUPATTRIBUTE' }
+  def test_attribute_when_not_supported_attribute
+    assert_nil REF.attribute('MADEUPATTRIBUTE')
   end
 
   def test_role
@@ -120,8 +120,8 @@ class TestAccessibilityCore < MiniTest::Unit::TestCase
     refute invalid_ref.writable? KAXRoleAttribute
   end
 
-  def test_writable_handles_errors
-    assert_raises(ArgumentError) { REF.writable? 'FAKE' }
+  def test_writable_false_for_bad_attributes
+    refute REF.writable? 'FAKE'
   end
 
   def test_set_number

metadata

@@ -2,14 +2,14 @@
 name: AXElements
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00 Z
+date: 2012-04-06 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest