refine Appium ruby binding

[KazuCocoa]

Just proposal.

Current Appium ruby binding have many monkey patches for Selenium webdriver.
So, the library is affected by selenium-webdriver's changes such as Update selenium-webdriver related methods #558 .

To reduce the impact and enhance maintainability, I'd like to refine the implementations.

---

1. refactor/rewrite the library such as selenium's other drivers
2. ...?

---

• Selenium
  • driver
    • ruby_lib call here
  • remeote/bridge

---

for various drivers

• default(iOS or Android) inherit selenium
  • bridge for Android, override default driver for some Android specific methods
    • uiautomator1
    • uiautomator2
    • espresso
    • ...
  • bridge for iOS, override default driver for some iOS specific methods
    • UIAutomation
    • XCUITest
    • EarlGrey, etc...

---

• example

    class Driver
      include SearchContext

      class << self
        def for(os, driver, opts = {})
          listener = opts.delete(:listener)

          bridge = case os
            when :android
               case driver
               when :uiautomator2
                 Android::UIAutomator2::Bridge.new(opts)
               when :espresso
                 Android::Espresso::Bridge.new(opts)
               else # default for android
                 Android::UIAutomato1::Bridge.new(opts)
            when :ios
               case driver
               when :xcuitest
                 IOS::XCUITest::Bridge.new(opts)
               when :earlgrey
                 IOS::EarlGrey::Bridge.new(opts)
               else # default for ios
                 IOS::UIAutomation::Bridge.new(opts)
            else
              # Default::Bridge < :: Selenium::WebDriver::Driver::Remote::Bridge
              Default::Bridge.new(ops) # default. Each driver inherit this default bridge
          end

          bridge = Support::EventFiringBridge.new(bridge, listener) if listener

          new(bridge)
        end
      end

[jlipps]

I would not be opposed to a total rewrite. I think @KazuCocoa and @titusfortner might also have ideas on that

[KazuCocoa]

Previously, I and @vbanthia discussed the topic, so I mention him.

[KazuCocoa]

first, adding deprecation marks for unused or used rarely methods.

[titusfortner]

For the record, I think the best approach here would be to create a ruby_core gem that allows for easy extensibility for things like Capybara & Watir syntax. The ruby_lib can continue to be backward compatible by implementing its collection of helper methods on top of ruby_core.

[KazuCocoa]

👀
I'll check https://github.com/watir/watir

[KazuCocoa]

memo

• checking all APIs if we can remove or not
  • location_rel is needed

[KazuCocoa]

0. re-struct directory
   • move drivers in each directory(done)
1. re-struct ruby_lib like the following.(done)

lib/appium_lib.rb
   /appium_lib
       /core # inherit selenium-webdriver and minimal spec to communicate with Appium server
       /drivers
           /android # extend core
               /common
               /uiautomator2
               /espresso
           /ios
               /common
               /xcuitest
       appium.rb
       source_labs.rb # sauce labs specific functions
       driver.rb # ruby_lib's driver

2. move or re-factor not core logic to out of core
   • some methods for compatibility
   • sauce labs specific
   • driver specific
3. clean up core, android, ios and the others

[KazuCocoa]

todo

• update https://github.com/appium/appium_capybara
  • Appium::Driver.new
• move common methods, if exist, from Appium::Android and Appium::Ios to Appium::Core or Appium::Common
• clean up
• apply example's bridge pattern for lib/appium_lib/driver