AXElements 0.7.8 → 0.8.0

data/docs/TestingExtensions.markdown

@@ -1,52 +0,0 @@
-# Test Helpers
-
-@todo Pretend that this does not exist yet
-
-There are some types of assertions that you would like to make during
-testing that simply does not make sense using the build in
-assertions. These can include things like existence checks which you
-would have to implement by searching, or ... that is really the only
-one I have so far :)
-
-## RSpec
-
-RSpec 2 is the Marketcircle choice for implementing functional and
-behavioural tests for apps using AXElements. It is great and offers
-the flexibility and features that make using it very good for large
-test suites.
-
-You can load the RSpec matchers that AXElements adds by requiring
-
-    require 'rspec/ax_elements'
-
-### Existence
-
-Checking for the existence of an object in RSpec with AXElements looks
-a bit awkward:
-
-    window.search(:button).should be_empty
-    # or
-    window.search(:button).should_not be_empty
-
-That does not communicate intent as clearly as it could. What if you
-could say something like:
-
-    window.should have_a :button
-    # or
-    window.should_not have_a :button
-
-What if you have filters? Well, that is handled as well, though maybe
-not as nicely:
-
-    window.should have_a(:button).with(title: 'Hello')
-
-## Minitest
-
-AXElements uses minitest for its own regression test suite. Minitest
-is pretty cool, and there is good cause to support it as well. To that
-end, we have provided the equivalent assertions.
-
-You can load it like so:
-
-    require 'minitest/ax_elements'
-

data/docs/images/ui_hierarchy.dot

@@ -1,34 +0,0 @@
-digraph {
-        Application  [label = "Application: Mail", style=filled]
-        MainWindow   [label = "MainWindow: Inbox"]
-        Outline      [label = "Outline"]
-        Table        [label = "Table: Emails"]
-        TableRow1    [label = "TableRow: Spam"]
-        TableRow2    [label = "TableRow: Daily LOLcat"]
-        MenuBar      [label = "MenuBar", style=filled]
-        MenuBarItem1 [label = "MenuBarItem: File", style=filled]
-        MenuBarItem2 [label = "MenuBarItem: Edit"]
-        MenuBarItem3 [label = "MenuBarItem: Help"]
-        Menu1        [label = "Menu", style=filled]
-        MenuItem1    [label = "MenuItem: Preferences"]
-        MenuItem2    [label = "MenuItem: Services", style=filled]
-        MenuItem3    [label = "MenuItem: Quit"]
-        Menu2        [label = "Menu", style=filled]
-        MenuItem4    [label = "MenuItem: Services Preferences", style=filled]
-
-        Application  -> MainWindow
-        Application  -> MenuBar
-        MainWindow   -> Outline
-        MainWindow   -> Table
-        Table        -> TableRow1
-        Table        -> TableRow2
-        MenuBar      -> MenuBarItem1
-        MenuBar      -> MenuBarItem2
-        MenuBar      -> MenuBarItem3
-        MenuBarItem1 -> Menu1
-        Menu1        -> MenuItem1
-        Menu1        -> MenuItem2
-        Menu1        -> MenuItem3
-        MenuItem2    -> Menu2
-        Menu2        -> MenuItem4
-}

data/lib/accessibility/debug.rb

@@ -1,164 +0,0 @@
-require 'accessibility/version'
-framework 'Cocoa'
-
-##
-# Collection of utility methods helpful when trying to debug issues.
-module Accessibility::Debug
-
-  # Initialize the DEBUG value
-  @on = ENV.fetch 'AXDEBUG', $DEBUG
-
-
-  class << self
-
-    ##
-    # Whether or not to turn on DEBUG features in AXElements. The
-    # value is initially inherited from `$DEBUG` but can be overridden
-    # by an environment variable named `AXDEBUG` or changed dynamically
-    # at runtime.
-    #
-    # @return [Boolean]
-    attr_accessor :on
-    alias_method :on?, :on
-
-    ##
-    # Get a list of elements, starting with an element you give, and riding
-    # the hierarchy up to the top level object (i.e. the {AX::Application}).
-    #
-    # @example
-    #
-    #   element = AX::DOCK.list.application_dock_item
-    #   path_for element
-    #     # => [AX::ApplicationDockItem, AX::List, AX::Application]
-    #
-    # @param [AX::Element]
-    # @return [Array<AX::Element>] the path in ascending order
-    def path *elements
-      element = elements.last
-      return path(elements << element.parent) if element.respond_to? :parent
-      return elements
-    end
-
-    ##
-    # @note This is an unfinished feature
-    #
-    # Make a `dot` format graph of the tree, meant for graphing with
-    # GraphViz.
-    #
-    # @return [String]
-    def graph_subtree root
-      require 'accessibility/graph'
-      dot = Accessibility::Graph.new(root)
-      dot.build!
-      dot.to_s
-    end
-
-    ##
-    # Dump a tree to the console, indenting for each level down the
-    # tree that we go, and inspecting each element.
-    #
-    # @example
-    #
-    #   puts subtree_for app
-    #
-    # @return [String]
-    def text_subtree element
-      output = element.inspect + "\n"
-      # @todo should use each_child_with_level instead
-      enum   = Accessibility::Enumerators::DepthFirst.new element
-      enum.each_with_level do |element, depth|
-        output << "\t"*depth + element.inspect + "\n"
-      end
-      output
-    end
-
-    ##
-    # Highlight an element on screen. You can optionally specify the
-    # highlight colour or pass a timeout to automatically have the
-    # highlighter disappear.
-    #
-    # The highlighter is actually a window, so if you do not set a
-    # timeout, you will need to call `#stop` or `#close` on the `NSWindow`
-    # object that this method returns in order to get rid of the
-    # highlighter.
-    #
-    # You could use this method to highlight an arbitrary number of
-    # elements on screen, with a rainbow of colours for debugging.
-    #
-    # @example
-    #
-    #   highlighter = highlight window.outline
-    #   highlight window.outline.row, colour: NSColor.greenColor, timeout: 5
-    #   highlighter.stop
-    #
-    # @param [AX::Element]
-    # @param [Hash] opts
-    # @option opts [Number] :timeout
-    # @option opts [NSColor] :colour
-    # @return [NSWindow]
-    def highlight element, opts = {}
-      app    = NSApplication.sharedApplication
-      colour = opts[:colour] || opts[:color] || NSColor.magentaColor
-      window = highlight_window_for element.bounds, colour
-
-      if opts.has_key? :timeout
-        Dispatch::Queue.new('window_killer').after opts[:timeout] do
-          window.close
-        end
-      end
-
-      window
-    end
-
-
-    private
-
-    ##
-    # Create the window that acts as the highlighted portion of the screen.
-    #
-    # @param [NSRect]
-    # @param [NSColor]
-    # @return [NSWindow]
-    def highlight_window_for bounds, colour
-      bounds.flip!
-      window = NSWindow.alloc.initWithContentRect bounds,
-                                       styleMask: NSBorderlessWindowMask,
-                                         backing: NSBackingStoreBuffered,
-                                           defer: true
-
-      window.setOpaque false
-      window.setAlphaValue 0.20
-      window.setLevel NSStatusWindowLevel
-      window.setBackgroundColor colour
-      window.setIgnoresMouseEvents true
-      window.setFrame bounds, display: false
-      window.makeKeyAndOrderFront NSApp
-      def window.stop
-        close
-      end
-      window
-    end
-
-  end
-end
-
-
-##
-# AXElements extensions to `CGRect`.
-class CGRect
-  ##
-  # Treats the rect as belonging to one co-ordinate system and then
-  # converts it to the other system.
-  #
-  # This is useful because accessibility API's expect to work with
-  # the flipped co-ordinate system (origin in top left), but AppKit
-  # prefers to use the cartesian co-ordinate system (origin in bottom
-  # left).
-  #
-  # @return [CGRect]
-  def flip!
-    screen_height = NSMaxY(NSScreen.mainScreen.frame)
-    origin.y      = screen_height - NSMaxY(self)
-    self
-  end
-end

data/test/integration/accessibility/test_debug.rb

@@ -1,44 +0,0 @@
-require 'test/integration/helper'
-
-class TestAccessibilityDebug < MiniTest::Unit::TestCase
-
-  def app
-    @app ||= AX::Application.new PID
-  end
-
-  def test_path_returns_correct_elements_in_correct_order
-    list = Accessibility::Debug.path(app.window.close_button)
-    assert_equal 3, list.size
-    assert_instance_of AX::CloseButton,    list.first
-    assert_instance_of AX::StandardWindow, list.second
-    assert_instance_of AX::Application,    list.third
-  end
-
-  def test_dump_works_for_nested_tab_groups
-    element = app.window.tab_group
-    output  = Accessibility::Debug.subtree_for element
-
-    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_debug.rb

@@ -1,63 +0,0 @@
-require 'test/runner'
-require 'accessibility/debug'
-
-class TestAccessibilityDebug < MiniTest::Unit::TestCase
-
-  def mock_element
-    @mock = Object.new
-    def @mock.bounds; CGRectMake(100,100,100,100); end
-    @mock
-  end
-
-  def test_debug_setting
-    assert_respond_to Accessibility::Debug, :on?
-    assert_respond_to Accessibility::Debug, :on=
-  end
-
-  def test_highlight_returns_created_window
-    w = Accessibility::Debug.highlight mock_element
-    assert_kind_of NSWindow, w
-    assert_respond_to w, :stop
-  ensure
-    w.close if w
-  end
-
-  def test_highlight_can_take_a_timeout
-    w = Accessibility::Debug.highlight mock_element, timeout: 0.1
-    assert w.visible?
-    sleep 0.15
-    refute w.visible? # Not exactly the assertion I want, but close enough
-  ensure
-    w.close if w
-  end
-
-  def test_highlight_can_have_custom_colour
-    w = Accessibility::Debug.highlight mock_element, color: NSColor.cyanColor
-    assert w.backgroundColor == NSColor.cyanColor
-    w.close
-
-    # test both spellings of colour
-    w = Accessibility::Debug.highlight mock_element, colour: NSColor.purpleColor
-    assert w.backgroundColor == NSColor.purpleColor
-  end
-
-  def test_highlight_highlights_correct_rect
-    w = Accessibility::Debug.highlight mock_element
-    assert_equal w.frame, mock_element.bounds.flip!
-  end
-
-end
-
-class TestCGRectExtensions < MiniTest::Unit::TestCase
-
-  def test_flipping
-    size = NSScreen.mainScreen.frame.size
-    assert_equal CGRectMake(  0,     size.height,  0,  0), CGRectZero.dup.flip!
-    assert_equal CGRectMake(100, size.height-200,100,100), CGRectMake(100,100,100,100).flip!
-  end
-
-  def test_flipping_twice_returns_to_original
-    assert_equal CGRectZero.dup, CGRectZero.dup.flip!.flip!
-  end
-
-end