appium_lib 9.3.8 → 9.4.0

data/docs/ios_xcuitest.md

@@ -79,5 +79,12 @@ finds_exact(value) # Return any elements include `value` as its name attributes.
 xpaths("//some xpaths")
 ```
 
+## Gesture
+- `mobile:` commands are provided by WDA.
+- Documentations
+    - https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/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
+
 ## Other actions
 Basically, other actions such as `type` are compatible with `automationName = Appium`.

data/ios_tests/lib/ios/specs/ios/xcuitest_gestures.rb

@@ -0,0 +1,61 @@
+# rake ios[ios/xcuitest_gestures]
+describe 'ios/xcuitest_gestures' do
+  def before_first
+    screen.must_equal catalog
+  end
+
+  def after_last
+    screen.must_equal catalog
+  end
+
+  t 'before_first' do
+    before_first
+  end
+
+  t 'tap' do
+    element = text('controls')
+    tap(x: 0, y: 0, element: element)
+  end
+
+  t 'double_tap' do
+    element = button('Tinted')
+    double_tap(element: element)
+  end
+
+  t 'scroll' do
+    scroll direction: 'down'
+    text('Style Default').displayed?.must_be true
+  end
+
+  t 'swipe' do
+    swipe direction: 'down'
+    swipe direction: 'down'
+
+    proc { text('Style Default') }.must_raise ::Selenium::WebDriver::Error::NoSuchElementError
+  end
+
+  t 'pinch' do
+    pinch(scale: 0.5, velocity: -1)
+  end
+
+  t 'back to top' do
+    back_click
+  end
+
+  t 'select_picker_wheel' do
+    element = text('pickers')
+    tap(x: 0, y: 0, element: element)
+
+    e = find_element :name, 'John Appleseed'
+    select_picker_wheel(element: e, order: 'next')
+
+    e.displayed?.must_be false
+    find_element(:name, 'Serena Auroux').displayed?.must_be true
+
+    back_click
+  end
+
+  t 'after_last' do
+    after_last
+  end
+end

data/lib/appium_lib/android/element/button.rb

@@ -7,31 +7,20 @@ module Appium
     private
 
     # @private
-    def _button_visible_selectors(opts = {})
-      button_index       = opts.fetch :button_index, false
-      image_button_index = opts.fetch :image_button_index, false
-
-      if button_index && image_button_index
-        "new UiSelector().className(#{Button}).instance(#{button_index});" \
-          "new UiSelector().className(#{ImageButton}).instance(#{image_button_index});"
-      else
-        "new UiSelector().className(#{Button});" \
-          "new UiSelector().className(#{ImageButton});"
-      end
+    def _button_visible_selectors
+      "//#{Button}|#{ImageButton}"
     end
 
     # @private
     def _button_exact_string(value)
-      button       = string_visible_exact Button, value
-      image_button = string_visible_exact ImageButton, value
-      button + image_button
+      string_visible_exact(Button, value) +
+          string_visible_exact(ImageButton, value).sub(/\A\/\//, '|')
     end
 
     # @private
     def _button_contains_string(value)
-      button       = string_visible_contains Button, value
-      image_button = string_visible_contains ImageButton, value
-      button + image_button
+      string_visible_contains(Button, value) +
+          string_visible_contains(ImageButton, value).sub(/\A\/\//, '|')
     end
 
     public
@@ -47,10 +36,12 @@ module Appium
         index = value
         raise "#{index} is not a valid index. Must be >= 1" if index <= 0
 
-        return find_element :uiautomator, _button_visible_selectors(index: index)
+        result = find_elements(:xpath, _button_visible_selectors)[value - 1]
+        raise Selenium::WebDriver::Error::NoSuchElementError unless result
+        return result
       end
 
-      find_element :uiautomator, _button_contains_string(value)
+      find_element :xpath, _button_contains_string(value)
     end
 
     # Find all buttons containing value.
@@ -58,43 +49,36 @@ module Appium
     # @param value [String] the value to search for
     # @return [Array<Button>]
     def buttons(value = false)
-      return find_elements :uiautomator, _button_visible_selectors unless value
-      find_elements :uiautomator, _button_contains_string(value)
+      return find_elements :xpath, _button_visible_selectors unless value
+      find_elements :xpath, _button_contains_string(value)
     end
 
     # Find the first button.
     # @return [Button]
     def first_button
-      find_element :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
+      find_element :xpath, _button_visible_selectors
     end
 
     # Find the last button.
     # @return [Button]
     def last_button
-      # uiautomator index doesn't support last
-      # and it's 0 indexed
-      button_index = tags(Button).length
-      button_index -= 1 if button_index > 0
-      image_button_index = tags(ImageButton).length
-      image_button_index -= 1 if image_button_index > 0
-
-      find_element :uiautomator,
-                   _button_visible_selectors(button_index: button_index,
-                                             image_button_index: image_button_index)
+      result = find_elements(:xpath, _button_visible_selectors).last
+      raise Selenium::WebDriver::Error::NoSuchElementError unless result
+      result
     end
 
     # Find the first button that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [Button]
     def button_exact(value)
-      find_element :uiautomator, _button_exact_string(value)
+      find_element :xpath, _button_exact_string(value)
     end
 
     # Find all buttons that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<Button>]
     def buttons_exact(value)
-      find_elements :uiautomator, _button_exact_string(value)
+      find_elements :xpath, _button_exact_string(value)
     end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/helper.rb

@@ -286,19 +286,15 @@ module Appium
     # @param value [String] the value to search for
     # @return [String]
     def string_visible_contains(class_name, value)
-      value = %("#{value}")
+      r_id = resource_id(value, " or @resource-id='#{value}'")
 
       if class_name == '*'
-        return (resource_id(value, "new UiSelector().resourceId(#{value});") +
-          "new UiSelector().descriptionContains(#{value});" \
-          "new UiSelector().textContains(#{value});")
+        return "//*[contains(translate(@text,'#{value.upcase}', '#{value}'), '#{value}')" \
+            " or contains(translate(@content-desc,'#{value.upcase}', '#{value}'), '#{value}')" + r_id + ']'
       end
 
-      class_name = %("#{class_name}")
-
-      resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
-        "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
-        "new UiSelector().className(#{class_name}).textContains(#{value});"
+      "//#{class_name}[contains(translate(@text,'#{value.upcase}', '#{value}'), '#{value}')" \
+        " or contains(translate(@content-desc,'#{value.upcase}', '#{value}'), '#{value}')" + r_id + ']'
     end
 
     # Find the first element that contains value
@@ -306,7 +302,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_find_contains(element, value)
-      find_element :uiautomator, string_visible_contains(element, value)
+      find_element :xpath, string_visible_contains(element, value)
     end
 
     # Find all elements containing value
@@ -314,7 +310,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def complex_finds_contains(element, value)
-      find_elements :uiautomator, string_visible_contains(element, value)
+      find_elements :xpath, string_visible_contains(element, value)
     end
 
     # @private
@@ -323,19 +319,13 @@ module Appium
     # @param value [String] the value to search for
     # @return [String]
     def string_visible_exact(class_name, value)
-      value = %("#{value}")
+      r_id = resource_id(value, " or @resource-id='#{value}'")
 
       if class_name == '*'
-        return (resource_id(value, "new UiSelector().resourceId(#{value});") +
-          "new UiSelector().description(#{value});" \
-          "new UiSelector().text(#{value});")
+        return "//*[@text='#{value}' or @content-desc='#{value}'" + r_id + ']'
       end
 
-      class_name = %("#{class_name}")
-
-      resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
-        "new UiSelector().className(#{class_name}).description(#{value});" \
-        "new UiSelector().className(#{class_name}).text(#{value});"
+      "//#{class_name}[@text='#{value}' or @content-desc='#{value}'" + r_id + ']'
     end
 
     # Find the first element exactly matching value
@@ -343,7 +333,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_find_exact(class_name, value)
-      find_element :uiautomator, string_visible_exact(class_name, value)
+      find_element :xpath, string_visible_exact(class_name, value)
     end
 
     # Find all elements exactly matching value
@@ -351,7 +341,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_finds_exact(class_name, value)
-      find_elements :uiautomator, string_visible_exact(class_name, value)
+      find_elements :xpath, string_visible_exact(class_name, value)
     end
 
     # Returns XML string for the current page

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '9.3.8'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2017-04-13'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.4.0'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-04-17'.freeze unless defined? ::Appium::DATE
 end

data/lib/appium_lib/driver.rb

@@ -24,6 +24,7 @@ require_relative 'ios/element/generic'
 require_relative 'ios/element/textfield'
 require_relative 'ios/element/text'
 require_relative 'ios/mobile_methods'
+require_relative 'ios/xcuitest_gestures'
 
 # android
 require_relative 'android/helper'
@@ -411,6 +412,7 @@ module Appium
       else
         # load iOS specific methods
         extend Appium::Ios
+        extend Appium::Ios::XcuitestGesture if automation_name_is_xcuitest? # Override touch actions
       end
 
       # apply os specific patches

data/lib/appium_lib/ios/xcuitest_gestures.rb

@@ -0,0 +1,144 @@
+module Appium
+  module Ios
+    module XcuitestGesture
+      # @param [string] direction Either 'up', 'down', 'left' or 'right'.
+      # @option opts [Element] :element Element to swipe on
+      #
+      #   ```ruby
+      #   swipe direction: "down"
+      #   ```
+      def swipe(direction:, element: nil)
+        return unless %w(up down left right).include?(direction)
+
+        args = { direction: direction }
+        args[:element] = element.ref if element
+
+        execute_script 'mobile: swipe', args
+      end
+
+      # @param [string] direction Either 'up', 'down', 'left' or 'right'.
+      # @option opts [String] :name the accessibility id of the child element, to which scrolling is performed.
+      # @option opts [Element] :element Element id to long tap on.
+      # @option opts [bool] :to_visible Boolean parameter. If set to true then asks to scroll to the first visible
+      #   element in the parent container. Has no effect if element is not set
+      # @option opts [String] :predicate_string the NSPredicate locator of the child element,
+      #   to which the scrolling should be performed. Has no effect if element is not a container
+      #
+      #   ```ruby
+      #   scroll direction: "down"
+      #   ```
+      def scroll(direction:, name: nil, element: nil, to_visible: nil, predicate_string: nil)
+        return 'Set "up", "down", "left" or "right" for :direction' unless %w(up down left right).include?(direction)
+
+        args =  { direction: direction }
+        args[:element] = element.ref if element
+        args[:name] = name if name
+        args[:toVisible] = to_visible if to_visible
+        args[:predicateString] = predicate_string if predicate_string
+
+        execute_script 'mobile: scroll', args
+      end
+
+      # @param scale [scale] X tap coordinate of type float. Mandatory parameter
+      # @param velocity [float] Y tap coordinate of type float. Mandatory parameter
+      # @option opts [Element] :element Element id to long tap on.
+      #
+      #   ```ruby
+      #   pinch scale: 0.5, velocity: -1
+      #   ```
+      def pinch(scale:, velocity: 1.0, element: nil)
+        return unless automation_name_is_xcuitest?
+
+        args = { scale: scale, velocity: velocity }
+        args[:element] = element.ref if element
+
+        execute_script 'mobile: pinch', args
+      end
+
+      # @param x [float] X Screen x tap coordinate of type float. Mandatory parameter only if element is not set
+      # @param y [float] Y Screen y tap coordinate of type float. Mandatory parameter only if element is not set
+      # @option opts [Element] :element Element to long tap on.
+      #
+      #   ```ruby
+      #   double_tap x: 100, y: 100
+      #   double_tap element: find_element(:accessibility_id, "some item")
+      #   ```
+      def double_tap(x: nil, y: nil, element: nil)
+        return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
+        return 'Set x, y or element' if (x.nil? || y.nil?) && element.nil?
+
+        args = element.nil? ? { x: x, y: y } : { element: element.ref }
+        execute_script 'mobile: doubleTap', args
+      end
+
+      # @param [Element] :element Element to long tap on.
+      #
+      #   ```ruby
+      #   two_finger_tap element: find_element(:accessibility_id, "some item")
+      #   ```
+      def two_finger_tap(element:)
+        return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
+
+        args = { element: element.ref }
+        execute_script 'mobile: twoFingerTap', args
+      end
+
+      # @param x [float] X tap coordinate of type float. Mandatory parameter
+      # @param y [float] Y tap coordinate of type float. Mandatory parameter
+      # @option opts [Element] :element Element id to long tap on. x and y tap coordinates will be calculated
+      #   relatively to the current element position on the screen if this argument is provided.
+      #   Otherwise they should be calculated relatively to screen borders.
+      #
+      #   ```ruby
+      #   tap x: 100, y: 100
+      #   tap x: 100, y: 100, element: find_element(:accessibility_id, "some item")
+      #   ```
+      def tap(x:, y:, element: nil)
+        return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
+
+        args = { x: x, y: y }
+        args[:element] = element.ref
+        execute_script 'mobile: tap', args
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+      # @param duration [float] Float number of seconds in range [0.5, 60]. How long the tap gesture at starting
+      #   drag point should be before to start dragging. Mandatory parameter
+      # @param from_x [float] The x coordinate of starting drag point (type float). Mandatory parameter
+      # @param from_y [float] The y coordinate of starting drag point (type float). Mandatory parameter
+      # @param to_x [float] The x coordinate of ending drag point (type float). Mandatory parameter
+      # @param to_y [float] The y coordinate of ending drag point (type float). Mandatory parameter
+      # @option opts [Element] :element  Element id to perform drag on. All the coordinates will be calculated
+      #   relatively this this element position on the screen. Absolute screen coordinates are expected
+      #   if this argument is not set
+      #
+      #   ```ruby
+      #   drag_from_to_for_duration from_x: 100, from_y: 100, to_x: 150, to_y: 150
+      #   ```
+      def drag_from_to_for_duration(from_x:, from_y:, to_x:, to_y:, duration: 1.0, element: nil)
+        return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
+
+        args = { from_x: from_x, from_y: from_y, to_x: to_x, to_y: to_y, duration: duration }
+        args[:element] = element if element
+        execute_script 'mobile: dragFromToForDuration', args
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      # https://github.com/facebook/WebDriverAgent/pull/523
+      # https://github.com/appium/appium-xcuitest-driver/pull/420
+      # @param order [String] The order to move picker to. "next" or "previous".
+      # @param element [Element]  Element id to perform select picker wheel on.
+      #
+      #   ```ruby
+      #   select_picker_wheel order: "next", element: find_element(:accessibility_id, "some picker")
+      #   ```
+      def select_picker_wheel(element:, order:)
+        return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
+        return 'Set "next" or "previous" for :order' unless %w(next previous).include?(order)
+
+        args = { element: element.ref, order: order }
+        execute_script 'mobile: selectPickerWheelValue', args
+      end
+    end # module XcuitestGesture
+  end # module Ios
+end # module Appium

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v9.3.8 2017-04-13
+
+- [7a7cf44](https://github.com/appium/ruby_lib/commit/7a7cf44c3cb11a90142285b8e8d731dc452b89eb) Release 9 3 8 (#540)
+- [5e67b88](https://github.com/appium/ruby_lib/commit/5e67b8813950148661bc4491811a696edeffc63c) allow using TestObject server (#538)
+- [9fdf89f](https://github.com/appium/ruby_lib/commit/9fdf89f9c3993730aabf1b8e25f03a773e565d98) add link to mobile gesture for XCUITets (#536)
+
+
 #### v9.3.7 2017-04-09
 
 - [8daf6f7](https://github.com/appium/ruby_lib/commit/8daf6f773c9b8acd7a89e2a9225fd834de5b4e2e) Release 9 3 7 (#535)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.3.8
+  version: 9.4.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -333,6 +333,7 @@ files:
 - ios_tests/lib/ios/specs/ios/helper.rb
 - ios_tests/lib/ios/specs/ios/mobile_methods.rb
 - ios_tests/lib/ios/specs/ios/patch.rb
+- ios_tests/lib/ios/specs/ios/xcuitest_gestures.rb
 - ios_tests/lib/run.rb
 - ios_tests/readme.md
 - ios_tests/upload/sauce_storage.rb
@@ -368,6 +369,7 @@ files:
 - lib/appium_lib/ios/helper.rb
 - lib/appium_lib/ios/mobile_methods.rb
 - lib/appium_lib/ios/patch.rb
+- lib/appium_lib/ios/xcuitest_gestures.rb
 - lib/appium_lib/logger.rb
 - lib/appium_lib/rails/duplicable.rb
 - readme.md