calabash-page-objects 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53ca9ca6d996a039a9b1e1d04675267a889a3f2a
+  data.tar.gz: 9ef0111bb7e576a8bd1331d3da57cc4a58bdb7e2
+SHA512:
+  metadata.gz: 4fea84b0b3c128459cdbbf9bff64a27d92a50f546ea17c080dc3a23da79bd168e66718715c3478636fb4e4a943888c97c602fa5277b4a13857b7b72b5e639ba7
+  data.tar.gz: 95aa7fa23b22f133189adf2c19b48e8b41bc2c7e64ade82e9110787674ac845d03c4a5622560a7572e09d7c01e229c2812659015550c7165503d7982d8beda4a

data/.gitignore

@@ -0,0 +1,16 @@
+# Created by .gitignore support plugin (hsz.mobi)
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+.idea

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+FileName:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to calabash-page-objects
+
+♥ calabash-page-objects and want to get involved?
+Great! There are plenty of ways you can help!
+
+If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the below guidelines so that we can help you out and/or get your code merged quickly.
+
+## If you find what looks like a bug:
+
+* Check the [GitHub issue tracker](http://github.com/justeat/CalabashPageObjects/issues/) to see if anyone else has reported the issue.
+* Make sure you are using the latest version of calabash-page-objects
+* If you are still having an issue, create an issue including:
+  * Information you will need to reproduce and diagnose the problem
+
+## If you want to contribute an enhancement or a fix:
+
+0. Discuss any major enhancement with the project moderator.
+0. Write your Spec and/or Functional tests.
+0. Write or modify any accompanying documentation.
+0. Ensure that your tests work and your documentation is complete.
+
+
+### General Contribution Guidelines:
+We follow the standard GitHub fork & pull request approach to open source collaboration.
+You can find an awesome description on how this works on the [gun.io blog](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+
+In a nutshell:
+
+0. Fork it.
+0. Create your feature branch (`git checkout -b feature/my-new-feature`).
+0. Commit your changes (`git commit -am 'Add some feature'`) and [reference any issues](https://github.com/blog/831-issues-2-0-the-next-generation).
+0. Push to your branch (`git push origin my-new-feature`).
+0. Send a new Pull Request describing what you have done and why, in detail.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
+license your work under the the terms of the Apache 2.0 license. A copy of this
+license is provided in the root of the repository.

data/CalabashPageObjects.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'CalabashPageObjects/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'calabash-page-objects'
+  spec.version       = CalabashPageObjects::VERSION
+  spec.authors       = ['Alan Nichols and Andrew Barnett']
+  spec.email         = ['alan.nichols@outlook.com']
+  spec.summary       = 'Page Object framework for calabash'
+  spec.description   = 'Page Object frameworks for calabash on iOS and Android'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'calabash-android', '>=0.5.14'
+  spec.add_development_dependency 'calabash-cucumber'
+  spec.add_development_dependency 'geminabox'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-expectations'
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in calabash-page-objects.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    CalabashPageObjects (0.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.3.1)
+    awesome_print (1.6.1)
+    builder (3.2.2)
+    calabash-android (0.5.14)
+      awesome_print (~> 1.2)
+      cucumber (~> 1.3.17)
+      escape (~> 0.0.4)
+      httpclient (>= 2.3.2, < 3.0)
+      json (~> 1.8)
+      retriable (>= 1.3.3.1, < 1.5)
+      rubyzip (~> 1.1)
+      slowhandcuke (~> 0.0.3)
+    calabash-common (0.0.1)
+      cucumber (~> 1.3.0)
+    calabash-cucumber (0.13.0)
+      CFPropertyList
+      awesome_print
+      bundler (~> 1.3)
+      calabash-common (~> 0.0.1)
+      cucumber (~> 1.3.17)
+      edn (>= 1.0.6, < 2.0)
+      geocoder (>= 1.1.8, < 2.0)
+      httpclient (>= 2.3.2, < 3.0)
+      json
+      run_loop (~> 1.2.7)
+      sim_launcher (~> 0.4.13)
+      slowhandcuke (~> 0.0.3)
+    cucumber (1.3.19)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    diff-lcs (1.2.5)
+    edn (1.0.6)
+    escape (0.0.4)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    geminabox (0.12.4)
+      builder
+      faraday
+      httpclient (>= 2.2.7)
+      nesty
+      sinatra (>= 1.2.7)
+    geocoder (1.2.8)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    httpclient (2.6.0.1)
+    json (1.8.3)
+    multi_json (1.11.0)
+    multi_test (0.1.2)
+    multipart-post (2.0.0)
+    nesty (1.0.2)
+    rack (1.6.0)
+    rack-protection (1.5.3)
+      rack
+    retriable (1.4.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubyzip (1.1.7)
+    run_loop (1.2.9)
+      CFPropertyList (~> 2.2)
+      awesome_print (~> 1.2)
+      json (~> 1.8)
+      retriable (>= 1.3.3.1, < 2.0)
+    sim_launcher (0.4.13)
+      sinatra
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slowhandcuke (0.0.3)
+      cucumber
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  CalabashPageObjects!
+  bundler (~> 1.6)
+  calabash-android (>= 0.5.14)
+  calabash-cucumber
+  geminabox
+  rspec
+  rspec-expectations
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.MD

@@ -0,0 +1,7 @@
+Copyright 2015 JUST EAT plc
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/README.md

@@ -0,0 +1,244 @@
+#CalabashPageObjects
+=====================
+
+The Calabash Page Object ruby gem provides a way to define on-screen elements in your application. These elements then have methods defined to make interacting with them in a Calabash test framework easier and more consistent across iOS and Android.
+
+The methods can be used whether the application is on iOS or Android.
+
+Defining an element in Android `AElement.new` (or `IElement.new` for iOS) will provide you with methods to wait for that element, find it with or without scrolling, click it, retrieve properties etc. Using the gem takes away the headache of having cater for scrolling depending on screen size, dealing with several scrollviews and interacting with elements inside webviews.
+
+#Getting Started
+
+##Installing the gem
+```
+gem install 'CalabashPageObjects'
+```
+or add the following to your Gemfile if you use Bundler:
+```
+gem 'CalabashPageObjects'
+```
+Then require it in your page object class:
+```
+require 'CalabashPageObjects'
+```
+
+##Defining Elements
+
+There are two different types of element made available in the gem, IElement (for iOS apps) and AElement (for Android apps). These two classes provide exactly the same functionality, but abstract away slight differences in implementation between the platforms.
+
+The constructors of both classes take a Calabash query string as their only argument. More information about the Calabash query syntax can be found [here](https://github.com/calabash/calabash-android/wiki/05-Query-Syntax).
+
+###For Android:
+To define elements for an Android app:
+```
+require 'CalabashPageObjects'
+class HomeScreen
+
+  def initialize
+    @my_element = AElement.new("* id:'search_button'")
+  end
+...
+```
+
+###iOS
+To define elements for an iOS app:
+```
+require 'CalabashPageObjects'
+class HomeScreen
+
+  def initialize
+    @my_element = IElement.new("* id:'search_button'")
+  end
+...
+```
+
+#Methods (for iOS and Android)
+
+Both AElement and IElement have the same methods. All of the methods take options as a hash. However, many of the methods have defaults set for some of their arguments and in many cases these won't need to be changed.
+
+###screen_query
+Queries the current screen using the elements locator.
+This will return an array of hashes of each element on the screen that matches your locator. This is useful for counting objects with @my_element.screen_query.size, or you can delve further into an element's attributes.
+
+#####Example
+```
+@my_element.screen_query
+```
+
+###when_visible
+Waits a number of seconds for the element to be present. As soon as it is, the method will return.
+#####Args
+```
+Can take an argument for timeout. Default is 10 seconds.
+```
+
+#####Example
+```
+@my_element.when_visible(30)
+```
+Use this method to make sure a particular screen/element has loaded before continuing the test run. See 'present?' if you want to assert on the presence of an element.
+
+###when_not_visible
+Will wait a full amount of seconds for the element to not be on the screen.
+#####Args
+```
+Can take an argument for timeout. Default is 10 seconds.
+```
+
+#####Example
+```
+@my_element.when_not_visible(30)
+```
+
+###present?
+Checks to see if the element is present. Returns a boolean. Can optionally scroll in search of the element.
+#####Args
+```
+Can take an argument for timeout. Default is 0.1.
+Can take an argument for parent. Default is nil
+Can take an argument for webview. Default is false
+Can take an argument for scroll. Default is false. 
+```
+
+#####Example
+```
+@my_element.present?(timeout: 2, scroll: true)
+```
+The method will wait 'timeout' seconds for the element to be present on the screen. If 'scroll' is set to true, the method will wait 'timeout' seconds for the element to be present, and if it is not, it will automatically start scrolling to find it. It will return true if the element is found during this time and it will return false if it has reached the bottom of the screen and it hasn't found the element anywhere.
+
+###prod
+This is probably the method you'll use the most. It is our method for tapping the element. We made sure that we used new methods names so that you can still use the regular Calabash Operations methods as well as ours.
+#####Args
+```
+Can take an argument for timeout.  Default is 1 second. 
+Can take an argument for parent. Default is nil.
+Can take an argument for webview. Default is false.
+```
+
+```
+@my_element.prod
+```
+It will wait 'timeout' seconds for an element to be present before scrolling to find it. The beauty of this method is you can now both wait for an element to be present and tap it using the same method. Just include an integer or float for however long you want to wait for it as the timeout!
+
+###input
+Clears the text in an element and then enters the text that is passed in.
+#####Args
+```
+Always takes a string argument for 'value'. 
+Can take an argument for timeout. Default is 1 second. Works in the same way as the 'prod' method.
+Can take an argument for parent. Default is nil.
+Can take an argument for webview. Default is false.
+```
+Value is is the text you want to enter. It should be the first parameter passed in.
+
+#####Example
+```
+@my_element.input('email@email.com', parent: @form_scrollview)
+```
+
+###check
+Sets a checkbox element to 'checked' state.
+#####Args
+```
+Can take an argument for timeout. Default is 1 second.
+Can take an argument for parent. Default is nil.
+Can take an argument for webview. Default is false.
+```
+
+#####Example
+```
+@my_checkbox.check
+```
+Will scroll to find the element after the timeout has elapsed.
+
+###uncheck
+Works in the same way as 'check' except sets the state of the checkbox to 'unchecked'.
+#####Args
+```
+Can take an argument for timeout. Default is 1 second.
+Can take an argument for parent. Default is nil.
+Can take an argument for webview. Default is false.
+```
+
+#####Example
+```
+@my_checkbox.uncheck
+```
+Will scroll to find the element after the timeout has elapsed.
+
+###checked?
+Finds the checked status of a checkbox element. Returns true if it's checked and false if it's unchecked.
+
+#####Args
+```
+Can take an argument for timeout.  Default is 1 second.
+Can take an argument for parent. Default is nil.
+Can take an argument for webview. Default is false.
+```
+
+#####Example
+```
+@my_checkbox.checked?
+```
+Will scroll to find the element after the timeout has elapsed.
+
+###text
+Retrieves the text attribute of an element and returns it as a string.
+
+#####Args
+```
+Can take an argument for timeout. Default is 1 second.
+Can take an argument for parent. Default is nil.
+Can take an argument for webview. Default is false.
+```
+
+#####Example
+```
+@my_element.text
+```
+Will scroll to find the element after the timeout has elapsed.
+
+#Parameter usage
+###Some examples:
+
+The AElement @my_element has a method called 'prod' which will tap it. It can accept values for the timeout for the element to appear, a secondary 'parent' element that your element lives inside, and whether the element is in a webview. The defaults for these values are as follows:
+```
+timeout: 1
+parent: nil
+webview: false
+```
+so if the defaults are suitable then the prod method can be called with no arguments:
+`@my_element.prod`
+
+but to run the method in a situation where the defaults are not suitable, you can override as many as you like. In this example we override timeout and webview, but not parent:
+`@my_element.prod(timeout: 10, webview: true)`
+
+###Shorthand for timeout
+As in most cases, the only default that will be overridden is the timeout. There is a shorthand implemented especially for doing this. If the only argument passed in is an integer or float, then it is assumed that it is a timeout and all other arguments are left as default:
+`@my_element.prod(10)`
+
+###Parent elements
+Most of the generated methods contain optional functionality to search the screen for your element.  This is useful in cases where your element may not be visible on the screen.  By default, Calabash scrolls down the first scrollable view in the hierarchy to look for your element, which isn't always the required behaviour.  In these cases, it is necessary to specify the parent element that you want to scroll through to find your element.
+
+For example the 'prod' method will scroll through the screen to find your element and then tap it.  To make Calabash scroll through a specific scrollable view you can pass a Calabash query string locator for that scroll view element as an argument.
+
+`@my_element.prod(parent: "* id:'my_list_container'")`
+
+However, it is not good practice to use hardcoded strings any more than necessary.  To assist with this, a 'locator' attritute is provided to return the Calabash query string for an element.  This means that the parent element that you want to scroll through can be defined in the same way as all of your other elements.
+
+e.g.
+```
+require 'CalabashPageObjects'
+class PageObjectClass
+
+  def initialize
+    @my_element = IElement.new("* id:'search_button'")
+    @my_parent_element = IElement.new("* id:'my_list_container'")
+  end
+  
+  def tap_my_element
+    @my_element.prod(parent: @my_parent_element.locator)
+  end
+...
+```
+Note: passing in an element for 'parent' rather than its locator will not work at present.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'geminabox'
+
+task :build do
+  system 'gem build CalabashPageObjects.gemspec'
+end
+
+task upload_to_internal_server: :build do
+  system "gem inabox pkg/CalabashPageObjects-#{CalabashPageObjects::VERSION}.gem -g http://gems.ict.je-labs.com:8808"
+end

data/lib/CalabashPageObjects.rb

@@ -0,0 +1,9 @@
+require 'calabash-android'
+require 'calabash-cucumber'
+require 'CalabashPageObjects/version'
+require 'CalabashPageObjects/element_base'
+require 'CalabashPageObjects/aelement'
+require 'CalabashPageObjects/ielement'
+# Calabash Page Objects module.
+module CalabashPageObjects
+end

data/lib/CalabashPageObjects/aelement.rb

@@ -0,0 +1,11 @@
+# The android specific implementation of ElementBase.
+class AElement < ElementBase
+  include Calabash::Android::WaitHelpers
+  include Calabash::Android::Operations
+  include Calabash::Android::TextHelpers
+
+  def initialize(*args)
+    @wait_error = Calabash::Android::WaitHelpers::WaitError
+    super(*args)
+  end
+end

data/lib/CalabashPageObjects/element_base.rb

@@ -0,0 +1,141 @@
+require_relative 'element_base_option_parser'
+require_relative 'element_finder'
+# The main class for functionality for defined elements.
+class ElementBase
+  include ElementBaseOptionParser
+  include ElementFinder
+
+  attr_reader :locator
+
+  CPO_LOGGING ||= false
+
+  # Constructor for ElementBase.
+  # Takes an argument for the Calabash Query that locates the object.
+  def initialize(locator)
+    @locator = locator
+  end
+
+  # Queries the current screen using the elements locator.
+  def screen_query
+    query("#{@locator}")
+  end
+
+  # Waits for an element to be visible on the current screen.
+  # Can take an argument for timeout. Default is 10 seconds.
+  def when_visible(options = {})
+    opts = options_parser(options, timeout: 10)
+    puts "Waiting for element with locator #{@locator} to appear..." if CPO_LOGGING
+    wait_for_element_exists(@locator, timeout: opts[:timeout], screenshot_on_error: false)
+  end
+
+  # Waits for an element to not be visible on the current screen.
+  # Can take an argument for timeout. Default is 10 seconds.
+  def when_not_visible(options = {})
+    opts = options_parser(options, timeout: 10)
+    puts "Waiting for element with locator #{@locator} to not be present..." if CPO_LOGGING
+    wait_for_element_does_not_exist(@locator, timeout: opts[:timeout], screenshot_on_error: false)
+  end
+
+  # Checks to see if the element is present. Can optionally scroll down to try and find the element.
+  # Can take an argument for timeout. Default is 0.5 as 0 can cause calabash to hang.
+  # Can take an argument for parent. Default is nil
+  # Can take an argument for webview. Default is false
+  # Can take an argument for scroll. Default is false
+  def present?(options = {})
+    opts = options_parser(options, timeout: 0.5, parent: nil, webview: false, scroll: false)
+    if opts[:scroll]
+      find(opts[:timeout], opts[:parent], opts[:webview])
+    else
+      puts "Checking for the presence of an element with locator #{@locator} after #{opts[:timeout]} seconds..." if CPO_LOGGING
+      begin
+        wait_for_element_exists(@locator, timeout: opts[:timeout], screenshot_on_error: false)
+        true
+      rescue
+        false
+      end
+    end
+  end
+
+  # Taps the element.
+  # Can take an argument for timeout. Default is 1 second
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def prod(options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    sleep 0.1
+    puts "Touching an element with locator #{@locator}." if CPO_LOGGING
+    touch(@locator)
+  end
+
+  # Clears the text in an element and then enters the text that is passed into the method.
+  # Always takes an argument for 'value'.
+  # Can take an argument for timeout. Default is 1 second.
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def input(value, options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    puts "Clearing text from element with locator #{@locator}..." if CPO_LOGGING
+    clear_text_in(@locator)
+    puts "Entering text in element with locator #{@locator}..." if CPO_LOGGING
+    enter_text(@locator, value)
+  end
+
+  # Set a checkbox element to 'checked' state.
+  # Can take an argument for timeout. Default is 1 second.
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def check(options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    puts "Setting checkbox with locator #{@locator} to checked..." if CPO_LOGGING
+    query("#{@locator}", setChecked: true)
+  end
+
+  # Set a checkbox element to 'unchecked' state.
+  # Can take an argument for timeout. Default is 1 second.
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def uncheck(options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    puts "Setting checkbox with locator #{@locator} to unchecked..." if CPO_LOGGING
+    query("#{@locator}", setChecked: false)
+  end
+
+  # Find the checked status of a checkbox element.
+  # Can take an argument for timeout. Default is 1 second.
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def checked?(options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    puts "Checking status of checkbox element with locator #{@locator}." if CPO_LOGGING
+    query("#{@locator}", :isChecked)
+  end
+
+  # Retrieve the text attribute of an element.
+  # Can take an argument for timeout. Default is 1 second.
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def text(options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    puts "Retrieving text from element with locator #{@locator}..." if CPO_LOGGING
+    query("#{@locator}", :text)[0]
+  end
+
+  # Search the whole screen for an element, scrolling down if it doesn't find it after the timeout.
+  # Can take an argument for timeout. Default is 1 second.
+  # Can take an argument for parent. Default is nil.
+  # Can take an argument for webview. Default is false.
+  def look_for(options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+    fail @wait_error, "Timeout waiting for element with locator #{@locator}" unless find(opts[:timeout], opts[:parent], opts[:webview])
+  end
+end

data/lib/CalabashPageObjects/element_base_option_parser.rb

@@ -0,0 +1,15 @@
+# A class that handles merging of default options.
+module ElementBaseOptionParser
+  # Merges provided options with defaults.
+  def options_parser(input_options, defaults = {})
+    if input_options.is_a?(Integer) || input_options.is_a?(Float)
+      timeout_only_output_options = {}
+      timeout_only_output_options[:timeout] = input_options
+      timeout_only_output_options
+    else
+      defaults.merge(input_options)
+    end
+  end
+
+  private :options_parser
+end

data/lib/CalabashPageObjects/element_finder.rb

@@ -0,0 +1,49 @@
+# Provides a method that searches the screen for an element.
+module ElementFinder
+  CPO_LOGGING ||= false
+
+  # Searches the screen for an element if it isn't visible after an initial delay.
+  def find(initial_delay, parent, webview)
+    puts "Looking for element with locator #{@locator} and an initial delay of #{initial_delay} seconds." if CPO_LOGGING
+    return true if present?(initial_delay)
+
+    puts 'Element has not been found within initial_delay.' if CPO_LOGGING
+    element_present = false
+    current_screen_state = query_screen(webview)
+    prev_screen_state = []
+
+    while !element_present && current_screen_state != prev_screen_state
+      puts 'Element not found. Scrolling...' if CPO_LOGGING
+      prev_screen_state = current_screen_state
+      scroll_down_the_screen(parent, webview)
+      current_screen_state = query_screen(webview)
+      element_present = present?(0.4)
+    end
+
+    element_present
+  end
+
+  def query_screen(webview)
+    webview ? current_screen_state = query("webview css:'*'") : current_screen_state = query('*')
+    current_screen_state
+  end
+
+  def scroll_down_the_screen(parent, webview)
+    if !parent.nil?
+      puts "Scrolling down parent element - #{parent.locator}." if CPO_LOGGING
+      scroll(parent.locator, :down)
+    elsif webview
+      puts "Scrolling down the default webview." if CPO_LOGGING
+      scroll('webview', :down)
+    else
+      begin
+        puts 'Scrolling down the default element.' if CPO_LOGGING
+        scroll_down
+      rescue
+        puts 'View is not currently scrollable.'
+      end
+    end
+  end
+
+  private :find, :query_screen, :scroll_down_the_screen
+end

data/lib/CalabashPageObjects/ielement.rb

@@ -0,0 +1,30 @@
+# The ios specific implementation of ElementBase.
+class IElement < ElementBase
+  include Calabash::Cucumber::Core
+  include Calabash::Cucumber::WaitHelpers
+  include Calabash::Cucumber::KeyboardHelpers
+
+  def initialize(*args)
+    @wait_error = Calabash::Cucumber::WaitHelpers::WaitError
+    super(*args)
+  end
+
+  # Need to override the method in the Element class as this one has a different name in the iOS libs.
+  # Waits for an element to not be present.
+  # Can take an argument for timeout. Default is 10 seconds.
+  def when_not_visible(options = {})
+    opts = options_parser(options, timeout: 10)
+    puts "Waiting for element with locator #{@locator} to not be present..." if CPO_LOGGING
+    wait_for_element_does_not_exists(@locator, timeout: opts[:timeout], screenshot_on_error: false)
+  end
+
+  # The ios libs have a different name for the method to clear the test from a field.
+  def input(value, options = {})
+    opts = options_parser(options, timeout: 1, parent: nil, webview: false)
+    find(opts[:timeout], opts[:parent], opts[:webview])
+    puts "Clearing text from element with locator #{@locator}..." if CPO_LOGGING
+    clear_text(@locator)
+    puts "Entering text in element with locator #{@locator}..." if CPO_LOGGING
+    enter_text(@locator, value)
+  end
+end

data/lib/CalabashPageObjects/version.rb

@@ -0,0 +1,4 @@
+# Version information.
+module CalabashPageObjects
+  VERSION = '0.5.2'
+end

data/specs/android_page_object.rb

@@ -0,0 +1,70 @@
+require 'calabash-page-objects'
+# Page object for tests.
+class AndroidPageObjectClass
+  # rubocop:disable CyclomaticComplexity
+  # rubocop:disable PerceivedComplexity
+  # rubocop:disable AbcSize
+  def initialize
+    @my_element = AElement.new("* text:'ggg'")
+  end
+
+  def try_all_methods
+    begin
+      @my_element.screen_query
+      @my_element.touch('asdf')
+
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.when_visible
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.when_not_visible
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.present?
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.prod
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.input('test_string')
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.check
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.uncheck
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.checked?
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.text
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+    begin
+      @my_element.look_for
+    rescue RuntimeError => e
+      raise unless e.message == 'No connected devices'
+    end
+  end
+end

data/specs/ios_page_object.rb

@@ -0,0 +1,68 @@
+require 'calabash-page-objects'
+# Page object for tests.
+class IosPageObjectClass
+  # rubocop:disable CyclomaticComplexity
+  # rubocop:disable PerceivedComplexity
+  # rubocop:disable AbcSize
+  def initialize
+    @my_element = IElement.new("* text:'ggg'")
+  end
+
+  def try_all_methods
+    begin
+      @my_element.screen_query
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.when_visible
+    rescue RuntimeError => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265) (Errno::ECONNREFUSED)'
+    end
+    begin
+      @my_element.when_not_visible
+    rescue RuntimeError => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265) (Errno::ECONNREFUSED)'
+    end
+    begin
+      @my_element.present?
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.prod
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.input('test_string')
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.check
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.uncheck
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.checked?
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.text
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+    begin
+      @my_element.look_for
+    rescue Errno::ECONNREFUSED => e
+      raise unless e.message == 'Connection refused - connect(2) (http://localhost:37265)'
+    end
+  end
+end

data/specs/test_spec.rb

@@ -0,0 +1,18 @@
+require 'rspec'
+require 'rspec/expectations'
+require_relative 'android_page_object'
+require_relative 'ios_page_object'
+include RSpec
+extend RSpec::Matchers
+
+RSpec.describe calabash-page-objects do
+  it 'android has inherited methods' do
+    android_page_object = AndroidPageObjectClass.new
+    android_page_object.try_all_methods
+  end
+
+  it 'ios has inherited methods' do
+    ios_page_object = IosPageObjectClass.new
+    ios_page_object.try_all_methods
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: calabash-page-objects
+version: !ruby/object:Gem::Version
+  version: 0.5.2
+platform: ruby
+authors:
+- Alan Nichols and Andrew Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: calabash-android
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.14
+- !ruby/object:Gem::Dependency
+  name: calabash-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Page Object frameworks for calabash on iOS and Android
+email:
+- alan.nichols@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CONTRIBUTING.md
+- CalabashPageObjects.gemspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.MD
+- README.md
+- Rakefile
+- lib/CalabashPageObjects.rb
+- lib/CalabashPageObjects/aelement.rb
+- lib/CalabashPageObjects/element_base.rb
+- lib/CalabashPageObjects/element_base_option_parser.rb
+- lib/CalabashPageObjects/element_finder.rb
+- lib/CalabashPageObjects/ielement.rb
+- lib/CalabashPageObjects/version.rb
+- specs/android_page_object.rb
+- specs/ios_page_object.rb
+- specs/test_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Page Object framework for calabash
+test_files: []