testa_appium_driver 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de964b80dabf1bc1507dcca4f28803c392f7b2da2cc6f8863479550ad55d49f2
-  data.tar.gz: 1555d6350706198af6a082cc0010295aabf07cebb7bc2527704c69fbbe96efd0
+  metadata.gz: 6e65b137d1cb9c0486402e7e9e6a4d5148ceb64a77b921cd77cefbd2af1f4dfe
+  data.tar.gz: 52291aa9e594d60c2c0903ee54f2ad77f324421b62ed66057499c87f7fc43ce6
 SHA512:
-  metadata.gz: f4a5426075f7a95d195e841f6b2043e0ac0401b4df7cefafab1c205f5fc5288c0cd56bdc5ab7cd64a55d1d7aa62b2b97467edc181c2c767ac8f01f0fa18161c0
-  data.tar.gz: 776de44ceaf20140dc3e414a6ee66b05bb7b74356196f9a644b4f88539c17fe8c68dcfce59bf2115bcda1e3424ee0aa54130f323a2d97c1ada405a2218027f59
+  metadata.gz: 42069df54528be14370204db3e2918a767bdc280b663b9a26369d88dd246a0430e4b141b6ec0076052d394daa27e19d4ddab956b604cda0c43210338df5235e9
+  data.tar.gz: 43138275c2b499c4edda27c817e096cdba33a18f8be6a57b8fe92d69f8b42a18426d47edbba376d69723a675a4a87af3bd6d65d22a631198551649e4d7752e3d

data/.gitignore

@@ -10,6 +10,7 @@
 # rspec failure tracking
 .rspec_status
 
+/.idea/deployment
 /.idea/workspace.xml
 /.idea/misc.xml
 Gemfile.lock

data/.idea/deployment.xml

@@ -1,21 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
-  <component name="PublishConfigData" autoUpload="On explicit save action" promptOnRemoteOverwrite="CHECK_CONTENT" serverName="supertesta.com" createEmptyFolders="true" remoteFilesAllowedToDisappearOnAutoupload="false" autoUploadExternalChanges="true">
+  <component name="PublishConfigData">
     <serverData>
       <paths name="supertesta.com">
         <serverdata>
           <mappings>
-            <mapping deploy="/testa_docker/path_data\testa_appium_driver" local="$PROJECT_DIR$" web="/" />
+            <mapping local="$PROJECT_DIR$" web="/" />
           </mappings>
-          <excludedPaths>
-            <excludedPath local="true" path="$PROJECT_DIR$/.idea" />
-            <excludedPath local="true" path="$PROJECT_DIR$/tmp" />
-            <excludedPath local="true" path="$PROJECT_DIR$/testa_appium_driver.iml" />
-            <excludedPath local="true" path="$PROJECT_DIR$/Gemfile.lock" />
-          </excludedPaths>
         </serverdata>
       </paths>
     </serverData>
-    <option name="myAutoUpload" value="ON_EXPLICIT_SAVE" />
   </component>
 </project>

data/.idea/webServers.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="WebServers">
     <option name="servers">
-      <webServer id="b1f6f214-0ed7-4869-998b-43dc6e5c154a" name="supertesta.com">
+      <webServer id="b1f6f214-0ed7-4869-998b-43dc6e5c154a" name="supertesta.com" url="http://something">
         <fileTransfer rootFolder="/ruby_apps" accessType="SFTP" host="supertesta.com" port="22" sshConfigId="ea45cb27-d516-4292-a1f7-430f02857685" sshConfig="Supertesta.com">
           <advancedOptions>
             <advancedOptions dataProtectionLevel="Private" keepAliveTimeout="0" passiveMode="true" shareSSLContext="true" />

data/README.md

@@ -1,52 +1,365 @@
-# TestaAppiumDriver
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
-into a gem. Put your Ruby code in the file `lib/testa_appium_driver`. To experiment with that code, run `bin/console`
-for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'testa_appium_driver'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install testa_appium_driver
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
-also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
-version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/testa_appium_driver. This project
-is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
-the [code of conduct](https://github.com/[USERNAME]/testa_appium_driver/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the TestaAppiumDriver project's codebases, issue trackers, chat rooms and mailing lists is
-expected to follow
-the [code of conduct](https://github.com/[USERNAME]/testa_appium_driver/blob/master/CODE_OF_CONDUCT.md).
+# Testa Appium Driver
+
+Testa appium driver is a wrapper around the `ruby_lib_core` driver for appium. 
+It leverages all driver features and makes them simple and easy to use. 
+
+There are two key concepts in the testa driver
+#### 1. Elements are fetched only when needed
+It allows you to chain all the selectors and use the adjacent selectors without finding each element in the chain.
+For example `driver.linear_layout.list_view.view_group.button` will not execute any find element commands
+because element command is not given. If `click`, `send_keys` or any attribute method is added to the end of chain
+it will execute find_element before triggering the given element command.
+
+This concept allows you to store the selectors and reuse them later on. For example
+```ruby
+# element is not fetched yet
+my_fancy_progress_bar = driver.linear_layout.progress_bar
+
+puts my_fancy_progress_bar.text # will fetch the element and print the text (output: "You are on the first page")
+driver.button(text: "next page").click # go to the next page that has the same progress bar locator
+
+# will fetch the element again and print the text (output: "You are on the second page")
+# without TestaAppiumDriver, a Stale Object Exception would be thronw
+puts my_fancy_progress_bar.text 
+```
+
+
+#### 2. The Best element find / scroll strategy is automatically determined
+When given an element locator such as the progress_bar in the first concept, testa appium driver automatically determines
+the best find element strategy. The only thing to keep in mind is that you cannot mix strategy specific selectors. 
+Strategy specific selectors are `from_parent` for uiautomator or `parent`, `siblings` or `children` for xpath strategy.
+
+There are also multiple scroll strategies. Android supports both `uiautomator` and `w3c`, while iOS only supports `w3c` 
+scroll strategy. Uiautomator scroll strategy is more fluent and faster but it cannot be limited with single direction
+ element finding, and it does not have sufficient deadzone support.      
+
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testa_appium_driver'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install testa_appium_driver
+    
+    
+For the android platform, make sure you are using the latest version of uiautomator server. Versions older than 4.21.2 have breaking issues.
+To get the latest server version execute:
+```shell script
+npm install appium-uiautomator2-server
+``` 
+And apks will be located in `./node_modules/appium-uiautomator2-server/apks`. Install both apks on the target device
+and make sure you have the `skipServerInstallation: true` capability when starting the driver.
+## Usage
+
+### Initialization
+```ruby
+opts = {
+    caps: {
+        platformName: "Android",
+        deviceName: "MyPhone",
+        app: "/path/to/your/apk",
+        udid: "your_phone_udid",
+        automationName: "uiautomator2",
+        skipServerInstallation: true, # if uiautomator server is manually installed
+        enableMultiWindows: true, # enables appium to see some otherwise "hidden" elements
+    }
+}
+driver = TestaAppiumDriver::Driver.new(opts)
+```
+
+#### Example 1 
+```ruby
+driver.linear_layout.button(id: "com.package.name:id/myElementId").click
+```
+Looks for the first linear layout and a button within the linear layout that has the provided id.
+Only 1 find element is executed with the resolved strategy (xpath or uiautomator):<br>
+underlying selectors:<br>
+xpath: `//android.widget.LinearLayout[1]//android.widget.Button[@resource-id="com.package.name:id/myElementId"]` <br>
+uiautomator: `new UiSelector().className("android.widget.LinearLayout").instance(0).childSelector(new UiSelector.className("android.widget.Button").resourceId("com.package.name:id/myElementId")));`<br>
+
+#### Example 2
+```ruby
+driver.linear_layout(id: "myShortIdExample").parent.text_view.wait_until_exists(10).text
+```
+Testa driver converts shorthand ids(that dont have :id/) to full ids
+by reading the current package under test and prepending it to the shorthand id. If you don't want to prepend the package
+name to the id, use = sign before the id, for example `id: "=idWithoutAPackageName"`.
+
+After adding the `parent` and `text_view` selectors and before retrieving the text value `wait_until_exists(10)` is used to
+wait up to 10 seconds for the element to appear in the page before exception is thrown.  
+
+underlying selectors:<br>
+xpath: `//android.widget.LinearLayout[@resource-id="com.package.name:id/myShortIdExample"][1]/../android.widget.TextView[1]` <br>
+uiautomator: `exception: parent selector cannot be used with uiautomator strategy`
+
+#### Example 3
+```ruby
+driver.list_view(top: 200).edit_text(text: "Looking for this text").scroll_to.align!(:bottom).enabled?
+```
+If the element cannot be found in the current view, `scroll_to` action will scroll to start of the scrollable container,
+and start scrolling to the end until the element is found or end is reached. Once found the `align!(:bottom)` command
+will align the element to the bottom of the scrollable container.
+Finally, once the element is scrolled into view and aligned, it will check if the edit_text is enabled.
+
+The scrollable container is resolved by looking the chain of selectors. 
+Selector can be a scrollable container if  `scrollable: true` or is one of the scrollable classes:
+- android.widget.ListView
+- android.widget.ScrollView
+- android.widget.HorizontalScrollView
+- androidx.recyclerview.widget.RecyclerView
+- XCUIElementTypeScrollView
+
+If the selector chain does not contain a scrollable container, a `driver.scrollabe` command will be executed to
+retrieve the first scrollable element in page.
+
+Scrollable selectors can accept the `top`, `right`, `bottom` and `left` parameters as deadzone to prevent that edge of the 
+container be used as scrollable surface.
+Custom views can also be used as scrollable containers with `as_scrollable` command. 
+The command marks the last selector as scrollable container.
+`driver.view(id: "myCustomScrollableView").as_scrollable(top: 200).page_down`
+
+
+
+
+
+#### Example 4
+```ruby
+driver.buttons.each do |element|
+  puts element.text
+end
+```
+The `each` method is one of the scrollable actions. It will start from the beginning of the scrollable container,
+in this case `driver.scrollable`, and find every button in the screen. It will scroll the page until the end of scrollable 
+container is reached and all buttons are found.
+
+
+
+#### Example 5 (Invalid combination)
+```ruby
+driver.frame_layout.from_parent.button(text: "My Cool text").siblings
+```
+This example demonstrates a invalid selector because it cannot be resolved with xpath nor uiautomator strategy.
+It will raise StrategyMixException because from_parent selector can only be used with uiautomator strategy and
+siblings selector can only be used with xpath strategy.
+
+
+# Methods 
+
+## Android
+### Class Selectors
+- element
+- elements
+- scrollable
+- scrollables
+- image_view
+- image_views
+- frame_layout
+- frame_layouts
+- linear_layout
+- linear_layouts
+- view
+- views
+- edit_text
+- edit_texts
+- view_group
+- view_groups
+- relative_layout
+- relative_layouts
+- recycler_view
+- recycler_views
+- button
+- buttons
+- image_button
+- image_buttons
+- horizontal_scroll_view
+- horizontal_scroll_views
+- scroll_view
+- scroll_views
+- view_pager
+- view_pagers
+- check_box
+- check_boxes
+- list_view
+- list_views
+- progress_bar
+- progress_bars
+- radio_button
+- radio_buttons
+- radio_group
+- radio_groups
+- search_view
+- search_views
+- spinner
+- spinners
+- toast
+- toasts
+- toolbar
+- toolbars
+- text_view
+- text_views
+
+Adjacent selectors
+- from_parent
+- parent
+- child
+- children
+- siblings
+- preceding_sibling
+- preceding_siblings
+- following_sibling
+- following_siblings
+
+
+Class Selector arguments
+- id
+- long_clickable
+- desc
+- class
+- text
+- package
+- checkable
+- checked
+- clickable
+- enabled
+- focusable
+- focused
+- index
+- selected
+- scrollable
+
+### Attributes
+- text
+- package
+- class_name
+- checkable?
+- checked?
+- clickable?
+- desc
+- enabled?
+- focusable?
+- focused?
+- long_clickable?
+- password?
+- id
+- scrollable?
+- selected?
+- displayed?
+- selection_start
+- selection_end
+- bounds
+- index
+
+# iOS
+## Type Selectors 
+- element
+- elements
+- window
+- windows
+- other
+- others
+- navigation_bar
+- navigation_bars
+- button
+- buttons
+- image
+- images
+- static_text
+- static_texts
+- scrollable
+- scrollables
+- scroll_view
+- scroll_views
+- table
+- tables
+- cell
+- cells
+
+Adjacent selectors
+- parent
+- child
+- children
+- siblings
+- preceding_sibling
+- preceding_siblings
+- following_sibling
+- following_siblings
+
+Type Selector arguments
+- enabled
+- type, class
+- label
+- width
+- height
+- visible
+- name, id
+- value
+
+
+## Attributes
+- accessibility_container
+- accessible?
+- class_name
+- enabled?
+- frame
+- index
+- label, text
+- name
+- rect, bounds
+- selected?
+- type
+- value
+- visible?
+
+# Scroll actions
+- each
+- align!
+- align_top!
+- align_bottom!
+- align_left!
+- align_right!
+- align
+- align_top
+- align_bottom
+- align_left
+- align_right
+- scroll_to
+- scroll_down_to
+- scroll_up_to
+- scroll_right_to
+- scroll_left_to
+- scroll_to_start
+- scroll_to_end
+- page_down
+- page_up
+- page_left
+- page_right
+- fling_down
+- fling_up
+- fling_left
+- fling_right
+- drag_to
+- drag_by
+
+# Helpers
+- as_scrollable
+- wait_until_exists
+- wait_while_exists
+- exists?
+- long_tap
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+

data/lib/testa_appium_driver/android/locator.rb

@@ -19,6 +19,15 @@ module TestaAppiumDriver
         else
           @scroll_orientation = :vertical
         end
+
+        if !params[:top].nil? || !params[:bottom].nil? || !params[:right].nil? || !params[:left].nil?
+          @scroll_deadzone = {}
+          @scroll_deadzone[:top] = params[:top].to_f unless params[:top].nil?
+          @scroll_deadzone[:bottom] = params[:bottom].to_f unless params[:bottom].nil?
+          @scroll_deadzone[:right] = params[:right].to_f unless params[:right].nil?
+          @scroll_deadzone[:left] = params[:left].to_f unless params[:left].nil?
+        end
+
         params[:scrollable_locator] = self.dup
       end
 
@@ -27,16 +36,18 @@ module TestaAppiumDriver
 
 
     # resolve selector which will be used for finding element
-    def selector
+    def strategy_and_selector
+      if @can_use_id_strategy
+        return FIND_STRATEGY_ID, @can_use_id_strategy
+      end
       if (@strategy.nil? && @default_find_strategy == FIND_STRATEGY_UIAUTOMATOR) || @strategy == FIND_STRATEGY_UIAUTOMATOR
-        ui_selector
+        [FIND_STRATEGY_UIAUTOMATOR, ui_selector]
       elsif (@strategy.nil? && @default_find_strategy == FIND_STRATEGY_XPATH) || @strategy == FIND_STRATEGY_XPATH
-        @xpath_selector
+        [FIND_STRATEGY_XPATH, @xpath_selector]
       end
     end
 
 
-
     # @param [Boolean] include_semicolon should the semicolon be included at the end
     # @return ui_selector for uiautomator find strategy
     def ui_selector(include_semicolon = true)
@@ -71,6 +82,7 @@ module TestaAppiumDriver
       raise "Cannot add child selector to Array" if single && !@single
 
       locator = self.dup
+      locator.can_use_id_strategy = false
       if (@strategy.nil? && !single) || @strategy == FIND_STRATEGY_XPATH
         locator.strategy = FIND_STRATEGY_XPATH
         locator.strategy_reason = "multiple child selector"

data/lib/testa_appium_driver/android/locator/attributes.rb

@@ -63,8 +63,8 @@ module TestaAppiumDriver
       attribute("longClickable", *args).to_s == "true"
     end
 
-    def password(*args)
-      attribute("password", *args)
+    def password?(*args)
+      attribute("password", *args).to_s == "true"
     end
 
     def id(*args)

data/lib/testa_appium_driver/common/constants.rb

@@ -4,6 +4,8 @@
 module TestaAppiumDriver
   FIND_STRATEGY_UIAUTOMATOR = :uiautomator
   FIND_STRATEGY_XPATH = :xpath
+  FIND_STRATEGY_ID = :id
+  FIND_STRATEGY_NAME = :name
 
   SCROLL_STRATEGY_UIAUTOMATOR = :uiautomator
   SCROLL_STRATEGY_W3C = :w3c

data/lib/testa_appium_driver/common/helpers.rb

@@ -29,27 +29,17 @@ module TestaAppiumDriver
     def hash_to_uiautomator(hash, single = true)
       command = "new UiSelector()"
 
-      if hash[:id] && hash[:id].kind_of?(String) && !hash[:id].match?(/.*:id\//)
-        # shorthand ids like myId make full ids => my.app.package:id/myId
-
-        if hash[:id][0] == "="
-          id = hash[:id][1..-1]
-        else
-          id = "#{@driver.current_package}:id/#{hash[:id]}"
-        end
-      else
-        id = hash[:id]
-      end
+      id = resolve_id(hash[:id])
       command = "#{ command }.resourceId(\"#{ %(#{ id }) }\")" if id && id.kind_of?(String)
-      command = "#{ command }.resourceIdMatches(\"#{ %(#{ id.source }) }\")" if id && id.kind_of?(Regexp)
+      command = "#{ command }.resourceIdMatches(\".*#{ %(#{ id.source }) }.*\")" if id && id.kind_of?(Regexp)
       command = "#{ command }.description(\"#{ %(#{ hash[:desc] }) }\")" if hash[:desc] && hash[:desc].kind_of?(String)
-      command = "#{ command }.descriptionMatches(\"#{ %(#{ hash[:desc].source }) }\")" if hash[:desc] && hash[:desc].kind_of?(Regexp)
+      command = "#{ command }.descriptionMatches(\".*#{ %(#{ hash[:desc].source }) }.*\")" if hash[:desc] && hash[:desc].kind_of?(Regexp)
       command = "#{ command }.className(\"#{ %(#{ hash[:class] }) }\")" if hash[:class] && hash[:class].kind_of?(String)
-      command = "#{ command }.classNameMatches(\"#{ %(#{ hash[:class].source }) }\")" if hash[:class] && hash[:class].kind_of?(Regexp)
+      command = "#{ command }.classNameMatches(\".*#{ %(#{ hash[:class].source }) }.*\")" if hash[:class] && hash[:class].kind_of?(Regexp)
       command = "#{ command }.text(\"#{ %(#{ hash[:text] }) }\")" if hash[:text] && hash[:text].kind_of?(String)
-      command = "#{ command }.textMatches(\"#{ %(#{ hash[:text].source }) }\")" if hash[:text] && hash[:text].kind_of?(Regexp)
+      command = "#{ command }.textMatches(\".*#{ %(#{ hash[:text].source }) }.*\")" if hash[:text] && hash[:text].kind_of?(Regexp)
       command = "#{ command }.packageName(\"#{ %(#{ hash[:package] }) }\")" if hash[:package] && hash[:package].kind_of?(String)
-      command = "#{ command }.packageNameMatches(\"#{ %(#{ hash[:package].source }) }\")" if hash[:package] && hash[:package].kind_of?(Regexp)
+      command = "#{ command }.packageNameMatches(\".*#{ %(#{ hash[:package].source }) }.*\")" if hash[:package] && hash[:package].kind_of?(Regexp)
 
       command = "#{ command }.longClickable(#{ hash[:long_clickable] })" if hash[:long_clickable]
       command = "#{ command }.checkable(#{ hash[:checkable] })" unless hash[:checkable].nil?
@@ -99,18 +89,10 @@ module TestaAppiumDriver
 
       command = "//"
 
-      if hash[:id] && hash[:id].kind_of?(String) && !hash[:id].match?(/.*:id\//)
-        # shorthand ids like myId make full ids => my.app.package:id/myId
-        if hash[:id][0] == "="
-          id = hash[:id][1..-1]
-        else
-          id = "#{@driver.current_package}:id/#{hash[:id]}"
-        end
-      else
-        id = hash[:id]
-      end
+
 
       if for_android
+        id = resolve_id(hash[:id])
         if hash[:class] && hash[:class].kind_of?(String)
           command = "#{ command }#{hash[:class] }"
         elsif hash[:class] && hash[:class].kind_of?(Regexp)
@@ -140,6 +122,8 @@ module TestaAppiumDriver
         command = "#{ command }[@selected=\"#{ hash[:selected] }\"]" unless hash[:selected].nil?
         command = "#{ command }[@scrollable=\"#{ hash[:scrollable] }\"]" unless hash[:scrollable].nil?
       else
+
+        hash[:type] = hash[:class] unless hash[:class].nil?
         if hash[:type] && hash[:type].kind_of?(String)
           command = "#{ command }#{hash[:type] }"
         elsif hash[:type] && hash[:type].kind_of?(Regexp)
@@ -196,7 +180,7 @@ module TestaAppiumDriver
     def extract_selectors_from_params(params = {})
       selectors = params.select { |key, value| [
           :id,
-          :longClickable,
+          :long_clickable,
           :desc,
           :class,
           :text,
@@ -220,7 +204,7 @@ module TestaAppiumDriver
           :height,
           :visible,
           :name,
-          :value
+          :value,
       ].include?(key) }
       params = Hash[params.to_a - selectors.to_a]
 
@@ -238,5 +222,19 @@ module TestaAppiumDriver
 
       return params, selectors
     end
+
+
+    def resolve_id(id)
+      if id && id.kind_of?(String) && !id.match?(/.*:id\//)
+        # shorthand ids like myId make full ids => my.app.package:id/myId
+        if id[0] == "="
+          return id[1..-1]
+        else
+          return "#{@driver.current_package}:id/#{id}"
+        end
+      else
+        id
+      end
+    end
   end
 end

data/lib/testa_appium_driver/common/locator.rb

@@ -13,6 +13,7 @@ module TestaAppiumDriver
     attr_accessor :strategy
     attr_accessor :strategy_reason
     attr_accessor :last_selector_adjacent
+    attr_accessor :can_use_id_strategy
 
     attr_accessor :from_element
     attr_accessor :scroll_orientation
@@ -37,11 +38,11 @@ module TestaAppiumDriver
       @driver = driver
 
       params, selectors = extract_selectors_from_params(params)
-
       single = params[:single]
 
       @single = single
 
+      selectors[:id] = selectors[:name] unless selectors[:name].nil?
       if from_element.instance_of?(Selenium::WebDriver::Element)
         @xpath_selector = "//*" # to select current element
         @xpath_selector += hash_to_xpath(@driver.device, selectors, single)[1..-1]
@@ -54,6 +55,15 @@ module TestaAppiumDriver
       @default_find_strategy = params[:default_find_strategy]
       @default_scroll_strategy = params[:default_scroll_strategy]
 
+      @can_use_id_strategy = selectors.keys.count == 1 && !selectors[:id].nil?
+      if @can_use_id_strategy
+        if @driver.device == :android
+          @can_use_id_strategy = resolve_id(selectors[:id])
+        else
+          @can_use_id_strategy = selectors[:id]
+        end
+      end
+
 
       @strategy = params[:strategy]
       @strategy_reason = params[:strategy_reason]
@@ -84,7 +94,12 @@ module TestaAppiumDriver
       if @xpath_selector == "//*/*[1]" && @from_element.instance_of?(Selenium::WebDriver::Element)
         return @from_element
       end
-      @driver.execute(@from_element, selector, @single, @strategy, @default_find_strategy, skip_cache)
+
+
+      strategy, selector = strategy_and_selector
+
+
+      @driver.execute(@from_element, selector, @single, strategy, @default_find_strategy, skip_cache)
     end
 
 
@@ -128,15 +143,34 @@ module TestaAppiumDriver
       found
     end
 
+    # @return [TestaAppiumDriver::Locator]
+    def first
+      self[0]
+    end
+
+    # @return [TestaAppiumDriver::Locator]
+    def second
+      self[1]
+    end
+
+    # @return [TestaAppiumDriver::Locator]
+    def third
+      self[2]
+    end
+
+    # @return [TestaAppiumDriver::Locator]
+    def last
+      self[-1]
+    end
 
     def [](instance)
       raise "Cannot add index selector to non-Array" if @single
-
-      if (@strategy.nil? && !@last_selector_adjacent) || @strategy == FIND_STRATEGY_UIAUTOMATOR
+      if ((@strategy.nil? && !@last_selector_adjacent) || @strategy == FIND_STRATEGY_UIAUTOMATOR) && instance >= 0
         locator = self.dup
         locator.strategy = FIND_STRATEGY_UIAUTOMATOR
         locator.ui_selector = "#{@ui_selector}.instance(#{instance})"
         locator.single = true
+        locator.can_use_id_strategy = false
         locator
       else
         from_element = self.execute[instance]
@@ -235,6 +269,7 @@ module TestaAppiumDriver
       locator.strategy = FIND_STRATEGY_XPATH
       locator.strategy_reason = "parent"
       locator.xpath_selector += "/.."
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -250,6 +285,7 @@ module TestaAppiumDriver
       locator.xpath_selector += "/*"
       locator.single = false
       locator.last_selector_adjacent = true
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -265,6 +301,7 @@ module TestaAppiumDriver
       locator.strategy_reason = "child"
       locator.xpath_selector += "/*[1]"
       locator.single = true
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -281,6 +318,7 @@ module TestaAppiumDriver
       locator.xpath_selector += "/../*[not(@index=\"#{index}\")]"
       locator.single = false
       locator.last_selector_adjacent = true
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -296,6 +334,7 @@ module TestaAppiumDriver
       locator.xpath_selector += "/../*[position() < #{index + 1}]" # position() starts from 1
       locator.single = false
       locator.last_selector_adjacent = true
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -313,6 +352,7 @@ module TestaAppiumDriver
       return nil if i == 0
       locator.xpath_selector += "/../*[@index=\"#{i - 1}\"]"
       locator.last_selector_adjacent = true
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -329,6 +369,7 @@ module TestaAppiumDriver
       locator.xpath_selector += "/../*[position() > #{index + 1}]" # position() starts from 1
       locator.single = false
       locator.last_selector_adjacent = true
+      locator.can_use_id_strategy = false
       locator
     end
 
@@ -346,6 +387,7 @@ module TestaAppiumDriver
       return nil if i == 0
       locator.xpath_selector += "/../*[@index=\"#{i + 1}\"]"
       locator.last_selector_adjacent = true
+      locator.can_use_id_strategy = false
       locator
     end
 

data/lib/testa_appium_driver/common/locator/scroll_actions.rb

@@ -98,33 +98,37 @@ module TestaAppiumDriver
     # First scrolls to the beginning of the scrollable container and then scrolls down until element is found or end is reached
     # @return [TestaAppiumDriver::Locator]
     def scroll_to(deadzone: nil, max_scrolls: nil, direction: nil)
-      _scroll_to(deadzone, max_scrolls, direction)
+      if direction
+        _scroll_dir_to(deadzone, max_scrolls, direction)
+      else
+        _scroll_to(deadzone, max_scrolls)
+      end
     end
 
 
     # Scrolls down until element is found or end is reached
     # @return [TestaAppiumDriver::Locator]
     def scroll_down_to(deadzone: nil, max_scrolls: nil)
-      _scroll_to(deadzone, max_scrolls, :down)
+      _scroll_dir_to(deadzone, max_scrolls, :down)
     end
 
     # Scrolls up until element is found or end is reached
     # @return [TestaAppiumDriver::Locator]
     def scroll_up_to(deadzone: nil, max_scrolls: nil)
-      _scroll_to(deadzone, max_scrolls, :up)
+      _scroll_dir_to(deadzone, max_scrolls, :up)
     end
 
     # Scrolls right until element is found or end is reached
     # @return [TestaAppiumDriver::Locator]
     def scroll_right_to(deadzone: nil, max_scrolls: nil)
-      _scroll_to(deadzone, max_scrolls, :right)
+      _scroll_dir_to(deadzone, max_scrolls, :right)
     end
 
 
     # Scrolls left until element is found or end is reached
     # @return [TestaAppiumDriver::Locator]
     def scroll_left_to(deadzone: nil, max_scrolls: nil)
-      _scroll_to(deadzone, max_scrolls, :left)
+      _scroll_dir_to(deadzone, max_scrolls, :left)
     end
 
     # Scrolls to the start of the scrollable container (top on vertical container, left on horizontal)
@@ -272,16 +276,28 @@ module TestaAppiumDriver
       self
     end
 
-    def _scroll_to(deadzone, max_scrolls, direction)
+    def _scroll_to(deadzone, max_scrolls)
       deadzone = @scrollable_locator.scroll_deadzone if deadzone.nil? && !@scrollable_locator.nil?
       sa = ScrollActions.new(@scrollable_locator,
                              locator: self,
                              deadzone: deadzone,
                              max_scrolls: max_scrolls,
-                             direction: direction,
                              default_scroll_strategy: @default_scroll_strategy)
       sa.scroll_to
       self
     end
+
+    def _scroll_dir_to(deadzone, max_scrolls, direction)
+      deadzone = @scrollable_locator.scroll_deadzone if deadzone.nil? && !@scrollable_locator.nil?
+      sa = ScrollActions.new(@scrollable_locator,
+                             locator: self,
+                             deadzone: deadzone,
+                             max_scrolls: max_scrolls,
+                             direction: direction,
+                             default_scroll_strategy: @default_scroll_strategy)
+
+      sa.send("scroll_#{direction}_to")
+      self
+    end
   end
 end

data/lib/testa_appium_driver/common/scroll_actions.rb

@@ -26,7 +26,7 @@ module TestaAppiumDriver
       @strategy = nil
       if @scrollable.strategy == FIND_STRATEGY_XPATH || # uiautomator cannot resolve scrollable from a xpath locator
           !@deadzone.nil? ||
-          !@scrollable.from_element.instance_of?(TestaAppiumDriver::Driver)  # uiautomator cannot resolve nested scrollable
+          !@scrollable.from_element.instance_of?(TestaAppiumDriver::Driver) # uiautomator cannot resolve nested scrollable
         @strategy = SCROLL_STRATEGY_W3C
       end
 
@@ -41,8 +41,8 @@ module TestaAppiumDriver
     end
 
     # @return [Array]
-    def each(skip_scroll_to_start,  &block)
-      w3c_each(skip_scroll_to_start,  &block)
+    def each(skip_scroll_to_start, &block)
+      w3c_each(skip_scroll_to_start, &block)
     end
 
     def resolve_strategy
@@ -63,39 +63,19 @@ module TestaAppiumDriver
     end
 
     def scroll_down_to
-      if resolve_strategy == SCROLL_STRATEGY_W3C
-        # we have direction enabled, uiautomator does not support direction specific element search
-        w3c_scroll_to(:down)
-      elsif resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
-        raise "scroll_down_to is not supported for uiautomator scroll strategy. Use scroll_to without deadzone"
-      end
+      w3c_scroll_to(:down)
     end
 
     def scroll_up_to
-      if resolve_strategy == SCROLL_STRATEGY_W3C
-        # we have direction enabled, uiautomator does not support direction specific element search
-        w3c_scroll_to(:up)
-      elsif resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
-        raise "scroll_up_to is not supported for uiautomator scroll strategy. Use scroll_to without deadzone"
-      end
+      w3c_scroll_to(:up)
     end
 
     def scroll_right_to
-      if resolve_strategy == SCROLL_STRATEGY_W3C
-        # we have direction enabled, uiautomator does not support direction specific element search
-        w3c_scroll_to(:right)
-      elsif resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
-        raise "scroll_right_to is not supported for uiautomator scroll strategy. Use scroll_to without deadzone"
-      end
+      w3c_scroll_to(:right)
     end
 
     def scroll_left_to
-      if resolve_strategy == SCROLL_STRATEGY_W3C
-        # we have direction enabled, uiautomator does not support direction specific element search
-        w3c_scroll_to(:left)
-      elsif resolve_strategy == SCROLL_STRATEGY_UIAUTOMATOR
-        raise "scroll_left_to is not supported for uiautomator scroll strategy. Use scroll_to without deadzone"
-      end
+      w3c_scroll_to(:left)
     end
 
     def page_next
@@ -202,6 +182,7 @@ module TestaAppiumDriver
 
 
     private
+
     def is_end_of_scroll?
       old_elements = @previous_elements
       @previous_elements = @scrollable.first_and_last_leaf

data/lib/testa_appium_driver/common/selenium_element.rb

@@ -0,0 +1,19 @@
+module Selenium
+  module WebDriver
+    #noinspection RubyClassVariableUsageInspection
+    class Element
+      def self.set_driver(driver, udid)
+        udid = "unknown" if udid.nil?
+        @@drivers ||= {}
+        @@drivers[udid] = driver
+      end
+
+      def get_driver
+        udid = @bridge.capabilities.instance_variable_get(:@capabilities)["udid"]
+        udid = "unknown" if udid.nil?
+        @@drivers[udid]
+      end
+
+    end
+  end
+end

data/lib/testa_appium_driver/driver.rb

@@ -5,9 +5,11 @@ require_relative 'common/exceptions/strategy_mix_exception'
 require_relative 'common/helpers'
 require_relative 'common/locator'
 require_relative 'common/scroll_actions'
+require_relative 'common/selenium_element'
 
 module TestaAppiumDriver
   class Driver
+    include Helpers
     attr_accessor :driver
     attr_reader :device
     attr_reader :automation_name
@@ -19,7 +21,7 @@ module TestaAppiumDriver
 
 
 
-      core = Appium::Core.for(opts)
+      core = ::Appium::Core.for(opts)
       extend_for(core.device, core.automation_name)
       @device = core.device
       @automation_name = core.automation_name
@@ -30,8 +32,7 @@ module TestaAppiumDriver
       invalidate_cache!
 
 
-
-      extend_element_with_driver(opts[:caps][:udid])
+      ::Selenium::WebDriver::Element.set_driver(self, opts[:caps][:udid])
     end
 
 
@@ -45,21 +46,7 @@ module TestaAppiumDriver
       }
     end
 
-    #noinspection RubyClassVariableUsageInspection
-    def extend_element_with_driver(udid)
-      Selenium::WebDriver::Element.define_singleton_method(:set_driver) do |driver|
-        udid = "unknown" if udid.nil?
-        @@drivers ||={}
-        @@drivers[udid] = driver
-      end
 
-      Selenium::WebDriver::Element.set_driver(self)
-      Selenium::WebDriver::Element.define_method(:get_driver) do
-        udid = self.instance_variable_get(:@bridge).instance_variable_get(:@capabilities).instance_variable_get(:@capabilities)["udid"]
-        udid = "unknown" if udid.nil?
-        @@drivers[udid]
-      end
-    end
 
 
     #noinspection RubyScope
@@ -75,13 +62,14 @@ module TestaAppiumDriver
       # if user wants to wait for element to exist, he can use wait_until_present
       disable_wait_for_idle
 
+
       # if not restricted to a strategy, use the default one
       strategy = default_strategy if strategy.nil?
 
       # resolve from_element unique id, so that we can cache it properly
-      from_element_id = from_element.kind_of?(TestaAppiumDriver::Locator) ? from_element.selector : nil
+      from_element_id = from_element.kind_of?(TestaAppiumDriver::Locator) ? from_element.strategy_and_selector[1] : nil
 
-      puts "Executing #{from_element_id ? "from #{from_element.strategy}: #{from_element.selector} => " : ""}#{strategy}: #{selector}"
+      puts "Executing #{from_element_id ? "from #{from_element.strategy}: #{from_element.strategy_and_selector} => " : ""}#{strategy}: #{selector}"
       begin
         if @cache[:selector] != selector || # cache miss, selector is different
             @cache[:time] + 5 <= Time.now || # cache miss, older than 5 seconds
@@ -89,23 +77,13 @@ module TestaAppiumDriver
             @cache[:from_element_id] != from_element_id || # cache miss, search is started from different element
             skip_cache # cache is skipped
 
-          if strategy == FIND_STRATEGY_UIAUTOMATOR
-            if single
-              execute_result = from_element.find_element(uiautomator: selector)
-            else
-              execute_result = from_element.find_elements(uiautomator: selector)
-            end
-
-          elsif strategy == FIND_STRATEGY_XPATH
-            if single
-              execute_result = from_element.find_element(xpath: selector)
-            else
-              execute_result = from_element.find_elements(xpath: selector)
-            end
+          if single
+            execute_result = from_element.find_element("#{strategy}": selector)
           else
-            raise "Unknown find_element strategy"
+            execute_result = from_element.find_elements("#{strategy}": selector)
           end
 
+
           unless skip_cache
             @cache[:selector] = selector
             @cache[:strategy] = strategy

data/lib/testa_appium_driver/ios/locator.rb

@@ -8,6 +8,15 @@ module TestaAppiumDriver
     def init(params, selectors, single)
       if is_scrollable_selector?(selectors, single)
         @scroll_orientation = :vertical
+
+        if !params[:top].nil? || !params[:bottom].nil? || !params[:right].nil? || !params[:left].nil?
+          @scroll_deadzone = {}
+          @scroll_deadzone[:top] = params[:top].to_f unless params[:top].nil?
+          @scroll_deadzone[:bottom] = params[:bottom].to_f unless params[:bottom].nil?
+          @scroll_deadzone[:right] = params[:right].to_f unless params[:right].nil?
+          @scroll_deadzone[:left] = params[:left].to_f unless params[:left].nil?
+        end
+
         params[:scrollable_locator] = self.dup
       end
 
@@ -15,8 +24,11 @@ module TestaAppiumDriver
     end
 
 
-    def selector
-      @xpath_selector
+    def strategy_and_selector
+      if @can_use_id_strategy
+        return FIND_STRATEGY_NAME, @can_use_id_strategy
+      end
+      [FIND_STRATEGY_XPATH, @xpath_selector]
     end
 
 

data/lib/testa_appium_driver/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestaAppiumDriver
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/testa_appium_driver.gemspec

@@ -1,40 +1,40 @@
-# frozen_string_literal: true
-
-require_relative "lib/testa_appium_driver/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "testa_appium_driver"
-  spec.version = TestaAppiumDriver::VERSION
-  spec.authors = ["karlo.razumovic"]
-  spec.email = ["karlo.razumovic@gmail.com"]
-
-  spec.summary = "Appium made easy"
-  spec.description = "Testa appium driver is a wrapper around ruby_lib_core. It significantly reduces the amount of code need to achieve your goals."
-  spec.homepage = "https://github.com/Karazum/testa_appium_driver"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
-
-  #spec.metadata["allowed_push_host"] = "Set to 'https://mygemserver.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Karazum/testa_appium_driver"
-  spec.metadata["changelog_uri"] = "https://github.com/Karazum/testa_appium_driver"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "appium_lib_core", ["= 4.7.0"]
-  spec.add_runtime_dependency "json", ["= 2.1.0"]
-
-  spec.add_development_dependency "rubocop", ["= 1.19.0"]
-  spec.add_development_dependency "rake", ["~> 13.0"]
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end
+# frozen_string_literal: true
+
+require_relative "lib/testa_appium_driver/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "testa_appium_driver"
+  spec.version = TestaAppiumDriver::VERSION
+  spec.authors = ["karlo.razumovic"]
+  spec.email = ["karlo.razumovic@gmail.com"]
+
+  spec.summary = "Appium made easy"
+  spec.description = "Testa appium driver is a wrapper around ruby_lib_core. It significantly reduces the amount of code need to achieve your goals."
+  spec.homepage = "https://github.com/Karazum/testa_appium_driver"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  #spec.metadata["allowed_push_host"] = "Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Karazum/testa_appium_driver"
+  spec.metadata["changelog_uri"] = "https://github.com/Karazum/testa_appium_driver"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "appium_lib_core", ["= 4.7.0"]
+  spec.add_runtime_dependency "json", [">= 2.3.0"]
+
+  spec.add_development_dependency "rubocop", ["= 1.19.0"]
+  spec.add_development_dependency "rake", ["~> 13.0"]
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/testa_appium_driver.iml

@@ -39,41 +39,7 @@
   </component>
   <component name="RakeTasksCache">
     <option name="myRootTask">
-      <RakeTaskImpl id="rake">
-        <subtasks>
-          <RakeTaskImpl description="Build testa_appium_driver-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
-          <RakeTaskImpl id="build">
-            <subtasks>
-              <RakeTaskImpl description="Generate SHA512 checksum if testa_appium_driver-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
-          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install testa_appium_driver-0.1.0.gem into system gems" fullCommand="install" id="install" />
-          <RakeTaskImpl id="install">
-            <subtasks>
-              <RakeTaskImpl description="Build and install testa_appium_driver-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v0.1.0 and build and push testa_appium_driver-0.1.0.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
-          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
-          <RakeTaskImpl id="rubocop">
-            <subtasks>
-              <RakeTaskImpl description="Auto-correct RuboCop offenses" fullCommand="rubocop:auto_correct" id="auto_correct" />
-            </subtasks>
-          </RakeTaskImpl>
-          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
-          <RakeTaskImpl description="" fullCommand="default" id="default" />
-          <RakeTaskImpl description="" fullCommand="release" id="release" />
-          <RakeTaskImpl id="release">
-            <subtasks>
-              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
-              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
-              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
-            </subtasks>
-          </RakeTaskImpl>
-        </subtasks>
-      </RakeTaskImpl>
+      <RakeTaskImpl id="rake" />
     </option>
   </component>
 </module>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testa_appium_driver
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - karlo.razumovic
@@ -28,16 +28,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,7 @@ files:
 - lib/testa_appium_driver/common/scroll_actions.rb
 - lib/testa_appium_driver/common/scroll_actions/json_wire_scroll_actions.rb
 - lib/testa_appium_driver/common/scroll_actions/w3c_scroll_actions.rb
+- lib/testa_appium_driver/common/selenium_element.rb
 - lib/testa_appium_driver/driver.rb
 - lib/testa_appium_driver/ios/driver.rb
 - lib/testa_appium_driver/ios/locator.rb