appium_lib 10.2.0 → 10.3.0

data/lib/appium_lib.rb

@@ -1,3 +1,17 @@
+# 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.
+
 # Enforce UTF-8 Encoding
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8

data/lib/appium_lib/android/android.rb

@@ -1,3 +1,17 @@
+# 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.
+
 require_relative 'common/helper'
 require_relative 'common/command/command'
 

data/lib/appium_lib/android/common/command/command.rb

@@ -1,3 +1,17 @@
+# 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
     module Command

data/lib/appium_lib/android/common/helper.rb

@@ -1,3 +1,17 @@
+# 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
     # @private

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

@@ -1,3 +1,17 @@
+# 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
     # Click the first alert button that contains value or by index.

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

@@ -1,12 +1,29 @@
+# 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.
@@ -24,7 +41,7 @@ module Appium
     # 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
 
@@ -32,19 +49,19 @@ module Appium
     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,
@@ -54,14 +71,14 @@ module Appium
 
     # 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
@@ -80,23 +97,23 @@ module Appium
       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

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

@@ -1,3 +1,17 @@
+# 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
     # Find the first element containing value

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

@@ -1,52 +1,67 @@
+# 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.
+
 # TextView methods
 module Appium
   module Android
-    TextView = 'android.widget.TextView'.freeze
+    TEXT_VIEW = 'android.widget.TextView'
+    TextView = TEXT_VIEW
 
     # Find the first TextView that contains value or by index.
     # @param value [String, Integer] the value to find.
     # If int then the TextView at that index is returned.
     # @return [TextView]
     def text(value)
-      return ele_index TextView, value if value.is_a? Numeric
+      return ele_index TEXT_VIEW, value if value.is_a? Numeric
 
-      complex_find_contains TextView, value
+      complex_find_contains TEXT_VIEW, value
     end
 
     # Find all TextViews containing value.
     # If value is omitted, all texts are returned.
     # @param value [String] the value to search for
-    # @return [Array<TextView>]
+    # @return [Array<TEXT_VIEW>]
     def texts(value = false)
-      return tags TextView unless value
+      return tags TEXT_VIEW unless value
 
-      complex_finds_contains TextView, value
+      complex_finds_contains TEXT_VIEW, value
     end
 
     # Find the first TextView.
-    # @return [TextView]
+    # @return [TEXT_VIEW]
     def first_text
-      first_ele TextView
+      first_ele TEXT_VIEW
     end
 
     # Find the last TextView.
-    # @return [TextView]
+    # @return [TEXT_VIEW]
     def last_text
-      last_ele TextView
+      last_ele TEXT_VIEW
     end
 
     # Find the first TextView that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [TextView]
+    # @return [TEXT_VIEW]
     def text_exact(value)
-      complex_find_exact TextView, value
+      complex_find_exact TEXT_VIEW, value
     end
 
     # Find all TextViews that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<TextView>]
+    # @return [Array<TEXT_VIEW>]
     def texts_exact(value)
-      complex_finds_exact TextView, value
+      complex_finds_exact TEXT_VIEW, value
     end
   end # module Android
 end # module Appium

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

@@ -1,51 +1,66 @@
+# 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
-    EditText = 'android.widget.EditText'.freeze
+    EDIT_TEXT = 'android.widget.EditText'
+    EditText = EDIT_TEXT
 
     # Find the first EditText that contains value or by index.
     # @param value [String, Integer] the text to match exactly.
     # If int then the EditText at that index is returned.
-    # @return [EditText]
+    # @return [EDIT_TEXT]
     def textfield(value)
-      return ele_index EditText, value if value.is_a? Numeric
+      return ele_index EDIT_TEXT, value if value.is_a? Numeric
 
-      complex_find_contains EditText, value
+      complex_find_contains EDIT_TEXT, value
     end
 
     # Find all EditTexts containing value.
     # If value is omitted, all EditTexts are returned.
     # @param value [String] the value to search for
-    # @return [Array<EditText>]
+    # @return [Array<EDIT_TEXT>]
     def textfields(value = false)
-      return tags EditText unless value
+      return tags EDIT_TEXT unless value
 
-      complex_finds_contains EditText, value
+      complex_finds_contains EDIT_TEXT, value
     end
 
     # Find the first EditText.
-    # @return [EditText]
+    # @return [EDIT_TEXT]
     def first_textfield
-      first_ele EditText
+      first_ele EDIT_TEXT
     end
 
     # Find the last EditText.
-    # @return [EditText]
+    # @return [EDIT_TEXT]
     def last_textfield
-      last_ele EditText
+      last_ele EDIT_TEXT
     end
 
     # Find the first EditText that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [EditText]
+    # @return [EDIT_TEXT]
     def textfield_exact(value)
-      complex_find_exact EditText, value
+      complex_find_exact EDIT_TEXT, value
     end
 
     # Find all EditTexts that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<EditText>]
+    # @return [Array<EDIT_TEXT>]
     def textfields_exact(value)
-      complex_finds_exact EditText, value
+      complex_finds_exact EDIT_TEXT, value
     end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/espresso.rb

@@ -1,3 +1,17 @@
+# 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.
+
 require_relative 'espresso/helper'
 require_relative 'espresso/element'
 require_relative 'espresso/bridge'

data/lib/appium_lib/android/espresso/bridge.rb

@@ -1,3 +1,17 @@
+# 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.
+
 require_relative '../android'
 
 module Appium

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

@@ -1,3 +1,17 @@
+# 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.
+
 require_relative 'element/generic'
 require_relative 'element/button'
 

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

@@ -1,3 +1,17 @@
+# 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
     module Espresso
@@ -17,8 +31,8 @@ module Appium
             _button_visible_selectors_xpath(index: index - 1)
           end
 
-          i = find_elements :xpath, _button_contains_string_xpath(Button, value)
-          e = find_elements :xpath, _button_contains_string_xpath(ImageButton, value)
+          i = find_elements :xpath, _button_contains_string_xpath(BUTTON, value)
+          e = find_elements :xpath, _button_contains_string_xpath(IMAGE_BUTTON, value)
 
           raise_no_such_element_if_empty(i + e)
 
@@ -32,8 +46,8 @@ module Appium
         def buttons(value = false)
           return _button_visible_selectors_xpath unless value
 
-          i = find_elements :xpath, _button_contains_string_xpath(Button, value)
-          e = find_elements :xpath, _button_contains_string_xpath(ImageButton, value)
+          i = find_elements :xpath, _button_contains_string_xpath(BUTTON, value)
+          e = find_elements :xpath, _button_contains_string_xpath(IMAGE_BUTTON, value)
           i + e
         end
 
@@ -48,9 +62,9 @@ module Appium
         def last_button
           # uiautomator index doesn't support last
           # and it's 0 indexed
-          button_index = tags(::Appium::Android::Button).length
+          button_index = tags(::Appium::Android::BUTTON).length
           button_index -= 1 if button_index > 0
-          image_button_index = tags(::Appium::Android::ImageButton).length
+          image_button_index = tags(::Appium::Android::IMAGE_BUTTON).length
           image_button_index -= 1 if image_button_index > 0
 
           _button_visible_selectors_xpath(button_index: button_index,
@@ -61,8 +75,8 @@ module Appium
         # @param value [String] the value to match exactly
         # @return [Button]
         def button_exact(value)
-          i = find_elements :xpath, _button_exact_string_xpath(Button, value)
-          e = find_elements :xpath, _button_exact_string_xpath(ImageButton, value)
+          i = find_elements :xpath, _button_exact_string_xpath(BUTTON, value)
+          e = find_elements :xpath, _button_exact_string_xpath(IMAGE_BUTTON, value)
 
           raise_no_such_element_if_empty(i + e)
 
@@ -73,8 +87,8 @@ module Appium
         # @param value [String] the value to match exactly
         # @return [Array<Button>]
         def buttons_exact(value)
-          i = find_elements :xpath, _button_exact_string_xpath(Button, value)
-          e = find_elements :xpath, _button_exact_string_xpath(ImageButton, value)
+          i = find_elements :xpath, _button_exact_string_xpath(BUTTON, value)
+          e = find_elements :xpath, _button_exact_string_xpath(IMAGE_BUTTON, value)
           i + e
         end
 
@@ -93,8 +107,8 @@ module Appium
 
           index = opts.fetch :index, false
 
-          b = find_elements :xpath, "//#{Button}"
-          i = find_elements :xpath, "//#{ImageButton}"
+          b = find_elements :xpath, "//#{BUTTON}"
+          i = find_elements :xpath, "//#{IMAGE_BUTTON}"
 
           if index
             raise_no_such_element_if_empty(b + i)