appium_lib 10.2.0 → 10.3.0

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

@@ -1,18 +1,35 @@
+# 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.
+
 # XCUIElementTypeButton methods
 module Appium
   module Ios
-    UIAButton = 'UIAButton'.freeze
-    XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
+    UIA_BUTTON = 'UIAButton'
+    UIAButton = UIA_BUTTON
+
+    XCUIELEMENT_TYPE_BUTTON = 'XCUIElementTypeButton'
+    XCUIElementTypeButton = XCUIELEMENT_TYPE_BUTTON
 
     # @return [String] Class name for button
     def button_class
-      UIAButton
+      UIA_BUTTON
     end
 
     # Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
     # @param value [String, Integer] the value to exactly match.
     # If int then the UIAButton|XCUIElementTypeButton at that index is returned.
-    # @return [UIAButton|XCUIElementTypeButton]
+    # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
     def button(value)
       # return button at index.
       return ele_index button_class, value if value.is_a? Numeric
@@ -23,7 +40,7 @@ module Appium
     # Find all UIAButtons|XCUIElementTypeButtons containing value.
     # If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
     # @param value [String] the value to search for
-    # @return [Array<UIAButton|XCUIElementTypeButton>]
+    # @return [Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
     def buttons(value = false)
       return tags button_class unless value
 
@@ -31,7 +48,7 @@ module Appium
     end
 
     # Find the first UIAButton|XCUIElementTypeButton.
-    # @return [UIAButton|XCUIElementTypeButton]
+    # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
     def first_button
       first_ele button_class
     end
@@ -39,21 +56,21 @@ module Appium
     # TODO: add documentation regarding previous element.
     #       Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
     # Find the last UIAButton|XCUIElementTypeButton.
-    # @return [UIAButton|XCUIElementTypeButton]
+    # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
     def last_button
       last_ele button_class
     end
 
     # Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [UIAButton|XCUIElementTypeButton]
+    # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
     def button_exact(value)
       ele_by_json_visible_exact button_class, value
     end
 
     # Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<UIAButton|XCUIElementTypeButton>]
+    # @return [Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
     def buttons_exact(value)
       eles_by_json_visible_exact button_class, value
     end

data/lib/appium_lib/ios/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 Ios
     # Find the first element containing value

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

@@ -1,18 +1,35 @@
+# 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.
+
 # UIAStaticText|XCUIElementTypeStaticText methods
 module Appium
   module Ios
-    UIAStaticText = 'UIAStaticText'.freeze
-    XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
+    UIA_STATIC_TEXT = 'UIAStaticText'
+    UIAStaticText = UIA_STATIC_TEXT
+
+    XCUIELEMENT_TYPE_STATIC_TEXT = 'XCUIElementTypeStaticText'
+    XCUIElementTypeStaticText = XCUIELEMENT_TYPE_STATIC_TEXT
 
     # @return [String] Class name for text
     def static_text_class
-      UIAStaticText
+      UIA_STATIC_TEXT
     end
 
     # Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
     # @param value [String, Integer] the value to find.
     # If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
-    # @return [UIAStaticText|XCUIElementTypeStaticText]
+    # @return [UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
     def text(value)
       return ele_index static_text_class, value if value.is_a? Numeric
 
@@ -22,7 +39,7 @@ module Appium
     # Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
     # If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
     # @param value [String] the value to search for
-    # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
+    # @return [Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>]
     def texts(value = false)
       return tags static_text_class unless value
 
@@ -30,27 +47,27 @@ module Appium
     end
 
     # Find the first UIAStaticText|XCUIElementTypeStaticText.
-    # @return [UIAStaticText|XCUIElementTypeStaticText]
+    # @return [UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
     def first_text
       first_ele static_text_class
     end
 
     # Find the last UIAStaticText|XCUIElementTypeStaticText.
-    # @return [UIAStaticText|XCUIElementTypeStaticText]
+    # @return [UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
     def last_text
       last_ele static_text_class
     end
 
     # Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
     # @param value [String] the value to match exactly
-    # @return [UIAStaticText|XCUIElementTypeStaticText]
+    # @return [UIA_STATIC_TEXT|XCUIElementTypeStaticText]
     def text_exact(value)
       ele_by_json_visible_exact static_text_class, value
     end
 
     # Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
     # @param value [String] the value to match exactly
-    # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
+    # @return [Array<UIA_STATIC_TEXT|XCUIElementTypeStaticText>]
     def texts_exact(value)
       eles_by_json_visible_exact static_text_class, value
     end

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

@@ -1,19 +1,37 @@
+# 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 Ios
-    UIATextField = 'UIATextField'.freeze
-    UIASecureTextField = 'UIASecureTextField'.freeze
+    UIA_TEXT_FIELD = 'UIATextField'
+    UIATextField = UIA_TEXT_FIELD
+    UIA_SECURE_TEXT_FIELD = 'UIASecureTextField'
+    UIASecureTextField = UIA_SECURE_TEXT_FIELD
 
-    XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
-    XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
+    XCUIELEMENT_TYPE_TEXT_FIELD = 'XCUIElementTypeTextField'
+    XCUIElementTypeTextField = XCUIELEMENT_TYPE_TEXT_FIELD
+    XCUIELEMENT_TYPE_SECURE_TEXT_FIELD = 'XCUIElementTypeSecureTextField'
+    XCUIElementTypeSecureTextField = XCUIELEMENT_TYPE_SECURE_TEXT_FIELD
 
     # @return [String] Class name for text field
     def text_field_class
-      UIATextField
+      UIA_TEXT_FIELD
     end
 
     # @return [String] Class name for secure text field
     def secure_text_field_class
-      UIASecureTextField
+      UIA_SECURE_TEXT_FIELD
     end
 
     # Find the first TextField that contains value or by index.
@@ -79,7 +97,7 @@ module Appium
 
     # Appium
     def _textfield_visible
-      { typeArray: [UIATextField, UIASecureTextField], onlyVisible: true }
+      { typeArray: [UIA_TEXT_FIELD, UIA_SECURE_TEXT_FIELD], onlyVisible: true }
     end
 
     # Appium

data/lib/appium_lib/ios/ios.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/errors'
 

data/lib/appium_lib/ios/xcuitest.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 'xcuitest/element'
 require_relative 'xcuitest/command'
 require_relative 'xcuitest/helper'

data/lib/appium_lib/ios/xcuitest/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 '../ios'
 
 module Appium

data/lib/appium_lib/ios/xcuitest/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.
+
 require_relative 'command/pasteboard'
 require_relative 'command/gestures'
 require_relative 'command/source'

data/lib/appium_lib/ios/xcuitest/command/certificate.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 'base64'
 
 module Appium

data/lib/appium_lib/ios/xcuitest/command/gestures.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 Ios
     module Xcuitest

data/lib/appium_lib/ios/xcuitest/command/get_context.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 Ios
     module Xcuitest

data/lib/appium_lib/ios/xcuitest/command/multi_app_handler.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 Ios
     module Xcuitest

data/lib/appium_lib/ios/xcuitest/command/pasteboard.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 Ios
     module Xcuitest

data/lib/appium_lib/ios/xcuitest/command/source.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 Ios
     module Xcuitest

data/lib/appium_lib/ios/xcuitest/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/text'
 require_relative 'element/textfield'
 require_relative 'element/generic'

data/lib/appium_lib/ios/xcuitest/element/button.rb

@@ -1,19 +1,33 @@
+# 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.
+
 # XCUIElementTypeButton methods
 module Appium
   module Ios
     module Xcuitest
       module Element
-        # XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
+        # XCUIElementTypeButton = 'XCUIElementTypeButton'
 
         # @return [String] Class name for button
         def button_class
-          ::Appium::Ios::XCUIElementTypeButton
+          ::Appium::Ios::XCUIELEMENT_TYPE_BUTTON
         end
 
         # Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
         # @param value [String, Integer] the value to exactly match.
         # If int then the UIAButton|XCUIElementTypeButton at that index is returned.
-        # @return [UIAButton|XCUIElementTypeButton]
+        # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
         def button(value)
           # return button at index.
           return ele_index button_class, value if value.is_a? Numeric
@@ -24,7 +38,7 @@ module Appium
         # Find all UIAButtons|XCUIElementTypeButtons containing value.
         # If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
         # @param value [String] the value to search for
-        # @return [Array<UIAButton|XCUIElementTypeButton>]
+        # @return [Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
         def buttons(value = false)
           return tags button_class unless value
 
@@ -33,7 +47,7 @@ module Appium
         end
 
         # Find the first UIAButton|XCUIElementTypeButton.
-        # @return [UIAButton|XCUIElementTypeButton]
+        # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
         def first_button
           first_ele button_class
         end
@@ -41,21 +55,21 @@ module Appium
         # TODO: add documentation regarding previous element.
         #       Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
         # Find the last UIAButton|XCUIElementTypeButton.
-        # @return [UIAButton|XCUIElementTypeButton]
+        # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
         def last_button
           last_ele button_class
         end
 
         # Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
         # @param value [String] the value to match exactly
-        # @return [UIAButton|XCUIElementTypeButton]
+        # @return [UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
         def button_exact(value)
           raise_error_if_no_element buttons_exact(value).first
         end
 
         # Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
         # @param value [String] the value to match exactly
-        # @return [Array<UIAButton|XCUIElementTypeButton>]
+        # @return [Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
         def buttons_exact(value)
           elements = find_eles_by_predicate(class_name: button_class, value: value)
           select_visible_elements elements