appium_lib 9.6.1 → 9.7.0

data/lib/appium_lib/ios/{helper.rb → common/helper.rb}

@@ -12,6 +12,7 @@ module Appium
         _print_attr(type, page['name'], page['label'], page['value'], page['hint'], page['visible'])
       end
 
+      # @private
       def _print_attr(type, name, label, value, hint, visible) # rubocop:disable Metrics/ParameterLists
         if name == label && name == value
           puts type.to_s if name || label || value || hint || visible
@@ -43,97 +44,13 @@ module Appium
       8226.chr('UTF-8') * length
     end
 
-    # Returns a string of interesting elements. iOS only.
-    #
-    # Defaults to inspecting the 1st windows source only.
-    # use get_page(get_source) for all window sources
-    #
-    # @option element [Object] the element to search. omit to search everything
-    # @option class_name [String,Symbol] the class name to filter on. case insensitive include match.
-    # @return [String]
-    # @deprecated
-    def get_page(element = source_window(0), class_name = nil)
-      warn '[DEPRECATION] get_page will be removed. Please use page or source instead.'
-
-      lazy_load_strings # populate @strings_xml
-      class_name = class_name.to_s.downcase
-
-      # @private
-      def empty(ele)
-        (ele['name'] || ele['label'] || ele['value']).nil?
-      end
-
-      # @private
-      def fix_space(s)
-        # if s is an int, we can't call .empty
-        return nil if s.nil? || (s.respond_to?(:empty) && s.empty?)
-        # ints don't respond to force encoding
-        # ensure we're converting to a string
-        unless s.respond_to? :force_encoding
-          s_s = s.to_s
-          return s_s.empty? ? nil : s_s
-        end
-        # char code 160 (name, label) vs 32 (value) will break comparison.
-        # convert string to binary and remove 160.
-        # \xC2\xA0
-        s = s.force_encoding('binary').gsub("\xC2\xA0".force_encoding('binary'), ' ') if s
-        s.empty? ? nil : s.force_encoding('UTF-8')
-      end
-
-      unless empty(element) || element['visible'] == false
-        name    = fix_space element['name']
-        label   = fix_space element['label']
-        value   = fix_space element['value']
-        hint    = fix_space element['hint']
-        visible = fix_space element['visible']
-        type    = fix_space element['type']
-
-        # if class_name is set, mark non-matches as invisible
-        visible = (type.downcase.include? class_name).to_s if class_name
-        if visible && visible == 'true'
-
-          UITestElementsPrinter.new._print_attr(type, name, label, value, hint, visible)
-
-          # there may be many ids with the same value.
-          # output all exact matches.
-          attributes = [name, label, value, hint].select { |attr| !attr.nil? }
-          partial    = {}
-          id_matches = @strings_xml.select do |key, val|
-            next if val.nil? || val.empty?
-            partial[key] = val if attributes.detect { |attr| attr.include?(val) }
-            attributes.detect { |attr| val == attr }
-          end
-
-          # If there are no exact matches, display partial matches.
-          id_matches = partial if id_matches.empty?
-
-          unless id_matches.empty?
-            match_str = ''
-            max_len   = id_matches.keys.max_by(&:length).length
-
-            # [0] = key, [1] = val
-            id_matches.each do |key, val|
-              arrow_space = ' ' * (max_len - key.length).to_i
-              match_str += ' ' * 7 + "#{key} #{arrow_space}=> #{val}\n"
-            end
-            puts "   id: #{match_str.strip}\n"
-          end
-        end
-      end
-
-      children = element['children']
-      children.each { |c| get_page c, class_name } if children
-      nil
-    end
-
     # Prints a string of interesting elements to the console.
     #
-    # Example
-    #
-    # ```ruby
-    # page class: :UIAButton # filter on buttons
-    # page class: :UIAButton, window: 1
-    # ```
+    # @example
+    #     ```ruby
+    #     page class: :UIAButton # filter on buttons
+    #     page class: :UIAButton, window: 1
+    #     ```
     #
     # @option visible [Symbol] visible value to filter on
     # @option class [Symbol] class name to filter on
@@ -145,7 +62,7 @@ module Appium
       # current_context may be nil which breaks start_with
       if current_context && current_context.start_with?('WEBVIEW')
         s      = get_source
-        parser = @android_html_parser ||= Nokogiri::HTML::SAX::Parser.new(Common::HTMLElements.new)
+        parser = @android_html_parser ||= Nokogiri::HTML::SAX::Parser.new(Appium::Common::HTMLElements.new)
         parser.document.reset
         parser.document.filter = class_name
         parser.parse s
@@ -163,22 +80,11 @@ module Appium
 
     # Gets the JSON source of window number
     # @return [JSON]
-    def source_window(window_number = nil)
-      warn '[DEPRECATION] The argument window_number will be removed. Plesse remove window_number' unless window_number
+    def source_window(_window_number = nil)
+      warn '[DEPRECATION] source_window will be removed. Please use source instead.'
       get_source
     end
 
-    # Prints parsed page source to console.
-    #
-    # example: page_window 0
-    #
-    # @param window_number [Integer] the int index of the target window
-    # @return [void]
-    def page_window(window_number = 0)
-      get_page source_window window_number
-      nil
-    end
-
     # Find by id
     # @param id [String] the id to search for
     # @return [Element]
@@ -186,13 +92,6 @@ module Appium
       find_element(:id, id)
     end
 
-    # Return the iOS version as an array of integers
-    # @return [Array<Integer>]
-    def ios_version
-      ios_version = execute_script 'UIATarget.localTarget().systemVersion()'
-      ios_version.split('.').map(&:to_i)
-    end
-
     # Get the element of type class_name at matching index.
     # @param class_name [String] the class name to find
     # @param index [Integer] the index

data/lib/appium_lib/ios/ios.rb

@@ -0,0 +1,20 @@
+require_relative 'common/helper'
+require_relative 'common/errors'
+
+require_relative 'element/alert'
+require_relative 'element/button'
+require_relative 'element/generic'
+require_relative 'element/textfield'
+require_relative 'element/text'
+
+require_relative 'xcuitest'
+
+module Appium
+  module Ios
+    class Bridge
+      def self.for(target)
+        target.extend Appium::Ios
+      end
+    end
+  end
+end

data/lib/appium_lib/ios/xcuitest.rb

@@ -1,10 +1,8 @@
-require_relative 'xcuitest/search_context'
 require_relative 'xcuitest/element'
-require_relative 'xcuitest/gestures'
 require_relative 'xcuitest/command'
-require_relative 'xcuitest/device'
 require_relative 'xcuitest/helper'
 require_relative 'xcuitest/element'
+require_relative 'xcuitest/bridge'
 
 module Appium
   module Ios

data/lib/appium_lib/ios/xcuitest/bridge.rb

@@ -0,0 +1,19 @@
+require_relative '../ios'
+
+module Appium
+  module Ios
+    module Xcuitest
+      class Bridge
+        def self.for(target)
+          target.extend Appium::Ios
+          target.extend Appium::Ios::Device
+          target.extend Appium::Ios::Xcuitest
+          target.extend Appium::Ios::Xcuitest::Command
+          target.extend Appium::Ios::Xcuitest::Helper
+          target.extend Appium::Ios::Xcuitest::Gesture
+          target.extend Appium::Ios::Xcuitest::Element
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib/ios/xcuitest/command.rb

@@ -1,8 +1,11 @@
 require_relative 'command/pasteboard'
+require_relative 'command/gestures'
 
 module Appium
   module Ios
-    module Command
+    module Xcuitest
+      module Command
+      end
     end
   end
 end

data/lib/appium_lib/ios/xcuitest/{gestures.rb → command/gestures.rb}

@@ -85,7 +85,7 @@ module Appium
           @driver.execute_script 'mobile: touchAndHold', args
         end
 
-        # @param [Element] :element Element to long tap on.
+        # @param [Element] element Element to long tap on.
         #
         #   ```ruby
         #   two_finger_tap element: find_element(:accessibility_id, "some item")

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

@@ -7,24 +7,7 @@ module Appium
   module Ios
     module Xcuitest
       module Element
-        # @private
-        # class_eval inside a method because class Selenium::WebDriver::Element
-        # will trigger as soon as the file is required. in contrast a method
-        # will trigger only when invoked.
-        def patch_webdriver_element
-          Selenium::WebDriver::Element.class_eval do
-            # Enable access to iOS accessibility label
-            # accessibility identifier is supported as 'name'
-            def label
-              attribute('label')
-            end
-
-            # Cross platform way of entering text into a textfield
-            def type(text)
-              send_keys text
-            end # def type
-          end # Selenium::WebDriver::Element.class_eval
-        end # def patch_webdriver_element
+        # no
       end # module Element
     end # module Xcuitest
   end # module Ios

data/lib/appium_lib/ios/xcuitest/helper.rb

@@ -2,12 +2,6 @@ module Appium
   module Ios
     module Xcuitest
       module Helper
-        # Return the iOS version as an array of integers
-        # @return [Array<Integer>]
-        def ios_version
-          @driver.capabilities['platformVersion']
-        end
-
         # @private
         def string_attr_exact(class_name, attr, value)
           if attr == '*'

data/lib/appium_lib/sauce_labs.rb

@@ -0,0 +1,29 @@
+module Appium
+  class SauceLabs
+    # Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
+    attr_reader :username
+    # Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
+    attr_reader :access_key
+    # Override the Sauce Appium endpoint to allow e.g. TestObject tests
+    attr_reader :endpoint
+
+    def initialize(appium_lib_opts)
+      @username   = appium_lib_opts.fetch :sauce_username, ENV['SAUCE_USERNAME']
+      @username   = nil if !@username || (@username.is_a?(String) && @username.empty?)
+
+      @access_key = appium_lib_opts.fetch :sauce_access_key, ENV['SAUCE_ACCESS_KEY']
+      @access_key = nil if !@access_key || (@access_key.is_a?(String) && @access_key.empty?)
+
+      @endpoint   = appium_lib_opts.fetch :sauce_endpoint, ENV['SAUCE_ENDPOINT']
+      @endpoint   = 'ondemand.saucelabs.com:443/wd/hub' if !@endpoint || (@endpoint.is_a?(String) && @endpoint.empty?)
+    end
+
+    def sauce_server_url?
+      !username.nil? && !access_key.nil?
+    end
+
+    def server_url
+      sauce_server_url? ? "https://#{username}:#{access_key}@#{endpoint}" : 'http://127.0.0.1:4723/wd/hub'
+    end
+  end
+end

data/lib/appium_lib/version.rb

@@ -0,0 +1,5 @@
+module Appium
+  # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
+  VERSION = '9.7.0'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-10-01'.freeze unless defined? ::Appium::DATE
+end

data/release_notes.md

@@ -1,3 +1,11 @@
+#### v9.6.1 2017-08-27
+
+- [a542287](https://github.com/appium/ruby_lib/commit/a5422874b4ab60430ab9d58289aac001ecd90ecf) [Release 9 6 1 (#650)](https://github.com/appium/ruby_lib/issues/650)
+- [cb9450d](https://github.com/appium/ruby_lib/commit/cb9450d207fb2e23b4dfef4318f47ea3d04c7689) [refactor: divide dependencies (#649)](https://github.com/appium/ruby_lib/issues/649)
+- [0673ad7](https://github.com/appium/ruby_lib/commit/0673ad71a0c13e72c96fa7928ce1077c3684d4c2) [feature: add commands for get_pasteboard and set_pasteboard (#648)](https://github.com/appium/ruby_lib/issues/648)
+- [420c855](https://github.com/appium/ruby_lib/commit/420c855efb27e2dd84fce8b0dbeb0e86d41f72ee) [use 1.8.0 to reduce constant ::Fixnum error (#647)](https://github.com/appium/ruby_lib/issues/647)
+
+
 #### v9.6.0 2017-08-20
 
 - [e1a2cd4](https://github.com/appium/ruby_lib/commit/e1a2cd493a370655b390a1d3803a85fbdb5f7f9d) [Release 9 6 0 (#643)](https://github.com/appium/ruby_lib/issues/643)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.6.1
+  version: 9.7.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-27 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -253,55 +253,80 @@ files:
 - docs_gen/docs_from_js.md
 - docs_gen/make_docs.rb
 - lib/appium_lib.rb
-- lib/appium_lib/android/client_xpath.rb
-- lib/appium_lib/android/device.rb
+- lib/appium_lib/android/android.rb
+- lib/appium_lib/android/common/helper.rb
 - lib/appium_lib/android/element/alert.rb
 - lib/appium_lib/android/element/button.rb
 - lib/appium_lib/android/element/generic.rb
 - lib/appium_lib/android/element/text.rb
 - lib/appium_lib/android/element/textfield.rb
-- lib/appium_lib/android/helper.rb
-- lib/appium_lib/android/mobile_methods.rb
-- lib/appium_lib/android/patch.rb
 - lib/appium_lib/android/uiautomator2.rb
+- lib/appium_lib/android/uiautomator2/bridge.rb
 - lib/appium_lib/android/uiautomator2/element.rb
 - lib/appium_lib/android/uiautomator2/element/button.rb
 - lib/appium_lib/android/uiautomator2/helper.rb
-- lib/appium_lib/capabilities.rb
-- lib/appium_lib/common/command.rb
-- lib/appium_lib/common/element/window.rb
-- lib/appium_lib/common/error.rb
+- lib/appium_lib/appium.rb
 - lib/appium_lib/common/helper.rb
-- lib/appium_lib/common/patch.rb
-- lib/appium_lib/common/search_context.rb
-- lib/appium_lib/common/version.rb
+- lib/appium_lib/common/log.rb
+- lib/appium_lib/common/multi_touch.rb
+- lib/appium_lib/common/touch_actions.rb
 - lib/appium_lib/common/wait.rb
-- lib/appium_lib/device/device.rb
-- lib/appium_lib/device/multi_touch.rb
-- lib/appium_lib/device/touch_actions.rb
+- lib/appium_lib/core/android.rb
+- lib/appium_lib/core/android/device.rb
+- lib/appium_lib/core/android/search_context.rb
+- lib/appium_lib/core/android/uiautomator1/bridge.rb
+- lib/appium_lib/core/android/uiautomator2/bridge.rb
+- lib/appium_lib/core/android_uiautomator2.rb
+- lib/appium_lib/core/common.rb
+- lib/appium_lib/core/common/base.rb
+- lib/appium_lib/core/common/base/bridge.rb
+- lib/appium_lib/core/common/base/capabilities.rb
+- lib/appium_lib/core/common/base/command.rb
+- lib/appium_lib/core/common/base/driver.rb
+- lib/appium_lib/core/common/base/http_default.rb
+- lib/appium_lib/core/common/base/search_context.rb
+- lib/appium_lib/core/common/base/wait.rb
+- lib/appium_lib/core/common/command.rb
+- lib/appium_lib/core/common/device.rb
+- lib/appium_lib/core/common/error.rb
+- lib/appium_lib/core/common/log.rb
+- lib/appium_lib/core/common/logger.rb
+- lib/appium_lib/core/core.rb
+- lib/appium_lib/core/device/multi_touch.rb
+- lib/appium_lib/core/device/touch_actions.rb
+- lib/appium_lib/core/driver.rb
+- lib/appium_lib/core/ios.rb
+- lib/appium_lib/core/ios/device.rb
+- lib/appium_lib/core/ios/search_context.rb
+- lib/appium_lib/core/ios/uiautomation/bridge.rb
+- lib/appium_lib/core/ios/uiautomation/patch.rb
+- lib/appium_lib/core/ios/xcuitest/bridge.rb
+- lib/appium_lib/core/ios/xcuitest/device.rb
+- lib/appium_lib/core/ios/xcuitest/search_context.rb
+- lib/appium_lib/core/ios_xcuitest.rb
+- lib/appium_lib/core/patch.rb
 - lib/appium_lib/driver.rb
+- lib/appium_lib/ios/common/errors.rb
+- lib/appium_lib/ios/common/helper.rb
 - lib/appium_lib/ios/element/alert.rb
 - lib/appium_lib/ios/element/button.rb
 - lib/appium_lib/ios/element/generic.rb
 - lib/appium_lib/ios/element/text.rb
 - lib/appium_lib/ios/element/textfield.rb
-- lib/appium_lib/ios/errors.rb
-- lib/appium_lib/ios/helper.rb
-- lib/appium_lib/ios/mobile_methods.rb
-- lib/appium_lib/ios/patch.rb
+- lib/appium_lib/ios/ios.rb
 - lib/appium_lib/ios/xcuitest.rb
+- lib/appium_lib/ios/xcuitest/bridge.rb
 - lib/appium_lib/ios/xcuitest/command.rb
+- lib/appium_lib/ios/xcuitest/command/gestures.rb
 - lib/appium_lib/ios/xcuitest/command/pasteboard.rb
-- lib/appium_lib/ios/xcuitest/device.rb
 - lib/appium_lib/ios/xcuitest/element.rb
 - lib/appium_lib/ios/xcuitest/element/button.rb
 - lib/appium_lib/ios/xcuitest/element/generic.rb
 - lib/appium_lib/ios/xcuitest/element/text.rb
 - lib/appium_lib/ios/xcuitest/element/textfield.rb
-- lib/appium_lib/ios/xcuitest/gestures.rb
 - lib/appium_lib/ios/xcuitest/helper.rb
-- lib/appium_lib/ios/xcuitest/search_context.rb
-- lib/appium_lib/logger.rb
+- lib/appium_lib/sauce_labs.rb
+- lib/appium_lib/version.rb
 - readme.md
 - release_notes.md
 homepage: https://github.com/appium/ruby_lib