AXElements 1.0.0.beta3 → 1.0.0.beta4

data/.yardopts

@@ -10,4 +10,5 @@ lib/**/*.rb
 ext/**/*{.m,.c}
 -
 History.markdown
+CONTRIBUTING.markdown
 

data/History.markdown

@@ -1,7 +1,13 @@
-# 1.0.0 
+# 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
@@ -14,15 +20,17 @@
   * 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 repository/gem [minitest-ax\_elements](https://github.com/AXElements/minitest-ax_elements)
-  * Moved RSpec extensions to their own repository/gem [rspec-ax\_elements](https://github.com/AXElements/rspec-ax_elements)
+  * 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
@@ -30,3 +38,4 @@
   * 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

@@ -179,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/lib/accessibility/dsl.rb

@@ -274,7 +274,7 @@ module Accessibility::DSL
   # @param app [AX::Application]
   # @return [AX::Window]
   def show_preferences_window_for app
-    app.show_preferences_window
+    app.application.show_preferences_window
   end
 
   ##
@@ -312,6 +312,31 @@ module Accessibility::DSL
     element.ancestor(:menu).scroll_to element
   end
 
+  ##
+  # @note This is a hack to workaround an AXAPI deficiency
+  # @note This method may move or be renamed in the next release, though
+  #       it will not be removed
+  #
+  # Find a contextual menu that is open near the mouses current position
+  #
+  # This method assumes that it is being called in the block of a call to
+  # {#right_click}, and that the contextual menu is going to be very close
+  # to the mouse pointer.
+  #
+  # @return [AX::Menu,nil]
+  def contextual_menu
+    # CAST, just like high school trigonometry! :P
+    c, a, s, t = quads = Array.new(4) { Mouse.current_position }
+    c.x -= 10; c.y += 10
+    a.x += 10; a.y += 10
+    s.x += 10; s.y -= 10
+    t.x -= 10; t.y -= 10
+    elements = quads.map { |quad| element_at_point quad }
+    elements.uniq!
+    elements.map! { |el| el.kind_of?(AX::Menu) ? el : el.ancestor(:menu) }
+    elements.find { |element| element.present? }
+  end
+
 
   # @!group Polling
 
@@ -480,7 +505,7 @@ module Accessibility::DSL
   # @option opts [Number] :wait (0.2) in seconds
   def move_mouse_to arg, opts = {}
     duration = opts[:duration] || 0.2
-    if Accessibility.debug? && arg.respond_to?(:bounds)
+    if Accessibility.debug? && arg.kind_of?(AX::Element)
       highlight arg, timeout: duration, color: NSColor.orangeColor
     end
     Mouse.move_to arg.to_point, duration
@@ -530,6 +555,27 @@ module Accessibility::DSL
     sleep wait
   end
 
+  ##
+  # @todo Need to expose the units option? Would allow scrolling by pixel.
+  #
+  # Horizontally scrolls an arbitrary number of lines at the mouses current
+  # point on the screen
+  #
+  # Use a positive number to scroll left, and a negative number to scroll
+  # right.
+  #
+  # If the second argument is provided then the mouse will move to that
+  # point first; the argument must respond to `#to_point`.
+  #
+  # @param lines [Number]
+  # @param obj [#to_point]
+  # @param wait [Number]
+  def horizontal_scroll lines, obj = nil, wait = 0.1
+    move_mouse_to obj, wait: 0 if obj
+    Mouse.horizontal_scroll lines
+    sleep wait
+  end
+
   ##
   # Perform a regular click.
   #
@@ -608,6 +654,97 @@ module Accessibility::DSL
     sleep wait
   end
 
+  ##
+  # Perform a swipe gesture in the given `direction`
+  #
+  # Valid directions are:
+  #
+  #   - `:up`
+  #   - `:down`
+  #   - `:left`
+  #   - `:right`
+  #
+  # An optional second argument can be provided. If the argument
+  # is provided then the mouse pointer will move to that point first.
+  #
+  # @example
+  #
+  #   swipe :left, safari.web_area
+  #
+  # @param direction [Symbol]
+  # @param obj [#to_point]
+  def swipe direction, obj = nil, wait = 0.2
+    move_mouse_to obj, wait: 0 if obj
+    Mouse.swipe direction
+    sleep wait
+  end
+
+  ##
+  # Perform a pinch gesture in the given `direction`
+  #
+  # You can optionally specify the `magnification` factor and
+  # `position` for the pinch event.
+  #*
+  # Available pinch directions are:
+  #
+  #   - `:zoom` or `:expand`
+  #   - `:unzoom` or `:contract`
+  #
+  # Magnification is a relative magnification setting. A zoom value of
+  # `1.0` means `1.0` more than the current zoom level. `2.0` would be
+  # `2.0` levels higher than the current zoom.
+  #
+  # You can also optionally specify an object/point on screen for the mouse
+  # pointer to be moved to before the gesture begins.
+  #
+  # @param direction [Symbol]
+  # @param magnification [Float]
+  # @param obj [#to_point]
+  def pinch direction, magnification = 1, obj = nil, wait = 0.2
+    move_mouse_to obj, wait: 0 if obj
+    Mouse.pinch direction, magnification
+    sleep wait
+  end
+
+  ##
+  # Perform a rotation gesture in the given `direction` the given `angle` degrees
+  #
+  # Possible directions are:
+  #
+  #   - `:cw`, ':clockwise`, ':clock_wise` to rotate in the clockwise
+  #     direction
+  #   - `:ccw`, ':counter_clockwise`, `:counter_clock_wise` to rotate in
+  #     the the counter clockwise direction
+  #
+  # The `angle` parameter is a number of degrees to rotate. There are 360
+  # degrees in a full rotation, as you would expect in Euclidian geometry.
+  #
+  # You can also optionally specify an object/point on screen for the mouse
+  # pointer to be moved to before the gesture begins. The movement will
+  # be instantaneous.
+  #
+  # @param direction [Symbol]
+  # @param angle [Float]
+  # @param obj [#to_point]
+  def rotate direction, angle, obj = nil, wait = 0.2
+    move_mouse_to obj, wait: 0 if obj
+    Mouse.rotate direction, angle
+    sleep wait
+  end
+
+  ##
+  # Perform a smart magnify (double tap on trackpad)
+  #
+  # You can optionally specify an object/point on the screen where to perform
+  # the smart magnification. The mouse will move to this point first
+  #
+  # @param obj [#to_point]
+  def smart_magnify obj = nil, wait = 0.2
+    move_mouse_to obj, wait: 0 if obj
+    Mouse.smart_magnify
+    sleep wait
+  end
+
 
   # @!group Debug Helpers
 
@@ -642,6 +779,7 @@ module Accessibility::DSL
   end
 
   ##
+  # @note This method is currently experimental
   # @note You will need to have GraphViz command line tools installed
   #       in order for this to work.
   #
@@ -708,7 +846,16 @@ module Accessibility::DSL
   # See (ScreenRecorder)[http://rdoc.info/gems/screen_recorder/frames]
   # for details on the screen recording options
   #
+  # @example
+  #
+  #   file = record do
+  #     run_tests
+  #   end
+  #   `open '#{file}'`
+  #
   # @param file [String]
+  # @yield
+  # @yieldparam recorder [ScreenRecorder]
   # @return [String]
   def record file = nil, &block
     require 'screen_recorder'

data/lib/accessibility/version.rb

@@ -4,8 +4,25 @@
 # The main AXElements namespace.
 module Accessibility
   # @return [String]
-  VERSION   = '1.0.0.beta3'
+  VERSION   = '1.0.0.beta4'
 
   # @return [String]
-  CODE_NAME = 'ルナトーン'
+  CODE_NAME = case RUBY_ENGINE
+              when 'macruby' then 'サンダース'
+              when 'ruby'    then 'ブースター'
+              when 'rbx'     then 'ブラッキー' # for when rbx has good cext support
+              else 'シャワーズ' # vapor(ware)eon
+              end
+
+  ##
+  # The complete version string for AXElements
+  #
+  # This differs from {Accessibility::VERSION} in that it also
+  # includes `RUBY_ENGINE` information.
+  #
+  # @return [String]
+  def self.version
+    "#{VERSION}-#{CODE_NAME}"
+  end
+
 end

data/lib/ax/element.rb

@@ -187,7 +187,7 @@ class AX::Element
   # @param attr [#to_sym]
   # @param param [Object]
   def parameterized_attribute attr, param
-    param = param.relative_to(@ref.value.size) if value.kind_of? Range
+    param = param.relative_to(@ref.value.size) if param.kind_of? Range
     @ref.parameterized_attribute(TRANSLATOR.cocoaify(attr), param).to_ruby
   end
 
@@ -264,6 +264,8 @@ class AX::Element
   # As the opposite of {#search}, this also takes filters, and can
   # be used to find a specific ancestor for the current element.
   #
+  # Returns `nil` if no ancestor is found.
+  #
   # @example
   #
   #   button.ancestor :window       # => #<AX::StandardWindow>
@@ -272,12 +274,13 @@ class AX::Element
   # @param kind [#to_s]
   # @param filters [Hash{Symbol=>Object}]
   # @yield Optional block used for search filtering
-  # @return [AX::Element]
+  # @return [AX::Element,nil]
   def ancestor kind, filters = {}, &block
     qualifier = Accessibility::Qualifier.new(kind, filters, &block)
-    element   = attribute :parent
+    element   = self
     until qualifier.qualifies? element
       element = element.attribute :parent
+      return nil unless element
     end
     element
   end
@@ -432,7 +435,7 @@ class AX::Element
   def bounds
     CGRect.new(attribute(:position), attribute(:size))
   end
-  alias_method :rect, :bounds
+  alias_method :to_rect, :bounds
 
   ##
   # Get the application object for the element.

data/test/integration/accessibility/test_dsl.rb

@@ -331,4 +331,15 @@ class TestAccessibilityDSL < MiniTest::Unit::TestCase
     pop_up.menu_item.perform :cancel unless pop_up.children.empty?
   end
 
+  def test_contextual_menu
+    Mouse.move_to app.window.web_area
+    menu = nil
+    dsl.right_click do
+      menu = dsl.contextual_menu
+    end
+    refute_nil menu, 'did not find the contextual menu'
+    refute_nil menu.item(title: 'Reload')
+    menu.perform :cancel
+  end
+
 end

data/test/integration/ax/test_element.rb

@@ -10,6 +10,13 @@ class TestAXElement < MiniTest::Unit::TestCase
     assert_equal app.window.close_button, list.first
   end
 
+  def test_parameterized_attribute_normalizes_ranges
+    text = app.main_window.static_text
+    expected = text.value
+    actual   = text.parameterized_attribute :string_for_range, 0..-1
+    assert_equal expected, actual
+  end
+
   def test_search_singular_returns_array
     result = app.search(:window)
     assert_kind_of AX::Window, result

data/test/sanity/accessibility/test_version.rb

@@ -0,0 +1,15 @@
+require 'test/runner'
+require 'accessibility/version'
+
+class TestAccessibilityVersion < MiniTest::Unit::TestCase
+
+  def test_version_is_ascii_only # RubyGems :(
+    assert_equal Accessibility::VERSION.encode(Encoding::ASCII), Accessibility::VERSION
+  end
+
+  def test_version_method
+    assert_match Accessibility::VERSION, Accessibility.version
+    assert_match Accessibility::ENGINE, Accessibility.version
+  end
+
+end

data/test/sanity/ax/test_application.rb

@@ -107,4 +107,8 @@ class TestAXApplication < MiniTest::Unit::TestCase
     assert_equal '1.0', app.version
   end
 
+  def test_ancestor
+    assert_nil app.ancestor(:menu)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: AXElements
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mouse
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: screen_recorder
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.10
+        version: 3.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.10
+        version: 3.2.11
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +176,7 @@ files:
 - test/sanity/accessibility/test_qualifier.rb
 - test/sanity/accessibility/test_string.rb
 - test/sanity/accessibility/test_translator.rb
+- test/sanity/accessibility/test_version.rb
 - test/sanity/ax/test_application.rb
 - test/sanity/ax/test_element.rb
 - test/sanity/ax/test_systemwide.rb
@@ -227,6 +228,7 @@ test_files:
 - test/sanity/accessibility/test_qualifier.rb
 - test/sanity/accessibility/test_string.rb
 - test/sanity/accessibility/test_translator.rb
+- test/sanity/accessibility/test_version.rb
 - test/sanity/ax/test_application.rb
 - test/sanity/ax/test_element.rb
 - test/sanity/ax/test_systemwide.rb