watir 1.4.1 → 7.3.0

data/spec/watirspec_helper.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'watirspec'
+require 'spec_helper'
+require 'selenium/webdriver/support/guards'
+
+Watir.default_timeout = 5
+
+if ENV['SELENIUM_STATS'] == 'true'
+  require 'selenium_statistics'
+  at_exit { SeleniumStatistics.print_results }
+end
+
+class LocalConfig
+  def initialize(imp)
+    @imp = imp
+  end
+
+  def browser
+    @browser ||= (ENV['WATIR_BROWSER'] || :chrome).to_sym
+  end
+
+  def configure
+    @imp.browser_class = Watir::Browser
+    set_webdriver
+    set_browser_args
+  end
+
+  private
+
+  def set_webdriver
+    @imp.name = :local_driver
+  end
+
+  def set_browser_args
+    args = create_args
+    @imp.browser_args = [browser, args]
+  end
+
+  def create_args
+    method = "#{browser}_args".to_sym
+    args = if private_methods.include?(method)
+             send method
+           else
+             {}
+           end
+
+    if ENV['SELECTOR_STATS']
+      listener = SelectorListener.new
+      args[:listener] = listener
+      at_exit { listener.report }
+    end
+
+    args
+  end
+
+  def firefox_args
+    opts = {options: {}}
+    opts[:headless] = true if ENV['HEADLESS']
+    opts[:options][:binary] = ENV['FIREFOX_BINARY'] if ENV['FIREFOX_BINARY']
+    opts
+  end
+
+  def safari_preview_args
+    @browser = :safari
+    Selenium::WebDriver::Safari.technology_preview!
+    {technology_preview: true}
+  end
+
+  def chrome_args
+    opts = {options: {args: ['--disable-translate']}}
+    opts[:headless] = true if ENV['HEADLESS']
+    opts[:options][:binary] = ENV['CHROME_BINARY'] if ENV['CHROME_BINARY']
+    opts
+  end
+
+  def edge_args
+    opts = {options: {args: ['--disable-translate']}}
+    opts[:headless] = true if ENV['HEADLESS']
+    opts[:options][:binary] = ENV['EDGE_BINARY'] if ENV['EDGE_BINARY']
+    opts
+  end
+
+  class SelectorListener < Selenium::WebDriver::Support::AbstractEventListener
+    def initialize
+      super
+      @counts = Hash.new(0)
+    end
+
+    def before_find(how, _what, _driver)
+      @counts[how] += 1
+    end
+
+    def report
+      total = @counts.values.sum
+      str = "Selenium selector stats: \n"
+      @counts.each do |how, count|
+        str << "\t#{how.to_s.ljust(20)}: #{count * 100 / total} (#{count})\n"
+      end
+      Watir.logger.warn str
+    end
+  end
+end
+
+class RemoteConfig < LocalConfig
+  def configure
+    @url = ENV['REMOTE_SERVER_URL'] || begin
+      require 'watirspec/remote_server'
+
+      remote_server = WatirSpec::RemoteServer.new
+      remote_server.start(4444)
+      remote_server.server.webdriver_url
+    end
+    super
+  end
+
+  private
+
+  def create_args
+    super.merge(url: @url)
+  end
+
+  def set_webdriver
+    @imp.name = :remote_driver
+  end
+end
+
+if ENV['REMOTE_SERVER_URL'] || ENV['USE_REMOTE']
+  RemoteConfig.new(WatirSpec.implementation).configure
+else
+  LocalConfig.new(WatirSpec.implementation).configure
+end
+
+WatirSpec.run!
+
+RSpec.configure do |config|
+  config.before do |example|
+    guards = Selenium::WebDriver::Support::Guards.new(example,
+                                                      bug_tracker: 'https://github.com/watir/watir/issues')
+
+    guards.add_condition(:browser, WatirSpec.implementation.browser_args.first)
+    guards.add_condition(:platform, Selenium::WebDriver::Platform.os)
+    guards.add_condition(:driver, WatirSpec.implementation.name)
+
+    headless = WatirSpec.implementation.browser_args.last[:headless]
+    guards.add_condition(:headless, headless)
+
+    guards.add_condition(:ci, ENV['DESKTOP_SESSION'].nil?)
+
+    results = guards.disposition
+    send(*results) if results
+
+    $browser = WatirSpec.new_browser if $browser.nil? || $browser.closed?
+  end
+
+  if ENV['AUTOMATIC_RETRY']
+    require 'rspec/retry'
+    config.verbose_retry = true
+    config.display_try_failure_messages = true
+    config.default_retry_count = 3
+    config.exceptions_to_retry = [IOError, Net::ReadTimeout]
+  end
+end

data/support/doctest_helper.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'watir'
+require 'watirspec'
+require 'webdrivers'
+
+#
+# 1. If example does not start browser, start new one, reuse until example
+#    finishes and close after.
+# 2. If example starts browser and assigns it to local variable `browser`,
+#    it will still be closed.
+#
+
+def browser
+  $browser ||= Watir::Browser.new(:chrome)
+end
+
+YARD::Doctest.configure do |doctest|
+  doctest.skip 'Watir::Browser.start'
+  doctest.skip 'Watir::Cookies'
+  doctest.skip 'Watir::Element#to_subtype'
+  doctest.skip 'Watir::Option'
+  doctest.skip 'Watir::Screenshot'
+  doctest.skip 'Watir::Window#size'
+  doctest.skip 'Watir::Window#position'
+  doctest.skip 'Watir::Window#maximize'
+
+  doctest.before do
+    WatirSpec.run!
+    sleep 1 # give Chrome some time to breathe in
+    browser.goto WatirSpec.url_for('forms_with_input_elements.html')
+  end
+
+  doctest.after do
+    sleep 1 # give Chrome some time to breathe out
+    browser.windows.drop(1).each(&:close)
+  end
+
+  %w[text ok close exists? present?].each do |name|
+    doctest.before("Watir::Alert##{name}") do
+      browser.goto WatirSpec.url_for('alerts.html')
+      browser.button(id: 'alert').click
+    end
+  end
+
+  doctest.before('Watir::Alert#set') do
+    browser.goto WatirSpec.url_for('alerts.html')
+    browser.button(id: 'prompt').click
+  end
+
+  %w[text exists? present?].each do |name|
+    doctest.after("Watir::Alert##{name}") do
+      browser.alert.close
+    end
+  end
+
+  %w[Watir::Browser#execute_script Watir::Element#drag_and_drop].each do |name|
+    doctest.before(name) do
+      browser.goto WatirSpec.url_for('drag_and_drop.html')
+    end
+  end
+
+  %w[attribute_value attribute].each do |name|
+    doctest.before("Watir::Element##{name}") do
+      browser.goto WatirSpec.url_for('non_control_elements.html')
+    end
+  end
+
+  %w[Watir::JSExecution Watir::List].each do |name|
+    doctest.before(name) do
+      browser.goto WatirSpec.url_for('non_control_elements.html')
+    end
+  end
+
+  %w[fire_event].each do |name|
+    doctest.before("Watir::JSExecution##{name}") do
+      browser.goto WatirSpec.url_for('forms_with_input_elements.html')
+    end
+  end
+
+  doctest.before('Watir::Table') do
+    browser.goto WatirSpec.url_for('tables.html')
+  end
+
+  %w[Watir::HasWindow Watir::Window#== Watir::Window#use].each do |name|
+    doctest.before(name) do
+      browser.goto WatirSpec.url_for('window_switching.html')
+      browser.a(id: 'open').click
+    end
+  end
+
+  doctest.after('Watir::Logger') do
+    Watir.logger.level = :warn
+  end
+
+  doctest.after('Watir::AfterHooks') do
+    browser.after_hooks.each do |hook|
+      browser.after_hooks.delete(hook)
+    end
+  end
+end

data/support/version_differ.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class VersionDiffer
+  def print_latest(io = $stdout)
+    io.puts diff(last_version, '.')
+  end
+
+  def update(path)
+    old = File.read(path)
+    File.open(path, 'w') do |file|
+      print_latest(file)
+      file << old
+    end
+  end
+
+  def generate(path)
+    versions = released_versions
+    versions.unshift '.'
+
+    versions.each_cons(2) do |new_version, old_version|
+      File.open(path, 'a') do |file|
+        file << diff(old_version, new_version)
+      end
+    end
+  end
+
+  private
+
+  def last_version
+    released_versions.first
+  end
+
+  def released_versions
+    require 'open-uri'
+    require 'multi_json'
+
+    versions = MultiJson.decode(open('https://rubygems.org/api/v1/versions/watir.json').read)
+    versions.map! { |e| e.fetch('number') }
+  end
+
+  def diff(old_version, new_version)
+    puts "diffing #{old_version} -> #{new_version}"
+
+    left = "watir-#{old_version}.gem"
+    right = new_version == '.' ? new_version : "watir-#{new_version}.gem"
+
+    str = StringIO.new
+    str.puts new_version.to_s
+    str.puts '=' * new_version.length
+    str.puts
+
+    # requires YARD > 0.8.2.1 (i.e. next release at the time of writing)
+    query = '!@private && @api.text != "private" && object.visibility == :public'
+    content = `yard diff --all --query #{query} #{left} #{right} 2>&1`
+    str.puts(content.split("\n").map { |line| line.empty? ? line : "   #{line}" })
+    str.puts "\n\n"
+
+    str.string
+  end
+end

data/watir.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'watir/version'
+
+Gem::Specification.new do |s|
+  s.name = 'watir'
+  s.version = Watir::VERSION
+  s.required_ruby_version = '>= 3.0.0'
+
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Alex Rodionov', 'Titus Fortner', 'Justin Ko']
+  s.email = ['p0deje@gmail.com', 'titusfortner@gmail.com', 'jkotests@gmail.com ']
+  s.homepage = 'https://github.com/watir/watir'
+  s.summary = 'Watir powered by Selenium'
+  s.description = <<~DESCRIPTION_MESSAGE
+    Watir stands for Web Application Testing In Ruby
+    It facilitates the writing of automated tests by mimicing the behavior of a user interacting with a website.
+  DESCRIPTION_MESSAGE
+
+  s.license = 'MIT'
+  s.metadata['rubygems_mfa_required'] = 'true'
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'regexp_parser', '>= 1.2', '< 3'
+  s.add_runtime_dependency 'selenium-webdriver', '~> 4.2'
+
+  s.add_development_dependency 'activesupport', '~> 4.0', '>= 4.1.11' # for pluralization during code generation
+  s.add_development_dependency 'coveralls_reborn'
+  s.add_development_dependency 'nokogiri', '>= 1.14.0.rc1'
+  s.add_development_dependency 'pry', '~> 0.14'
+  s.add_development_dependency 'rake', '>= 12.3.3'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-retry'
+  s.add_development_dependency 'rubocop', '~> 1.42'
+  s.add_development_dependency 'rubocop-performance', '~> 1.15'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.16'
+  s.add_development_dependency 'selenium_statistics'
+  s.add_development_dependency 'selenium-webdriver', '~> 4.11'
+  s.add_development_dependency 'simplecov-console'
+  s.add_development_dependency 'webidl', '>= 0.2.2'
+  s.add_development_dependency 'yard', '> 0.9.11'
+  s.add_development_dependency 'yard-doctest', '~> 0.1.14'
+end