lib/appium_lib/android/element/button.rb in appium_lib-10.2.0 vs lib/appium_lib/android/element/button.rb in appium_lib-10.3.0

@@ -1,14 +1,31 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Appium
   module Android
-    Button      = 'android.widget.Button'.freeze
-    ImageButton = 'android.widget.ImageButton'.freeze
+    BUTTON = 'android.widget.Button'
+    Button = BUTTON # backward compatibility
 
+    IMAGE_BUTTON = 'android.widget.ImageButton'
+    ImageButton = IMAGE_BUTTON # backward compatibility
+
     # Find the first button that contains value or by index.
     # @param value [String, Integer] the value to exactly match.
     # If int then the button at that index is returned.
-    # @return [Button]
+    # @return [BUTTON]
     def button(value)
       # Don't use ele_index because that only works on one element type.
       # Android needs to combine button and image button to match iOS.
       if value.is_a? Numeric
         index = value
@@ -22,48 +39,48 @@
     end
 
     # Find all buttons containing value.
     # If value is omitted, all buttons are returned.
     # @param value [String] the value to search for
-    # @return [Array<Button>]
+    # @return [Array<BUTTON>]
     def buttons(value = false)
       return find_elements :uiautomator, _button_visible_selectors unless value
 
       find_elements :uiautomator, _button_contains_string(value)
     end
 
     # Find the first button.
-    # @return [Button]
+    # @return [BUTTON]
     def first_button
       find_element :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
     end
 
     # Find the last button.
-    # @return [Button]
+    # @return [BUTTON]
     def last_button
       # uiautomator index doesn't support last
       # and it's 0 indexed
-      button_index = tags(Button).length
+      button_index = tags(BUTTON).length
       button_index -= 1 if button_index > 0
-      image_button_index = tags(ImageButton).length
+      image_button_index = tags(IMAGE_BUTTON).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)
     end
 
     # Find the first button that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [Button]
+    # @return [BUTTON]
     def button_exact(value)
       find_element :uiautomator, _button_exact_string(value)
     end
 
     # Find all buttons that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<Button>]
+    # @return [Array<BUTTON>]
     def buttons_exact(value)
       find_elements :uiautomator, _button_exact_string(value)
     end
 
     private
@@ -78,26 +95,26 @@
     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});"
+        "new UiSelector().className(#{BUTTON}).instance(#{button_index});" \
+        "new UiSelector().className(#{IMAGE_BUTTON}).instance(#{image_button_index});"
       else
-        "new UiSelector().className(#{Button});" \
-        "new UiSelector().className(#{ImageButton});"
+        "new UiSelector().className(#{BUTTON});" \
+        "new UiSelector().className(#{IMAGE_BUTTON});"
       end
     end
 
     def _button_exact_string(value)
-      button       = string_visible_exact Button, value
-      image_button = string_visible_exact ImageButton, value
+      button       = string_visible_exact BUTTON, value
+      image_button = string_visible_exact IMAGE_BUTTON, value
       button + image_button
     end
 
     def _button_contains_string(value)
-      button       = string_visible_contains Button, value
-      image_button = string_visible_contains ImageButton, value
+      button       = string_visible_contains BUTTON, value
+      image_button = string_visible_contains IMAGE_BUTTON, value
       button + image_button
     end
   end # module Android
 end # module Appium