get ride of auto method generation to enhance ide support (#72)

* get ride of auto method generation to enhance ide support

* fix lint

* fix activity name

* clean up

* fix lint and arrange syntax

Author: KazuCocoa

lib/appium_lib_core/android/device.rb

@@ -8,6 +8,106 @@ module Device
 
       # rubocop:disable Metrics/LineLength
 
+      # @!method open_notifications
+      #   Open Android notifications
+      #
+      # @example
+      #
+      #   @driver.open_notifications
+      #
+
+      # @!method current_activity
+      # Get current activity name
+      # @return [String] An activity name
+      #
+      # @example
+      #
+      #   @driver.current_activity # '.ApiDemos'
+      #
+
+      # @!method current_package
+      # Get current package name
+      # @return [String] A package name
+      #
+      # @example
+      #
+      #   @driver.current_package # 'com.example.android.apis'
+      #
+
+      # @!method get_system_bars
+      # Get system bar's information
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.get_system_bars
+      #
+
+      # @!method get_display_density
+      # Get connected device's density.
+      # @return [Integer] The size of density
+      #
+      # @example
+      #
+      #   @driver.get_display_density # 320
+      #
+
+      # @!method is_keyboard_shown
+      # Get whether keyboard is displayed or not.
+      # @return [Boolean] Return true if keyboard is shown. Return false if keyboard is hidden.
+      #
+      # @example
+      #   @driver.is_keyboard_shown # false
+      #
+
+      # @!method get_network_connection
+      #   Get the device network connection current status
+      #   See set_network_connection method for return value
+      #
+      # @example
+      #
+      #   @driver.network_connection_type #=> 6
+      #   @driver.get_network_connection  #=> 6
+      #
+
+      # @!method toggle_wifi
+      #   Switch the state of the wifi service only for Android
+      #
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.toggle_wifi
+      #
+
+      # @!method toggle_data
+      #   Switch the state of data service only for Android, and the device should be rooted
+      #
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.toggle_data
+      #
+
+      # @!method toggle_location_services
+      #   Switch the state of the location service
+      #
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.toggle_location_services
+      #
+
+      # @!method toggle_airplane_mode
+      # Toggle flight mode on or off
+      #
+      # @example
+      #
+      #   @driver.toggle_airplane_mode
+      #
+
       # @!method hide_keyboard(close_key = nil, strategy = nil)
       # Hide the onscreen keyboard
       # @param [String] close_key The name of the key which closes the keyboard.
@@ -149,7 +249,79 @@ class << self
         def extended(_mod)
           Appium::Core::Device.extend_webdriver_with_forwardable
 
-          # Android
+          Appium::Core::Device.add_endpoint_method(:open_notifications) do
+            def open_notifications
+              execute :open_notifications
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:toggle_airplane_mode) do
+            def toggle_airplane_mode
+              execute :toggle_airplane_mode
+            end
+            alias_method :toggle_flight_mode, :toggle_airplane_mode
+          end
+
+          Appium::Core::Device.add_endpoint_method(:current_activity) do
+            def current_activity
+              execute :current_activity
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:current_package) do
+            def current_package
+              execute :current_package
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:get_system_bars) do
+            def get_system_bars
+              execute :get_system_bars
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:get_display_density) do
+            def get_display_density
+              execute :get_display_density
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:is_keyboard_shown) do
+            def is_keyboard_shown # rubocop:disable Naming/PredicateName for compatibility
+              execute :is_keyboard_shown
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:get_network_connection) do
+            def get_network_connection
+              execute :get_network_connection
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:get_performance_data_types) do
+            def get_performance_data_types
+              execute :get_performance_data_types
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:toggle_wifi) do
+            def toggle_wifi
+              execute :toggle_wifi
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:toggle_data) do
+            def toggle_data
+              execute :toggle_data
+            end
+          end
+
+          Appium::Core::Device.add_endpoint_method(:toggle_location_services) do
+            def toggle_location_services
+              execute :toggle_location_services
+            end
+          end
+
           Appium::Core::Device.add_endpoint_method(:start_activity) do
             def start_activity(opts)
               raise 'opts must be a hash' unless opts.is_a? Hash
@@ -191,6 +363,11 @@ def end_coverage(path, intent)
 
           Appium::Core::Device.add_endpoint_method(:set_network_connection) do
             def set_network_connection(mode)
+              # TODO. Update set_network_connection as well
+              # connection_type = {airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0}
+              # raise ArgumentError, 'Invalid connection type' unless type_to_values.keys.include? mode
+              # type = connection_type[mode]
+              # execute :set_network_connection, {}, type: type
               execute :set_network_connection, {}, type: mode
             end
           end

lib/appium_lib_core/common/command.rb

@@ -4,73 +4,69 @@ module Appium
   module Core
     # ref: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js
     module Commands
-      COMMAND_NO_ARG = {
-        # Common
-        shake:                      [:post, 'session/:session_id/appium/device/shake'.freeze],
-        launch_app:                 [:post, 'session/:session_id/appium/app/launch'.freeze],
-        close_app:                  [:post, 'session/:session_id/appium/app/close'.freeze],
-        reset:                      [:post, 'session/:session_id/appium/app/reset'.freeze],
-        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'.freeze],
-        unlock:                     [:post, 'session/:session_id/appium/device/unlock'.freeze],
-        device_time:                [:get,  'session/:session_id/appium/device/system_time'.freeze],
-        current_context:            [:get,  'session/:session_id/context'.freeze],
-
-        # Android
-        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
-        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
-        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'.freeze],
-        current_package:            [:get,  'session/:session_id/appium/device/current_package'.freeze],
-        get_system_bars:            [:get,  'session/:session_id/appium/device/system_bars'.freeze],
-        get_display_density:        [:get,  'session/:session_id/appium/device/display_density'.freeze],
-        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'.freeze],
-        get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze], # defined also in OSS
-        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
-        toggle_wifi:                [:post, 'session/:session_id/appium/device/toggle_wifi'.freeze],
-        toggle_data:                [:post, 'session/:session_id/appium/device/toggle_data'.freeze],
-        toggle_location_services:   [:post, 'session/:session_id/appium/device/toggle_location_services'.freeze]
-
-        # iOS
-      }.freeze
-
       # Some commands differ for each driver.
       COMMAND = {
         # common
         available_contexts:         [:get,  'session/:session_id/contexts'.freeze],
         set_context:                [:post, 'session/:session_id/context'.freeze],
+        current_context:            [:get,  'session/:session_id/context'.freeze],
+
+        touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],
+        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.freeze],
+
+        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
+        replace_value:              [:post, 'session/:session_id/appium/element/:id/replace_value'.freeze],
+
+        launch_app:                 [:post, 'session/:session_id/appium/app/launch'.freeze],
+        close_app:                  [:post, 'session/:session_id/appium/app/close'.freeze],
+        reset:                      [:post, 'session/:session_id/appium/app/reset'.freeze],
+        background_app:             [:post, 'session/:session_id/appium/app/background'.freeze],
         app_strings:                [:post, 'session/:session_id/appium/app/strings'.freeze],
+
+        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'.freeze],
+        unlock:                     [:post, 'session/:session_id/appium/device/unlock'.freeze],
         lock:                       [:post, 'session/:session_id/appium/device/lock'.freeze],
+        device_time:                [:get,  'session/:session_id/appium/device/system_time'.freeze],
         install_app:                [:post, 'session/:session_id/appium/device/install_app'.freeze],
         remove_app:                 [:post, 'session/:session_id/appium/device/remove_app'.freeze],
         app_installed?:             [:post, 'session/:session_id/appium/device/app_installed'.freeze],
         activate_app:               [:post, 'session/:session_id/appium/device/activate_app'.freeze],
         terminate_app:              [:post, 'session/:session_id/appium/device/terminate_app'.freeze],
         app_state:                  [:post, 'session/:session_id/appium/device/app_state'.freeze],
-        background_app:             [:post, 'session/:session_id/appium/app/background'.freeze],
+        shake:                      [:post, 'session/:session_id/appium/device/shake'.freeze],
         hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
         press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
         long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
         # keyevent is only for Selendroid
         keyevent:                   [:post, 'session/:session_id/appium/device/keyevent'.freeze],
-        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
-        replace_value:              [:post, 'session/:session_id/appium/element/:id/replace_value'.freeze],
         push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],
         pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'.freeze],
         pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
         get_clipboard:              [:post, 'session/:session_id/appium/device/get_clipboard'.freeze],
         set_clipboard:              [:post, 'session/:session_id/appium/device/set_clipboard'.freeze],
         get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
         update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
-        touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],
-        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'.freeze],
         stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'.freeze],
         start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'.freeze]
       }.freeze
 
       COMMAND_ANDROID = {
+        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'.freeze],
+        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'.freeze],
         start_activity:             [:post, 'session/:session_id/appium/device/start_activity'.freeze],
+        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'.freeze],
+        current_package:            [:get,  'session/:session_id/appium/device/current_package'.freeze],
+        get_system_bars:            [:get,  'session/:session_id/appium/device/system_bars'.freeze],
+        get_display_density:        [:get,  'session/:session_id/appium/device/display_density'.freeze],
+        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'.freeze],
+        toggle_wifi:                [:post, 'session/:session_id/appium/device/toggle_wifi'.freeze],
+        toggle_data:                [:post, 'session/:session_id/appium/device/toggle_data'.freeze],
+        toggle_location_services:   [:post, 'session/:session_id/appium/device/toggle_location_services'.freeze],
         end_coverage:               [:post, 'session/:session_id/appium/app/end_test_coverage'.freeze],
-        set_network_connection:     [:post, 'session/:session_id/network_connection'.freeze], # defined also in OSS
+        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'.freeze],
         get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'.freeze],
+        get_network_connection:     [:get,  'session/:session_id/network_connection'.freeze], # defined also in OSS
+        set_network_connection:     [:post, 'session/:session_id/network_connection'.freeze], # defined also in OSS
 
         # only emulator
         send_sms:                   [:post, 'session/:session_id/appium/device/send_sms'.freeze],
@@ -87,8 +83,7 @@ module Commands
         toggle_touch_id_enrollment: [:post, 'session/:session_id/appium/simulator/toggle_touch_id_enrollment'.freeze]
       }.freeze
 
-      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS)
-                   .merge(COMMAND_NO_ARG).freeze
+      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS).freeze
 
       COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(::Appium::Core::Base::Commands::OSS).merge(
         {