AXElements 0.8.1 → 0.9.0

data/lib/accessibility/system_info.rb

@@ -0,0 +1,230 @@
+require 'accessibility/version'
+require 'accessibility/extras'
+
+##
+# Interface for collecting some simple information about the system.
+# This information may be useful as diagnostic output when running
+# tests, or if you simply need to find the hostname of the machine so
+# it can be passed to another process to initiate a connection.
+#
+# This module extends itself, so all methods are available on the module
+# and you will want to use the module as a utility module.
+module Accessibility::SystemInfo
+  extend self
+
+  ##
+  # The name the machine uses for Bonjour
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.name
+  #     # => "ferrous"
+  #
+  # @return [String]
+  def name
+    NSHost.currentHost.localizedName
+  end
+
+  ##
+  # All hostnames that the system responds to
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.hostnames
+  #     # => ["ferrous.local", "localhost"]
+  #
+  # @return [Array<String>]
+  def hostnames
+    NSHost.currentHost.names
+  end
+
+  ##
+  # The first, and likely common, name the system responds to
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.hostname # => "ferrous.local"
+  #
+  # @return [Array<String>]
+  def hostname
+    hostnames.first
+  end
+
+  ##
+  # All IP addresses the system has interfaces for
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.addresses
+  #     # => ["fe80::6aa8:6dff:fe20:822%en1", "192.168.0.17", "fe80::1%lo0", "127.0.0.1", "::1"]
+  #
+  # @return [Array<String>]
+  def addresses
+    NSHost.currentHost.addresses
+  end
+
+  ##
+  # All IPv4 addresses the system has interfaces for
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.ipv4_addresses
+  #     # => ["192.168.0.17", "127.0.0.1"]
+  #
+  # @return [Array<String>]
+  def ipv4_addresses
+    addresses.select { |address| address.match /\./ }
+  end
+
+  ##
+  # All IPv6 addresses the system has interfaces for
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.ipv6_addresses
+  #     # => ["fe80::6aa8:6dff:fe20:822%en1", "fe80::1%lo0", "::1"]
+  #
+  # @return [Array<String>]
+  def ipv6_addresses
+    addresses.select { |address| address.match /:/ }
+  end
+
+  ##
+  # System model string
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.model # => "MacBookPro8,2"
+  #
+  # @return [String]
+  def model
+    @model ||= `sysctl hw.model`.split.last.chomp
+  end
+
+  ##
+  # OS X version string
+  #
+  # @example
+  #
+  #  Accessibility::SystemInfo.osx_version # => "Version 10.8.2 (Build 12C60)"
+  #
+  # @return [String]
+  def osx_version
+    NSProcessInfo.processInfo.operatingSystemVersionString
+  end
+
+  ##
+  # System uptime, in seconds
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.uptime # => 22999.76858776
+  #
+  # @return [Float]
+  def uptime
+    NSProcessInfo.processInfo.systemUptime
+  end
+
+  ##
+  # Total number of CPUs the system could use
+  #
+  # May not be the same as {#num_active_processors}.
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.num_processors # => 8
+  #
+  # @return [Fixnum]
+  def num_processors
+    NSProcessInfo.processInfo.processorCount
+  end
+
+  ##
+  # Number of CPUs the system current has enabled
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.num_active_processors # => 8
+  #
+  # @return [Fixnum]
+  def num_active_processors
+    NSProcessInfo.processInfo.activeProcessorCount
+  end
+
+  ##
+  # Total amount of memory for the system, in bytes
+  #
+  # @example
+  #
+  #   Accessibility::SystemInfo.total_ram # => 17179869184
+  #
+  # @return [Fixnum]
+  def total_ram
+    NSProcessInfo.processInfo.physicalMemory
+  end
+  alias_method :ram, :total_ram
+
+  ##
+  # Return the current state of the battery
+  #
+  # @example
+  #
+  #   battery_state # => :charged
+  #   # unplug AC cord
+  #   battery_state # => :discharging
+  #   # plug AC cord back in after several minutes
+  #   battery_state # => :charging
+  #
+  #   # try this method when you have no battery
+  #   battery_state # => :not_installed
+  #
+  # @return [Symbol]
+  def battery_state
+    Battery.state
+  end
+
+  ##
+  # Returns the charge percentage of the battery (if present)
+  #
+  # A special value of `-1.0` is returned if you have no battery.
+  #
+  # @example
+  #
+  #   battery_charge_level # => 1.0
+  #   # unplug AC cord and wait a couple of minutes
+  #   battery_charge_level # => 0.99
+  #
+  #   # if you have no battery
+  #   battery_charge_level # => -1.0
+  #
+  # @return [Float]
+  def battery_charge_level
+    Battery.level
+  end
+  alias_method :battery_level, :battery_charge_level
+
+  ##
+  # Return an estimate on the number of minutes until the battery is drained
+  #
+  # A special value of `0` indicates that the battery is not discharging.
+  # You should really only call this after you know that the battery is
+  # discharging by calling {#battery_state} and having `:discharging` returned.
+  #
+  # A special value of `-1` is returned when the estimate is in flux and
+  # cannot be accurately estimated.
+  #
+  # @example
+  #
+  #   # AC cord plugged in
+  #   battery_life_estimate # => 0
+  #   # unplug AC cord
+  #   battery_life_estimate # => -1
+  #   # wait a few minutes
+  #   battery_life_estimate # => 423
+  #
+  # @return [Fixnum]
+  def battery_life_estimate
+    Battery.time_to_empty
+  end
+
+end

data/lib/accessibility/translator.rb

@@ -1,18 +1,16 @@
 require 'accessibility/version'
-require 'ax_elements/vendor/inflector'
-
-framework 'ApplicationServices'
-
-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'
+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
 
+framework 'ApplicationServices' if on_macruby?
+
 
 ##
 # Maintain all the rules for transforming Cocoa constants into something
@@ -55,7 +53,7 @@ class Accessibility::Translator
   #   unprefix KAXWindowCreatedNotification # => 'WindowCreated'
   #   unprefix NSAccessibilityButtonRole    # => 'Button'
   #
-  # @param [String]
+  # @param key [String]
   # @return [String]
   def unprefix key
     @unprefixes[key]
@@ -69,15 +67,18 @@ class Accessibility::Translator
   #
   #   rubyize ["AXRole", "AXTitleUIElement"] # => [:role, :title_ui_element]
   #
+  # @param keys [Array<String>]
   # @return [Array<Symbol>]
   def rubyize keys
-    keys.map { |x| @rubyisms[x] }
+    keys = keys.map { |x| @rubyisms[x] }
+    keys.flatten!
+    keys
   end
 
   ##
   # Given a symbol, return the equivalent accessibility constant.
   #
-  # @param [#to_sym]
+  # @param key [#to_sym]
   # @return [String]
   def cocoaify key
     @cocoaifications[key.to_sym]
@@ -93,7 +94,7 @@ class Accessibility::Translator
   #   classify 'text_field' # => "TextField"
   #   classify 'buttons'    # => "Button"
   #
-  # @param [String]
+  # @param klass [String]
   # @return [String]
   def classify klass
     @classifications[klass]
@@ -109,7 +110,7 @@ class Accessibility::Translator
   #   singularize 'buttons'     # => 'button'
   #   singularize 'check_boxes' # => 'check_box'
   #
-  # @param [String]
+  # @param klass [String]
   # @return [String]
   def singularize klass
     @singularizations[klass]
@@ -121,7 +122,7 @@ class Accessibility::Translator
   # a notification constant then the original string parameter will
   # be returned.
   #
-  # @param [#to_s]
+  # @param name [#to_s]
   # @return [String]
   def guess_notification name
     name  = name.to_s.gsub /(?:^|_)(.)/ do $1.upcase! || $1 end
@@ -132,6 +133,17 @@ 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|
@@ -142,34 +154,32 @@ class Accessibility::Translator
   # @return [Hash{String=>Symbol}]
   def init_rubyisms
     @rubyisms = Hash.new do |hash, key|
-      hash[key] = Accessibility::Inflector.underscore(@unprefixes[key]).to_sym
+      hash[key] = [ActiveSupport::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|
-      hash[key] = "AX#{Accessibility::Inflector.camelize(key.chomp QUESTION_MARK)}"
+      str_key = key.to_s
+      str_key.chomp! QUESTION_MARK
+      hash[key] = "AX#{ActiveSupport::Inflector.camelize(str_key)}"
     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
+    preloads.each_pair do |k, v| @cocoaifications[k] = v end
   end
 
   # @return [Hash{String=>String}]
   def init_classifications
     @classifications = Hash.new do |hash, key|
-      hash[key] = Accessibility::Inflector.classify(key)
+      hash[key] = ActiveSupport::Inflector.classify(key)
     end
   end
 
   # @return [Hash{String=>String}]
   def init_singularizations
     @singularizations = Hash.new do |hash, key|
-      hash[key] = Accessibility::Inflector.singularize(key)
+      hash[key] = ActiveSupport::Inflector.singularize(key)
     end
   end
 

data/lib/accessibility/version.rb

@@ -1,9 +1,31 @@
+# -*- coding: utf-8 -*-
+
 ##
 # The main AXElements namespace.
 module Accessibility
   # @return [String]
-  VERSION   = '0.8.1'
+  VERSION   = '0.9.0'
+
+  # @return [String]
+  CODE_NAME = 'エネコロロ'
 
   # @return [String]
-  CODE_NAME = 'Clefable'
+  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
+
 end

data/lib/accessibility.rb

@@ -20,10 +20,11 @@ class << Accessibility
   # @group Finding an application object
 
   ##
-  # @todo Move to {AX::Aplication#initialize} eventually.
+  # @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 then create the
+  # 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
@@ -40,15 +41,19 @@ class << Accessibility
   # @example
   #
   #   application_with_bundle_identifier 'com.apple.mail' # wait a few seconds
-  #   application_with_bundle_identifier 'com.marketcircle.Daylite'
+  #   application_with_bundle_identifier 'com.marketcircle.Daylite4'
   #
-  # @param [String] bundle a bundle identifier
+  # @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
-        return AX::Application.new(bundle) if app_running? bundle
-        sleep 1
+        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}'"
@@ -70,7 +75,7 @@ class << Accessibility
   # @param [String] name name of the application to launch
   # @return [AX::Application,nil]
   def application_with_name name
-    $stderr.puts 'DEPRECATED: Use AX::Application.new instead'
+    $stderr.puts "#{__method__} is DEPRECATED: Use AX::Application.new instead"
     AX::Application.new name
   end
 
@@ -83,12 +88,24 @@ class << Accessibility
   # Find out if the app is running and if so, return the running application
   # for that bundle.
   #
-  # @param [String]
+  # @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.
   #