AXElements 0.8.1 → 0.9.0

data/lib/ax/menu.rb

@@ -21,7 +21,7 @@ class AX::Menu < AX::Element
   #     menu.scroll_to menu.item(title: "Expensive Cake")
   #   end
   #
-  # @param [AX::Element]
+  # @param [AX::Element] element
   # @return [void]
   def scroll_to element
     Mouse.move_to self.to_point
@@ -58,6 +58,10 @@ class AX::Menu < AX::Element
   # Search the menu for a `menu_item` that matches the given
   # filters. The filters should be specified just as they would
   # be when calling {#search}.
+  #
+  # @param [Hash] filters
+  # @yield Optional block used for search filtering
+  # @return [AX::Element]
   def item filters = {}, &block
     result = self.search :menu_item, filters, &block
     return result unless result.blank?

data/lib/ax/row.rb

@@ -25,7 +25,7 @@ class AX::Row < AX::Element
   #   }
   #   puts "The average price is $ #{total / rows.size}"
   #
-  # @param [Hash]
+  # @param [Hash] filters
   # @return [AX::Element]
   def child_in_column filters, &block
     qualifier = Accessibility::Qualifier.new(:Column, filters, &block)

data/lib/ax/scroll_area.rb

@@ -17,17 +17,18 @@ class AX::ScrollArea < AX::Element
   #
   #   scroll_area.scroll_to table.rows.last
   #
-  # @param [AX::Element]
+  # @param element [AX::Element]
   # @return [void]
   def scroll_to element
     return if NSContainsRect(self.bounds, element.bounds)
     Mouse.move_to self.to_point
-    # calculate direction to scroll
+
+    # calculate direction and velocity for scrolling
     direction = element.position.y > self.position.y ? -5 : 5
-    until NSContainsRect(self.bounds, element.bounds)
-      Mouse.scroll direction
-    end
-    sleep 0.1
+
+    Mouse.scroll direction until NSContainsRect(self.bounds, element.bounds)
+
+    spin 0.1
   end
 
 end

data/lib/ax/systemwide.rb

@@ -11,10 +11,37 @@ require 'accessibility/string'
 class AX::SystemWide < AX::Element
   include Accessibility::String
 
+  class << self
+    ##
+    # Find and return the group that represents the desktop
+    #
+    # @return [AX::Group]
+    def desktop
+      AX::Application.finder.scroll_areas.first.groups.first
+    end
+
+    ##
+    # @note This currently does not include spotlight or the
+    #       notification center as they interact oddly with
+    #       accessibility APIs and how AXElements handle errors
+    #
+    # Find and return menu bar items for the system
+    #
+    # That is, menu bar items that do not belong to the current
+    # app, but that belong to the system, such as the clock or
+    # wi-fi menu.
+    #
+    # @return [AX::MenuBarItem]
+    def status_items
+      AX::Application.new('SystemUIServer').menu_bar.children
+    end
+  end
+
+
   ##
   # Overridden since there is only one way to get the element ref.
   def initialize
-    super AXUIElementCreateSystemWide()
+    super Accessibility::Element.system_wide
   end
 
   ##
@@ -27,6 +54,7 @@ class AX::SystemWide < AX::Element
   # [Keyboarding documentation](http://github.com/Marketcircle/AXElements/wiki/Keyboarding)
   # for more information on how to format strings.
   #
+  # @param string [String]
   # @return [Boolean]
   def type string
     @ref.post keyboard_events_for string
@@ -44,7 +72,7 @@ class AX::SystemWide < AX::Element
   #     drag_mouse_to point
   #   end
   #
-  # @param [String]
+  # @param key [String]
   # @return [Number,nil]
   def hold_modifier key
     code = EventGenerator::CUSTOM[key]
@@ -78,10 +106,10 @@ class AX::SystemWide < AX::Element
   #
   # `nil` will be returned if there was nothing at that point.
   #
-  # @param [#to_point]
+  # @param point [#to_point]
   # @return [AX::Element,nil]
   def element_at point
-    process @ref.element_at point
+    @ref.element_at(point).to_ruby
   end
 
   ##
@@ -89,10 +117,15 @@ class AX::SystemWide < AX::Element
   # and looking up attributes incurs a lot of IPC calls and sometimes an
   # app is slow to respond.
   #
-  # @param [Number]
+  # @param seconds [Number]
   # @return [Number]
   def set_global_timeout seconds
     @ref.set_timeout_to seconds
   end
 
+  # (see AX::Application.frontmost_application)
+  def focused_application
+    AX::Application.frontmost_app
+  end
+
 end

data/lib/ax_elements/active_support_selections.rb

@@ -0,0 +1,10 @@
+# this is just a list of core extensions from Active Support
+# that I would like to have loaded by default
+
+require 'active_support/core_ext/numeric'
+require 'active_support/core_ext/date/calculations'
+require 'active_support/core_ext/date/conversions'
+require 'active_support/core_ext/time/calculations'
+require 'active_support/core_ext/time/conversions'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/date_time/conversions'

data/lib/ax_elements/mri.rb

@@ -0,0 +1,57 @@
+unless on_macruby?
+
+  KAXChildrenAttribute         = 'AXChildren'
+  KAXRoleAttribute             = 'AXRole'
+  KAXSubroleAttribute          = 'AXSubrole'
+  KAXIdentifierAttribute       = 'AXIdentifier'
+  KAXWindowCreatedNotification = 'AXWindowCreated'
+  KAXMainWindowAttribute       = 'AXMainWindow'
+  KAXFocusedAttribute          = 'AXFocused'
+  KAXValueChangedNotification  = 'AXValueChanged'
+  KAXTitleAttribute            = 'AXTitle'
+  KAXURLAttribute              = 'AXURL'
+  KAXTitleUIElementAttribute   = 'AXTitleUIElement'
+  KAXPlaceholderValueAttribute = 'AXPlaceholderValue'
+  KAXWindowRole                = 'AXWindow'
+  KAXCloseButtonSubrole        = 'AXCloseButton'
+  KAXTrashDockItemSubrole      = 'AXTrashDockItem'
+  KAXRTFForRangeParameterizedAttribute    = 'AXRTFForRange'
+  KAXIsApplicationRunningAttribute        = 'AXIsApplicationRunning'
+  KAXStringForRangeParameterizedAttribute = 'AXStringForRange'
+
+  unless defined? NSString
+    NSString = String
+  end
+
+  unless defined? NSDictionary
+    NSDictionary = Hash
+  end
+
+  unless defined? NSArray
+    NSArray = Array
+  end
+
+  unless defined? NSDate
+    NSDate = Time
+  end
+
+  class Symbol
+
+    def chomp suffix
+      to_s.chomp suffix
+    end
+
+  end
+
+end
+
+unless defined? KAXIdentifierAttribute
+  ##
+  # Added for backwards compatability with Snow Leopard.
+  # This attribute is standard with Lion and newer. AXElements depends
+  # on it being defined.
+  #
+  # @return [String]
+  KAXIdentifierAttribute = 'AXIdentifier'
+end
+

data/lib/ax_elements/nsarray_compat.rb

@@ -1,5 +1,6 @@
 require 'ax/element'
 require 'accessibility/translator'
+require 'active_support/core_ext/array/access'
 
 ##
 # An old hack on arrays that allows you to map a single method across
@@ -11,18 +12,6 @@ require 'accessibility/translator'
 # on this and so I will just keep it around for backwards compatability.
 module Accessibility::NSArrayCompat
 
-  ##
-  # Equivalent to `#at(1)`
-  def second
-    at(1)
-  end
-
-  ##
-  # Equivalent to `#at(2)`
-  def third
-    at(2)
-  end
-
   ##
   # @note Debatably bad idea. Maintained for backwards compatibility.
   #
@@ -40,11 +29,11 @@ module Accessibility::NSArrayCompat
   #   outline.rows.text_fields.values # all at once
   #
   def method_missing method, *args
-    smethod = TRANSLATOR.singularize(method.chomp('?'))
+    smethod = TRANSLATOR.singularize(method.to_s.chomp('?'))
     map do |x|
-      if    !x.kind_of? AX::Element then super
-      elsif  x.respond_to? method   then x.send method,  *args
-      else                               x.send smethod, *args
+      if    !x.kind_of?(AX::Element) then super
+      elsif  x.respond_to? method    then x.send method,  *args
+      else                                x.send smethod, *args
       end
     end
   end
@@ -58,8 +47,99 @@ module Accessibility::NSArrayCompat
 
 end
 
+unless defined? NSArray
+  NSArray = Array
+end
 
-# AXElements extensions for `NSArray`.
+##
+# AXElements extensions for `NSArray`
 class NSArray
   include Accessibility::NSArrayCompat
+
+  if on_macruby?
+
+    ##
+    # Returns the tail of the array from `position`
+    #
+    # @example
+    #
+    #   [1, 2, 3, 4].from(0)   # => [1, 2, 3, 4]
+    #   [1, 2, 3, 4].from(2)   # => [3, 4]
+    #   [1, 2, 3, 4].from(10)  # => []
+    #   [].from(0)             # => []
+    #
+    # @param position [Fixnum]
+    # @return [Array]
+    def from position
+      self[position, length] || []
+    end
+
+    ##
+    # Returns the beginning of the array up to `position`
+    #
+    #   [1, 2, 3, 4].to(0)   # => [1]
+    #   [1, 2, 3, 4].to(2)   # => [1, 2, 3]
+    #   [1, 2, 3, 4].to(10)  # => [1, 2, 3, 4]
+    #   [].to(0)             # => []
+    #
+    # @param count [Fixnum]
+    # @return [Array]
+    def to count
+      take count + 1
+    end
+
+    ##
+    # Equal to `self[1]`
+    def second
+      self[1]
+    end
+
+    ##
+    # Equal to `self[2]`
+    def third
+      self[2]
+    end
+
+    ##
+    # Equal to `self[3]`
+    def fourth
+      self[3]
+    end
+
+    ##
+    # Equal to `self[4]`
+    def fifth
+      self[4]
+    end
+
+    ##
+    # Equal to `self[41]`
+    #
+    # Also known as accessing "the reddit".
+    def forty_two
+      self[41]
+    end
+
+  else
+
+    ##
+    # Create a new array with the same contents as the given array
+    #
+    # @param ary [Array]
+    def self.arrayWithArray ary
+      ary.dup
+    end
+
+    ##
+    # Create and return a new empty array
+    #
+    # @return [Array]
+    def self.array
+      []
+    end
+
+  end
+
+  alias_method :the_reddit, :forty_two
+
 end

data/lib/ax_elements.rb

@@ -1,12 +1,20 @@
+require 'ax_elements/active_support_selections'
+require 'accessibility/bridge'
+require 'ax_elements/mri' unless on_macruby?
+
 # Mix the language methods into the TopLevel
 require 'accessibility/dsl'
 include Accessibility::DSL
 
+require 'accessibility/system_info'
+
 ##
+# @deprecated Please use {AX::Application.dock} instead
+#
 # The Mac OS X dock application.
 #
 # @return [AX::Application]
-AX::DOCK = AX::Application.new('com.apple.dock')
+AX::DOCK = AX::Application.dock
 
 # Load explicitly defined elements that are optional
 require 'ax/button'

data/rakelib/gem.rake

@@ -4,25 +4,25 @@ ax_elements = Gem::Specification.load('AXElements.gemspec')
 Gem::PackageTask.new(ax_elements) { }
 
 desc 'Build and install gem (not including deps)'
-task :install => :gem do
+task :install => [:gem, :setup] do
   require 'rubygems/installer'
   Gem::Installer.new("pkg/#{ax_elements.file_name}").install
 end
 
-desc 'Install dependencies for development'
-task :setup_dev do
+desc 'Install dependencies for running AXElements'
+task :setup do
   require 'rubygems/dependency_installer'
-  spec.development_dependencies.each do |dep|
+  ax_elements.runtime_dependencies.each do |dep|
     puts "Installing #{dep.name} (#{dep.requirement})"
     Gem::DependencyInstaller.new.install(dep.name, dep.requirement)
   end
 end
 
-ax_typer = Gem::Specification.load('AXTyper.gemspec')
-Gem::PackageTask.new(ax_typer) { }
-
-desc 'Build and install AXTyper'
-task :install_typer => :gem do
-  require 'rubygems/installer'
-  Gem::Installer.new("pkg/#{ax_typer.file_name}").install
+desc 'Install dependencies for development'
+task :setup_dev => :setup do
+  require 'rubygems/dependency_installer'
+  (ax_elements.runtime_dependencies + ax_elements.development_dependencies).each do |dep|
+    puts "Installing #{dep.name} (#{dep.requirement})"
+    Gem::DependencyInstaller.new.install(dep.name, dep.requirement)
+  end
 end

data/rakelib/test.rake

@@ -41,13 +41,4 @@ namespace :test do
     t.pattern = "test/sanity/accessibility/test_string.rb"
   end
   task :string => :ext
-
-  desc 'Run tests under CRuby (where applicable)'
-  task :cruby do
-    if ENV['RUBY_VERSION'] # using rvm
-      puts sh 'rvm 1.9.3 do rake test:string'
-    else
-      sh 'rake test:string'
-    end
-  end
 end

data/test/helper.rb

@@ -1,25 +1,18 @@
-framework 'Cocoa'
+require 'rubygems'
+require 'accessibility/core'
+framework 'Cocoa' if on_macruby?
 
 # We want to launch the test app and make sure it responds to
 # accessibility queries, but that is difficult to know at what
 # point it will start to respond, so we just sleep
-APP_BUNDLE_URL = NSURL.fileURLWithPath File.expand_path './test/fixture/Release/AXElementsTester.app'
+APP_BUNDLE_PATH       = File.expand_path './test/fixture/Release/AXElementsTester.app'
 APP_BUNDLE_IDENTIFIER = 'com.marketcircle.AXElementsTester'
 
-error    = Pointer.new :id
-TEST_APP = NSWorkspace.sharedWorkspace.launchApplicationAtURL APP_BUNDLE_URL,
-                                                     options: NSWorkspaceLaunchAsync,
-                                               configuration: {},
-                                                       error: error
-if TEST_APP.nil?
-  $stderr.puts 'You need to build AND run the fixture app once before running tests'
-  $stderr.puts 'Run `rake run_fixture` to initalize the fixture'
-  exit 3
-else
-  sleep 2 # Instead of using high level features of AXElements that we are
-          # testing, I think it is just safer to sleep
-  # Make sure the test app is closed when testing finishes
-  at_exit do TEST_APP.terminate end
+`open #{APP_BUNDLE_PATH}`
+sleep 3
+
+at_exit do
+  `killall AXElementsTester`
 end
 
 
@@ -29,6 +22,5 @@ require 'test/runner'
 class MiniTest::Unit::TestCase
   # needs to be defined in the class, there is a TOPLEVEL::PID
   PID = pid_for APP_BUNDLE_IDENTIFIER
-  REF = AXUIElementCreateApplication(PID)
+  REF = Accessibility::Element.application_for PID
 end
-

data/test/integration/accessibility/test_dsl.rb

@@ -14,8 +14,20 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
 
   def text_area;       @@text_area ||= app.main_window.text_area                             end
   def pop_up;          @@pop_up    ||= app.main_window.pop_up                                end
-  def pref_window;     app.children.find { |x| x.attribute(:title) == 'Preferences'   }      end
-  def spelling_window; app.children.find { |x| x.attribute(:title).to_s.match(/^Spelling/) } end
+  def pref_window
+    app.children.find { |x|
+      if x.respond_to? :title
+        x.attribute(:title) == 'Preferences'
+      end
+    }
+  end
+  def spelling_window
+    app.children.find { |x|
+      if x.respond_to? :title
+        x.attribute(:title).to_s.match(/^Spelling/)
+      end
+    }
+  end
 
   def try_typing string, expected = nil
     expected = string unless expected
@@ -154,7 +166,8 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
 
   def test_wait_for_invalidation_of_element
     app.main_window.button(title: 'Yes').perform(:press)
-    Dispatch::Queue.new("herp").after(1) do
+    Thread.new do
+      sleep 1
       app.main_window.button(title: 'No').perform(:press)
     end
 
@@ -163,7 +176,8 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
 
   def test_wait_for_invalidation_of_wait_for
     app.main_window.button(title: 'Yes').perform(:press)
-    Dispatch::Queue.new("herp").after(1) do
+    Thread.new do
+      sleep 1
       app.main_window.button(title: 'No').perform(:press)
     end
 
@@ -187,48 +201,33 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
     app.main_window.set :position, orig_window_position if orig_window_position
   end
 
+  def test_right_click_with_block
+    area = app.main_window.web_area
+
+    got_called = false
+    dsl.right_click area do
+      got_called = true
+    end
+    assert got_called
+  ensure
+    dsl.click area
+  end
+
+  def test_triple_click
+    dummy_text = 'Lorem ipsum dolor.' * 15
+    text_area.set :value, dummy_text
+    dsl.triple_click text_area
+    assert_equal dummy_text, text_area.selected_text
+  ensure
+    app.main_window.text_area.set :value, ''
+  end
+
   def test_highlight
     highlighter = dsl.highlight app.main_window, colour: NSColor.blueColor
     assert_kind_of Accessibility::Highlighter, highlighter
-    assert_equal   NSColor.blueColor,          highlighter.backgroundColor
+    assert_equal   NSColor.blueColor,          highlighter.color
     highlighter.stop
-
-    def highlight_test
-      @got_called = true
-    end
-    highlighter = dsl.highlight app.main_window, color: NSColor.greenColor, timeout: 0.1
-    NSNotificationCenter.defaultCenter.addObserver self,
-                                         selector: 'highlight_test',
-                                             name: NSWindowWillCloseNotification,
-                                           object: highlighter
-    sleep 0.1
-    assert @got_called
-  end
-
-  def test_dump_works_for_nested_tab_groups
-    output = dsl.subtree_for app.window.tab_group
-
-    expected = [
-                ['AX::TabGroup',    0],
-                ['AX::RadioButton', 1], ['AX::RadioButton', 1], ['AX::TabGroup', 1],
-                ['AX::RadioButton', 2], ['AX::RadioButton', 2], ['AX::TabGroup', 2],
-                ['AX::RadioButton', 3], ['AX::RadioButton', 3], ['AX::TabGroup', 3],
-                ['AX::RadioButton', 4], ['AX::RadioButton', 4],
-                ['AX::Group',       4],
-                ['AX::TextField',   5], ['AX::StaticText',  6],
-                ['AX::TextField' ,  5], ['AX::StaticText',  6]
-               ]
-
-    refute_empty output
-    output = output.split("\n")
-
-    until output.empty?
-      line           = output.shift
-      klass, indents = expected.shift
-      assert_equal indents, line.match(/^\t*/).to_a.first.length, line
-      line.strip!
-      assert_match /^\#<#{klass}/, line
-    end
+    refute highlighter.visible?
   end
 
   def test_screenshot
@@ -332,4 +331,15 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
     pop_up.menu_item.perform :cancel unless pop_up.children.empty?
   end
 
+  def test_contextual_menu
+    Mouse.move_to app.window.web_area
+    menu = nil
+    dsl.right_click do
+      menu = dsl.contextual_menu
+    end
+    refute_nil menu, 'did not find the contextual menu'
+    refute_nil menu.item(title: 'Reload')
+    menu.perform :cancel
+  end
+
 end

data/test/integration/accessibility/test_enumerators.rb

@@ -49,7 +49,6 @@ end
 
 
 class TestAccessibilityEnumeratorsDepthFirst < MiniTest::Unit::TestCase
-  include Accessibility::Core
 
   def app
     @@app ||= AX::Application.new REF

data/test/integration/accessibility/test_graph.rb

@@ -4,6 +4,7 @@ require 'accessibility/graph'
 class TestAccessibilityGraph < MiniTest::Unit::TestCase
 
   def test_generate
+    skip 'graphs are broken right now'
     p = Accessibility::Graph.new(app.main_window).generate_png!
     assert File.exists? p
     assert_match /^PNG image/, `file --brief #{p}`

data/test/integration/accessibility/test_qualifier.rb

@@ -72,14 +72,14 @@ class TestAccessibilityQualifier < MiniTest::Unit::TestCase
 
   def test_qualifies_based_on_param_attribute_value
     e = app.attribute(:main_window).attribute(:title_ui_element)
-    q = qualifier(:StaticText, [:string_for_range, CFRange.new(0,2)] => 'AX' )
+    q = qualifier(:StaticText, [:string_for_range, 0..1] => 'AX' )
     assert q.qualifies? e
     refute q.qualifies? list
   end
 
   def test_qualifies_based_on_param_attribute_regexp_match
     e = app.attribute(:main_window).attribute(:title_ui_element)
-    q = qualifier(:StaticText, [:string_for_range, CFRange.new(0,2)] => /AX/ )
+    q = qualifier(:StaticText, [:string_for_range, 0..1] => /AX/ )
     assert q.qualifies? e
     refute q.qualifies? items.sample
   end

data/test/integration/ax/test_application.rb

@@ -13,6 +13,13 @@ class TestAXApplication < MiniTest::Unit::TestCase
     assert_equal app, AX::Application.new(running_app)
   end
 
+  def test_initialize_causing_app_to_launch
+    app = AX::Application.new('com.apple.Grab')
+    assert_kind_of AX::Application, app
+  ensure
+    app.terminate if app
+  end
+
   def test_can_set_focus_and_blur_app # lol, blur
     assert app.set :focused, false
     refute app.active?
@@ -25,7 +32,7 @@ class TestAXApplication < MiniTest::Unit::TestCase
     assert app.attribute :focused?
 
   ensure
-    running_app.activateWithOptions NSApplicationActivateIgnoringOtherApps
+    running_app.activateWithOptions NSRunningApplication::NSApplicationActivateIgnoringOtherApps
   end
 
   def test_can_hide_and_unhide_app
@@ -42,7 +49,7 @@ class TestAXApplication < MiniTest::Unit::TestCase
     refute app.hidden?
 
   ensure
-    running_app.activateWithOptions NSApplicationActivateIgnoringOtherApps
+    running_app.activateWithOptions NSRunningApplication::NSApplicationActivateIgnoringOtherApps
   end
 
   def test_set_calls_super