rspec-ax_elements 0.9.0

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,48 @@
+# rspec-ax\_elements
+
+RSpec is a framework for writing tests. AXElements is a library for
+automating GUI interactions on OS X. When you combine them you get
+`rspec-ax_elements`, a powerful tool for writing automated tests for
+GUI applications on OS X.
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/AXElements/rspec-ax_elements)
+
+
+## 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,37 @@
+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 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+
+# Gem stuff
+
+require 'rubygems/package_task'
+SPEC = Gem::Specification.load('rspec-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/rspec/ax_elements/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Accessibility
+    VERSION = '0.9.0'
+  end
+end

data/lib/rspec/expectations/ax_elements.rb

@@ -0,0 +1,234 @@
+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 kind [#to_s]
+    # @param filters [Hash]
+    # @yield Optional block used for search filtering
+    def initialize kind, filters, &block
+      @kind, @filters, @block = kind, filters, block
+    end
+
+    # @param element [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 parent [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 ancestor [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 parent [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 ancestor [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 kind [#to_s]
+# @param filters [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 kind [#to_s]
+# @param filters [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 kind [#to_s]
+# @param filters [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 kind [#to_s]
+# @param filters [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/spec/helper.rb

@@ -0,0 +1,2 @@
+require 'rspec/autorun'
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rspec-ax_elements
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Rada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 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: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !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: ! 'RSpec extensions for using AXElements
+
+'
+email: mrada@marketcircle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/ax_elements/version.rb
+- lib/rspec/expectations/ax_elements.rb
+- Rakefile
+- README.markdown
+- History.markdown
+- .yardopts
+- spec/helper.rb
+homepage: http://github.com/AXElements/rspec-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'
+      segments:
+      - 0
+      hash: -1431659742520994729
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1431659742520994729
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RSpec extensions for using AXElements
+test_files:
+- spec/helper.rb