watir 6.13.0 → 6.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee77498367fb399c13c754467a7e0b751cff3b3e
-  data.tar.gz: 38566fb0f06601dc54206268cc4904d184d193fa
+  metadata.gz: 6a6cd2d994ac6819dcc74e5b15639de4061bf1fe
+  data.tar.gz: f713658a590057181b64c8cfb26e2c278c02fdda
 SHA512:
-  metadata.gz: 3538e96c26022ffc51d3a9e8bf3a40eedf4ac739001547059f015cc3d034b24c3dd9a99b3477a7a3c3125ee074edb94cdaa130f440ac8e5e6ff0c32f5f43de36
-  data.tar.gz: 480541837a063fa207523e68e32a72f6ad8d39dc18362d466c25adc410bf1686370e0a58b9fbf2e06dcbf4c03f4706ca93c55c486f0492795233086b45f5ce6d
+  metadata.gz: c55e3c6cb644323b2e1e4dfe0b1488a9c0a53733d88022f4986e55cfb6ee0ad5b4b64c5604f096df2d702d86f4d2393012f6ad507468e88fad4be89c10fbbee1
+  data.tar.gz: 07f6e39aa359c8c89b2dc012a7ce6ef4a4c17b68645ef827aed01bb03cf130217e94c69eb0fadc5d41826708fe672c443b73c80e54613f7e08ca81c2f1bbad04

data/.rubocop.yml

@@ -0,0 +1,141 @@
+# Offense count: 144
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/watir/elements/html_elements.rb'
+    - 'lib/watir/elements/svg_elements.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/watir/elements/html_elements.rb'
+    - 'lib/watir/elements/svg_elements.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/watir/elements/html_elements.rb'
+    - 'lib/watir/elements/svg_elements.rb'
+
+# Offense count: 85
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/watirspec.rb'
+
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'support/doctest_helper.rb'
+    - 'watir.gemspec'
+    - 'Rakefile'
+
+## Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/watir/elements/html_elements.rb'
+    - 'lib/watir/elements/svg_elements.rb'
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 18
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 116
+  Exclude:
+    - 'lib/watir/locators/element/locator.rb'
+    - 'lib/watir/browser.rb'
+    - 'lib/watir/elements/element.rb'
+    - 'lib/watir/elements/select.rb'
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 28
+Metrics/AbcSize:
+  Max: 22
+  Exclude:
+    - 'lib/watir/locators/element/selector_builder.rb'
+    - 'lib/watir/generator/base/generator.rb'
+
+# TODO: fix with Watir 7
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/watir/wait.rb'
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+## Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  AllowedVariables:
+    - $browser
+
+### Cop supports --auto-correct.
+### Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+## SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/watir/elements/html_elements.rb'
+    - 'lib/watir/elements/svg_elements.rb'
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+# TODO: I can't tell if this applies
+## Configuration parameters: EnforcedStyle.
+## SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  Exclude:
+    - 'lib/watir/browser.rb'
+    - 'lib/watir/locators/text_field/selector_builder.rb'
+    - 'lib/watir/window.rb'
+
+Style/Documentation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/watir-webdriver.rb'

data/.travis.yml

@@ -71,6 +71,12 @@ matrix:
       - env: RAKE_TASK=spec:chrome HEADLESS=true
         <<: *five
         <<: *chrome
+      - env: RAKE_TASK=spec:stats
+        <<: *five
+        <<: *chrome
       - env: RAKE_TASK=yard:doctest
         <<: *five
         <<: *chrome
+      - env: RAKE_TASK=rubocop
+        <<: *three
+        <<: *chrome

data/CHANGES.md

@@ -1,3 +1,15 @@
+### 6.14.0 (2018-09-13)
+
+* HTML Element attribute support updated to HTML 5.2
+* `#wait_until_present` and `#wait_while_present` accept custom message arguments (thanks Jakub Samek)
+* Added `Element#located?` method
+* Fix bug preventing collections from waiting for a parent element (#759)
+* Fix bug preventing collection elements from being cached
+* Update code style in accordance with Rubocop settings
+* Add `Element#attribute_list` and `Element#attribute_values` (thanks Lakshya Kapoor)
+* Fix bug preventing location of elements based on how XPath deals with default namespaces 
+* Ruby 2.2 and below are no longer supported.
+
 ### 6.13.0 (2018-09-02)
 
 * Allow wait methods to wait for values of any attribute

data/Gemfile

@@ -1,16 +1,10 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-unless ENV['TRAVIS']
-  gem "simplecov", ">= 0.3.5", platform: :ruby_19
-end
+gem 'simplecov', '>= 0.3.5', platform: :ruby_19 unless ENV['TRAVIS']
 
-if ENV['LOCAL_WEBIDL']
-  gem 'webidl', path: File.expand_path('../webidl')
-end
+gem 'webidl', path: File.expand_path('../webidl') if ENV['LOCAL_WEBIDL']
 
-if ENV['LOCAL_SELENIUM']
-  gem 'selenium-webdriver', path: File.expand_path('../selenium/build/rb')
-end
+gem 'selenium-webdriver', path: File.expand_path('../selenium/build/rb') if ENV['LOCAL_SELENIUM']
 
 # Specify your gem's dependencies in watir.gemspec
 gemspec

data/README.md

@@ -6,50 +6,33 @@ Watir Powered By Selenium!
 [![Travis Status](https://travis-ci.org/watir/watir.svg?branch=master)](https://travis-ci.org/watir/watir)
 [![AppVeyor status](https://ci.appveyor.com/api/projects/status/9vbb7pp5p4uyoott/branch/master?svg=true)](https://ci.appveyor.com/project/p0deje/watir)
 [![Code Climate](https://codeclimate.com/github/watir/watir.svg)](https://codeclimate.com/github/watir/watir)
-[![Dependency Status](https://gemnasium.com/watir/watir.svg)](https://gemnasium.com/watir/watir)
 [![Coverage Status](https://coveralls.io/repos/watir/watir/badge.svg?branch=master)](https://coveralls.io/r/watir/watir)
 
-## Example
-
-```ruby
-require 'watir'
-
-browser = Watir::Browser.new
-
-browser.goto 'watir.com'
-browser.link(text: 'Guides').click
-
-puts browser.title
-# => 'Guides – Watir Project'
-browser.close
-```
-
 ## Using Watir
 
-Everything you need is on the [Watir website](http://watir.com): news, guides, additional resources, support information and more.
-
-If you are interested in contributing to the project or the ecosystem, continue reading this README.
+This README is for people interested in writing code for Watir or gems in the Watir ecosystem
+that leverage private-api Watir code.
 
-## Implementation
+For our users, everything you'll need is on the [Watir website](http://watir.com): 
+examples, news, guides, additional resources, support information and more.
 
-The majority of element methods Watir provides is autogenerated from specifications.
-This is done by extracting the IDL parts from the spec and processing them with the WebIDL gem (link below).
-Currently supported specifications are:
+## Procedure for Patches/Pull Requests
 
-* [HTML](https://www.w3.org/TR/2017/PR-html51-20170803/single-page.html) (`lib/watir/elements/html_elements.rb`)
-* [SVG](https://www.w3.org/TR/2016/CR-SVG2-20160915/single-page.html) (`lib/watir/elements/svg_elements.rb`)
-
-## Specs
-
-### WatirSpec
-
-Watir uses WatirSpec for testing - an executable specification of Watir API.
+* Fork the project.
+* Clone onto your local machine.
+* Create a new feature branch (bonus points for good names).
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so we don't unintentionally break it in a future version.
+* Commit, do not change Rakefile, gemspec, or CHANGES files, we'll take care of that on release.
+* Make sure it is passing doctests.
+* Make sure it is passing rubocop.
+* Push to your forked repository.
+* Send a pull request.
 
-#### Using In Other Gems
+## Developing Extensions
 
-When developing Watir extension, you might want to make sure it's fully compatible with
-existing API. To achieve that, you can run WatirSpec against your own extension. Assuming
-your gem depends on Watir, you should do next:
+When developing a gem intended to be used with Watir, you can run your code with WatirSpec 
+to make sure that requiring your code does not break something else in Watir.
 
 First, add WatirSpec Rake tasks to your gem:
 
@@ -65,30 +48,62 @@ Second, initialize WatirSpec for your gem:
 $ bundle exec rake watirspec:init
 ```
 
-After initialized, just follow the instructions to customize Watir implementation in use.
+This command will walk you through how to customize your code.
+
+## Automatic Element Generation
+
+The majority of element methods Watir provides is autogenerated from specifications.
+This is done by extracting the IDL parts from the spec and processing them with the 
+[WebIDL gem](https://github.com/jarib/webidl).
+
+Generated elements are currently based on the following specifications:
+
+* [HTML](https://www.w3.org/TR/2017/REC-html52-20171214/) (`lib/watir/elements/html_elements.rb`)
+* [SVG](https://www.w3.org/TR/2018/CR-SVG2-20180807/) (`lib/watir/elements/svg_elements.rb`)
+
+To run:
+```bash
+$ bundle exec rake html:update
+$ bundle exec rake svg:update
+```
+
+## Specs
 
-### Watir-specific Specs
+#### Travis CI
 
-Specs specific to Watir are found in `spec/*_spec.rb`, with watirspec in `spec/watirspec/`.
+Watir specs are run on [Travis CI](https://travis-ci.org/watir/watir).
 
-### Doctests
+Watir code is tested with 2.3, 2.4 and 2.5 versions in multiple browsers and with multiple configurations.
 
-Watir uses [yard-doctest](https://github.com/p0deje/yard-doctest) for testing documentation examples.
+#### Doctests
+
+Watir uses [yard-doctest](https://github.com/p0deje/yard-doctest) to directly test
+our documentation examples.
 
 ```bash
+mkdir ~/.yard
+bundle exec yard config -a autoload_plugins yard-doctest
 rake yard:doctest
 ```
 
-## Note on Patches/Pull Requests
+#### Coveralls
 
-* Fork the project.
-* Clone onto your local machine.
-* Create a new feature branch (bonus points for good names).
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so we don't unintentionally break it in a future version.
-* Commit, do not change Rakefile, gemspec, or CHANGES files.
-* Push to your forked repository.
-* Send a pull request.
+Watir code is run through [Coveralls](https://coveralls.io/github/watir/watir) to encourage PRs
+to ensure all paths in their code have tests associated with them.
+
+#### Rubocop
+
+Watir is using [Rubocop](https://github.com/rubocop-hq/rubocop) to ensure a consistent style across the
+code base. It is run with our minimum supported Ruby version (2.3) 
+We have some [established exceptions](https://github.com/watir/watir/blob/master/.rubocop.yml) 
+that might need to be tweaked for new code submissions. This can be addressed in the PR as necessary.
+
+#### Statistics
+
+Element specs are run with 
+[Selenium Statistics gem](https://github.com/titusfortner/selenium_statistics)
+to verify that changes to the code do not dramatically decrease the performance based
+on wire calls.
 
 ## Copyright
 

data/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 require 'bundler'
 Bundler::GemHelper.install_tasks
@@ -9,33 +9,39 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
 namespace :spec do
   RSpec::Core::RakeTask.new(:html) do |spec|
-    spec.rspec_opts = "--format html --out #{ENV["SPEC_REPORT"] || "specs.html"}"
+    spec.rspec_opts = "--format html --out #{ENV['SPEC_REPORT'] || 'specs.html'}"
     spec.pattern = 'spec/**/*_spec.rb'
   end
 end
 
 {
-  html: 'https://www.w3.org/TR/html/single-page.html',
+  html: 'https://www.w3.org/TR/html52/single-page.html',
   svg: 'http://www.w3.org/TR/SVG2/single-page.html'
 }.each do |type, spec_uri|
   namespace type do
     spec_path = "support/#{type}.html"
 
     task generator_lib: :lib do
-      require "watir/generator"
+      require 'watir/generator'
     end
 
     desc "Download #{type.upcase} spec from #{spec_uri}"
     task :download do
-      require "open-uri"
+      require 'open-uri'
       mv spec_path, "#{spec_path}.old" if File.exist?(spec_path)
       downloaded_bytes = 0
 
-      File.open(spec_path, "w") do |io|
+      File.open(spec_path, 'w') do |io|
         io << "<!--  downloaded from #{spec_uri} on #{Time.now} -->\n"
-        io << data = open(spec_uri).read
+        io << data = URI.open(spec_uri).read
         downloaded_bytes = data.bytesize
       end
 
@@ -54,7 +60,7 @@ end
 
       if extractor.errors.any?
         puts "\n\n<======================= ERRORS =======================>\n\n"
-        puts extractor.errors.join("\n" + "=" * 80 + "\n")
+        puts extractor.errors.join("\n" + '=' * 80 + "\n")
       end
     end
 
@@ -63,13 +69,11 @@ end
       old_file = "lib/watir/elements/#{type}_elements.rb"
       generator = Watir::Generator.const_get(type.upcase).new
 
-      File.open("#{old_file}.new", "w") do |file|
+      File.open("#{old_file}.new", 'w') do |file|
         generator.generate(spec_path, file)
       end
 
-      if File.exist?(old_file)
-        system "diff -Naut #{old_file} #{old_file}.new | less"
-      end
+      system "diff -Naut #{old_file} #{old_file}.new | less" if File.exist?(old_file)
     end
 
     desc "Move #{type}.rb.new to #{type}.rb"
@@ -79,7 +83,7 @@ end
     end
 
     desc "download spec -> generate -> #{type}.rb"
-    task update: [:download, :generate, :overwrite]
+    task update: %i[download generate overwrite]
   end
 end
 
@@ -120,7 +124,7 @@ namespace :spec do
   require 'selenium-webdriver'
 
   desc 'Run specs in all browsers'
-  task all_browsers: [:browsers, :remote_browsers]
+  task all_browsers: %i[browsers remote_browsers]
 
   desc 'Run specs locally for all browsers'
   task browsers: [:chrome,
@@ -136,7 +140,7 @@ namespace :spec do
                          (:remote_ie if Selenium::WebDriver::Platform.windows?),
                          (:remote_edge if Selenium::WebDriver::Platform.windows?)].compact
 
-  %w(firefox chrome safari ie edge).each do |browser|
+  %w[firefox chrome safari ie edge].each do |browser|
     desc "Run specs in #{browser}"
     task browser do
       ENV['WATIR_BROWSER'] = browser
@@ -146,8 +150,16 @@ namespace :spec do
     desc "Run specs in Remote #{browser}"
     task "remote_#{browser}" do
       ENV['WATIR_BROWSER'] = browser
-      ENV["USE_REMOTE"] = 'true'
+      ENV['USE_REMOTE'] = 'true'
       Rake::Task[:spec].execute
     end
   end
+
+  desc 'Run element location specs and report wire calls'
+  RSpec::Core::RakeTask.new(:stats) do |spec|
+    ENV['SELENIUM_STATS'] = 'true'
+    spec.pattern = 'spec/**/**_spec.rb'
+    spec.exclude_pattern = '**/window_switching_spec.rb, **/browser_spec.rb, **/after_hooks_spec.rb, ' \
+                           '**/alert_spec.rb, **/wait_spec.rb, **/screenshot_spec.rb'
+  end
 end