AXElements 1.0.0.beta4 → 6.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b61857f042227f18716780302b724e51803461f
+  data.tar.gz: 24308e7efc98e7ad11047e4a68099303a556c095
+SHA512:
+  metadata.gz: 38c616f7f1d5ad7982ba5fc836dc803fdab4cf70d378d1c4898755a6f69f5344af71043f8b082a84c437545cc3eb978850a5a1b60646933fb3051484cd860a2f
+  data.tar.gz: 023fa8b38c431e9d9a2ac335a6e07ae111eb27f33819b6dcd0595196c30205b34fa98a2d98141565773ea9973b5a33184b348ed8bd81af284c0b7b53d3b87abc

data/History.markdown

@@ -1,3 +1,10 @@
+# 6.0.0
+
+  * Compatability with Sea Lion (OS X 10.9)
+    - You can no longer send simulated input directly to an object,
+      we now approximate the old behaviour by trying to set focus
+      to the element before simulating system wide input
+
 # 0.9.0
 
   * AXElements can now run on MRI as well as MacRuby

data/README.markdown

@@ -24,12 +24,12 @@ The code from the demo video is right here:
     Accessibility.debug = true
 
     # Get a reference to the Finder and bring it to the front
-    finder = app_with_bundle_identifier 'com.apple.finder'
+    finder = AX::Application.new 'com.apple.finder'
     set_focus_to finder
 
     # Open a new window
     type "\\COMMAND+n"
-    sleep 1 # pause for "slow motion"
+    sleep 1 # pause for "slow motion" effect
 
     # Find and click the "Applications" item in the sidebar
     window = finder.main_window
@@ -64,12 +64,31 @@ The code from the demo video is right here:
 
 ## Getting Setup
 
-You will need Ruby 1.9.3 or a MacRuby nightly build for
-installation. You can get help installing Ruby 1.9.3 from the
-[Ruby Website](http://www.ruby-lang.org), or help installing MacRuby
-from the
-[Setup MacRuby](https://github.com/MacRuby/MacRuby/wiki/Setting-up-MacRuby)
-guide on Github.
+If you are running OS X 10.9 (Sea Lion) or newer, all you need are the
+command line tools, and then you can install AXElements:
+
+```bash
+  xcode-select --install # if you need to install the command line tools
+
+  sudo gem install AXElements
+```
+
+Alternatively, if you know how to change your `$GEM_HOME`, then you can
+install AXElements without using `sudo`.
+
+You will be asked to "Grant access" for Accessibility to Terminal.app
+when you first try using AXElements. Make sure you select Terminal in
+the list on the right, and then AXElements should work without requiring
+you to grant further permissions:
+
+![Grant Access](http://axelements.com/images/access.png)
+
+![How To Grant Access](http://axelements.com/images/privacy_prefs.png)
+
+For older versions of OS X, you will need to install a compatible version
+of Ruby along with the Developer tools. Supported Rubies are:
+
+  - [Ruby 1.9.4+](http://www.ruby-lang.org/)
 
 You will also need to make sure you "enable access for assistive devices".
 This can be done in System Preferences in the Universal Access section:
@@ -80,15 +99,20 @@ Then you can install AXElements either from RubyGems or from source. The
 RubyGems install is as usual, but you may need `sudo` power:
 
 ```bash
-    gem install AXElements --pre
+    gem install AXElements
 ```
 
-Or you can install from source:
+
+### Install From Source
+
+If the gem install processes are not working for you, you can build
+AXElements from source, but you will need to be familiar with tools
+like `bundler` and `rake`.
 
 ```bash
     cd ~/Documents # or where you want to put the AXElements code
-    git clone git://github.com/Marketcircle/AXElements
-    cd AXElements && rake install
+    git clone git://github.com/AXElements/AXElements
+    cd AXElements && bundle install && rake install
 ```
 
 Once all the setup is finished, you can start up AXElements in IRB:
@@ -97,20 +121,10 @@ Once all the setup is finished, you can start up AXElements in IRB:
     irb -rubygems -rax_elements
 ```
 
-__NOTE__: If you are not using RVM, but are using MacRuby, then you
-should use `macrake` instead of `rake`, and `macirb` instead of `irb`,
-etc.. You may also need to add `sudo` to your command when you install
-the gem. If you are not using RVM with MacRuby, but have RVM
-installed, remember to disable it like so:
-
-```bash
-    rvm use system
-```
-
 
 ## Getting Started
 
-The [wiki](http://github.com/Marketcircle/AXElements/wiki)
+The [wiki](http://github.com/AXElements/AXElements/wiki)
 is the best place to get started, it includes tutorials to help you get
 started. API documentation is also available on
 [rdoc.info](http://rdoc.info/gems/AXElements/frames).
@@ -123,13 +137,14 @@ as some of the technical the technical underpinnings of AXElements.
 
 ## Development
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Marketcircle/AXElements)
+[![Dependency Status](https://gemnasium.com/AXElements/AXElements.png)](https://gemnasium.com/AXElements/AXElements)
+[![Code Climate](https://codeclimate.com/github/AXElements/AXElements.png)](https://codeclimate.com/github/AXElements/AXElements)
 
 AXElements has reached a point where the main focus is stability,
 documentation, and additional conveniences. It will be out of this
 world, so we're code naming the next version "Lunatone".
 
-![The Moon](https://github.com/Marketcircle/AXElements/raw/gh-pages/images/next_version.png)
+![The Moon](https://raw.github.com/AXElements/axelements.github.com/master/images/next_version.png)
 
 Proper releases to rubygems will be made as milestones are reached.
 
@@ -137,7 +152,7 @@ Proper releases to rubygems will be made as milestones are reached.
 
 There are still a bunch of things that could be done to improve
 AXElements. Some of the higher level tasks are outlined in various
-[Github Issues](http://github.com/Marketcircle/AXElements/issues).
+[Github Issues](http://github.com/AXElements/AXElements/issues).
 Smaller items are peppered through the code base and marked with `@todo`
 tags.
 
@@ -155,9 +170,6 @@ you simply need to run the `test` task:
     rake test
 ```
 
-If there is a test that crashes MacRuby then you will need to run tests
-in verbose mode.
-
 __NOTE__: There may be some tests are dependent on Accessibility
 features that are new in OS X Lion which will cause test failures on
 OS X Snow Leopard. If you have any issues then you should look at the

data/Rakefile

@@ -3,12 +3,7 @@ require 'rubygems'
 task :default => :test
 
 desc 'Remove all generated files'
-task :clean   => :clobber
-desc 'Remove all generated files'
-task :clobber => :clobber_ext
-
-desc 'Compile C extensions'
-task :ext => 'ext:key_coder'
+task :clean => :clobber
 
 desc 'Run all tests'
 task :test => ['test:sanity', 'test:integration']

data/lib/accessibility/dsl.rb

@@ -165,6 +165,9 @@ module Accessibility::DSL
   end
 
   ##
+  # @todo Introduce a method to set focus to closest ancestor that
+  #       supports focus.
+  #
   # Focus an element on the screen, but only if it can be directly
   # focused. It is safe to pass any element into this method as nothing
   # will happen if it does not have a writable focused state attribute.
@@ -448,26 +451,25 @@ module Accessibility::DSL
   # all search results have been returned.
   #
   # @overload wait_for_invalidation_of element
-  # @param element [AX::Element]
-  # @param filters [Hash]
-  # @option filters [Number] :timeout (5) in seconds
-  # @return [Boolean]
+  #   @param element [AX::Element]
+  #   @param filters [Hash]
+  #   @option filters [Number] :timeout (5) in seconds
+  #   @return [Boolean]
   #
-  # @example
+  #   @example
   #
-  #   wait_for_invalidation_of table.row(static_text: { value: 'Cake' })
+  #     wait_for_invalidation_of table.row(static_text: { value: 'Cake' })
   #
   # @overload wait_for_invalidation_of kind, filters = {}, &block
-  # @param element [#to_s]
-  # @param filters [Hash]
-  # @option filters [Number] :timeout (5) in seconds
-  # @return [Boolean]
+  #   @param element [#to_s]
+  #   @param filters [Hash]
+  #   @option filters [Number] :timeout (5) in seconds
+  #   @return [Boolean]
   #
-  # @example
+  #   @example
   #
-  #   wait_for_invalidation_of :row, parent: table, static_text: { value: 'Cake' }
+  #     wait_for_invalidation_of :row, parent: table, static_text: { value: 'Cake' }
   #
-  # @return [Boolean]
   def wait_for_invalidation_of element, filters = {}, &block
     timeout = filters[:timeout] || 5
     start   = Time.now
@@ -769,13 +771,13 @@ module Accessibility::DSL
   #   # highlighter automatically turns off after 5 seconds
   #   highlight window.outline.row, colour: NSColor.greenColor, timeout: 5
   #
-  # @param obj [#bounds]
+  # @param obj [#to_rect]
   # @param opts [Hash]
   # @option opts [Number] :timeout
   # @option opts [NSColor] :colour (NSColor.magentaColor)
   # @return [Accessibility::Highlighter]
   def highlight obj, opts = {}
-    Accessibility::Highlighter.new obj.bounds, opts
+    Accessibility::Highlighter.new obj, opts
   end
 
   ##

data/lib/accessibility/pretty_printer.rb

@@ -58,12 +58,11 @@ module Accessibility::PrettyPrinter
   #
   # @return [String]
   def pp_position
-    position = attribute :position
-    if position
-      " (#{position.x}, #{position.y})"
-    else
-      EMPTY_STRING
+    if attributes.include? :position
+      position = attribute :position
+      return " (#{position.x}, #{position.y})" if position
     end
+    EMPTY_STRING
   end
 
   ##
@@ -72,14 +71,13 @@ module Accessibility::PrettyPrinter
   #
   # @return [String]
   def pp_children
-    child_count = size_of :children
-    if child_count > 1
-      " #{child_count} children"
-    elsif child_count == 1
-      ONE_CHILD
-    else # there are some odd edge cases
-      EMPTY_STRING
+    if attributes.include? :children
+      child_count = size_of :children
+      return " #{child_count} children" if child_count > 1
+      return ONE_CHILD                  if child_count == 1
+      # there are some odd edge cases where 0 children are reported
     end
+    EMPTY_STRING
   end
 
   ##
@@ -93,6 +91,36 @@ module Accessibility::PrettyPrinter
     " #{attr}[#{attribute(attr) ? CHECKMARK : CROSS }]"
   end
 
+  ##
+  # Safely create a {pp_checkbox} for the `KAXEnabledAttribute`
+  #
+  # If the receiver does not have the attribute then an empty
+  # string will be returned.
+  #
+  # @return [String]
+  def pp_enabled
+    if attributes.include? :enabled
+      pp_checkbox(:enabled)
+    else
+      EMPTY_STRING
+    end
+  end
+
+  ##
+  # Safely create a {pp_checkbox} for the `KAXFocusedAttribute`
+  #
+  # If the receiver does not have the attribute then an empty
+  # string will be returned.
+  #
+  # @return [String]
+  def pp_focused
+    if attributes.include? :focused
+      pp_checkbox(:focused)
+    else
+      EMPTY_STRING
+    end
+  end
+
 
   private
 

data/lib/accessibility/system_info.rb

@@ -138,6 +138,7 @@ module Accessibility::SystemInfo
   def num_processors
     NSProcessInfo.processInfo.processorCount
   end
+  alias_method :number_of_processors, :num_processors
 
   ##
   # Number of CPUs the system current has enabled
@@ -150,6 +151,7 @@ module Accessibility::SystemInfo
   def num_active_processors
     NSProcessInfo.processInfo.activeProcessorCount
   end
+  alias_method :number_of_active_processors, :num_active_processors
 
   ##
   # Total amount of memory for the system, in bytes

data/lib/accessibility/text_highlighter.rb

@@ -0,0 +1,73 @@
+require 'accessibility/version'
+require 'mouse'
+
+##
+# Mix-in module
+module Accessibility::TextHighlighter
+
+  ##
+  # @note The implementation of this code makes assumptions about the
+  #       minimum size of text and may not work with very small fonts.
+  #
+  # Highlights text in the field/area that matches the given `text`
+  #
+  # The given `text` can be a `String`, `Range`, or `Regexp` that
+  # matches some range of text in the receiver. An exception will
+  # be raised if the `text` is not valid for any reason.
+  #
+  # @example
+  #
+  #   text_field.highlight_text(0..5); type "\\DELETE"
+  #   text_area.highligtht_text("W"); type "W"
+  #   text_field.highlight_text(/is a lie?/i); type "is delicious and moist"
+  #
+  # @param text [String,Regexp,Range]
+  def highlight_text text
+    text = highlighter_range_for(text).to_a
+
+    head = parameterized_attribute(:bounds_for_range, text.first..text.first)
+    tail = parameterized_attribute(:bounds_for_range, text.last..text.last)
+
+    if Accessibility.debug?
+      highlight head, timeout: 5, colour: NSColor.yellowColor
+      highlight tail, timeout: 5, colour: NSColor.brownColor
+    end
+
+    head_point = head.origin
+    head_point.x += 1
+    head_point.y += 1
+    click
+
+    tail_point = tail.origin
+    tail_point.x += tail.size.width - 1
+    tail_point.y += tail.size.height - 1
+    drag_mouse_to tail_point
+  end
+
+
+  private
+
+  def highlighter_range_for text
+    value = @ref.value
+
+    case text
+    when Regexp
+      match = value.match text
+      if match
+        pair = match.offset(0)
+        pair[1] -= 1
+        pair
+      end
+    when String
+      start = value.index text
+      [start, start.to_i + text.length - 1]
+    when Range
+      text
+    else
+      raise ArgumentError,
+       "Cannot figure out what to highlight given #{text.inspect}"
+    end
+  end
+
+
+end

data/lib/accessibility/translator.rb

@@ -7,6 +7,7 @@ ActiveSupport::Inflector.inflections do |inflect|
   inflect.acronym('UI')
   inflect.acronym('RTF')
   inflect.acronym('URL')
+  inflect.acronym('AMPM')
 end
 
 framework 'ApplicationServices' if on_macruby?

data/lib/accessibility/version.rb

@@ -4,7 +4,7 @@
 # The main AXElements namespace.
 module Accessibility
   # @return [String]
-  VERSION   = '1.0.0.beta4'
+  VERSION   = '6.0.0'
 
   # @return [String]
   CODE_NAME = case RUBY_ENGINE

data/lib/accessibility.rb

@@ -1,121 +1,20 @@
 require 'accessibility/version'
-require 'ax/application'
 
-class << Accessibility
+module Accessibility
+
+  class << self
+    ##
+    # Whether or not to turn on DEBUG features in AXElements. The
+    # value is initially inherited from `$DEBUG` but can be overridden
+    # by an environment variable named `AXDEBUG` or changed dynamically
+    # at runtime.
+    #
+    # @return [Boolean]
+    attr_accessor :debug
+    alias_method :debug?, :debug
+  end
 
   # Initialize the DEBUG value
   @debug = ENV.fetch 'AXDEBUG', $DEBUG
 
-  ##
-  # Whether or not to turn on DEBUG features in AXElements. The
-  # value is initially inherited from `$DEBUG` but can be overridden
-  # by an environment variable named `AXDEBUG` or changed dynamically
-  # at runtime.
-  #
-  # @return [Boolean]
-  attr_accessor :debug
-  alias_method :debug?, :debug
-
-
-  # @group Finding an application object
-
-  ##
-  # @note Bundle identifiers are case-sensitive.
-  # @deprecated Use {AX::Aplication#initialize} instead.
-  #
-  # This is the standard way of creating an application object. It will
-  # launch the app if it is not already running and create the
-  # accessibility object.
-  #
-  # However, this method is a bit of a hack in cases where the app is not
-  # already running; I've tried to register for notifications, launch
-  # synchronously, etc., but there is always a problem with accessibility
-  # not being ready right away.
-  #
-  # If this method fails to find an app with the appropriate bundle
-  # identifier then it will raise an exception. If the problem was not a
-  # typo, then it might mean that the bundle identifier has not been
-  # registered with the system yet and you should launch the app once
-  # manually.
-  #
-  # @example
-  #
-  #   application_with_bundle_identifier 'com.apple.mail' # wait a few seconds
-  #   application_with_bundle_identifier 'com.marketcircle.Daylite4'
-  #
-  # @param bundle [String] a bundle identifier
-  # @return [AX::Application,nil]
-  def application_with_bundle_identifier bundle
-    $stderr.puts "#{__method__} is DEPRECATED: Use AX::Application.new instead"
-    if app_running?(bundle) || launch_application(bundle)
-      10.times do
-        if app_running?(bundle) && (app = try_wrapping(bundle))
-          return app
-        else
-          sleep 1
-        end
-      end
-    else
-      raise ArgumentError, "Could not launch app matching bundle id `#{bundle}'"
-    end
-    nil
-  end
-
-  ##
-  # @deprecated Directly initialize an {AX::Application} instance instead
-  #             (e.g. `AX::Application.new('Terminal')`).
-  #
-  # Get the accessibility object for an application given its localized
-  # name. This will only work if the application is already running.
-  #
-  # @example
-  #
-  #   application_with_name 'Mail'
-  #
-  # @param [String] name name of the application to launch
-  # @return [AX::Application,nil]
-  def application_with_name name
-    $stderr.puts "#{__method__} is DEPRECATED: Use AX::Application.new instead"
-    AX::Application.new name
-  end
-
-  # @endgroup
-
-
-  private
-
-  ##
-  # Find out if the app is running and if so, return the running application
-  # for that bundle.
-  #
-  # @param bundle [String]
-  # @return [NSRunningApplication,nil]
-  def app_running? bundle
-    NSRunningApplication.runningApplicationsWithBundleIdentifier(bundle).first
-  end
-
-  ##
-  # Try to wrap an application object, just in case it is not quite ready
-  # for accessibility yet.
-  #
-  # @param [String]
-  # @return [AX::Application]
-  def try_wrapping bundle
-    AX::Application.new bundle
-  rescue RuntimeError
-    nil
-  end
-
-  ##
-  # Asynchronously launch an application given the bundle identifier.
-  #
-  # @param [String] bundle the bundle identifier for the app
-  # @return [Boolean]
-  def launch_application bundle
-    NSWorkspace.sharedWorkspace.launchAppWithBundleIdentifier bundle,
-                                                     options: NSWorkspaceLaunchAsync,
-                              additionalEventParamDescriptor: nil,
-                                            launchIdentifier: nil
-  end
-
 end