watir 7.1.0 → 7.2.0

data/lib/watir/scroll.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module Scrolling
     def scroll
@@ -7,7 +9,9 @@ module Watir
 
   class Scroll
     def initialize(object)
+      @driver = object.browser.wd
       @object = object
+      @origin = nil
     end
 
     # Scrolls by offset.
@@ -15,15 +19,20 @@ module Watir
     # @param [Fixnum] top Vertical offset
     #
     def by(left, top)
-      @object.browser.execute_script('window.scrollBy(arguments[0], arguments[1]);', Integer(left), Integer(top))
+      if @origin
+        @driver.action.scroll_from(@origin, left, top).perform
+      else
+        @object.browser.execute_script('window.scrollBy(arguments[0], arguments[1]);', Integer(left), Integer(top))
+      end
       self
     end
 
-    #
     # Scrolls to specified location.
     # @param [Symbol] param
     #
     def to(param = :top)
+      return scroll_to_element if param == :viewport
+
       args = @object.is_a?(Watir::Element) ? element_scroll(param) : browser_scroll(param)
       raise ArgumentError, "Don't know how to scroll #{@object} to: #{param}!" if args.nil?
 
@@ -31,8 +40,24 @@ module Watir
       self
     end
 
+    # Sets an origin point for a future scroll
+    # @param [Integer] x_offset
+    # @param [Integer] y_offset
+    def from(x_offset = 0, y_offset = 0)
+      @origin = if @object.is_a?(Watir::Element)
+                  Selenium::WebDriver::WheelActions::ScrollOrigin.element(@object.we, x_offset, y_offset)
+                else
+                  Selenium::WebDriver::WheelActions::ScrollOrigin.viewport(x_offset, y_offset)
+                end
+      self
+    end
+
     private
 
+    def scroll_to_element
+      @driver.action.scroll_to(@object.we).perform
+    end
+
     def element_scroll(param)
       script = case param
                when :top, :start

data/lib/watir/search_context.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Watir
+  module SearchContext
+    #
+    # Returns true if element exists.
+    # Checking for staleness is deprecated
+    #
+    # @return [Boolean]
+    #
+
+    def exists?
+      if located? && stale?
+        reset!
+      elsif located?
+        return true
+      end
+
+      assert_exists
+      true
+    rescue Exception::UnknownObjectException, Exception::UnknownFrameException
+      false
+    end
+    alias exist? exists?
+
+    def assert_exists
+      locate unless located?
+      return if located?
+
+      raise unknown_exception, "unable to locate: #{inspect}"
+    end
+
+    def wait_for_exists
+      return if located? # Performance shortcut
+
+      begin
+        @query_scope.wait_for_exists unless @query_scope.is_a? Browser
+        wait_until(element_reset: true, &:exists?)
+      rescue Wait::TimeoutError
+        msg = "timed out after #{Watir.default_timeout} seconds, waiting for #{inspect} to be located"
+        raise unknown_exception, msg
+      end
+    end
+
+    # TODO: - this will get addressed with Watir::Executor implementation
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength # : # ::
+    def element_call(precondition = nil, &block)
+      caller = caller_locations(1, 1)[0].label
+      already_locked = browser.timer.locked?
+      browser.timer = Wait::Timer.new(timeout: Watir.default_timeout) unless already_locked
+
+      begin
+        check_condition(precondition, caller)
+        Watir.logger.debug "-> `Executing #{inspect}##{caller}`"
+        yield
+      rescue unknown_exception => e
+        element_call(:wait_for_exists, &block) if precondition.nil?
+        raise unknown_exception, e.message + custom_message
+      rescue Selenium::WebDriver::Error::StaleElementReferenceError, Selenium::WebDriver::Error::NoSuchElementError
+        reset!
+        retry
+        # TODO: - InvalidElementStateError is deprecated, so no longer calling `raise_disabled`
+        # need a better way to handle this
+      rescue Selenium::WebDriver::Error::ElementNotInteractableError
+        raise_present unless browser.timer.remaining_time.positive?
+        raise_present unless %i[wait_for_present wait_for_enabled wait_for_writable].include?(precondition)
+        retry
+      rescue Selenium::WebDriver::Error::NoSuchWindowError
+        raise Exception::NoMatchingWindowFoundException, 'browser window was closed'
+      ensure
+        Watir.logger.debug "<- `Completed #{inspect}##{caller}`"
+        browser.timer.reset! unless already_locked
+      end
+    end
+
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    def check_condition(condition, caller)
+      Watir.logger.debug "<- `Verifying precondition #{inspect}##{condition} for #{caller}`"
+      begin
+        condition.nil? ? assert_exists : send(condition)
+        Watir.logger.debug "<- `Verified precondition #{inspect}##{condition || 'assert_exists'}`"
+      rescue unknown_exception
+        raise unless condition.nil?
+
+        Watir.logger.debug "<- `Unable to satisfy precondition #{inspect}##{condition}`"
+        check_condition(:wait_for_exists, caller)
+      end
+    end
+
+    def unknown_exception
+      Exception::UnknownObjectException
+    end
+  end
+end

data/lib/watir/shadow_root.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Watir
+  class ShadowRoot
+    include Container
+    include Exception
+    include SearchContext
+    include Waitable
+
+    def initialize(element)
+      @query_scope = element
+    end
+
+    def browser
+      @query_scope.browser
+    end
+
+    def located?
+      !!@shadow_root
+    end
+
+    def wd
+      assert_exists
+      @shadow_root
+    end
+
+    def execute_script(script, *args, function_name: nil)
+      browser.execute_script(script, *args, function_name: function_name)
+    end
+
+    def stale?
+      @shadow_root.find_elements(css: 'checking_stale_shadow_root')
+      false
+    rescue Selenium::WebDriver::Error::DetachedShadowRootError
+      true
+    end
+
+    def reset!
+      @shadow_root = nil
+    end
+
+    def locate
+      @shadow_root = @query_scope.wd.shadow_root
+    rescue Selenium::WebDriver::Error::NoSuchShadowRootError
+      nil
+    end
+
+    #
+    # @api private
+    #
+
+    def selector_string
+      "#{@query_scope.selector_string} --> shadow_root"
+    end
+
+    def custom_message
+      ''
+    end
+  end
+end

data/lib/watir/user_editable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module UserEditable
     #
@@ -34,7 +36,7 @@ module Watir
 
     def set!(*args)
       msg = '#set! does not support special keys, use #set instead'
-      raise ArgumentError, msg if args.any? { |v| v.is_a?(::Symbol) }
+      raise ArgumentError, msg if args.any?(::Symbol)
 
       input_value = args.join
       set input_value[0]

data/lib/watir/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
-  VERSION = '7.1.0'.freeze
+  VERSION = '7.2.0'
 end

data/lib/watir/wait/timer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module Wait
     class Timer
@@ -14,7 +16,7 @@ module Watir
       #
 
       def wait(timeout, &block)
-        end_time = @end_time || current_time + timeout
+        end_time = @end_time || (current_time + timeout)
         loop do
           yield(block)
           @remaining_time = end_time - current_time

data/lib/watir/wait.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'watir/wait/timer'
 
 module Watir
@@ -62,11 +64,9 @@ module Watir
       private
 
       def message_for(timeout, object, message)
-        message = message.call(object) if message.is_a?(Proc)
-        err = "timed out after #{timeout} seconds"
-        err << ", #{message}" if message
-
-        err
+        message = message.is_a?(Proc) ? message.call(object) : message || ''
+        additional = message.empty? ? '' : ", #{message}"
+        "timed out after #{timeout} seconds#{additional}"
       end
 
       def run_with_timer(timeout, interval)

data/lib/watir/window.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Window
     include Waitable
@@ -15,14 +17,16 @@ module Watir
       elsif selector.key? :handle
         @handle = selector.delete :handle
       else
-        return if selector.keys.all? { |k| %i[title url element].include? k }
+        types = %i[title url element]
+        return if selector.keys.all? { |k| types.include? k }
 
         raise ArgumentError, "invalid window selector: #{selector_string}"
       end
     end
 
     def inspect
-      format('#<%s:0x%x located=%s>', self.class, hash * 2, !!@handle)
+      format('#<%<class>s:0x%<hash>x located=%<handle>s>',
+             class: self.class, hash: hash * 2, handle: !!@handle)
     end
 
     #
@@ -148,7 +152,7 @@ module Watir
     alias eql? ==
 
     def hash
-      handle.hash ^ self.class.hash
+      [handle, self.class].hash
     end
 
     #

data/lib/watir/window_collection.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Watir
   class WindowCollection
     include Enumerable
     include Waitable
 
     def initialize(browser, selector = {})
-      unless selector.keys.all? { |k| %i[title url element].include? k }
+      types = %i[title url element]
+      unless selector.keys.all? { |k| types.include? k }
         raise ArgumentError, "invalid window selector: #{selector.inspect}"
       end
 

data/lib/watir.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'selenium-webdriver'
 require 'time'
 
+require 'watir/search_context'
 require 'watir/scroll'
 require 'watir/wait'
 require 'watir/exception'
@@ -99,5 +102,6 @@ require 'watir/elements/text_area'
 require 'watir/elements/text_field'
 require 'watir/elements/input'
 require 'watir/radio_set'
+require 'watir/shadow_root'
 
 require 'watir/aliases'

data/lib/watirspec/guards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WatirSpec
   module Guards
     class << self

data/lib/watirspec/implementation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WatirSpec
   class Implementation
     attr_writer :name, :guard_proc, :browser_class
@@ -37,16 +39,18 @@ module WatirSpec
     end
 
     def inspect_args
-      hash = browser_args.last
-      desired_capabilities = hash.delete(:desired_capabilities)
-      string = ''
-      hash.each { |arg| string << "#{arg.inspect}\n" }
-      return "#{string} default capabilities" unless desired_capabilities
-
-      string << "\tcapabilities:\n"
-      caps.each { |k, v| string << "\t\t#{k}: #{v}\n" }
-      hash[:desired_capabilities] = desired_capabilities
-      string
+      selenium_opts = browser_args.last
+
+      options = selenium_opts.delete(:options)
+      args = ["#{browser_args.first} tests:\n"]
+      selenium_opts.each { |opt| args << "#{opt.inspect}\n" }
+
+      return "#{browser_args.first} default options" if selenium_opts.empty? && options.nil?
+
+      args << "\toptions:\n"
+      options.each { |k, v| args << "\t\t#{k}: #{v}\n" }
+
+      args.join
     end
   end # Implementation
 end # WatirSpec

data/lib/watirspec/rake_tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/tasklib'
 
 module WatirSpec
@@ -27,12 +29,10 @@ module WatirSpec
     private
 
     def init_watirspec
-      Dir.mkdir('spec') unless Dir.exist?('spec')
+      FileUtils.mkdir_p('spec')
       return if File.exist?('spec/watirspec_helper.rb')
 
-      File.open('spec/watirspec_helper.rb', 'w') do |file|
-        file.write(watirspec_helper_template)
-      end
+      File.write('spec/watirspec_helper.rb', watirspec_helper_template)
     end
 
     def print_specs

data/lib/watirspec/remote_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WatirSpec
   class RemoteServer
     include Watir::Exception
@@ -21,17 +23,17 @@ module WatirSpec
 
     def jar
       if File.exist?(ENV['REMOTE_SERVER_BINARY'] || '')
-        ENV['REMOTE_SERVER_BINARY']
+        ENV.fetch('REMOTE_SERVER_BINARY', nil)
       elsif ENV['LOCAL_SELENIUM']
         File.expand_path('../selenium/bazel-bin/java/server/src/org/openqa/selenium/grid/selenium_server_deploy.jar')
       elsif !Dir.glob('*selenium*.jar').empty?
         Dir.glob('*selenium*.jar').first
       else
-        Selenium::Server.download :latest
+        Selenium::Server.download
       end
     rescue SocketError
       # not connected to internet
-      raise Error, 'unable to find or download selenium-server-standalone jar'
+      raise Error, 'unable to find or download selenium-server jar'
     end
   end
 end

data/lib/watirspec/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WatirSpec
   module Runner
     module BrowserHelper
@@ -25,7 +27,7 @@ module WatirSpec
     end
 
     def execute
-      start_server
+      start_server unless ENV['WATIR_PUBLIC_SERVER']
       configure
       add_guard_hook
 

data/lib/watirspec/server/app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WatirSpec
   class Server
     class App

data/lib/watirspec/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 require 'watirspec/server/app'
 

data/lib/watirspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tmpdir'
 require 'watirspec/guards'
 require 'watirspec/implementation'
@@ -22,7 +24,7 @@ module WatirSpec
     end
 
     def host
-      @host ||= "http://#{Server.bind}:#{Server.port}"
+      @host ||= ENV['WATIR_PUBLIC_SERVER'] ? 'http://watir.com/examples' : "http://#{Server.bind}:#{Server.port}"
     end
 
     def unguarded?
@@ -61,6 +63,7 @@ module WatirSpec
 
       instance = klass.new(*args)
       print_browser_info_once(instance)
+      instance.window.maximize
 
       instance
     end
@@ -78,13 +81,13 @@ module WatirSpec
       caps = instance.driver.capabilities
 
       info << caps.browser_name.to_s
-      info << caps.version.to_s
+      info << caps.browser_version.to_s
       info << @implementation.driver_info
 
       Watir.logger.warn "running watirspec against #{info.join ' '} using:\n#{WatirSpec.implementation.inspect_args}",
                         id: [:browser_info]
-    rescue StandardError
-      # ignored
+    rescue StandardError => e
+      Watir.logger.warn("Unable to print browser info: #{e}")
     end
   end # class << WatirSpec
 end # WatirSpec

data/spec/locator_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LocatorSpecHelper
   def browser
     @browser ||= instance_double(Watir::Browser, wd: driver)

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))