AXElements 1.0.0.beta4 → 6.0.0

data/lib/ax/application.rb

@@ -1,5 +1,5 @@
 require 'ax/element'
-require 'accessibility/string'
+require 'accessibility/keyboard'
 
 ##
 # The accessibility object representing the running application. This
@@ -9,7 +9,7 @@ require 'accessibility/string'
 # As this class has evolved, it has gathered some functionality from
 # the `NSRunningApplication` and `NSBundle` classes.
 class AX::Application < AX::Element
-  include Accessibility::String
+  include Accessibility::Keyboard
 
   class << self
     ##
@@ -75,12 +75,16 @@ class AX::Application < AX::Element
   end
 
   ##
+  # @note Initialization with bundle identifiers is case-sensitive
+  #       (e.g. 'com.apple.iCal' is correct, 'com.apple.ical' is wrong)
+  #
   # Standard way of creating a new application object
   #
   # You can initialize an application object with either the process
-  # identifier (pid) of the application, the name of the application,
-  # an `NSRunningApplication` instance for the application, or an
-  # accessibility (`AXUIElementRef`) token.
+  # identifier (pid) of the application, the name of the application, the
+  # bundle identifier string (e.g. 'com.company.appName'), an
+  # `NSRunningApplication` instance for the application, or an accessibility
+  # (`AXUIElementRef`) token.
   #
   # Given a PID, we try to lookup the application and wrap it.
   #
@@ -105,46 +109,27 @@ class AX::Application < AX::Element
   #
   #   AX::Application.new 'com.apple.mail'
   #   AX::Application.new 'Mail'
+  #   AX::Application.new 578
+  #   AX::Application.new 'com.apple.iCal'
+  #   AX::Application.new 'Calendar'
+  #   AX::Application.new 3782
+  #   AX::Application.new 'com.apple.AddressBook'
+  #   AX::Application.new 'Contacts'
   #   AX::Application.new 43567
   #
   # @param arg [Number,String,NSRunningApplication]
   def initialize arg
-    case arg
-    when Fixnum
-      super Accessibility::Element.application_for arg
-      @app = NSRunningApplication.runningApplicationWithProcessIdentifier arg
-    when String
-      until @app
-        @app =
-         (
-          app = NSRunningApplication.runningApplicationsWithBundleIdentifier arg
-          app.first
-
-         ) || (
-           spin
-           NSWorkspace.sharedWorkspace.runningApplications.find { |app|
-             app.localizedName == arg
-           }
-
-         ) || (
-           count ||= 0
-           if AX::Application.launch arg
-             spin 1
-             count += 1
-             raise "#{arg} failed to launch in time" if count == 10
-           else
-             raise "#{arg} is not a registered bundle identifier for the system"
+    @app = case arg
+           when String
+             init_with_bundle_id(arg) || init_with_name(arg) || try_launch(arg)
+           when Fixnum
+             NSRunningApplication.runningApplicationWithProcessIdentifier arg
+           when NSRunningApplication
+             arg
+           else # assume it is an AXUIElementRef (Accessibility::Element)
+             NSRunningApplication.runningApplicationWithProcessIdentifier arg.pid
            end
-        )
-      end
-      super Accessibility::Element.application_for @app.processIdentifier
-    when NSRunningApplication
-      super Accessibility::Element.application_for arg.processIdentifier
-      @app = arg
-    else
-      super arg # assume it is an AXUIElementRef
-      @app = NSRunningApplication.runningApplicationWithProcessIdentifier pid
-    end
+    super Accessibility::Element.application_for @app.processIdentifier
   end
 
 
@@ -318,8 +303,10 @@ class AX::Application < AX::Element
   # @param string [String]
   # @return [Boolean]
   def type string
-    @ref.post keyboard_events_for string
-    true
+    perform(:unhide) unless focused?
+    keyboard_events_for(string).each do |event|
+      KeyCoder.post_event event
+    end
   end
   alias_method :type_string, :type
 
@@ -437,4 +424,29 @@ class AX::Application < AX::Element
     @bundle ||= NSBundle.bundleWithURL @app.bundleURL
   end
 
+  def init_with_bundle_id id
+    app = NSRunningApplication.runningApplicationsWithBundleIdentifier id
+    app.first
+  end
+
+  def init_with_name name
+    spin
+    NSWorkspace.sharedWorkspace.runningApplications.find { |app|
+      app.localizedName == name
+    }
+  end
+
+  def try_launch id
+    10.times do
+      app = init_with_bundle_id id
+      return app if app
+      if AX::Application.launch id
+        spin 1
+      else
+        raise "#{arg} is not a registered bundle identifier for the system"
+      end
+    end
+    raise "#{arg} failed to launch in time"
+  end
+
 end

data/lib/ax/element.rb

@@ -227,6 +227,22 @@ class AX::Element
     @ref.perform TRANSLATOR.cocoaify action
   end
 
+  ##
+  # @note As of OS X 10.9 (Sea Lion), it is no longer possible to send
+  #       keyboard events directly to an element. What we have here is
+  #       only an approximation.
+  #
+  # Send keyboard events to the receiver.
+  #
+  # @param string [String]
+  # @return [Boolean]
+  def type string
+    set_focus_to self unless focused?
+    keyboard_events_for(string).each do |event|
+      KeyCoder.post_event event
+    end
+  end
+
 
   # @group Search
 
@@ -280,7 +296,7 @@ class AX::Element
     element   = self
     until qualifier.qualifies? element
       element = element.attribute :parent
-      return nil unless element
+      break unless element
     end
     element
   end
@@ -365,12 +381,9 @@ class AX::Element
   #
   # @return [String]
   def inspect
-    msg  = "#<#{self.class}" << pp_identifier.to_s
-    msg << pp_position if attributes.include? :position
-    msg << pp_children if attributes.include? :children
-    msg << pp_checkbox(:enabled) if attributes.include? :enabled
-    msg << pp_checkbox(:focused) if attributes.include? :focused
-    msg << '>'
+    "#<#{self.class}" << pp_identifier.to_s <<
+                         pp_position << pp_children <<
+                         pp_enabled << pp_focused << '>'
   end
 
   ##
@@ -384,6 +397,13 @@ class AX::Element
     inspect
   end
 
+  ##
+  #
+  # @return [Hash{Symbol=>Object}]
+  def to_h
+    Hash[attributes.zip attributes.map { |attr| attribute(attr) }]
+  end
+
   ##
   # Get the relevant details about the receiver and also the children
   # and further descendents of the receiver. Each generation down the

data/lib/ax/scroll_area.rb

@@ -1,4 +1,5 @@
 require 'ax/element'
+require 'mouse'
 
 ##
 # UI element for a view that can scroll? I'm not sure how else to

data/lib/ax/systemwide.rb

@@ -1,5 +1,5 @@
 require 'ax/element'
-require 'accessibility/string'
+require 'accessibility/keyboard'
 
 ##
 # Represents the special `SystemWide` accessibility object.
@@ -9,7 +9,7 @@ require 'accessibility/string'
 # of the system wide object when you need to use it (even though they
 # are all the same thing).
 class AX::SystemWide < AX::Element
-  include Accessibility::String
+  include Accessibility::Keyboard
 
   class << self
     ##
@@ -57,8 +57,9 @@ class AX::SystemWide < AX::Element
   # @param string [String]
   # @return [Boolean]
   def type string
-    @ref.post keyboard_events_for string
-    true
+    keyboard_events_for(string).each do |event|
+      KeyCoder.post_event event
+    end
   end
   alias_method :type_string, :type
 

data/lib/ax/text_area.rb

@@ -0,0 +1,16 @@
+require 'ax/element'
+require 'accessibility/text_highlighter'
+
+##
+# Represents a generic text field on screen that users can
+# manipulate. Usually seen in form with placeholder text.
+class AX::TextArea < AX::Element
+  include Accessibility::TextHighlighter
+
+  # (see Accessibility::TextHighlighter#highlight_text)
+  def highlight_text range
+    # @todo make sure the text is visible first
+    super
+  end
+
+end

data/lib/ax/text_field.rb

@@ -0,0 +1,10 @@
+require 'ax/element'
+require 'accessibility/text_highlighter'
+
+
+##
+# Represents a generic text field on screen that users can
+# manipulate. Usually seen in form with placeholder text.
+class AX::TextField < AX::Element
+  include Accessibility::TextHighlighter
+end

data/lib/ax_elements/mri.rb

@@ -1,42 +1,78 @@
 unless on_macruby?
 
+  # @return [String]
   KAXChildrenAttribute         = 'AXChildren'
+  # @return [String]
   KAXRoleAttribute             = 'AXRole'
+  # @return [String]
   KAXSubroleAttribute          = 'AXSubrole'
+  # @return [String]
   KAXIdentifierAttribute       = 'AXIdentifier'
+  # @return [String]
   KAXWindowCreatedNotification = 'AXWindowCreated'
+  # @return [String]
   KAXMainWindowAttribute       = 'AXMainWindow'
+  # @return [String]
   KAXFocusedAttribute          = 'AXFocused'
+  # @return [String]
   KAXValueChangedNotification  = 'AXValueChanged'
+  # @return [String]
   KAXTitleAttribute            = 'AXTitle'
+  # @return [String]
   KAXURLAttribute              = 'AXURL'
+  # @return [String]
   KAXTitleUIElementAttribute   = 'AXTitleUIElement'
+  # @return [String]
   KAXPlaceholderValueAttribute = 'AXPlaceholderValue'
+  # @return [String]
   KAXWindowRole                = 'AXWindow'
+  # @return [String]
   KAXCloseButtonSubrole        = 'AXCloseButton'
+  # @return [String]
   KAXTrashDockItemSubrole      = 'AXTrashDockItem'
+  # @return [String]
+  KAXPosition                  = 'AXPosition'
+  # @return [String]
+  KAXSize                      = 'AXSize'
+  # @return [String]
   KAXRTFForRangeParameterizedAttribute    = 'AXRTFForRange'
+  # @return [String]
   KAXIsApplicationRunningAttribute        = 'AXIsApplicationRunning'
+  # @return [String]
   KAXStringForRangeParameterizedAttribute = 'AXStringForRange'
 
   unless defined? NSString
+    # Alias for the `String` class, compatible with MacRuby
+    # @return [Class]
     NSString = String
   end
 
   unless defined? NSDictionary
+    # Alias for the `Hash` class, compatible with MacRuby
+    # @return [Class]
     NSDictionary = Hash
   end
 
   unless defined? NSArray
+    # Alias for the `Array` class, compatible with MacRuby
+    # @return [Class]
     NSArray = Array
   end
 
   unless defined? NSDate
+    # Alias for the `Time` class, compatible with MacRuby
+    # @return [Class]
     NSDate = Time
   end
 
+  ##
+  # AXElements extensions to the Symbol class
   class Symbol
 
+    ##
+    # Equivalent to `String#chomp`, coerces receiver to string first
+    #
+    # @return [String]
     def chomp suffix
       to_s.chomp suffix
     end
@@ -54,4 +90,3 @@ unless defined? KAXIdentifierAttribute
   # @return [String]
   KAXIdentifierAttribute = 'AXIdentifier'
 end
-

data/rakelib/ci.rake

@@ -0,0 +1,9 @@
+desc 'Run flog on lib/ and report the results'
+task :flog do
+  sh 'flog -g lib/'
+end
+
+desc 'Generate documentation'
+task :yard do
+  sh 'yard'
+end

data/rakelib/doc.rake

@@ -1,16 +1,7 @@
-# begin
-#   require 'yard'
-#   YARD::Rake::YardocTask.new
-# rescue LoadError => e
-#   $stderr.puts 'It seems as though you do not have yard installed.'
-#   command = ENV['RUBY_VERSION'] ? 'rake' : 'sudo macrake'
-#   $stderr.puts "You can install it by running `#{command} setup_dev`"
-# end
-
-# desc 'Generate Graphviz object graph'
-# task :garden => :yard do
-#   sh 'yard graph --full --dependencies --dot="-Tpng:quartz" -f docs/images/AX.dot'
-# end
+desc 'Generate Graphviz object graph'
+task :garden => :yard do
+  sh 'yard graph --full --dependencies --dot="-Tpng:quartz" -f docs/images/AX.dot'
+end
 
 desc 'Remove files generated by YARD'
 task :clobber_yard do

data/rakelib/ext.rake

@@ -1,61 +1,5 @@
-module ExtHelpers
-  def macruby?
-    defined? MACRUBY_REVISION
-  end
-
-  def cruby?
-    RUBY_ENGINE == 'ruby'
-  end
-
-  def needs_regeneration? source, bundle
-    return true unless File.exists? bundle
-    return true unless File.mtime(bundle) > File.mtime(source)
-    return true if macruby? && ext_platform(bundle) == :cruby
-    return true if cruby?   && ext_platform(bundle) == :macruby
-  end
-
-  def ext_platform bundle
-    return :macruby if `otool -L #{bundle}`.match /MacRuby/
-    return :cruby
-  end
-end
-
-
-namespace :ext do
-  extend ExtHelpers
-
-  desc 'Compile the key_coder C extension'
-  task :key_coder do
-    dir = 'ext/accessibility/key_coder'
-    ext = "#{dir}/key_coder"
-    if needs_regeneration? "#{ext}.c", "#{ext}.bundle"
-      Rake::Task['clobber_key_coder'].execute
-      Dir.chdir(dir) do
-        ruby 'extconf.rb'
-        sh   'make'
-      end
-      cp "#{ext}.bundle", 'lib/accessibility'
-    end
-  end
-end
-
-
-desc 'Remove files generated by compiling key_coder'
-task :clobber_key_coder do
-  Dir.glob('{lib,ext}/**/*{.bundle,.o}').each do |file|
-    $stdout.puts "rm #{file}"
-    rm_f file
-  end
-  file = 'ext/accessibility/key_coder/Makefile'
-  $stdout.puts "rm #{file}"
-  rm_f file
-end
-
-desc 'Remove files generated by compiling extensions'
-task :clobber_ext => [:clobber_key_coder]
-
-
 if RUBY_ENGINE == 'macruby'
   require 'rake/compiletask'
   Rake::CompileTask.new
 end
+

data/rakelib/gem.rake

@@ -1,28 +1,12 @@
-require 'rubygems/package_task'
+require 'bundler/gem_tasks'
 
-ax_elements = Gem::Specification.load('AXElements.gemspec')
-Gem::PackageTask.new(ax_elements) { }
+task :install => :setup
 
-desc 'Build and install gem (not including deps)'
-task :install => [:gem, :setup] do
-  require 'rubygems/installer'
-  Gem::Installer.new("pkg/#{ax_elements.file_name}").install
-end
-
-desc 'Install dependencies for running AXElements'
+desc 'Install AXElements dependencies'
 task :setup do
-  require 'rubygems/dependency_installer'
-  ax_elements.runtime_dependencies.each do |dep|
-    puts "Installing #{dep.name} (#{dep.requirement})"
-    Gem::DependencyInstaller.new.install(dep.name, dep.requirement)
-  end
+  sh 'bundle install'
 end
 
-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
+desc 'Install AXElements development dependencies'
+task :setup_dev => :setup
+

data/rakelib/test.rake

@@ -1,6 +1,7 @@
 desc 'Start up irb with AXElements loaded'
-task :console => :ext do
+task :console do
   irb = ENV['RUBY_VERSION'] ? 'irb' : 'macirb'
+  ENV['AXDEBUG'] = '1'
   sh "#{irb} -Ilib -rubygems -rax_elements"
 end
 
@@ -21,24 +22,16 @@ task :clobber_fixture do
 end
 task :clobber => :clobber_fixture
 
-require 'rake/testtask'
 namespace :test do
-  Rake::TestTask.new(:sanity) do |t|
-    t.libs   << '.'
-    t.pattern = "test/sanity/**/test_*.rb"
+  desc 'Run sanity tests (basic, fast stuff)'
+  task :sanity => :fixture do
+    files = FileList['test/sanity/**/test_*.rb']
+    sh "./test/runner #{files}"
   end
-  task :sanity => [:ext, :fixture]
 
-  Rake::TestTask.new(:integration) do |t|
-    t.libs   << '.'
-    t.pattern = "test/integration/**/test_*.rb"
+  desc 'Run integration tests (complex, slow stuff)'
+  task :integration => :fixture do
+    files = FileList['test/integration/**/test_*.rb']
+    sh "./test/runner #{files}"
   end
-  task :integration => [:ext, :fixture]
-
-  desc 'Run tests for the string parser'
-  Rake::TestTask.new(:string) do |t|
-    t.libs   << '.'
-    t.pattern = "test/sanity/accessibility/test_string.rb"
-  end
-  task :string => :ext
 end

data/test/helper.rb

@@ -1,26 +1,23 @@
 require 'rubygems'
-require 'accessibility/core'
-framework 'Cocoa' if on_macruby?
+require 'simplecov' unless RUBY_ENGINE == '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_PATH       = File.expand_path './test/fixture/Release/AXElementsTester.app'
-APP_BUNDLE_IDENTIFIER = 'com.marketcircle.AXElementsTester'
+require 'test/fixture_app' # must be loaded before minitest
+require 'minitest/autorun'
 
-`open #{APP_BUNDLE_PATH}`
-sleep 3
-
-at_exit do
-  `killall AXElementsTester`
+# preprocessor powers, assemble!
+if ENV['BENCH']
+  require 'minitest/benchmark'
+else
+  require'minitest/pride'
 end
 
+class MiniTest::Unit::TestCase
 
-require 'test/runner'
-
+  def self.bench_range
+    bench_exp 100, 100_000
+  end
 
-class MiniTest::Unit::TestCase
-  # needs to be defined in the class, there is a TOPLEVEL::PID
-  PID = pid_for APP_BUNDLE_IDENTIFIER
-  REF = Accessibility::Element.application_for PID
 end
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+

data/test/integration/accessibility/test_dsl.rb

@@ -12,8 +12,14 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
     @dsl ||= DSL.new
   end
 
-  def text_area;       @@text_area ||= app.main_window.text_area                             end
-  def pop_up;          @@pop_up    ||= app.main_window.pop_up                                end
+  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|
       if x.respond_to? :title
@@ -54,7 +60,7 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
   end
 
   def test_application_with_pid
-    assert_equal app, dsl.app_with_pid(PID)
+    assert_equal app, dsl.app_with_pid(APP_PID)
   end
 
   def test_set_focus_to

data/test/integration/ax/test_application.rb

@@ -7,7 +7,7 @@ class TestAXApplication < MiniTest::Unit::TestCase
   end
 
   def test_initialize_args
-    assert_equal app, AX::Application.new(PID)
+    assert_equal app, AX::Application.new(APP_PID)
     assert_equal app, AX::Application.new(APP_BUNDLE_IDENTIFIER)
     assert_equal app, AX::Application.new(running_app.localizedName)
     assert_equal app, AX::Application.new(running_app)

data/test/integration/ax/test_text_area.rb

@@ -0,0 +1,62 @@
+require 'test/integration/helper'
+
+class TestAXTextArea < MiniTest::Unit::TestCase
+
+  def text_area
+    @area ||= app.main_window.text_area
+  end
+
+  def text
+    <<-EOS
+Lorem ipsum dolor sit amet, dignissim at eget. Porttitor ut, montes eget, sed ante nec faucibus erat id, fermentum sed eu inceptos turpis, rutrum vitae lectus est augue. Leo leo pede eu sem. Ornare ridiculus bibendum elit amet integer elit, leo porttitor vestibulum vestibulum, ut dignissim faucibus laoreet sodales nullam tellus, lacus pellentesque laoreet consectetur viverra ut. Turpis risus vestibulum purus. Integer convallis, in eros conubia, augue metus ut, hac litora elit lorem. Enim feugiat sem vel, ut integer, fermentum in wisi, pharetra pharetra posuere. Torquent vehicula hendrerit donec, scelerisque tincidunt adipiscing orci non fames luctus, per pellentesque lectus felis sed massa elit, praesent lectus diam est vitae congue et. Neque justo vitae suspendisse in. Et morbi, primis a.
+    EOS
+  end
+
+  def setup
+    text_area.value = text
+  end
+
+  def teardown
+    text_area.value = ''
+  end
+
+  def test_highlight_text_regexp
+    [
+     /L/,
+     /Lorem/,
+     /orem/,
+#     /a.$/
+    ].each do |expected|
+      text_area.highlight_text expected
+      actual   = text_area.selected_text
+      expected = text_area.value.scan(expected).first
+      assert_equal expected, actual
+    end
+  end
+
+  def test_highlight_text_string
+    skip
+    [
+     'Enim feugiat sem vel, ut integer, fermentum in wisi, pharetra pharetra posuere.',
+     'Enim',
+     'at'
+    ].each do |expected|
+      text_area.highlight_text expected
+      actual = text_area.selected_text
+      assert_equal expected, actual, expected
+    end
+  end
+
+  def test_highlight_text_range
+    [
+     6..10,
+     6...10,
+    ].each do |range|
+      expected = text_area.value[range]
+      text_area.highlight_text range
+      actual   = text_area.selected_text
+      assert_equal expected, actual, range
+    end
+  end
+
+end