appium_lib 16.3.1 → 16.4.0

data/docs/docs.md

@@ -1,130 +0,0 @@
-# Documentation
-## API Doc of Ruby Client
-- This library: http://www.rubydoc.info/github/appium/ruby_lib
-- Core: http://www.rubydoc.info/github/appium/ruby_lib_core
-- [Ruby selenium-webdriver](https://github.com/SeleniumHQ/selenium/wiki/Ruby-Bindings)
-
-### General
-- [Appium](https://github.com/appium/appium/blob/master/README.md)
-- [Supported platforms](https://github.com/appium/appium/blob/master/docs/en/about-appium/platform-support.md)
-- [All methods supported by Appium](https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md)
-    - Fundamental Commands: http://appium.io/docs/en/commands/status/ etc
-- [MiniTest Expectations](http://docs.seattlerb.org/minitest/Minitest/Expectations.html)
-
-### Driver types in Ruby Client
-
-```ruby
-# Appium specific driver with helpers available extending Standard Appium Driver.
-@appium_driver = Appium::Driver.new @options, false
-
-# Standard Appium Driver extends Selenium WebDriver.
-@selenium_driver = @appium_driver.start_driver
-```
-
-### Example
-
-Example of automating the built in Android settings.
-
-```ruby
-# run Pry, and paste the following
-apk = { 
-        platformName: 'android',
-        deviceName: :nexus,
-        appPackage: 'com.android.settings',
-        appActivity: '.Settings',
-        appWaitActivity: '.Settings'
-      }
-Appium::Driver.new({caps: apk}, false).start_driver
-```
-
-Example use of Appium's mobile gesture.
-
-
-Long click on an ImageView in Android.
-
-```
-last_image = find_elements(:class, 'ImageView').last
-long_press(element: last_image)
-```
-
-Rotate examples. The behaviour is depends on devices.
-
-```ruby
-driver.rotate :landscape
-driver.rotate :portrait
-```
-
-- `appium_server_version` Discover the Appium rev running on the server.
-- `element.send_keys "msg"` Sends keys to currently active element
-
-
-### APIs
-
-```ruby
-e.name # button, text
-e.value # secure, textfield
-e.type 'some text' # type text into textfield
-e.clear # clear textfield
-e.tag_name # calls .type (patch.rb)
-e.text
-e.size
-e.location
-e.location_rel
-e.click
-e.send_keys 'keys to send'
-e.displayed? # true or false depending if the element is visible
-e.selected? # is the tab selected?
-e.attribute('checked') # is the checkbox checked?
-
-
-# alert example without helper methods
-alert = @driver.switch_to.alert
-alert.text
-alert.accept
-alert.dismiss
-
-# Secure textfield example.
-#
-# Find using default value
-s = textfield 'Password'
-# Enter password
-s.send_keys 'hello'
-# Check value
-s.value == ios_password('hello'.length)
-```
-
---
-
-#### Driver
-- `start_driver` will restart the driver.
-- `x` will quit the driver and exit Pry.
-- `execute_script` calls `@driver.execute_script`
-- `find_element` calls `@driver.find_element`
-- `find_elements` calls `@driver.find_elements`
-- `no_wait` will set implicit wait to 0. `@driver.manage.timeouts.implicit_wait = 0`
-- `set_wait` will set implicit wait to default seconds. `@driver.manage.timeouts.implicit_wait = default`
-- `set_wait(timeout_seconds)` will set implicit wait to desired timeout. `@driver.manage.timeouts.implicit_wait = timeout`
-- `.click` to tap an element.
-- `.send_keys` or `.type` to type on an element.
-
-#### Cucumber Sauce Integration
-
-Reset after each test and when done report the result to Sauce after quiting the driver.
-
-```ruby
-require 'rest_client' # https://github.com/archiloque/rest-client
-require 'json' # for .to_json
-require 'sauce_whisk'
-
-After do |scenario|
-  # end the test session, ignoring any exceptions.
-  ignore { $driver.driver_quit }
-  
-  user   = ENV['SAUCE_USERNAME']
-  key    = ENV['SAUCE_ACCESS_KEY']
-  if user && !user.empty? && key && !key.empty?
-    passed = ! scenario.failed?
-    SauceWhisk::Jobs.change_status $driver.driver.session_id, passed
-  end
-end
-```

data/docs/ios_xcuitest.md

@@ -1,114 +0,0 @@
-## XCUITest
-- Over Appium1.6.0 provides `XCUITest` automation name based on WebDriverAgent.
-    - [appium-xcuitest-driver](https://github.com/appium/appium-xcuitest-driver)
-    - [WebDriverAgent](https://github.com/facebook/WebDriverAgent)
-- How to migrate XCUITest from UIAutomation
-    - [Migrating your iOS tests from UIAutomation](https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md)
-- Mobile gestures for XCUITest
-    - [ios-xctest-mobile-gestures](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md)
-    - Required Appium1.6.4+
-
-## find elements
-- supported elements by find_element are:
-    - [appium-xcuitest-driver](https://github.com/appium/appium-xcuitest-driver/blob/master/lib/commands/find.js#L17)
-        - [locatorStrategies](https://github.com/appium/appium-xcuitest-driver/blob/95886f1118d71fe950768f8262179d3608b40fc7/lib/driver.js#L81)
-    - [WebDriverAgent](https://github.com/facebook/WebDriverAgent/blob/8346199212bffceab24192e81bc0118d65132466/WebDriverAgentLib/Commands/FBFindElementCommands.m#L111)
-- Mapping
-    - https://github.com/facebook/WebDriverAgent/blob/master/WebDriverAgentLib/Utilities/FBElementTypeTransformer.m#L19
-
-### with except for XPath and Predicate
-#### examples
-- [button_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/button.rb#L8), [static_text_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/text.rb#L8), [text_field_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/textfield.rb#L10) and [secure_text_field_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/textfield.rb#L15) provide class name.
-    - If `automationName` is `Appium` or `nil`, then they provide `UIAxxxx`
-    - If `automationName` is `XCUITest`, then they provide `XCUIElementTypexxx`
-
-```ruby
-find_element(:class, button_class) # Return a element of XCUIElementTypeButton for XCUITest
-```
-
-- [tag/s](https://github.com/appium/ruby_lib/blob/ac03116756a72fbd624fa32ea886123b955d7089/lib/appium_lib/android/helper.rb#L238) is alias of `find_element :class, element`
-
-- `accessibility_id`
-
-```ruby
-find_element(:accessibility_id, element) # Return a element which has accessibilityIdentifier, `element`.
-```
-
-- `button/s(value)`, `button_exact/buttons_exact`, `text/s(value)`, `text_exact/texts_exact` 
-```ruby
-buttons(value) # Return button elements include `value` as its name attributes.
-```
-
-### with Predicate
-- We recommend to use predicate strategy instead of XPath strategy.
-    - e.g. `find_ele_by_predicate/find_eles_by_predicate`,  `find_ele_by_predicate_include/find_eles_by_predicate_include`
-- A helpful cheatsheet for predicate
-    - https://realm.io/news/nspredicate-cheatsheet/
-- For XCUITest(WebDriverAgent), without 'wd' prefixes are supported.
-    - https://github.com/facebook/WebDriverAgent/wiki/Queries
-    - For example, `%(name ==[c] "#{value}" || label ==[c] "#{value}" || value ==[c] "#{value}")` is equal to `%(wdName ==[c] "#{value}" || wdLabel ==[c] "#{value}" || wdValue ==[c] "#{value}")` in WebDriverAgent.
-
-#### examples
-- `textfield/s(value)`, `find/s`, `find_exact/finds_exact`, `find_ele_by_predicate/find_eles_by_predicate` and `find_ele_by_predicate_include/find_eles_by_predicate_include` use predicate strategy in their method.
-
-```ruby
-textfield(value) # Return a XCUIElementTypeSecureTextField or XCUIElementTypeTextField element which has `value` text.
-finds_exact(value) # Return any elements include `value` as its name attributes.
-```
-
-### with Class Chain
-- require Appium 1.6.4+
-    - https://github.com/appium/appium-xcuitest-driver/pull/391
-    - https://github.com/appium/java-client/pull/599/files
-- WebDriverAgent
-    - https://github.com/facebook/WebDriverAgent/wiki/Queries
-
-### with XPath
-- It is better to avoid XPath strategy.
-    - https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md#xpath-locator-strategy
-        - > Try not to use XPath locators unless there are absolutely no other alternatives. In general, XPath locators might be times slower, than other types of locators like accessibility id, class name and predicate (up to 100 times slower in some special cases). They are so slow because XPath location is not natively supported by Apple's XCTest framework.
-    - Improved performance a bit
-        - https://github.com/appium/appium/issues/6842
-        - https://github.com/facebook/WebDriverAgent/issues/306
-- XPath in WebDriverAgent
-    - https://github.com/facebook/WebDriverAgent/blob/2158a8d0f305549532f1338fe1e4628cfbd53cd9/WebDriverAgentLib/Categories/XCElementSnapshot%2BFBHelpers.m#L57
-
-#### examples
-
-```ruby
-xpaths("//some xpaths")
-```
-
-## Gesture
-- `mobile:` commands are provided by WDA.
-- Documentations
-    - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md
-- Specs by test code
-    - https://github.com/appium/appium-xcuitest-driver/blob/master/test/functional/basic/gesture-e2e-specs.js
-
-### Workaround
-- `mobile:` commands depends on WDA and Apple's framework and the behaviour depends on them.
-- Sometimes issues occur such as "doubleTap isn't tapping #548"
-    - workaround for it:
-        - with `selenium-webdriver >= 3.4.0`
-            ```ruby
-            def double_tap(element)
-              rect = element.rect
-              execute_script 'mobile: doubleTap', x: rect.x + rect.width / 2, y: rect.y + rect.height / 2
-            end
-            ```        
-        - with `selenium-webdriver < 3.4.0`
-            ```ruby
-              def double_tap(element)
-                size = element.size
-                location = element.location
-                execute_script 'mobile: doubleTap', x: location.x + size.width / 2, y: location.y + size.height / 2
-              end
-            ```
-
-## Other actions
-Basically, other actions such as `type` are compatible with `automationName = Appium`.
-
-## Pasteboard
-- Simulator only
-    - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios-xctest-pasteboard.md

data/docs/parallel.md

@@ -1,8 +0,0 @@
-Appium 1.7.0+ supports single server and multiple sessions, and it requires Xcode 9 for iOS.
-
-# Example
-## Run tests on Multiple Simulators with Xcode 9
-- https://github.com/appium/appium-xcuitest-driver/tree/master/test/functional/parallel
-- https://github.com/appium/ruby_lib/tree/master/ios_tests/parallel
-    - Thread programming: TestParallelRunThread
-    - Process programming: TestParallelRunProcess

data/docs/w3c.md

@@ -1,55 +0,0 @@
-Perform touch actions for W3C module. Generate `touch` pointer action here and users can use this via `driver.action`
-
-[Documentation](http://www.rubydoc.info/github/appium/ruby_lib_core/Appium%2FCore%2FBase%2FCoreBridgeW3C:action)
-
-# Example
-
-```ruby
-dialect #=> :w3c
-
-# then
-el = find_element(:name, 'Pickers')
-driver.action.click(el).perform #=> work
-
-
-# Scroll/Swipe
-driver.action
-      .move_to_location(500, 500).pointer_down(:left)
-      .move_to_location(0, 700)
-      .release.perform
-
-
-# Zoom in
-# multiple action chains
-f1 = driver.action.add_pointer_input(:touch, 'finger1')
-f1.create_pointer_move(duration: 1, x: 200, y: 500,
-                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
-f1.create_pointer_down(:left)
-f1.create_pause(0.5)
-f1.create_pointer_move(duration: 1, x: 200, y: 200,
-                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
-f1.create_pointer_up(:left)
-
-f2 = driver.action.add_pointer_input(:touch, 'finger2')
-f2.create_pointer_move(duration: 1, x: 200, y: 500,
-                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
-f2.create_pointer_down(:left)
-f2.create_pause(0.5)
-f2.create_pointer_move(duration: 1, x: 200, y: 800,
-                   origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
-f2.create_pointer_up(:left)
-
-driver.perform_actions [f1, f2]
-```
-
-# Note
-## Coordinate points
-- jsonwp
-    - Relative action coordinates are counted relatively to the **top left point** of element's rectangle
-- W3C
-    - Relative action coordinates are counted relatively to the **center** of element's rectangle
-
-## Limitations
-- WebDriverAgent support only `touch` as a `pointer type`.
-    - By default, [ruby_lib_core](https://github.com/appium/ruby_lib_core/blob/ab5d7c5ed31f318a9395e5aeafe1d0d655d3cff4/lib/appium_lib_core/common/base/w3c_bridge.rb#L26) generate `touch` based actions.
-    - About `pointer type` => [W3C](https://www.w3.org/TR/webdriver/#perform-actions) and [Simple WD Spec](https://github.com/jlipps/simple-wd-spec#perform-actions)