AXElements 0.8.1 → 0.9.0

data/lib/minitest/ax_elements.rb

@@ -1,175 +0,0 @@
-require 'ax/element'
-require 'accessibility/qualifier'
-require 'accessibility/dsl'
-
-##
-# AXElements assertions for MiniTest.
-# [Learn more about minitest.](https://github.com/seattlerb/minitest)
-class MiniTest::Assertions
-
-  ##
-  # Test that an element has a specific child. For example, test
-  # that a table has a row with certain contents. You can pass any
-  # filters that you normally would during a search, including a block.
-  #
-  # @example
-  #
-  #   assert_has_child table, :row, static_text: { value: 'Mark' }
-  #
-  # @param [AX::Element]
-  # @param [#to_s]
-  # @param [Hash]
-  # @return [AX::Element]
-  def assert_has_child parent, kind, filters = {}, &block
-    msg = message {
-      child = ax_search_id kind, filters, block
-      "Expected #{parent.inspect} to have #{child} as a child"
-    }
-    result = ax_check_children parent, kind, filters, block
-    refute result.blank?, msg
-    result
-  end
-
-  ##
-  # Test that an element has a specifc descendent. For example, test
-  # that a window contains a specific label. You can pass any filters
-  # that you normally would during a search, including a block.
-  #
-  # @example
-  #
-  #   assert_has_descendent window, :static_text, value: /Cake/
-  #
-  # @param [AX::Element]
-  # @param [#to_s]
-  # @param [Hash]
-  # @return [AX::Element]
-  def assert_has_descendent ancestor, kind, filters = {}, &block
-    msg = message {
-      descendent = ax_search_id kind, filters, block
-      "Expected #{ancestor.inspect} to have #{descendent} as a descendent"
-    }
-    result = ax_check_descendent ancestor, kind, filters, block
-    refute result.blank?, msg
-    result
-  end
-  alias_method :assert_has_descendant, :assert_has_descendent
-
-  ##
-  # Test that an element will have a child/descendent soon. This method
-  # will block until the element is found or a timeout occurs.
-  #
-  # This is a minitest front end to using {DSL#wait_for}, so any
-  # parameters you would normally pass to that method will work here.
-  # This also means that you must include either a `parent` key or an
-  # `ancestor` key as one of the filters.
-  #
-  # @param [#to_s]
-  # @param [Hash]
-  # @yield An optional block to be used in the search qualifier
-  def assert_shortly_has kind, filters = {}, &block
-    # need to know if parent/ancestor now because wait_for eats some keys
-    (ancest = filters[:ancestor]) || (parent = filters[:parent])
-    msg = message {
-      descend = ax_search_id kind, filters, block
-      if ancest
-        "Expected #{ancest.inspect} to have descendent #{descend} before a timeout occurred"
-      else
-        "Expected #{parent.inspect} to have child #{descend} before a timeout occurred"
-      end
-    }
-    result = wait_for kind, filters, &block
-    refute result.blank?, msg
-    result
-  end
-
-  ##
-  # Test that an element _does not_ have a specific child. For example,
-  # test that a row is no longer in a table. You can pass any filters
-  # that you normally would during a search, including a block.
-  #
-  # @example
-  #
-  #   refute_has_child table, :row, id: 'MyRow'
-  #
-  # @param [AX::Element]
-  # @param [#to_s]
-  # @param [Hash]
-  # @return [nil]
-  def refute_has_child parent, kind, filters = {}, &block
-    result = ax_check_children parent, kind, filters, block
-    msg    = message {
-      "Expected #{parent.inspect} NOT to have #{result} as a child"
-    }
-    assert result.blank?, msg
-    result
-  end
-
-  ##
-  # Test that an element _does not_ have a specific descendent. For
-  # example, test that a window does not contain a spinning progress
-  # indicator anymore.
-  #
-  # @example
-  #
-  #  refute_has_descendent window, :busy_indicator
-  #
-  # @param [AX::Element]
-  # @param [#to_s]
-  # @param [Hash]
-  # @return [nil,Array()]
-  def refute_has_descendent ancestor, kind, filters = {}, &block
-    result = ax_check_descendent ancestor, kind, filters, block
-    msg    = message {
-      "Expected #{ancestor.inspect} NOT to have #{result} as a descendent"
-    }
-    assert result.blank?, msg
-    result
-  end
-  alias_method :refute_has_descendant, :refute_has_descendent
-
-  ##
-  # @todo Does having this assertion make sense? I've only added it
-  #       for the time being because OCD demands it.
-  #
-  # Test that an element will NOT have a child/descendent soon. This
-  # method will block until the element is found or a timeout occurs.
-  #
-  # This is a minitest front end to using {DSL#wait_for}, so any
-  # parameters you would normally pass to that method will work here.
-  # This also means that you must include either a `parent` key or an
-  # `ancestor` key as one of the filters.
-  #
-  # @param [#to_s]
-  # @param [Hash]
-  # @yield An optional block to be used in the search qualifier
-  def refute_shortly_has kind, filters = {}, &block
-    result = wait_for kind, filters, &block
-    msg = message {
-      if ancest = filters[:ancestor]
-        "Expected #{ancest.inspect} NOT to have #{result.inspect} as a descendent"
-      else
-        parent = filters[:parent]
-        "Expected #{parent.inspect} NOT to have #{result.inspect} as a child"
-      end
-    }
-    assert result.blank?, msg
-    result
-  end
-
-
-  private
-
-  def ax_search_id kind, filters, block
-    Accessibility::Qualifier.new(kind, filters, &block).describe
-  end
-
-  def ax_check_children parent, kind, filters, block
-    q = Accessibility::Qualifier.new(kind, filters, &block)
-    parent.children.find { |x| q.qualifies? x }
-  end
-
-  def ax_check_descendent ancestor, kind, filters, block
-    ancestor.search(kind, filters, &block)
-  end
-
-end

data/lib/mouse.rb

@@ -1,223 +0,0 @@
-framework 'ApplicationServices'
-
-##
-# 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
-  # (origin in top left).
-  #
-  # @return [CGPoint]
-  def current_position
-    CGEventGetLocation(CGEventCreate(nil))
-  end
-
-  ##
-  # Move the mouse from the current position to the given point.
-  #
-  # @param [CGPoint]
-  # @param [Float] duration 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 [CGPoint]
-  # @param [Float] duration 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.
-  #
-  # @param [Fixnum] amount number of units to scroll; positive to scroll
-  #   up or negative to scroll down
-  # @param [Float] duration animation duration, in seconds
-  # @param [Symbol] units `:line` scrolls by line, `:pixel` scrolls by 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).floor
-      post new_scroll_event(units, 1, scroll)
-      sleep QUANTUM
-      current += scroll.to_f / amount
-    end
-  end
-
-  ##
-  # Perform a down click. You should follow this up with a call to
-  # {#click_up} to finish the click.
-  #
-  # @param [CGPoint]
-  def click_down point = current_position, duration = 12
-    event = new_event KCGEventLeftMouseDown, point, KCGMouseButtonLeft
-    post event
-    sleep QUANTUM*duration
-  end
-
-  ##
-  # Perform an up click. This should only be called after a call to
-  # {#click_down} to finish the click event.
-  #
-  # @param [CGPoint]
-  def click_up point = current_position
-    event = new_event KCGEventLeftMouseUp, point, KCGMouseButtonLeft
-    post event
-  end
-
-  ##
-  # Standard secondary click. Default position is the current position.
-  #
-  # @param [CGPoint]
-  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
-
-  ##
-  # A standard double click. Defaults to clicking at the current position.
-  #
-  # @param [CGPoint]
-  def double_click point = current_position
-    event = new_event KCGEventLeftMouseDown, point, KCGMouseButtonLeft
-    post event
-    set_type  event, KCGEventLeftMouseUp
-    post event
-
-    CGEventSetIntegerValueField(event, KCGMouseEventClickState, 2)
-    set_type  event, KCGEventLeftMouseDown
-    post event
-    set_type  event, KCGEventLeftMouseUp
-    post event
-  end
-
-  ##
-  # Click with an arbitrary mouse button, using numbers to represent
-  # the mouse button. 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 [CGPoint]
-  # @param [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 = current_position
-    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
-    delta = Math.sqrt((x**2) + (y**2))
-    delta <= 1.0
-  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/lib/rspec/expectations/ax_elements.rb

@@ -1,234 +0,0 @@
-require 'accessibility/dsl'
-require 'accessibility/qualifier'
-require 'ax/element'
-
-module Accessibility
-
-  ##
-  # @abstract
-  #
-  # Base class for RSpec matchers used with AXElements.
-  class AbstractMatcher
-
-    # @return [#to_s]
-    attr_reader :kind
-
-    # @return [Hash{Symbol=>Object}]
-    attr_reader :filters
-
-    # @return [Proc]
-    attr_reader :block
-
-    # @param [#to_s]
-    # @param [Hash]
-    # @yield
-    def initialize kind, filters, &block
-      @kind, @filters, @block = kind, filters, block
-    end
-
-    # @param [AX::Element]
-    def does_not_match? element
-      !matches?(element)
-    end
-
-
-    private
-
-    # @return [Accessibility::Qualifier]
-    def qualifier
-      @qualifier ||= Accessibility::Qualifier.new(kind, filters, &block)
-    end
-  end
-
-  ##
-  # Custom matcher for RSpec to check if an element has the specified
-  # child element.
-  class HasChildMatcher < AbstractMatcher
-    # @param [AX::Element]
-    def matches? parent
-      @parent = parent
-      @result = parent.children.find { |x| qualifier.qualifies? x }
-      !@result.blank?
-    end
-
-    # @return [String]
-    def failure_message_for_should
-      "Expected #@parent to have child #{qualifier.describe}"
-    end
-
-    # @return [String]
-    def failure_message_for_should_not
-      "Expected #@parent to NOT have child #@result"
-    end
-
-    # @return [String]
-    def description
-    "should have a child that matches #{qualifier.describe}"
-    end
-  end
-
-  ##
-  # Custom matcher for RSpec to check if an element has the specified
-  # descendent element.
-  class HasDescendentMatcher < AbstractMatcher
-    # @param [AX::Element]
-    def matches? ancestor
-      @ancestor = ancestor
-      @result   = ancestor.search(kind, filters, &block)
-      !@result.blank?
-    end
-
-    # @return [String]
-    def failure_message_for_should
-      "Expected #@ancestor to have descendent #{qualifier.describe}"
-    end
-
-    # @return [String]
-    def failure_message_for_should_not
-      "Expected #@ancestor to NOT have descendent #@result"
-    end
-
-    # @return [String]
-    def description
-      "should have a descendent matching #{qualifier.describe}"
-    end
-  end
-
-  ##
-  # Custom matcher for RSpec to check if an element has the specified
-  # child element within a grace period. Used for testing things
-  # after an asynchronous action is performed.
-  class HasChildShortlyMatcher < AbstractMatcher
-    include DSL
-
-    # @param [AX::Element]
-    def matches? parent
-      @filters[:parent] = @parent = parent
-      @result = wait_for kind, filters, &block
-      !@result.blank?
-    end
-
-    # @return [String]
-    def failure_message_for_should
-      "Expected #@parent to have child #{qualifier.describe} before a timeout occurred"
-    end
-
-    # @return [String]
-    def failure_message_for_should_not
-      "Expected #@parent to NOT have child #@result before a timeout occurred"
-    end
-
-    # @return [String]
-    def description
-      "should have a child that matches #{qualifier.describe} before a timeout occurs"
-    end
-  end
-
-  ##
-  # Custom matcher for RSpec to check if an element has the specified
-  # descendent element within a grace period. Used for testing things
-  # after an asynchronous action is performed.
-  class HasDescendentShortlyMatcher < AbstractMatcher
-    include DSL
-
-    # @param [AX::Element]
-    def matches? ancestor
-      @filters[:ancestor] = @ancestor = ancestor
-      @result = wait_for kind, filters, &block
-      !@result.blank?
-    end
-
-    # @return [String]
-    def failure_message_for_should
-      "Expected #@ancestor to have descendent #{qualifier.describe} before a timeout occurred"
-    end
-
-    # @return [String]
-    def failure_message_for_should_not
-      "Expected #@ancestor to NOT have descendent #@result before a timeout occurred"
-    end
-
-    # @return [String]
-    def description
-      "should have a descendent matching #{qualifier.describe} before a timeout occurs"
-    end
-  end
-end
-
-
-##
-# Assert that the receiving element has the specified child element. You
-# can use any filters you would normally use in a search, including
-# a block.
-#
-# @example
-#
-#   window.toolbar.should have_child(:search_field)
-#   table.should have_child(:row, static_text: { value: /42/ })
-#
-#   search_field.should_not have_child(:busy_indicator)
-#
-# @param [#to_s]
-# @param [Hash]
-# @yield An optional block to be used as part of the search qualifier
-def have_child kind, filters = {}, &block
-  Accessibility::HasChildMatcher.new kind, filters, &block
-end
-
-##
-# Assert that the given element has the specified descendent. You can
-# pass any parameters you normally would use during a search,
-# including a block.
-#
-# @example
-#
-#   app.main_window.should have_descendent(:button, title: 'Press Me')
-#
-#   row.should_not have_descendent(:check_box)
-#
-# @param [#to_s]
-# @param [Hash]
-# @yield An optional block to be used as part of the search qualifier
-def have_descendent kind, filters = {}, &block
-  Accessibility::HasDescendentMatcher.new kind, filters, &block
-end
-alias :have_descendant :have_descendent
-
-##
-# Assert that the given element has the specified child soon. This
-# method will block until the child is found or a timeout occurs. You
-# can pass any parameters you normally would use during a search,
-# including a block.
-#
-# @example
-#
-#   app.main_window.should shortly_have_child(:row, static_text: { value: 'Cake' })
-#
-#   row.should_not shortly_have_child(:check_box)
-#
-# @param [#to_s]
-# @param [Hash]
-# @yield An optional block to be used as part of the search qualifier
-def shortly_have_child kind, filters = {}, &block
-  Accessibility::HasChildShortlyMatcher.new(kind, filters, &block)
-end
-
-##
-# Assert that the given element has the specified descendent soon. This
-# method will block until the descendent is found or a timeout occurs.
-# You can pass any parameters you normally would use during a search,
-# including a block.
-#
-# @example
-#
-#   app.main_window.should shortly_have_child(:row, static_text: { value: 'Cake' })
-#
-#   row.should_not shortly_have_child(:check_box)
-#
-# @param [#to_s]
-# @param [Hash]
-# @yield An optional block to be used as part of the search qualifier
-def shortly_have_descendent kind, filters = {}, &block
-  Accessibility::HasDescendentShortlyMatcher.new kind, filters, &block
-end
-alias :shortly_have_descendant :shortly_have_descendent

data/test/integration/accessibility/test_core.rb

@@ -1,18 +0,0 @@
-require 'test/integration/helper'
-
-class TestAccessibilityCore < MiniTest::Unit::TestCase
-
-  # this assumes that radar://10040865 is not fixed
-  # once it is fixed, this case becomes less of an
-  # issue anyways
-  def test_nil_children_returns_empty_array
-    app  = app_with_name 'AXElementsTester'
-    menu = app.menu_bar_item(title: 'Help')
-    press menu
-
-    assert_empty menu.search_field.children
-  ensure
-    cancel menu if menu
-  end
-
-end