AXElements 1.0.0.alpha8 → 1.0.0.alpha9

data/History.markdown

@@ -1,6 +1,13 @@
 # 1.0.0 
 
   * Added History.markdown to track notable changes
+  * Added `Application.frontmost_application`
+  * Added `Application.menu_bar_owner`
+  * Added `SystemWide.status_bar_items`
+  * Added `SystemWide.desktop`
+  * Added `Application.finder`
+  * Added `Application.dock`
+  * Added `DSL#record` to run a screen recording of the given block
 
   * Ported `mouse.rb` to C and moved code to [MRMouse](https://github.com/ferrous26/MRMouse)
 

data/README.markdown

@@ -64,13 +64,10 @@ The code from the demo video is right here:
 
 ## Getting Setup
 
-You need to have the OS X command line tools installed in order to
-build and install AXElements, but you will also need Xcode if you want
-to run the test suite (sorry). Go ahead and install the tools now if you
-haven't done that yet, I'll wait. Once you have the developer tools,
-you should install MacRuby, version 0.12 or newer is required. If you
-are on Snow Leopard, you will also need to install the
-[Bridge Support Preview](http://www.macruby.org/blog/2010/10/08/bridgesupport-preview.html).
+You will need a MacRuby nightly build for installation. You can get help setting
+up by referencing the
+[Setup MacRuby](https://github.com/MacRuby/MacRuby/wiki/Setting-up-MacRuby)
+guide on Github.
 
 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:

data/lib/accessibility/core.rb

@@ -914,9 +914,6 @@ class NSArray
   def to_size;  CGSize.new(first, at(1))  end
   # @return [CGRect]
   def to_rect;  CGRectMake(*self[0..3])   end
-  ##
-  # Override `super` to exploit trivial parallelism.
-  #
   # @return [Array]
   def to_ruby
     map do |obj| obj.to_ruby end

data/lib/accessibility/dsl.rb

@@ -693,16 +693,17 @@ module Accessibility::DSL
   alias_method :capture_screen, :screenshot
 
   ##
-  # See {Accessibility::ScreenRecorder.record} for details.
+  # See (ScreenRecorder)[http://rdoc.info/gems/screen_recorder/frames]
+  # for details on the screen recording options
   #
   # @param file [String]
   # @return [String]
   def record file = nil, &block
-    require 'accessibility/screen_recorder'
+    require 'screen_recorder'
     if file
-      Accessibility::ScreenRecorder.record file, &block
+      ScreenRecorder.record file, &block
     else
-      Accessibility::ScreenRecorder.record &block
+      ScreenRecorder.record &block
     end
   end
 

data/lib/accessibility/version.rb

@@ -4,7 +4,7 @@
 # The main AXElements namespace.
 module Accessibility
   # @return [String]
-  VERSION   = '1.0.0.alpha8'
+  VERSION   = '1.0.0.alpha9'
 
   # @return [String]
   CODE_NAME = 'ルナトーン'

data/lib/ax/application.rb

@@ -23,6 +23,55 @@ class AX::Application < AX::Element
                                 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
 
   ##

data/lib/ax/systemwide.rb

@@ -11,6 +11,33 @@ require 'accessibility/string'
 class AX::SystemWide < AX::Element
   include Accessibility::String
 
+  class << self
+    ##
+    # Find and return the group that represents the dock
+    #
+    # @return [AX::Group]
+    def desktop
+      AX::Application.finder.scroll_areas.first.groups.first
+    end
+
+    ##
+    # @note This currently does not include spotlight or the
+    #       notification center as they interact oddly with
+    #       accessibility APIs and how AXElements handle errors
+    #
+    # Find and return menu bar items for the system
+    #
+    # That is, menu bar items that do not belong to the current
+    # app, but that belong to the system, such as the clock or
+    # wi-fi menu.
+    #
+    # @return [AX::MenuBarItem]
+    def status_items
+      AX::Application.new('SystemUIServer').menu_bar.children
+    end
+  end
+
+
   ##
   # Overridden since there is only one way to get the element ref.
   def initialize

data/lib/ax_elements/core_graphics_workaround.rb

@@ -1,6 +1,6 @@
 framework 'Cocoa'
 
-MOUNTAIN_LION_APPKIT_VERSION = 1187
+MOUNTAIN_LION_APPKIT_VERSION ||= 1187
 if NSAppKitVersionNumber >= MOUNTAIN_LION_APPKIT_VERSION
     framework '/System/Library/Frameworks/CoreGraphics.framework'
 end

metadata

@@ -2,14 +2,14 @@
 name: AXElements
 version: !ruby/object:Gem::Version
   prerelease: 6
-  version: 1.0.0.alpha8
+  version: 1.0.0.alpha9
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-08 00:00:00 Z
+date: 2012-12-11 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mouse
@@ -19,14 +19,46 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: screen_recorder
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "4.3"
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "4.3"
 - !ruby/object:Gem::Dependency
   name: yard
   prerelease: false
@@ -81,7 +113,6 @@ files:
 - lib/accessibility/highlighter.rb
 - lib/accessibility/pretty_printer.rb
 - lib/accessibility/qualifier.rb
-- lib/accessibility/screen_recorder.rb
 - lib/accessibility/statistics.rb
 - lib/accessibility/string.rb
 - lib/accessibility/translator.rb

data/lib/accessibility/screen_recorder.rb

@@ -1,217 +0,0 @@
-framework 'AVFoundation'
-require   'accessibility/version'
-require   'ax_elements/core_graphics_workaround'
-
-##
-# Screen recordings, easy as pie.
-#
-# Things that you need to be concerned about:
-#   - screen going to sleep
-#   - short recordings (~1 second) don't work too well; it looks like
-#     the last bit of the buffer does not get saved so the last ~0.5
-#     seconds are not saved to disk (we could add a 0.5 second sleep)
-#   - small memory leak when a recording starts on Mountain Lion (GC)
-#   - constantly leaking memory during recording on Lion (GC)
-#   - run loop hack is not needed if code is already being called from
-#     in a run loop
-#   - pausing is not working...not sure why
-#
-class Accessibility::ScreenRecorder
-
-  ##
-  # Record the screen while executing the given block. The path to the
-  # recording will be returned.
-  #
-  # The recorder object is yielded.
-  #
-  # @yield
-  # @yieldparam recorder [ScreenRecorder]
-  # @return [String]
-  def self.record file_name = nil
-    raise 'block required' unless block_given?
-
-    recorder = new
-    file_name ? recorder.start(file_name) : recorder.start
-    yield recorder
-    recorder.file
-
-  ensure
-    recorder.stop
-  end
-
-  ##
-  # Path to the screen recording. This is `nil` until the screen
-  # recording begins.
-  #
-  # @return [String]
-  attr_reader :file
-
-  ##
-  # @todo Expose configuration options at initialie time
-  def initialize
-    @session = AVCaptureSession.alloc.init
-
-    @input = AVCaptureScreenInput.alloc.initWithDisplayID CGMainDisplayID()
-    @input.capturesMouseClicks = true
-
-    @output = AVCaptureMovieFileOutput.alloc.init
-    @output.setDelegate self
-
-    @session.addInput @input
-    @session.addOutput @output
-
-    @sema = Dispatch::Semaphore.new 0
-  end
-
-  ##
-  # Synchrnously start recording. You can optionally specify a file
-  # name for the recording; if you do not then a default name will be
-  # provided in the form `~/Movies/TestRecording-20121017123230.mov`
-  # (the timestamp will be different for you).
-  #
-  # @param file_name [String]
-  def start file_name = default_file_name
-    @file = default_file_name
-    file_url = NSURL.fileURLWithPath @file, isDirectory: false
-
-    @session.startRunning
-    @output.startRecordingToOutputFileURL file_url,
-                       recordingDelegate: self
-
-    @sema.wait
-  end
-
-  ##
-  # Whether or not the recording has begun. This will be `true`
-  # after calling {#start} until {#stop} is called. It will be
-  # `true` while the recording is paused.
-  def started?
-    @output.recording?
-  end
-
-  # ##
-  # # Whether or not the recording has been paused.
-  # def paused?
-  #   @output.paused?
-  # end
-
-  ##
-  # Duration of the recording, in seconds.
-  #
-  # @return [Float]
-  def length
-    duration = @output.recordedDuration
-    (duration.value.to_f / duration.timescale.to_f)
-  end
-
-  ##
-  # Size of the recording on disk, in bytes.
-  #
-  # @return [Fixnum]
-  def size
-    @output.recordedFileSize
-  end
-
-  # ##
-  # # Synchronously pause the recording. You can optionally pass a block
-  # # to this method.
-  # #
-  # # If you pass a block, the recording is paused so that the block
-  # # can execute and recording resumes after the block finishes. If
-  # # you do not pass a block then the recording is paused until you
-  # # call {#resume} on the receiver.
-  # #
-  # # @yield Optionally pass a block
-  # def pause
-  #   @output.pauseRecording
-  #   wait_for_callback
-  #   @sema.wait
-
-  #   if block_given?
-  #     yield
-  #     resume
-  #   end
-  # end
-
-  # ##
-  # # Synchronously resume a {#pause}d recording.
-  # def resume
-  #   @output.resumeRecording
-  #   wait_for_callback
-  #   @sema.wait
-  # end
-
-  ##
-  # Synchronously stop recording and finish up commiting any data to disk.
-  # A recording cannot be {#start}ed again after it has been stopped; if
-  # you want to pause a recording then you should use {#pause} instead.
-  def stop
-    @session.stopRunning
-    @output.stopRecording
-    @sema.wait
-    wait_for_callback
-    @sema.wait
-  end
-
-
-  # @!group AVCaptureFileOutputDelegate
-
-  def captureOutput captureOutput, didOutputSampleBuffer:sampleBuffer, fromConnection:connection
-    # gets called for every chunk of the recording getting committed to disk
-  end
-
-  def captureOutput captureOutput, didDropSampleBuffer:sampleBuffer,   fromConnection:connection
-    NSLog("Error: dropped same data from recording")
-  end
-
-
-  # @!group AVCaptureFileOutputRecordingDelegate
-
-  def captureOutput captureOutput, didFinishRecordingToOutputFileAtURL:outputFileURL, fromConnections:connections, error:error
-    NSLog('Finishing')
-    CFRunLoopStop(CFRunLoopGetCurrent())
-    @sema.signal
-  end
-
-  def captureOutput captureOutput, didPauseRecordingToOutputFileAtURL:fileURL, fromConnections:connections
-    NSLog('Pausing')
-    CFRunLoopStop(CFRunLoopGetCurrent())
-    @sema.signal
-  end
-
-  def captureOutput captureOutput, didResumeRecordingToOutputFileAtURL:fileURL, fromConnections:connections
-    NSLog('Resuming')
-    CFRunLoopStop(CFRunLoopGetCurrent())
-    @sema.signal
-  end
-
-  def captureOutput captureOutput, didStartRecordingToOutputFileAtURL:fileURL, fromConnections:connections
-    NSLog('Starting')
-    @sema.signal
-  end
-
-  def captureOutput captureOutput, willFinishRecordingToOutputFileAtURL:fileURL, fromConnections:connections, error:error
-    NSLog('Will Finish')
-    @sema.signal
-  end
-
-
-  private
-
-  def default_file_name
-    date = Time.now.strftime '%Y%m%d%H%M%S'
-    File.expand_path("~/Movies/TestRecording-#{date}.mov")
-  end
-
-  def wait_for_callback
-    case CFRunLoopRunInMode(KCFRunLoopDefaultMode, 30, false)
-    when KCFRunLoopRunStopped
-      true
-    when KCFRunLoopRunTimedOut
-      raise 'did not get callback'
-    else
-      raise 'unexpected result from waiting for callback'
-    end
-  end
-
-end