AXElements 1.0.0.alpha11 → 1.0.0.beta

data/History.markdown

@@ -1,6 +1,10 @@
 # 1.0.0 
 
+  * AXElements can now run on MRI as well as MacRuby
+
+  * Added `NSScreen.wakeup` to the `NSScreen` class to wake up sleeping displays
   * Added `Accessibility::SystemInfo` for getting information about the running system
+    - Added a `Battery` module for querying information about the battery status
   * Added `DSL#record` to run a screen recording of the given block (actual video!)
   * Added `Application.frontmost_application`
   * Added `Application.menu_bar_owner`
@@ -11,8 +15,14 @@
   * Added `SystemWide.desktop`
   * Added History.markdown to track notable changes
 
-  * Ported `mouse.rb` to C and moved code to [MRMouse](https://github.com/ferrous26/MRMouse)
+  * Moved MiniTest extensions to their own repository/gem [minitest-ax\_elements](https://github.com/AXElements/minitest-ax_elements)
+  * Moved RSpec extensions to their own repository/gem [rspec-ax\_elements](https://github.com/AXElements/rspec-ax_elements)
+
+  * Ported `mouse.rb` to C and moved code to [mouse](https://github.com/AXElements/mouse)
+  * Ported `core.rb` to C and moved code to [accessibility\_core](https://github.com/AXElements/accessibility_core)
+  * Ported `screen_recorder.rb` to C and moved code to [screen\_recorder](https://github.com/AXElements/screen_recorder)
 
+  * Deprecate `AX::DOCK` constant, use `AX::Application.dock` instead
   * Remove `Accessibility.application_with_bundle_identifier`; use `AX::Application.new` instead
   * Remove `Accessibility.application_with_name; use `AX::Application.new` instead
   * Remove `DSL#subtree_for`; use `Element#inspect_subtree` instead

data/README.markdown

@@ -1,4 +1,4 @@
-# AXElements 
+# AXElements
 
 AXElements is a DSL abstraction built on top of the Mac OS X
 Accessibility and CGEvent APIs that allows code to be written in a
@@ -64,8 +64,10 @@ The code from the demo video is right here:
 
 ## Getting Setup
 
-You will need a MacRuby nightly build for installation. You can get help setting
-up by referencing the
+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.
 
@@ -95,11 +97,11 @@ Once all the setup is finished, you can start up AXElements in IRB:
     irb -rubygems -rax_elements
 ```
 
-__NOTE__: If you are not using RVM, 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:
+__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

data/Rakefile

@@ -11,4 +11,4 @@ desc 'Compile C extensions'
 task :ext => 'ext:key_coder'
 
 desc 'Run all tests'
-task :test => ['test:core', 'test:sanity', 'test:integration', 'test:cruby']
+task :test => ['test:sanity', 'test:integration', 'test:cruby']

data/lib/accessibility/dsl.rb

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+require 'active_support/core_ext/object/blank'
+
 require 'mouse'
 require 'ax/element'
 require 'ax/application'
@@ -8,6 +10,8 @@ require 'ax/scroll_area'
 require 'ax/menu'
 require 'accessibility'
 require 'accessibility/enumerators'
+require 'accessibility/highlighter'
+
 
 ##
 # DSL methods for AXElements.
@@ -129,7 +133,7 @@ module Accessibility::DSL
   #   The normal way to raise an exception.
   def raise *args
     arg = args.first
-    arg.kind_of?(AX::Element) ? arg.perform(:raise) : super(*args)
+    arg.kind_of?(AX::Element) ? arg.perform(:raise) : Kernel.raise(*args)
   end
 
   ##
@@ -625,7 +629,6 @@ module Accessibility::DSL
   # @option opts [NSColor] :colour (NSColor.magentaColor)
   # @return [Accessibility::Highlighter]
   def highlight obj, opts = {}
-    require 'accessibility/highlighter'
     Accessibility::Highlighter.new obj.bounds, opts
   end
 

data/lib/accessibility/factory.rb

@@ -1,92 +1,27 @@
 require 'accessibility/core'
 require 'accessibility/translator'
-require 'accessibility/statistics'
 
 ##
 # Namespace container for all the accessibility objects.
 module AX; class Element; end end
 
 
-##
-# Extensions to {Accessibility::Element} for the high level abstraction.
-# These extensions only make sense in the context of the high level API
-# and it requires knowledge of both layers, so the code has been placed
-# in its own file.
-module Accessibility::Element
-
-  ##
-  # @todo Should we handle cases where a subrole has a value of
-  #       'Unknown'? What is the performance impact?
-  #
-  # Wrap the low level wrapper with the appropriate high level wrapper.
-  # This involves determining the proper class in the {AX} namespace,
-  # possibly creating it on demand, and then instantiating the class to
-  # wrap the low level object.
-  #
-  # Some code paths have been unrolled for efficiency. Don't hate player,
-  # hate the game.
-  #
-  # @return [AX::Element]
-  def to_ruby
-    type = AXValueGetType(self)
-    if type.zero?
-      to_element
-    else
-      to_box type
-    end
-  end
-
-  private
-
-  def to_element
-    STATS.increment :Factory
-    if roll = self.role
-      roll = TRANSLATOR.unprefix roll
-      if attributes.include? KAXSubroleAttribute
-        subroll = self.subrole
-        # Some objects claim to have a subrole but return nil
-        if subroll
-          class_for2(TRANSLATOR.unprefix(subroll), roll).new self
-        else
-          class_for(roll).new self
-        end
-      else
-        class_for(roll).new self
-      end
-    else # failsafe in case object dies before we get the role
-      AX::Element.new self
-    end
-  end
-
-  def to_box type
-    STATS.increment :Unwrap
-    ptr = Pointer.new BOX_TYPES[type]
-    AXValueGetValue(self, type, ptr)
-    ptr.value.to_ruby
-  end
-
-
-  private
+class << AX
 
   ##
   # @private
   #
-  # Reference to the singleton instance of the translator.
+  # Mutex to make sure we only create one class at a time.
   #
-  # @return [Accessibility::Translator]
-  TRANSLATOR = Accessibility::Translator.instance
+  # @return [Mutex]
+  MUTEX = Mutex.new
 
   ##
   # @private
   #
-  # Serial queue to make sure we only create one class at a time.
+  # Find the class for a given role
   #
-  # @return [Dispatch::Queue]
-  CREATE_QUEUE = Dispatch::Queue.new 'com.marketcircle.axelements.create'
-
-  ##
-  # Find the class for a given role. If the class does not exist it will
-  # be created.
+  # If the class does not exist it will be created.
   #
   # @param role [#to_s]
   # @return [Class]
@@ -99,8 +34,11 @@ module Accessibility::Element
   end
 
   ##
-  # Find the class for a given subrole and role. If the class does not
-  # exist it will be created on demand.
+  # @private
+  #
+  # Find the class for a given subrole and role
+  #
+  # If the class does not exist it will be created on demand.
   #
   # @param subrole [#to_s]
   # @param role [#to_s]
@@ -114,13 +52,15 @@ module Accessibility::Element
   end
 
   ##
-  # Create a new class in the {AX} namespace that has {AX::Element}
-  # as the superclass.
+  # @private
+  #
+  # Create a class in the {AX} namespace that has {AX::Element} as the
+  # superclass
   #
   # @param name [#to_s]
   # @return [Class]
   def create_class name
-    CREATE_QUEUE.sync do
+    MUTEX.synchronize do
       # re-check now that we are in the critical section
       @klass = if AX.const_defined? name, false
                  AX.const_get name
@@ -133,8 +73,10 @@ module Accessibility::Element
   end
 
   ##
+  # @private
+  #
   # Create a new class in the {AX} namesapce that has the given
-  # `superklass` as the superclass..
+  # `superklass` as the superclass
   #
   # @param name [#to_s]
   # @param superklass [#to_s]
@@ -143,7 +85,7 @@ module Accessibility::Element
     unless AX.const_defined? superklass, false
       create_class superklass
     end
-    CREATE_QUEUE.sync do
+    MUTEX.synchronize do
       # re-check now that we are in the critical section
       @klass = if AX.const_defined? name, false
                  AX.const_get name
@@ -156,3 +98,117 @@ module Accessibility::Element
   end
 
 end
+
+
+if on_macruby?
+
+  ##
+  # Extensions to {Accessibility::Element} for the higher level abstractions
+  #
+  # These extensions only make sense in the context of the high level API
+  # but needs to be applied on the lower level class, so the code has been
+  # placed in its own file.
+  module Accessibility::Element
+
+    ##
+    # @todo Should we handle cases where a subrole has a value of
+    #       'Unknown'? What is the performance impact?
+    #
+    # Wrap the low level wrapper with the appropriate high level wrapper.
+    # This involves determining the proper class in the {AX} namespace,
+    # possibly creating it on demand, and then instantiating the class to
+    # wrap the low level object.
+    #
+    # Some code paths have been unrolled for efficiency. Don't hate player,
+    # hate the game.
+    #
+    # @return [AX::Element]
+    def to_ruby
+      type = AXValueGetType(self)
+      if type.zero?
+        to_element
+      else
+        to_box type
+      end
+    end
+
+
+    private
+
+    ##
+    # @private
+    #
+    # Reference to the singleton instance of the translator.
+    #
+    # @return [Accessibility::Translator]
+    TRANSLATOR = Accessibility::Translator.instance
+
+    def to_box type
+      ptr = Pointer.new ValueWrapper::BOX_TYPES[type]
+      AXValueGetValue(self, type, ptr)
+      ptr.value.to_ruby
+    end
+
+    def to_element
+      if roll = self.role
+        roll = TRANSLATOR.unprefix roll
+        if attributes.include? KAXSubroleAttribute
+          subroll = self.subrole
+          # Some objects claim to have a subrole but return nil
+          if subroll
+            AX.class_for2(TRANSLATOR.unprefix(subroll), roll).new self
+          else
+            AX.class_for(roll).new self
+          end
+        else
+          AX.class_for(roll).new self
+        end
+      else # failsafe in case object dies before we get the role
+        AX::Element.new self
+      end
+    end
+
+  end
+
+
+else
+
+
+  ##
+  # `AXElements` extensions to the `Accessibility::Element` class
+  class Accessibility::Element
+
+    ##
+    # Override the default `#to_ruby` so that proper classes are
+    # chosen for each object.
+    #
+    # @return [AX::Element]
+    def to_ruby
+      if roll = self.role
+        roll = TRANSLATOR.unprefix roll
+        if attributes.include? KAXSubroleAttribute
+          subroll = self.subrole
+          # Some objects claim to have a subrole but return nil
+          if subroll
+            AX.class_for2(TRANSLATOR.unprefix(subroll), roll).new self
+          else
+            AX.class_for(roll).new self
+          end
+        else
+          AX.class_for(roll).new self
+        end
+      else # failsafe in case object dies before we get the role
+        AX::Element.new self
+      end
+    end
+
+    ##
+    # @private
+    #
+    # Reference to the singleton instance of the translator.
+    #
+    # @return [Accessibility::Translator]
+    TRANSLATOR = Accessibility::Translator.instance
+  end
+
+end

data/lib/accessibility/qualifier.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+
+require 'active_support/core_ext/object/blank'
 require 'accessibility/translator'
 
 ##

data/lib/accessibility/system_info.rb

@@ -1,4 +1,5 @@
 require 'accessibility/version'
+require 'accessibility/extras'
 
 ##
 # Interface for collecting some simple information about the system.
@@ -11,17 +12,30 @@ require 'accessibility/version'
 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 
+  #   Accessibility::SystemInfo.hostnames
   #     # => ["ferrous.local", "localhost"]
   #
   # @return [Array<String>]
   def hostnames
-    host.names
+    NSHost.currentHost.names
   end
 
   ##
@@ -46,7 +60,7 @@ module Accessibility::SystemInfo
   #
   # @return [Array<String>]
   def addresses
-    host.addresses
+    NSHost.currentHost.addresses
   end
 
   ##
@@ -67,7 +81,7 @@ module Accessibility::SystemInfo
   #
   # @example
   #
-  #   Accessibility::SystemInfo.ipv6_addresses 
+  #   Accessibility::SystemInfo.ipv6_addresses
   #     # => ["fe80::6aa8:6dff:fe20:822%en1", "fe80::1%lo0", "::1"]
   #
   # @return [Array<String>]
@@ -86,7 +100,7 @@ module Accessibility::SystemInfo
   def model
     @model ||= `sysctl hw.model`.split.last.chomp
   end
-  
+
   ##
   # OS X version string
   #
@@ -96,7 +110,7 @@ module Accessibility::SystemInfo
   #
   # @return [String]
   def osx_version
-    pinfo.operatingSystemVersionString
+    NSProcessInfo.processInfo.operatingSystemVersionString
   end
 
   ##
@@ -108,7 +122,7 @@ module Accessibility::SystemInfo
   #
   # @return [Float]
   def uptime
-    pinfo.systemUptime
+    NSProcessInfo.processInfo.systemUptime
   end
 
   ##
@@ -122,7 +136,7 @@ module Accessibility::SystemInfo
   #
   # @return [Fixnum]
   def num_processors
-    pinfo.processorCount
+    NSProcessInfo.processInfo.processorCount
   end
 
   ##
@@ -134,7 +148,7 @@ module Accessibility::SystemInfo
   #
   # @return [Fixnum]
   def num_active_processors
-    pinfo.activeProcessorCount
+    NSProcessInfo.processInfo.activeProcessorCount
   end
 
   ##
@@ -146,20 +160,71 @@ module Accessibility::SystemInfo
   #
   # @return [Fixnum]
   def total_ram
-    pinfo.physicalMemory
+    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
 
-  private
-
-  def host
-    NSHost.currentHost
+  ##
+  # 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
 
-  def pinfo
-    NSProcessInfo.processInfo
+  ##
+  # 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
-