AXElements 1.0.0.alpha7 → 1.0.0.alpha8

data/History.markdown

@@ -1,5 +1,9 @@
 # 1.0.0 
 
+  * Added History.markdown to track notable changes
+
+  * Ported `mouse.rb` to C and moved code to [MRMouse](https://github.com/ferrous26/MRMouse)
+
   * 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/lib/accessibility/graph.rb

@@ -47,7 +47,7 @@ class Accessibility::Graph
 
     def identifier
       klass = @element.class.to_s.split(NAMESPACE).last
-      ident = @element.pp_identifier.dup
+      ident = @element.pp_identifier.to_s.dup
       if ident.length > 12
         ident = "#{ident[0...12]}..."
       end
@@ -58,9 +58,13 @@ class Accessibility::Graph
     end
 
     def shape
-      (@element.attribute(:focused) && OCTAGON) ||
-      (@element.actions.empty? && OVAL)         ||
-      BOX
+      if @element.attributes.include?(:focused) && @element.attribute(:focused)
+        OCTAGON
+      elsif @element.actions.empty?
+        OVAL
+      else
+        BOX
+      end
     end
 
     def style
@@ -69,7 +73,7 @@ class Accessibility::Graph
         return FILLED unless @element.attribute(:enabled)
       end
       # bold if focused and no children
-      if @element.attribute(:focused)
+      if @element.attributes.include?(:focused) && @element.attribute(:focused)
         return BOLD if @element.size_of(:children).zero?
       end
       SOLID

data/lib/accessibility/pretty_printer.rb

@@ -16,7 +16,7 @@ module Accessibility::PrettyPrinter
   # Create an identifier for the receiver by using various attributes
   # that should make it very easy to identify the element.
   #
-  # @return [String]
+  # @return [String,#to_s]
   def pp_identifier
     # @note use, or lack of use, of #inspect is intentional for visual effect
 
@@ -49,8 +49,7 @@ module Accessibility::PrettyPrinter
       return " id=#{attribute(:identifier)}"
     end
 
-    # @todo should we have other fallbacks?
-    return EMPTY_STRING
+  rescue NoMethodError
   end
 
   ##

data/lib/accessibility/version.rb

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

data/lib/ax/element.rb

@@ -360,7 +360,7 @@ class AX::Element
   #
   # @return [String]
   def inspect
-    msg  = "#<#{self.class}" << pp_identifier
+    msg  = "#<#{self.class}" << pp_identifier.to_s
     msg << pp_position if attributes.include? :position
     msg << pp_children if attributes.include? :children
     msg << pp_checkbox(:enabled) if attributes.include? :enabled

data/test/integration/accessibility/test_dsl.rb

@@ -226,32 +226,6 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
     assert @got_called
   end
 
-  def test_dump_works_for_nested_tab_groups
-    output = dsl.subtree_for app.window.tab_group
-
-    expected = [
-                ['AX::TabGroup',    0],
-                ['AX::RadioButton', 1], ['AX::RadioButton', 1], ['AX::TabGroup', 1],
-                ['AX::RadioButton', 2], ['AX::RadioButton', 2], ['AX::TabGroup', 2],
-                ['AX::RadioButton', 3], ['AX::RadioButton', 3], ['AX::TabGroup', 3],
-                ['AX::RadioButton', 4], ['AX::RadioButton', 4],
-                ['AX::Group',       4],
-                ['AX::TextField',   5], ['AX::StaticText',  6],
-                ['AX::TextField' ,  5], ['AX::StaticText',  6]
-               ]
-
-    refute_empty output
-    output = output.split("\n")
-
-    until output.empty?
-      line           = output.shift
-      klass, indents = expected.shift
-      assert_equal indents, line.match(/^\t*/).to_a.first.length, line
-      line.strip!
-      assert_match /^\#<#{klass}/, line
-    end
-  end
-
   def test_screenshot
     path = dsl.screenshot
     assert File.exists? path

data/test/integration/ax/test_element.rb

@@ -52,4 +52,30 @@ class TestAXElement < MiniTest::Unit::TestCase
     assert bye.invalid?
   end
 
+  def test_dump_works_for_nested_tab_groups
+    output = app.window.tab_group.inspect_subtree
+
+    expected = [
+                ['AX::TabGroup',    0],
+                ['AX::RadioButton', 1], ['AX::RadioButton', 1], ['AX::TabGroup', 1],
+                ['AX::RadioButton', 2], ['AX::RadioButton', 2], ['AX::TabGroup', 2],
+                ['AX::RadioButton', 3], ['AX::RadioButton', 3], ['AX::TabGroup', 3],
+                ['AX::RadioButton', 4], ['AX::RadioButton', 4],
+                ['AX::Group',       4],
+                ['AX::TextField',   5], ['AX::StaticText',  6],
+                ['AX::TextField' ,  5], ['AX::StaticText',  6]
+               ]
+
+    refute_empty output
+    output = output.split("\n")
+
+    until output.empty?
+      line           = output.shift
+      klass, indents = expected.shift
+      assert_equal indents, line.match(/^\t*/).to_a.first.length, line
+      line.strip!
+      assert_match /^\#<#{klass}/, line
+    end
+  end
+
 end

data/test/sanity/accessibility/test_pretty_printer.rb

@@ -18,10 +18,10 @@ class TestAccessibilityPrettyPrinter < MiniTest::Unit::TestCase
     assert_match /value=3.14/, pp_identifier
 
     @attribute  = ''
-    assert_match EMPTY_STRING, pp_identifier
+    assert_match EMPTY_STRING, pp_identifier.to_s
 
     @attribute  = nil
-    assert_match EMPTY_STRING, pp_identifier
+    assert_match EMPTY_STRING, pp_identifier.to_s
   end
 
   def test_identifier_using_title
@@ -44,7 +44,7 @@ class TestAccessibilityPrettyPrinter < MiniTest::Unit::TestCase
     assert_match /roflcopter/, pp_identifier
 
     @attribute  = NSString.string
-    assert_equal EMPTY_STRING, pp_identifier
+    assert_equal EMPTY_STRING, pp_identifier.to_s
 
     @attribute  = 26
     assert_match /26/, pp_identifier
@@ -62,7 +62,7 @@ class TestAccessibilityPrettyPrinter < MiniTest::Unit::TestCase
 
   def test_identifier_empty_string_as_final_fallback
     @attributes = NSArray.array
-    assert_equal EMPTY_STRING, pp_identifier
+    assert_equal EMPTY_STRING, pp_identifier.to_s
   end
 
   def test_position

metadata

@@ -2,31 +2,31 @@
 name: AXElements
 version: !ruby/object:Gem::Version
   prerelease: 6
-  version: 1.0.0.alpha7
+  version: 1.0.0.alpha8
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00 Z
+date: 2012-12-08 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mouse
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.1
-  type: :development
+        version: 1.0.1
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.1
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: yard
   prerelease: false
@@ -107,7 +107,6 @@ files:
 - lib/ax_elements.rb
 - lib/AXElements.rb
 - lib/minitest/ax_elements.rb
-- lib/mouse.rb
 - lib/rspec/expectations/ax_elements.rb
 - ext/accessibility/key_coder/extconf.rb
 - ext/accessibility/core/core.c
@@ -151,7 +150,6 @@ files:
 - test/sanity/rspec/expectations/test_ax_elements.rb
 - test/sanity/test_accessibility.rb
 - test/sanity/test_ax_elements.rb
-- test/sanity/test_mouse.rb
 - test/test_core.rb
 - test/helper.rb
 homepage: http://github.com/Marketcircle/AXElements
@@ -211,6 +209,5 @@ test_files:
 - test/sanity/rspec/expectations/test_ax_elements.rb
 - test/sanity/test_accessibility.rb
 - test/sanity/test_ax_elements.rb
-- test/sanity/test_mouse.rb
 - test/test_core.rb
 - test/helper.rb

data/lib/mouse.rb

@@ -1,273 +0,0 @@
-framework 'ApplicationServices'
-require   'ax_elements/core_graphics_workaround'
-
-
-##
-# This is a first attempt at writing a wrapper around the CoreGraphics event
-# taps API provided by OS X. The module provides a simple Ruby interface to
-# performing mouse interactions such as moving and clicking.
-#
-# [Reference](http://developer.apple.com/library/mac/#documentation/Carbon/Reference/QuartzEventServicesRef/Reference/reference.html).
-#
-# A rewrite is in the works, but in the mean time this code base still works
-# despite its warts.
-module Mouse
-  extend self
-
-  ##
-  # Number of animation steps per second
-  #
-  # @return [Number]
-  FPS     = 120
-
-  ##
-  # @note We keep the number as a rational to try and avoid rounding
-  #       error introduced by the floats, especially MacRuby floats.
-  #
-  # Smallest unit of time allowed for an animation step
-  #
-  # @return [Number]
-  QUANTUM = Rational(1, FPS)
-
-  ##
-  # Available constants for the type of units to use when scrolling
-  #
-  # @return [Hash{Symbol=>Fixnum}]
-  UNIT = {
-    line:  KCGScrollEventUnitLine,
-    pixel: KCGScrollEventUnitPixel
-  }
-
-  ##
-  # The coordinates of the mouse using the flipped coordinate system
-  #
-  # Flipped coordinates have the origin in top left corner of the
-  # primary screen.
-  #
-  # @return [CGPoint]
-  def current_position
-    CGEventGetLocation(CGEventCreate(nil))
-  end
-
-  ##
-  # Move the mouse from the current position to the given point
-  #
-  # @param point [CGPoint]
-  # @param duration [Float] animation duration, in seconds
-  def move_to point, duration = 0.2
-    animate KCGEventMouseMoved, KCGMouseButtonLeft, current_position, point, duration
-  end
-
-  ##
-  # Click and drag from the current position to the given point
-  #
-  # @param point [CGPoint]
-  # @param duration [Float] animation duration, in seconds
-  def drag_to point, duration = 0.2
-    post new_event(KCGEventLeftMouseDown, current_position, KCGMouseButtonLeft)
-
-    animate KCGEventLeftMouseDragged, KCGMouseButtonLeft, current_position, point, duration
-
-    post new_event(KCGEventLeftMouseUp, current_position, KCGMouseButtonLeft)
-  end
-
-  ##
-  # @todo Need to double check to see if I introduce any inaccuracies.
-  #
-  # Scroll at the current position the given amount of units
-  #
-  # Scrolling too much or too little in a period of time will cause the
-  # animation to look weird, possibly causing the app to mess things up.
-  #
-  # A positive `amonut` to scroll will scroll up and a negative `amount`
-  # will scroll down.
-  #
-  # @param amount [Fixnum] number of units to scroll
-  # @param duration [Float] in seconds
-  # @param units [Symbol] must be either `:line` or `:pixel`
-  def scroll amount, duration = 0.2, units = :line
-    units   = UNIT[units] || raise(ArgumentError, "#{units} is not a valid unit")
-    steps   = (FPS * duration).round
-    current = 0.0
-    steps.times do |step|
-      done     = (step+1).to_f / steps
-      scroll   = ((done - current)*amount).round
-      post new_scroll_event(units, 1, scroll)
-      sleep QUANTUM
-      current += scroll.to_f / amount
-    end
-  end
-
-  ##
-  # @api semipublic
-  #
-  # Perform a down click
-  #
-  # You should follow this up with a call to {#click_up} to finish the click.
-  #
-  # @param point [CGPoint]
-  # @param duration [Number]
-  def click_down point = current_position, duration = 12
-    event = new_event KCGEventLeftMouseDown, point, KCGMouseButtonLeft
-    post event
-    sleep QUANTUM*duration
-  end
-
-  ##
-  # @api semipublic
-  #
-  # Perform an up click
-  #
-  # This should only be called after a call to {#click_down} to finish
-  # the click event.
-  #
-  # @param point [CGPoint]
-  def click_up point = current_position
-    event = new_event KCGEventLeftMouseUp, point, KCGMouseButtonLeft
-    post event
-  end
-
-  ##
-  # Standard secondary click, sometimes called a "right click"
-  #
-  # Default position is the current position.
-  #
-  # @param point [CGPoint]
-  # @param duration [Number] in seconds
-  def secondary_click point = current_position, duration = 12
-    event = new_event KCGEventRightMouseDown, point, KCGMouseButtonRight
-    post event
-    sleep QUANTUM*duration
-    set_type event, KCGEventRightMouseUp
-    post event
-  end
-  alias_method :right_click, :secondary_click
-
-  ##
-  # @api semipublic
-  #
-  # Generate a multi click event at the given position
-  #
-  # `num_clicks` is the number of clicks for the event, where a value of `2'
-  # corresponds to a double click, `3` corresponds to a triple click, etc.
-  #
-  # However, I've only tested with a double and triple click, for which you
-  # can just call {#double_click} and {#triple_click} instead.
-  #
-  # @param num_clicks [Fixnum]
-  # @param point [CGPoint]
-  def multi_click num_clicks, point = current_position
-    event = new_event KCGEventLeftMouseDown, point, KCGMouseButtonLeft
-    CGEventSetIntegerValueField(event, KCGMouseEventClickState, num_clicks)
-    set_type  event, KCGEventLeftMouseDown
-    post event
-    set_type  event, KCGEventLeftMouseUp
-    post event
-  end
-
-  ##
-  # A standard double click
-  #
-  # Defaults to clicking at the current position.
-  #
-  # @param point [CGPoint]
-  def double_click point = current_position
-    # some apps still expect to receive the single click event first
-    # and then the double click event
-    multi_click 1, point
-    multi_click 2, point
-  end
-
-  ##
-  # A standard triple click
-  #
-  # Defaults to clicking at the current position.
-  #
-  # @param point [CGPoint]
-  def triple_click point = current_position
-    # some apps still expect to receive the single click event first
-    # and then the double and triple click events
-    double_click
-    multi_click 3, point
-  end
-
-  ##
-  # Click with an arbitrary mouse button
-  #
-  # Numbers are used to map the mouse buttons. At the time of writing,
-  # the documented values are:
-  #
-  #  - KCGMouseButtonLeft   = 0
-  #  - KCGMouseButtonRight  = 1
-  #  - KCGMouseButtonCenter = 2
-  #
-  # And the rest are not documented! Though they should be easy enough
-  # to figure out. See the `CGMouseButton` enum in the reference
-  # documentation for the most up to date list.
-  #
-  # @param point [CGPoint]
-  # @param button [Number]
-  # @param duration [Number]
-  def arbitrary_click point = current_position, button = KCGMouseButtonCenter, duration = 12
-    event = new_event KCGEventOtherMouseDown, point, button
-    post event
-    sleep QUANTUM*duration
-    set_type event, KCGEventOtherMouseUp
-    post event
-  end
-  alias_method :other_click, :arbitrary_click
-
-
-  private
-
-  ##
-  # Executes a mouse movement animation. It can be a simple cursor
-  # move or a drag depending on what is passed to `type`.
-  def animate type, button, from, to, duration
-    current = from
-    xstep   = (to.x - current.x) / (FPS * duration)
-    ystep   = (to.y - current.y) / (FPS * duration)
-    start   = NSDate.date
-
-    until close_enough?(current, to)
-      remaining  = to.x - current.x
-      current.x += xstep.abs > remaining.abs ? remaining : xstep
-
-      remaining  = to.y - current.y
-      current.y += ystep.abs > remaining.abs ? remaining : ystep
-
-      post new_event(type, current, button)
-
-      sleep QUANTUM
-      break if NSDate.date.timeIntervalSinceDate(start) > 5.0
-      current = current_position
-    end
-  end
-
-  def close_enough? current, target
-    x = current.x - target.x
-    y = current.y - target.y
-    ((x**2)+(y**2)) <= 1
-  end
-
-  def new_event event, position, button
-    CGEventCreateMouseEvent(nil, event, position, button)
-  end
-
-  # @param [Fixnum] wheel which scroll wheel to use (value between 1-3)
-  def new_scroll_event units, wheel, amount
-    CGEventCreateScrollWheelEvent(nil, units, wheel, amount)
-  end
-
-  def post event
-    CGEventPost(KCGHIDEventTap, event)
-  end
-
-  ##
-  # Change the event type for an instance of an event. This is how you would
-  # reuse a specific event. In most cases, reusing events is a necessity.
-  def set_type event, state
-    CGEventSetType(event, state)
-  end
-
-end

data/test/sanity/test_mouse.rb

@@ -1,22 +0,0 @@
-require 'test/runner'
-require 'mouse'
-
-class TestMouseModule < MiniTest::Unit::TestCase
-
-  def distance point1, point2
-    x = point1.x - point2.x
-    y = point1.y - point2.y
-    Math.sqrt((x**2) + (y**2))
-  end
-
-  def test_move_to
-    point = CGPoint.new(100, 100)
-    Mouse.move_to point
-    assert_in_delta 0, distance(point,Mouse.current_position), 1.0
-
-    point = CGPoint.new(rand(700)+150, rand(500)+100)
-    Mouse.move_to point
-    assert_in_delta 0, distance(point,Mouse.current_position), 1.0
-  end
-
-end