minitest-ax_elements 1.0.0.beta

data/.yardopts

@@ -0,0 +1,12 @@
+--no-cache
+--no-output
+--verbose
+--markup markdown
+--markup-provider redcarpet
+--asset docs/images:images
+--readme README.markdown
+--hide-void-return
+lib/**/*.rb
+-
+History.markdown
+

data/History.markdown

@@ -0,0 +1,4 @@
+# 1.0.0
+
+  * Extracted from AXElements
+

data/README.markdown

@@ -0,0 +1,46 @@
+# minitest-ax\_elements
+
+minitest is a library for writing tests. AXElements is a library for
+automating GUI interactions on OS X. When you combine them you get
+`minitest-ax_elements`, a powerful tool for writing automated tests for
+GUI applications on OS X.
+
+
+## Examples
+
+TODO...
+
+
+## Documentation
+
+TODO...
+
+
+## Copyright
+
+Copyright (c) 2012, Mark Rada
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of Mark Rada nor the names of its
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL Mark Rada BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,40 @@
+if defined? MACRUBY_REVISION
+  require 'rubygems'
+  def on_macruby?
+    true
+  end
+else
+  def on_macruby?
+    false
+  end
+end
+
+def on_mri?
+  !on_macruby?
+end
+
+task :default => :test
+
+
+# Testing
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << '.'
+  t.pattern = "test/**/*_test.rb"
+end
+
+
+# Gem stuff
+
+require 'rubygems/package_task'
+SPEC = Gem::Specification.load('minitest-ax_elements.gemspec')
+
+Gem::PackageTask.new(SPEC) { }
+
+desc 'Build and install gem (not including deps)'
+task :install => :gem do
+  require 'rubygems/installer'
+  Gem::Installer.new("pkg/#{SPEC.file_name}").install
+end
+

data/lib/minitest/ax_elements.rb

@@ -0,0 +1,180 @@
+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 parent [AX::Element]
+  # @param kind [#to_s]
+  # @param filters [Hash]
+  # @yield Optional block used for filtering
+  # @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 ancestor [AX::Element]
+  # @param kind [#to_s]
+  # @param filters [Hash]
+  # @yield Optional block used for filtering
+  # @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 kind [#to_s]
+  # @param filters [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 parent [AX::Element]
+  # @param kind [#to_s]
+  # @param filters [Hash]
+  # @yield An optional block to be used in the search qualifier
+  # @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 ancestor [AX::Element]
+  # @param kind [#to_s]
+  # @param filters [Hash]
+  # @yield An optional block to be used in the search qualifier
+  # @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 kind [#to_s]
+  # @param filters [Hash]
+  # @yield An optional block to be used in the search qualifier
+  # @return [nil]
+  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/minitest/ax_elements/version.rb

@@ -0,0 +1,6 @@
+module MiniTest
+  module Accessibility
+    VERSION = '1.0.0.beta'
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: minitest-ax_elements
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+  prerelease: 6
+platform: ruby
+authors:
+- Mark Rada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: AXElements
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+description: ! 'MiniTest extensions for using AXElements
+
+'
+email: mrada@marketcircle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/minitest/ax_elements/version.rb
+- lib/minitest/ax_elements.rb
+- Rakefile
+- README.markdown
+- History.markdown
+- .yardopts
+- test/helper.rb
+homepage: http://github.com/AXElements/minitest-ax_elements
+licenses:
+- BSD 3-clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: MiniTest extensions for using AXElements
+test_files:
+- test/helper.rb