appium_lib 9.4.7 → 9.4.8

data/lib/appium_lib/android/client_xpath.rb

@@ -33,11 +33,15 @@ module Appium
       _nodeset_to_uiselector nodes: nodes, first: first
     end
 
+    # @deprecated Please use :uiautomator or :xpath strategy directly
     def client_xpath(xpath)
+      warn '[DEPRECATION] client_xpath will be removed. Please use :uiautomator or :xpath strategy directly.'
       find_element :uiautomator, _client_xpath(xpath: xpath, first: true)
     end
 
+    # @deprecated Please use :uiautomator or :xpath strategy directly
     def client_xpaths(xpath)
+      warn '[DEPRECATION] client_xpaths will be removed. Please use :uiautomator or :xpath strategy directly.'
       find_elements :uiautomator, _client_xpath(xpath: xpath, first: false)
     end
   end

data/lib/appium_lib/common/command.rb

@@ -13,6 +13,7 @@ module Appium
         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],

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '9.4.7'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2017-06-11'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.4.8'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2017-06-24'.freeze unless defined? ::Appium::DATE
 end

data/lib/appium_lib/common/wait.rb

@@ -1,47 +1,50 @@
 module Appium
   module Common
-    # http://mudge.name/2011/01/26/passing-blocks-in-ruby-without-block.html
-    # Note that the Ruby timeout module is avoided. timeout has problems.
-    # https://coderwall.com/p/1novga
+    class Wait < ::Selenium::WebDriver::Wait
+      def initialize(opts = {})
+        valid_keys = [:timeout, :interval, :message, :ignore, :return_if_true]
+        invalid_keys = []
+        opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
+        # [:one, :two] => :one, :two
+        raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
 
-    # Wait code from the selenium Ruby gem
-    # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-    def _generic_wait(opts = {})
-      valid_keys = [:timeout, :interval, :message, :ignore, :return_if_true]
-      invalid_keys = []
-      opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
-      # [:one, :two] => :one, :two
-      raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
-
-      timeout        = opts.fetch(:timeout, @appium_wait_timeout)
-      interval       = opts.fetch(:interval, @appium_wait_interval)
-      message        = opts[:message]
-      ignored        = Array(opts[:ignore] || ::Exception)
-      return_if_true = opts[:return_if_true]
-
-      end_time   = Time.now + timeout
-      last_error = nil
-
-      until Time.now > end_time
-        begin
-          return yield unless return_if_true
-
-          result = yield
-          return result if result
-        rescue ::Errno::ECONNREFUSED => e
-          raise e
-        rescue *ignored => last_error # rubocop:disable Lint/HandleExceptions
-          # swallowed
-        end
+        @timeout        = opts.fetch(:timeout, DEFAULT_TIMEOUT)
+        @interval       = opts.fetch(:interval, DEFAULT_INTERVAL)
+        @message        = opts[:message]
+        @ignored        = Array(opts[:ignore] || ::Exception)
+        @return_if_true = opts[:return_if_true]
 
-        sleep interval
+        super(timeout: @timeout, interval: @interval, message: @message, ignore: @ignored)
       end
 
-      msg = message ? message.dup : "timed out after #{timeout} seconds"
+      # Wait code from the selenium Ruby gem
+      # https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
+      # @override
+      def until
+        end_time   = Time.now + @timeout
+        last_error = nil
+
+        until Time.now > end_time
+          begin
+            return yield unless @return_if_true
+
+            result = yield
+            return result if result
+          rescue ::Errno::ECONNREFUSED => e
+            raise e
+          rescue *@ignored => last_error # rubocop:disable Lint/HandleExceptions
+            # swallowed
+          end
+
+          sleep @interval
+        end
 
-      msg << " (#{last_error.message})" if last_error
+        msg = @message ? @message.dup : "timed out after #{@timeout} seconds"
 
-      raise Selenium::WebDriver::Error::TimeOutError, msg
+        msg << " (#{last_error.message})" if last_error
+
+        raise Selenium::WebDriver::Error::TimeOutError, msg
+      end
     end
 
     # process opts before calling _generic_wait
@@ -66,9 +69,14 @@ module Appium
     # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
-    def wait_true(opts = {}, &block)
+    def wait_true(opts = {})
       opts = _process_wait_opts(opts).merge(return_if_true: true)
-      _generic_wait opts, &block
+
+      opts[:timeout]  ||= @appium_wait_timeout
+      opts[:interval] ||= @appium_wait_interval
+
+      wait = ::Appium::Common::Wait.new opts
+      wait.until { yield }
     end
 
     # Check every interval seconds to see if yield doesn't raise an exception.
@@ -84,9 +92,14 @@ module Appium
     # @option opts [Numeric] :interval Seconds to sleep between polls. Set default by `appium_wait_interval` (0.5).
     # @option opts [String] :message Exception message if timed out.
     # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Exception)
-    def wait(opts = {}, &block)
+    def wait(opts = {})
       opts = _process_wait_opts(opts).merge(return_if_true: false)
-      _generic_wait opts, &block
+
+      opts[:timeout]  ||= @appium_wait_timeout
+      opts[:interval] ||= @appium_wait_interval
+
+      wait = ::Appium::Common::Wait.new opts
+      wait.until { yield }
     end
   end # module Common
 end # module Appium

data/lib/appium_lib/device/device.rb

@@ -22,6 +22,20 @@ module Appium
     #   ```
 
     # @!method current_activity
+    #   Get current activity name
+    #   @return [String] An activity name
+    #
+    #   ```ruby
+    #   current_activity # '.ApiDemos'
+    #   ```
+
+    # @!method current_package
+    #   Get current package name
+    #   @return [String] A package name
+    #
+    #   ```ruby
+    #   current_package # 'com.example.android.apis'
+    #   ```
 
     # @!method get_system_bars
     #   Get system bar's information
@@ -583,14 +597,20 @@ module Appium
     # @param context (String) The context to switch to for the duration of the block.
     #
     # ```ruby
-    # within_context('NATIVE_APP') do
-    #   find_element [:tag, "button"]
+    # result = within_context('NATIVE_APP') do
+    #   find_element :tag, "button"
+    # end # The result of `find_element :tag, "button"`
     # ```
     def within_context(context)
       existing_context = current_context
       set_context context
-      yield if block_given?
-      set_context existing_context
+      if block_given?
+        result = yield
+        set_context existing_context
+        result
+      else
+        set_context existing_context
+      end
     end
 
     # Change to the default context.  This is equivalent to `set_context nil`.

data/lib/appium_lib/ios/helper.rb

@@ -6,31 +6,32 @@ module Appium
       def start_element(type, attrs = [])
         return if filter && !filter.eql?(type)
         page = attrs.inject({}) do |hash, attr|
-          hash[attr[0]] = attr[1] if %w(name label value hint).include?(attr[0])
+          hash[attr[0]] = attr[1] if %w(name label value hint visible).include?(attr[0])
           hash
         end
-        _print_attr(type, page['name'], page['label'], page['value'], page['hint'])
+        _print_attr(type, page['name'], page['label'], page['value'], page['hint'], page['visible'])
       end
 
-      def _print_attr(type, name, label, value, hint)
+      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
+          puts type.to_s if name || label || value || hint || visible
           puts "   name, label, value: #{name}" if name
         elsif name == label
-          puts type.to_s if name || label || value || hint
+          puts type.to_s if name || label || value || hint || visible
           puts "   name, label: #{name}" if name
           puts "   value: #{value}" if value
         elsif name == value
-          puts type.to_s if name || label || value || hint
+          puts type.to_s if name || label || value || hint || visible
           puts "   name, value: #{name}" if name
           puts "  label: #{label}" if label
         else
-          puts type.to_s if name || label || value || hint
+          puts type.to_s if name || label || value || hint || visible
           puts "   name: #{name}" if name
           puts "  label: #{label}" if label
           puts "  value: #{value}" if value
         end
         puts "   hint: #{hint}" if hint
+        puts "   visible: #{visible}" if visible
       end
     end
     # iOS only. On Android uiautomator always returns an empty string for EditText password.
@@ -50,7 +51,10 @@ module Appium
     # @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
 
@@ -85,10 +89,10 @@ module Appium
         type    = fix_space element['type']
 
         # if class_name is set, mark non-matches as invisible
-        visible = (type.downcase.include? class_namet).to_s if class_name
+        visible = (type.downcase.include? class_name).to_s if class_name
         if visible && visible == 'true'
 
-          _print_attr(type, name, label, value, hint)
+          _print_attr(type, name, label, value, hint, visible)
 
           # there may be many ids with the same value.
           # output all exact matches.
@@ -128,22 +132,16 @@ module Appium
     #
     # ```ruby
     # page class: :UIAButton # filter on buttons
-    # page window: 1 # show source for window 1
     # page class: :UIAButton, window: 1
     # ```
     #
-    # @option window [Integer] window index. -1 for default
+    # @option visible [Symbol] visible value to filter on
     # @option class [Symbol] class name to filter on
     #
     # @return [void]
     def page(opts = {})
-      if opts.is_a?(Hash)
-        window_number = opts.fetch :window, -1
-        class_name    = opts.fetch :class, nil
-      else
-        window_number = -1
-        class_name    = opts
-      end
+      class_name = opts.is_a?(Hash) ? opts.fetch(:class, nil) : opts
+
       # current_context may be nil which breaks start_with
       if current_context && current_context.start_with?('WEBVIEW')
         s      = get_source
@@ -153,8 +151,7 @@ module Appium
         parser.parse s
         parser.document.result
       else
-
-        s = source_window(window_number || 0)
+        s = source_window
         parser = Nokogiri::XML::SAX::Parser.new(UITestElementsPrinter.new)
         if class_name
           parser.document.filter = class_name.is_a?(Symbol) ? class_name.to_s : class_name
@@ -165,14 +162,9 @@ module Appium
     end
 
     # Gets the JSON source of window number
-    # @param [Integer] _window_number The int index of the target window
     # @return [JSON]
-    def source_window(_window_number = 0)
-      # TODO: update comments
-      # appium 1.0 still returns JSON when getTree() is invoked so this
-      # doesn't need to change to XML. If getTree() is removed then
-      # source_window will need to parse the elements of getTreeForXML()\
-      # https://github.com/appium/appium-uiauto/blob/247eb71383fa1a087ff8f8fc96fac25025731f3f/uiauto/appium/element.js#L145
+    def source_window(window_number = nil)
+      warn '[DEPRECATION] The argument window_number will be removed. Plesse remove window_number' unless window_number
       get_source
     end
 

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v9.4.7 2017-06-11
+
+- [ef9efbd](https://github.com/appium/ruby_lib/commit/ef9efbd6d3fadfaebaa4245bed40d28aec33be32) [Release 9 4 7 (#601)](https://github.com/appium/ruby_lib/issues/601)
+- [29f031a](https://github.com/appium/ruby_lib/commit/29f031a0b8d180289cfd8a9de4216300916cd5cc) [Ignore server version check for grid (#600)](https://github.com/appium/ruby_lib/issues/600)
+- [1b7a4b4](https://github.com/appium/ruby_lib/commit/1b7a4b45074761141d25b1461d0c23672889905d) [Update CHANGELOG.md (#597)](https://github.com/appium/ruby_lib/issues/597)
+
+
 #### v9.4.6 2017-05-25
 
 - [a44ea77](https://github.com/appium/ruby_lib/commit/a44ea770287407ba9b488e25e259884676c89709) [Release 9 4 6 (#593)](https://github.com/appium/ruby_lib/issues/593)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.4.7
+  version: 9.4.8
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-11 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver