AXElements 0.8.1 → 0.9.0

data/.yardopts

@@ -8,3 +8,7 @@
 --hide-void-return
 lib/**/*.rb
 ext/**/*{.m,.c}
+-
+History.markdown
+CONTRIBUTING.markdown
+

data/History.markdown

@@ -0,0 +1,41 @@
+# 0.9.0
+
+  * AXElements can now run on MRI as well as MacRuby
+
+  * Added `DSL#pinch` to simulate pinch gestures
+  * Added `DSL#rotate` to simulate rotation gestures
+  * Added `DSL#swipe` to simulate swipe gestures
+  * Added `DSL#smart_magnify` to simulate smart magnification (two finger double tap)
+  * Added `DSL#horizontal_scroll`
+  * Added `DSL#contextual_menu` hack for finding contextual menus (WIP)
+  * 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`
+  * Added `Application.finder`
+  * Added `Application.dock`
+  * Added `SystemWide.focused_application` as override of built in attribute
+  * Added `SystemWide.status_items`
+  * Added `SystemWide.desktop`
+  * Added History.markdown to track notable changes
+  * Added CONTRIBUTING.markdown with much less stringent guidelines
+
+  * Moved MiniTest extensions to their own gem/repository [minitest-ax\_elements](https://github.com/AXElements/minitest-ax_elements)
+  * Moved RSpec extensions to their own gem/repository [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)
+
+  * Changed `DSL#right_click` to accept a block; block is yielded to between click down and click up events
+  * Changed `AX::Element#rect` to `AX::Element#to_rect`
+
+  * 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
+
+  * Fixed fetching parameterized attributes through `Element#method_missing`
+  * Fixed `Element#parameterized_attribute` automatically normalizing `Range` parameters

data/README.markdown

@@ -12,75 +12,75 @@ computer.
 
 ## Demo
 
-Perhaps you want to do something with the finder. This example opens a
-new Finder window, finds Activity Monitor, and then opens the application
-from a quick look window:
+[Demo Video](http://www.youtube.com/watch?v=G9O5wzb7oTY)
+
+The code from the demo video is right here:
 
 ```ruby
     require 'rubygems'
     require 'ax_elements'
 
+    # Highlight objects that the mouse will move to
+    Accessibility.debug = true
+
+    # Get a reference to the Finder and bring it to the front
     finder = app_with_bundle_identifier 'com.apple.finder'
-    set_focus_to finder # bring to the front so you can see it happening
+    set_focus_to finder
 
+    # Open a new window
     type "\\COMMAND+n"
-    sleep 1 # this is so you can see it happen in "slow motion"
+    sleep 1 # pause for "slow motion"
 
+    # Find and click the "Applications" item in the sidebar
     window = finder.main_window
     click window.outline.row(static_text: { value: 'Applications' })
 
+    # Find the Utilities folder
     utilities = window.row(text_field: { filename: 'Utilities' })
     scroll_to utilities
     double_click utilities
 
-    activity_monitor = window.text_field( filename: /Activity Monitor/ )
-    scroll_to activity_monitor
-    click activity_monitor
-    type " " # type a space, which should bring up quick look
-    sleep 1
-
-    click finder.quick_look.button(id: 'QLControlOpen')
-```
+    # Wait for the folder to open and find the Activity Monitor app
+    app = wait_for :text_field, ancestor: window, filename: /Activity Monitor/
+    scroll_to app
+    click app
 
-A simpler example would be changing the system volume by moving the
-slider in the menu bar (unless you've hidden it):
+    # Bring up QuickLook
+    type " "
+    sleep 1 # pause for "slow motion"
 
-```ruby
-    require 'rubygems'
-    require 'ax_elements'
+    # Click the Quick Look button that opens the app
+    click finder.quick_look.button(id: 'QLControlOpen')
+    sleep 1 # pause for "slow motion"
 
-    ui     = app_with_bundle_id 'com.apple.systemuiserver'
-    volume = ui.menu_extra(description: 'system sound volume')
+    # Get a reference to activity monitor and close the app
+    activity_monitor = app_with_bundle_identifier 'com.apple.ActivityMonitor'
+    terminate activity_monitor
 
-    click volume
-    15.times { decrement volume.slider }
-    15.times { increment volume.slider }
+    # Close the Finder window
+    select_menu_item finder, 'File', 'Close Window'
 ```
 
 
 ## 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 in order 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](http://macruby.org/), version 0.12 or
-later is required and downloads can be found at
-https://github.com/MacRuby/MacRuby/downloads.
-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 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.
 
-Then you can install AXElements. You can install AXElements via
-rubygems:
+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:
 
-```bash
-    gem install AXElements
-```
+![Universal Access](http://ferrous26.com/images/enable_accessibility.png)
 
-And then you can try things out in IRb:
+Then you can install AXElements either from RubyGems or from source. The
+RubyGems install is as usual, but you may need `sudo` power:
 
 ```bash
-    irb -rubygems -rax_elements
+    gem install AXElements --pre
 ```
 
 Or you can install from source:
@@ -91,19 +91,17 @@ Or you can install from source:
     cd AXElements && rake install
 ```
 
-And then try things out in the developer console. AXElements has no
-gem dependencies, so from the AXElements source directory you can just
-run the `console` task:
+Once all the setup is finished, you can start up AXElements in IRB:
 
 ```bash
-    rake console
+    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
@@ -114,20 +112,22 @@ disable it like so:
 
 The [wiki](http://github.com/Marketcircle/AXElements/wiki)
 is the best place to get started, it includes tutorials to help you get
-started as well the API documentation (API docs are broken right now due
-to incompatabilities between MacRuby and YARD).
+started. API documentation is also available on
+[rdoc.info](http://rdoc.info/gems/AXElements/frames).
 
 Though it is not required, you may want to read Apple's
 [Accessibility Overview](http://developer.apple.com/library/mac/#documentation/Accessibility/Conceptual/AccessibilityMacOSX/OSXAXModel/OSXAXmodel.html)
 as a primer on some the rationale for the accessibility APIs as well
-as the technical underpinnings of AXElements.
+as some of the technical the technical underpinnings of AXElements.
 
 
 ## Development
 
-AXElements has reached a point where the main focus is now performance,
-features, and documentation. It will be magical, so we're code naming
-the next version "Clefable".
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Marketcircle/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)
 
@@ -155,6 +155,9 @@ 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
@@ -176,18 +179,12 @@ disabled by default. In order to enable them you need to set the
 
 ## Contributing to AXElements
 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+See {file:CONTRIBUTING.markdown}
 
 
 ## Copyright
 
-Copyright (c) 2010-2012, Marketcircle Inc.
+Copyright (c) 2010-2013, Marketcircle Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

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

data/ext/accessibility/key_coder/extconf.rb

@@ -10,7 +10,7 @@ else
     clang = `which clang`.chomp
     if clang.empty?
       $stdout.puts "Clang not installed. Cannot build C extension"
-      exit 1
+      raise "Clang not installed. Cannot build C extension"
     else
       RbConfig::MAKEFILE_CONFIG["CC"]  = clang
       RbConfig::MAKEFILE_CONFIG["CXX"] = clang

data/ext/accessibility/key_coder/key_coder.c

@@ -3,7 +3,7 @@
  *  KeyCoder
  *
  *  Created by Mark Rada on 11-07-27.
- *  Copyright 2011 Marketcircle Incorporated. All rights reserved.
+ *  Copyright 2011-2012 Marketcircle Incorporated. All rights reserved.
  */
 
 
@@ -26,7 +26,8 @@
  *  @return [Hash{String=>Number}]
  */
 
-static VALUE
+static
+VALUE
 keycoder_dynamic_mapping()
 {
 
@@ -45,7 +46,8 @@ keycoder_dynamic_mapping()
     UniCharCount string_length = 0;
     UInt32       dead_key_state = 0;
     UCKeyTranslate(
-		   layout,key_code,
+		   layout,
+       key_code,
 		   kUCKeyActionDown,
 		   0,
 		   LMGetKbdType(),  // kb type
@@ -90,7 +92,8 @@ keycoder_dynamic_mapping()
  *  @return [true]
  */
 
-static VALUE
+static
+VALUE
 keycoder_post_event(VALUE self, VALUE event)
 {
   VALUE code  = rb_ary_entry(event, 0);
@@ -99,7 +102,7 @@ keycoder_post_event(VALUE self, VALUE event)
   CGEventRef event_ref = CGEventCreateKeyboardEvent(NULL, FIX2LONG(code), state);
   CGEventPost(kCGHIDEventTap, event_ref);
 
-  usleep(9000);
+  usleep(9000); // 9000 is a magic number
   return Qtrue;
 }