AXElements 0.9.0 → 1.0.0.alpha

data/lib/accessibility/translator.rb

@@ -1,15 +1,17 @@
 require 'accessibility/version'
-require 'active_support/inflector'
-require 'ax_elements/mri'
-
-ActiveSupport::Inflector.inflections do |inflect|
-  # Related to accessibility
-  inflect.acronym('UI')
-  inflect.acronym('RTF')
-  inflect.acronym('URL')
-end
+require 'ax_elements/vendor/inflector'
+
+framework 'ApplicationServices'
 
-framework 'ApplicationServices' if on_macruby?
+unless Object.const_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
 
 
 ##
@@ -70,9 +72,7 @@ class Accessibility::Translator
   # @param keys [Array<String>]
   # @return [Array<Symbol>]
   def rubyize keys
-    keys = keys.map { |x| @rubyisms[x] }
-    keys.flatten!
-    keys
+    keys.map { |x| @rubyisms[x] }
   end
 
   ##
@@ -133,17 +133,6 @@ class Accessibility::Translator
 
   private
 
-  def preloads
-    {
-     # basic preloads
-     id:                   KAXIdentifierAttribute,
-     placeholder:          KAXPlaceholderValueAttribute,
-     # workarounds for known case where AX uses "Is" for a boolean attribute
-     application_running:  KAXIsApplicationRunningAttribute,
-     application_running?: KAXIsApplicationRunningAttribute,
-    }
-  end
-
   # @return [Hash{String=>String}]
   def init_unprefixes
     @unprefixes = Hash.new do |hash, key|
@@ -154,32 +143,34 @@ class Accessibility::Translator
   # @return [Hash{String=>Symbol}]
   def init_rubyisms
     @rubyisms = Hash.new do |hash, key|
-      hash[key] = [ActiveSupport::Inflector.underscore(@unprefixes[key]).to_sym]
+      hash[key] = Accessibility::Inflector.underscore(@unprefixes[key]).to_sym
     end
-    preloads.each_pair do |k,v| @rubyisms[v] << k end
   end
 
   # @return [Hash{Symbol=>String}]
   def init_cocoaifications
     @cocoaifications = Hash.new do |hash, key|
-      str_key = key.to_s
-      str_key.chomp! QUESTION_MARK
-      hash[key] = "AX#{ActiveSupport::Inflector.camelize(str_key)}"
+      hash[key] = "AX#{Accessibility::Inflector.camelize(key.chomp QUESTION_MARK)}"
     end
-    preloads.each_pair do |k, v| @cocoaifications[k] = v end
+    # preload the table
+    @cocoaifications[:id]          = KAXIdentifierAttribute
+    @cocoaifications[:placeholder] = KAXPlaceholderValueAttribute
+    # workaround the one known case where AX uses "Is" for a boolean attribute
+    @cocoaifications[:application_running]  = # let the value all fall through
+    @cocoaifications[:application_running?] = KAXIsApplicationRunningAttribute
   end
 
   # @return [Hash{String=>String}]
   def init_classifications
     @classifications = Hash.new do |hash, key|
-      hash[key] = ActiveSupport::Inflector.classify(key)
+      hash[key] = Accessibility::Inflector.classify(key)
     end
   end
 
   # @return [Hash{String=>String}]
   def init_singularizations
     @singularizations = Hash.new do |hash, key|
-      hash[key] = ActiveSupport::Inflector.singularize(key)
+      hash[key] = Accessibility::Inflector.singularize(key)
     end
   end
 

data/lib/accessibility/version.rb

@@ -4,28 +4,8 @@
 # The main AXElements namespace.
 module Accessibility
   # @return [String]
-  VERSION   = '0.9.0'
+  VERSION   = '1.0.0.alpha'
 
   # @return [String]
-  CODE_NAME = 'エネコロロ'
-
-  # @return [String]
-  ENGINE = case RUBY_ENGINE
-           when 'macruby' then 'サンダース'
-           when 'ruby'    then 'ブースター'
-           when 'rbx'     then 'ブラッキー' # for when rbx has good cext support
-           else 'シャワーズ' # vapor(ware)eon
-           end
-
-  ##
-  # The complete version string for AXElements
-  #
-  # This differs from {Accessibility::VERSION} in that it also
-  # includes `RUBY_ENGINE` information.
-  #
-  # @return [String]
-  def self.version
-    "#{VERSION}-#{ENGINE}"
-  end
-
+  CODE_NAME = 'ルナトーン'
 end

data/lib/ax/application.rb

@@ -11,102 +11,12 @@ require 'accessibility/string'
 class AX::Application < AX::Element
   include Accessibility::String
 
-  class << self
-    ##
-    # Asynchronously launch an application with given the bundle identifier
-    #
-    # @param bundle [String] bundle identifier for the app
-    # @return [Boolean]
-    def launch bundle
-      NSWorkspace.sharedWorkspace.launchAppWithBundleIdentifier bundle,
-                                                       options: NSWorkspace::NSWorkspaceLaunchAsync,
-                                additionalEventParamDescriptor: nil,
-                                              launchIdentifier: nil
-    end
-
-    ##
-    # Find and return the dock application
-    #
-    # @return [AX::Application]
-    def dock
-      new 'com.apple.dock'
-    end
-
-    ##
-    # Find and return the dock application
-    #
-    # @return [AX::Application]
-    def finder
-      new 'com.apple.finder'
-    end
-
-    ##
-    # Find and return the notification center UI app
-    #
-    # Obviously, this will only work on OS X 10.8+
-    #
-    # @return [AX::Application]
-    def notification_center
-      new 'com.apple.notificationcenterui'
-    end
-
-    ##
-    # Find and return the application which is frontmost
-    #
-    # This is often, but not necessarily, the same as the app that
-    # owns the menu bar.
-    #
-    # @return [AX::Application]
-    def frontmost_application
-      new NSWorkspace.sharedWorkspace.frontmostApplication
-    end
-    alias_method :frontmost_app, :frontmost_application
-
-    ##
-    # Find and return the application which owns the menu bar
-    #
-    # This is often, but not necessarily, the same as the app that
-    # is frontmost.
-    #
-    # @return [AX::Application]
-    def menu_bar_owner
-      new NSWorkspace.sharedWorkspace.menuBarOwningApplication
-    end
-  end
-
   ##
-  # 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.
   #
-  # Given a PID, we try to lookup the application and wrap it.
-  #
-  # Given an `NSRunningApplication` instance, we simply wrap it.
-  #
-  # Given a string we do some complicated magic to try and figure out if
-  # the string is a bundle identifier or the localized name of the
-  # application. Given a bundle identifier we try to launch the app if
-  # it is not already running, given a localized name we search the running
-  # applications for the app. We wrap what we get back if we get anything
-  # back.
-  #
-  # Note however, given a bundle identifier to launch the application our
-  # implementation is a bit of a hack; I've tried to register for
-  # notifications, launch synchronously, etc., but there is always a problem
-  # with accessibility not being ready right away, so we will poll the app
-  # to see when it is ready with a timeout of ~10 seconds.
-  #
-  # If this method fails to find an app then an exception will be raised.
-  #
-  # @example
-  #
-  #   AX::Application.new 'com.apple.mail'
-  #   AX::Application.new 'Mail'
-  #   AX::Application.new 43567
-  #
   # @param arg [Number,String,NSRunningApplication]
   def initialize arg
     case arg
@@ -114,29 +24,14 @@ class AX::Application < AX::Element
       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"
-           end
+      @app =
+        NSRunningApplication.runningApplicationsWithBundleIdentifier(arg).first ||
+        (
+          spin_run_loop
+          NSWorkspace.sharedWorkspace.runningApplications.find { |app|
+            app.localizedName == arg
+          }
         )
-      end
       super Accessibility::Element.application_for @app.processIdentifier
     when NSRunningApplication
       super Accessibility::Element.application_for arg.processIdentifier
@@ -172,7 +67,7 @@ class AX::Application < AX::Element
   # to the dynamic `#focused?` method, but might make more sense to use
   # in some cases.
   def active?
-    spin
+    spin_run_loop
     @app.active?
   end
   alias_method :focused,  :active?
@@ -181,14 +76,14 @@ class AX::Application < AX::Element
   ##
   # Ask the app whether or not it is hidden.
   def hidden?
-    spin
+    spin_run_loop
     @app.hidden?
   end
 
   ##
   # Ask the app whether or not it is still running.
   def terminated?
-    spin
+    spin_run_loop
     @app.terminated?
   end
 
@@ -247,62 +142,23 @@ class AX::Application < AX::Element
 
   # @group Actions
 
-  ##
-  # @note This is often async and may return before the action is completed
-  #
-  # Ask the app to quit
-  #
-  # @return [Boolean]
-  def terminate
-    perform :terminate
-  end
-
-  ##
-  # @note This is often async and may return before the action is completed
-  #
-  # Force the app to quit
-  #
-  # @return [Boolean]
-  def terminate!
-    perform :force_terminate
-  end
-
-  ##
-  # @note This is often async and may return before the action is completed
-  #
-  # Ask the app to hide itself
-  #
-  # @return [Boolean]
-  def hide
-    perform :hide
-  end
-
-  ##
-  # @note This is often async and may return before the action is completed
-  #
-  # As the app to unhide itself and bring to front
-  #
-  # @return [Boolean]
-  def unhide
-    perform :unhide
-  end
 
   # (see AX::Element#perform)
   def perform name
     case name
     when :terminate
       return true if terminated?
-      @app.terminate; spin 0.25; terminated?
+      @app.terminate; sleep 0.2; terminated?
     when :force_terminate
       return true if terminated?
-      @app.forceTerminate; spin 0.25; terminated?
+      @app.forceTerminate; sleep 0.2; terminated?
     when :hide
       return true if hidden?
-      @app.hide; spin 0.25; hidden?
+      @app.hide; sleep 0.2; hidden?
     when :unhide
       return true if active?
-      @app.activateWithOptions(NSRunningApplication::NSApplicationActivateIgnoringOtherApps)
-      spin 0.25; active?
+      @app.activateWithOptions(NSApplicationActivateIgnoringOtherApps)
+      sleep 0.2; active?
     else
       super
     end
@@ -432,6 +288,11 @@ class AX::Application < AX::Element
 
   private
 
+  # @return [nil]
+  def spin_run_loop
+    NSRunLoop.currentRunLoop.runUntilDate Time.now
+  end
+
   # @return [NSBundle]
   def bundle
     @bundle ||= NSBundle.bundleWithURL @app.bundleURL

data/lib/ax/element.rb

@@ -1,13 +1,12 @@
 # -*- coding: utf-8 -*-
 
-require 'active_support/core_ext/object/blank'
 require 'accessibility/core'
 require 'accessibility/factory'
 require 'accessibility/translator'
 require 'accessibility/enumerators'
 require 'accessibility/qualifier'
 require 'accessibility/errors'
-require 'accessibility/pretty_printer'
+require 'accessibility/pp_inspector'
 
 
 ##
@@ -20,7 +19,7 @@ require 'accessibility/pretty_printer'
 # This abstract base class provides generic functionality that all
 # accessibility objects require.
 class AX::Element
-  include Accessibility::PrettyPrinter
+  include Accessibility::PPInspector
 
   # @param ref [AXUIElementRef]
   def initialize ref
@@ -55,7 +54,7 @@ class AX::Element
   #
   # @param attr [#to_sym]
   def attribute attr
-    @ref.attribute(TRANSLATOR.cocoaify(attr)).to_ruby
+    @ref.attribute TRANSLATOR.cocoaify(attr)
   end
 
   ##
@@ -66,7 +65,7 @@ class AX::Element
   #
   # @return [String]
   def description
-    attribute(:description).to_ruby
+    attribute :description
   end
 
   ##
@@ -74,12 +73,12 @@ class AX::Element
   #
   # @return [Array<AX::Element>]
   def children
-    @ref.children.to_ruby
+    attribute :children
   end
 
   ##
   # Get a list of elements, starting with the receiver and riding
-  # the hierarchy up to the top level object (i.e. the {AX::Application})
+  # the hierarchy up to the top level object (i.e. the {AX::Application}).
   #
   # @example
   #
@@ -88,16 +87,15 @@ class AX::Element
   #     # => [#<AX::ApplicationDockItem...>, #<AX::List...>, #<AX::Application...>]
   #
   # @return [Array<AX::Element>]
-  def ancestry elements = self
-    elements = Array(elements)
+  def ancestry *elements
+    elements = [self] if elements.empty?
     element  = elements.last
     if element.attributes.include? :parent
-      ancestry(elements << element.attribute(:parent))
+      ancestry(elements << element.parent)
     else
       elements
     end
   end
-  alias_method :lineage, :ancestry
 
   ##
   # Get the process identifier for the application that the element
@@ -187,8 +185,8 @@ class AX::Element
   # @param attr [#to_sym]
   # @param param [Object]
   def parameterized_attribute attr, param
-    param = param.relative_to(@ref.value.size) if param.kind_of? Range
-    @ref.parameterized_attribute(TRANSLATOR.cocoaify(attr), param).to_ruby
+    param = param.relative_to(@ref.value.size) if value.kind_of? Range
+    @ref.parameterized_attribute TRANSLATOR.cocoaify(attr), param
   end
 
 
@@ -264,8 +262,6 @@ class AX::Element
   # As the opposite of {#search}, this also takes filters, and can
   # be used to find a specific ancestor for the current element.
   #
-  # Returns `nil` if no ancestor is found.
-  #
   # @example
   #
   #   button.ancestor :window       # => #<AX::StandardWindow>
@@ -274,13 +270,12 @@ class AX::Element
   # @param kind [#to_s]
   # @param filters [Hash{Symbol=>Object}]
   # @yield Optional block used for search filtering
-  # @return [AX::Element,nil]
+  # @return [AX::Element]
   def ancestor kind, filters = {}, &block
     qualifier = Accessibility::Qualifier.new(kind, filters, &block)
-    element   = self
+    element   = attribute :parent
     until qualifier.qualifies? element
       element = element.attribute :parent
-      return nil unless element
     end
     element
   end
@@ -342,7 +337,7 @@ class AX::Element
       return attribute(method)
 
     elsif @ref.parameterized_attributes.include? key
-      return parameterized_attribute(method, args.first)
+      return paramaterized_attribute(method, args.first)
 
     elsif @ref.attributes.include? KAXChildrenAttribute
       if (result = search(method, *args, &block)).blank?
@@ -365,7 +360,7 @@ class AX::Element
   #
   # @return [String]
   def inspect
-    msg  = "#<#{self.class}" << pp_identifier.to_s
+    msg  = "#<#{self.class}" << pp_identifier
     msg << pp_position if attributes.include? :position
     msg << pp_children if attributes.include? :children
     msg << pp_checkbox(:enabled) if attributes.include? :enabled
@@ -435,7 +430,7 @@ class AX::Element
   def bounds
     CGRect.new(attribute(:position), attribute(:size))
   end
-  alias_method :to_rect, :bounds
+  alias_method :rect, :bounds
 
   ##
   # Get the application object for the element.
@@ -461,17 +456,11 @@ class AX::Element
     @ref.invalid?
   end
 
-  if on_macruby?
-    ##
-    # Like {#respond_to?}, this is overriden to include attribute methods.
-    # Though, it does include dynamic predicate methods at the moment.
-    def methods include_super = true, include_objc_super = false
-      super.concat(attributes).concat(parameterized_attributes)
-    end
-  else
-    def methods include_super = true
-      super.concat(attributes).concat(parameterized_attributes)
-    end
+  ##
+  # Like {#respond_to?}, this is overriden to include attribute methods.
+  # Though, it does include dynamic predicate methods at the moment.
+  def methods include_super = true, include_objc_super = false
+    super.concat(attributes).concat(parameterized_attributes)
   end
 
   ##
@@ -496,3 +485,24 @@ class AX::Element
   TRANSLATOR = Accessibility::Translator.instance
 
 end
+
+
+# Extensions so checking `#blank?` on search result "just works".
+class NSArray
+  # (see NilClass#blank?)
+  alias_method :blank?, :empty?
+end
+
+# Extensions so checking `#blank?` on search result "just works".
+class NilClass
+  ##
+  # Whether or not the object is "blank". The concept of blankness
+  # borrowed from `Active Support` and is true if the object is falsey
+  # or `#empty?`.
+  #
+  # This method is used by implicit searching in AXElements to
+  # determine if searches yielded responses.
+  def blank?
+    true
+  end
+end