watir 6.9.1 → 6.10.0

data/lib/watir/locators/text_field/locator.rb

@@ -2,15 +2,11 @@ module Watir
   module Locators
     class TextField
       class Locator < Element::Locator
-        def locate_all
-          find_all_by_multiple
-        end
 
         private
 
-        def wd_find_first_by(how, what)
-          how, what = selector_builder.build_wd_selector(how => what) if how == :tag_name
-          super
+        def using_selenium(*)
+          # force Watir usage
         end
 
         def matches_selector?(element, rx_selector)
@@ -28,13 +24,6 @@ module Watir
           super
         end
 
-        def by_id
-          element = super
-
-          if element && !Watir::TextField::NON_TEXT_TYPES.include?(element.attribute(:type))
-            element
-          end
-        end
       end
     end
   end

data/spec/browser_spec.rb

@@ -61,8 +61,8 @@ describe Watir::Browser do
             caps = Selenium::WebDriver::Remote::Capabilities.firefox(accept_insecure_certs: true)
             @opts.merge!(url: url, desired_capabilities: caps)
 
-            expect { @new_browser = WatirSpec.new_browser }.to output.to_stderr
-
+            msg = /You can now pass values directly into Watir::Browser opt without needing to use :desired_capabilities/
+            expect { @new_browser = WatirSpec.new_browser }.to output(msg).to_stdout_from_any_process
             expect(@new_browser.driver.capabilities.accept_insecure_certs).to eq true
           end
         end
@@ -104,7 +104,8 @@ describe Watir::Browser do
             opts = {desired_capabilities: Selenium::WebDriver::Remote::Capabilities.chrome,
                     url: url}
             WatirSpec.implementation.browser_args = [:remote, opts]
-            @new_browser = WatirSpec.new_browser
+            msg = /You can now pass values directly into Watir::Browser opt without needing to use :desired_capabilities/
+            expect { @new_browser = WatirSpec.new_browser }.to output(msg).to_stdout_from_any_process
             server_url = @new_browser.driver.instance_variable_get('@bridge').http.instance_variable_get('@server_url')
             expect(server_url).to eq URI.parse(url)
           end

data/spec/element_locator_spec.rb

@@ -8,7 +8,9 @@ describe Watir::Locators::Element::Locator do
       SELENIUM_SELECTORS.each do |loc|
         it "delegates to Selenium's #{loc} locator" do
           expect_one(loc, "bar").and_return(element(tag_name: "div"))
-          locate_one loc => "bar"
+          match = %i[link link_text partial_link_text].include?(loc) ? :to : :to_not
+          msg = /:#{loc} locator is deprecated\. Use :visible_text instead/
+          expect { locate_one loc => "bar" }.send(match, output(msg).to_stdout_from_any_process)
         end
       end
     end
@@ -75,7 +77,43 @@ describe Watir::Locators::Element::Locator do
       it "handles selector with multiple classes in string" do
         expect_one :xpath, ".//*[contains(concat(' ', @class, ' '), ' a b ')]"
 
-        locate_one class: "a b"
+        msg = /:class locator to locate multiple classes with a String value is deprecated\. Use Array instead/
+        expect { locate_one class: "a b" }.to output(msg).to_stdout_from_any_process
+      end
+
+      it "handles selector with tag_name and xpath" do
+          elements = [
+              element(tag_name: "div", attributes: { class: "foo" }),
+              element(tag_name: "span", attributes: { class: "foo" }),
+              element(tag_name: "div", attributes: { class: "foo" })
+          ]
+
+          expect_one(:xpath, './/*[@class="foo"]').and_return(elements.first)
+          expect_all(:xpath, './/*[@class="foo"]').and_return(elements)
+
+          selector = {
+              xpath: './/*[@class="foo"]',
+              tag_name: 'span'
+          }
+
+          expect(locate_one(selector).tag_name).to eq 'span'
+      end
+
+      it "handles custom attributes" do
+        elements = [
+            element(tag_name: "div", attributes: { custom_attribute: "foo" }),
+            element(tag_name: "span", attributes: { custom_attribute: "foo" }),
+            element(tag_name: "div", attributes: { custom_attribute: "foo" })
+        ]
+
+        expect_one(:xpath, ".//span[@custom-attribute='foo']").and_return(elements[1])
+
+        selector = {
+            custom_attribute: 'foo',
+            tag_name: 'span'
+        }
+
+        expect(locate_one(selector).tag_name).to eq 'span'
       end
     end
 
@@ -93,13 +131,6 @@ describe Watir::Locators::Element::Locator do
                    caption: "foo"
       end
 
-      it "translates :class_name to :class" do
-        expect_one :xpath, ".//div[contains(concat(' ', @class, ' '), ' foo ')]"
-
-        locate_one tag_name: "div",
-                   class_name: "foo"
-      end
-
       it "handles data-* attributes" do
         expect_one :xpath, ".//div[@data-name='foo']"
 
@@ -274,6 +305,10 @@ describe Watir::Locators::Element::Locator do
 
         expect_all(:tag_name, "label").ordered.and_return(label_elements)
         expect_all(:xpath, ".//div[@id='baz']").ordered.and_return(div_elements)
+
+        allow(browser).to receive(:ensure_context).and_return(nil)
+        allow(browser).to receive(:execute_script).and_return('foo', 'foob')
+
         expect(locate_one(tag_name: "div", label: /oob/)).to eq div_elements.first
       end
 
@@ -303,6 +338,7 @@ describe Watir::Locators::Element::Locator do
 
     it "returns nil if found element didn't match the selector tag_name" do
       expect_one(:xpath, "//div").and_return(element(tag_name: "div"))
+      expect_all(:xpath, "//div").and_return([element(tag_name: "div")])
 
       selector = {
         tag_name: "input",
@@ -323,14 +359,6 @@ describe Watir::Locators::Element::Locator do
         expect { locate_one(tag_name: 123) }.to \
         raise_error(TypeError, %[expected one of [Array, String, Regexp, TrueClass, FalseClass, Symbol], got 123:#{num_type}])
       end
-
-      it "raises a MissingWayOfFindingObjectException if the attribute is not valid" do
-        bad_selector = {tag_name: "input", href: "foo"}
-        valid_attributes = Watir::Input.attributes
-
-        expect { locate_one(bad_selector, valid_attributes) }.to \
-        raise_error(Watir::Exception::MissingWayOfFindingObjectException, "invalid attribute: :href")
-      end
     end
   end
 
@@ -339,7 +367,9 @@ describe Watir::Locators::Element::Locator do
       SELENIUM_SELECTORS.each do |loc|
         it "delegates to Selenium's #{loc} locator" do
           expect_all(loc, "bar").and_return([element(tag_name: "div")])
-          locate_all(loc => "bar")
+          match = %i[link link_text partial_link_text].include?(loc) ? :to : :to_not
+          msg = /:#{loc} locator is deprecated\. Use :visible_text instead/
+          expect { locate_all loc => "bar" }.send(match, output(msg).to_stdout_from_any_process)
         end
       end
     end
@@ -380,7 +410,8 @@ describe Watir::Locators::Element::Locator do
       it "handles selector with multiple classes in string" do
         expect_all :xpath, ".//*[contains(concat(' ', @class, ' '), ' a b ')]"
 
-        locate_all class: "a b"
+        msg = /Using the :class locator to locate multiple classes with a String value is deprecated\. Use Array instead/
+        expect { locate_all class: "a b" }.to output(msg).to_stdout_from_any_process
       end
     end
 

data/spec/locator_spec_helper.rb

@@ -37,7 +37,7 @@ module LocatorSpecHelper
     attrs.each do |key, value|
       allow(el).to receive(:attribute).with(key).and_return(value)
     end if attrs
-
+    allow(el).to receive(:enabled?).and_return true
     el
   end
 

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require 'webdrivers'
 require 'locator_spec_helper'
 require 'rspec'
 
-SELENIUM_SELECTORS = %i(class class_name css id tag_name xpath)
+SELENIUM_SELECTORS = %i(class class_name css id tag_name xpath link_text partial_link_text link)
 
 if ENV['RELAXED_LOCATE'] == "false"
   Watir.relaxed_locate = false

data/spec/watirspec/elements/area_spec.rb

@@ -44,10 +44,6 @@ describe "Area" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.area(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.area(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/button_spec.rb

@@ -92,10 +92,6 @@ describe "Button" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.button(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.button(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/checkbox_spec.rb

@@ -68,10 +68,6 @@ describe "CheckBox" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.checkbox(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.checkbox(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/dd_spec.rb

@@ -26,10 +26,6 @@ describe "Dd" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.dd(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.dd(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/del_spec.rb

@@ -37,10 +37,6 @@ describe "Del" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.del(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.del(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/div_spec.rb

@@ -13,12 +13,15 @@ describe "Div" do
       expect(browser.div(id: /header/)).to exist
       expect(browser.div(title: "Header and primary navigation")).to exist
       expect(browser.div(title: /Header and primary navigation/)).to exist
-      expect(browser.div(text: "This is a footer.")).to exist
-      expect(browser.div(text: /This is a footer\./)).to exist
+      expect(browser.div(text: "Not shownNot hidden")).to exist
+      msg =  /text locator with RegExp values to find elements based on only visible text is deprecated\. Use :visible_text instead/
+      expect { expect(browser.div(text: /Not hidden/)).to exist }.to output(msg).to_stdout_from_any_process
       expect(browser.div(class: "profile")).to exist
       expect(browser.div(class: /profile/)).to exist
       expect(browser.div(index: 0)).to exist
       expect(browser.div(xpath: "//div[@id='header']")).to exist
+      expect(browser.div(custom_attribute: "custom")).to exist
+      expect(browser.div(custom_attribute: /custom/)).to exist
     end
 
     it "returns the first div if given no args" do
@@ -31,7 +34,8 @@ describe "Div" do
       expect(browser.div(title: "no_such_title")).to_not exist
       expect(browser.div(title: /no_such_title/)).to_not exist
       expect(browser.div(text: "no_such_text")).to_not exist
-      expect(browser.div(text: /no_such_text/)).to_not exist
+      msg = /:text locator with RegExp values to find elements based on only visible text is deprecated\. Use :visible_text instead/
+      expect { expect(browser.div(text: /no_such_text/)).to_not exist }.to output(msg).to_stdout_from_any_process
       expect(browser.div(class: "no_such_class")).to_not exist
       expect(browser.div(class: /no_such_class/)).to_not exist
       expect(browser.div(index: 1337)).to_not exist
@@ -41,11 +45,6 @@ describe "Div" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.div(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.div(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
-
   end
 
   # Attribute methods
@@ -85,6 +84,11 @@ describe "Div" do
       browser.goto WatirSpec.url_for "multiple_ids.html"
       expect(browser.div(id: "multiple", class: "bar").class_name).to eq "bar"
     end
+
+    it "should find the id with the correct tag name" do
+      browser.goto WatirSpec.url_for "multiple_ids.html"
+      expect(browser.span(id: "multiple").class_name).to eq "foobar"
+    end
   end
 
   describe "#style" do
@@ -128,6 +132,12 @@ describe "Div" do
     end
   end
 
+  describe "custom methods" do
+    it "returns the custom attribute if the element exists" do
+      expect(browser.div(custom_attribute: "custom").attribute_value("custom-attribute")).to eq "custom"
+    end
+  end
+
   describe "#respond_to?" do
     it "returns true for all attribute methods" do
       expect(browser.div(index: 0)).to respond_to(:class_name)
@@ -137,6 +147,13 @@ describe "Div" do
     end
   end
 
+  describe "Deprecation Warnings" do
+    it "throws deprecation when for text and RegExp" do
+      msg =  /text locator with RegExp values to find elements based on only visible text is deprecated\. Use :visible_text instead/
+      expect { browser.div(text: /Not hidden/).exists? }.to output(msg).to_stdout_from_any_process
+    end
+  end
+
   # Manipulation methods
   not_compliant_on :headless do
     describe "#click" do
@@ -152,6 +169,11 @@ describe "Div" do
         expect { browser.div(index: 1337).click }.to raise_unknown_object_exception
         expect { browser.div(xpath: "//div[@id='no_such_id']").click }.to raise_unknown_object_exception
       end
+
+      it "includes custom message if element with a custom attribute does not exist" do
+        message = "Watir treated [\"custom_attribute\"] as a non-HTML compliant attribute, ensure that was intended"
+        expect { browser.div(custom_attribute: "not_there").click }.to raise_unknown_object_exception(message)
+      end
     end
 
     describe "#click!" do

data/spec/watirspec/elements/divs_spec.rb

@@ -14,7 +14,7 @@ describe "Divs" do
 
   describe "#length" do
     it "returns the number of divs" do
-      expect(browser.divs.length).to eq 14
+      expect(browser.divs.length).to eq 16
     end
   end
 

data/spec/watirspec/elements/dl_spec.rb

@@ -26,10 +26,6 @@ describe "Dl" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.dl(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.dl(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/dt_spec.rb

@@ -26,10 +26,6 @@ describe "Dt" do
     it "raises TypeError when 'what' argument is invalid" do
       expect { browser.dt(id: 3.14).exists? }.to raise_error(TypeError)
     end
-
-    it "raises MissingWayOfFindingObjectException when 'how' argument is invalid" do
-      expect { browser.dt(no_such_how: 'some_value').exists? }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
   end
 
   # Attribute methods

data/spec/watirspec/elements/element_spec.rb

@@ -71,6 +71,27 @@ describe "Element" do
     end
   end
 
+  describe "visible text" do
+    it "finds elements by visible text" do
+      browser.goto WatirSpec.url_for('non_control_elements.html')
+
+      expect(browser.link(visible_text: "all visible")).to exist
+      expect(browser.link(visible_text: /all visible/)).to exist
+      expect(browser.link(visible_text: "some visible")).to exist
+      expect(browser.link(visible_text: /some visible/)).to exist
+      expect(browser.link(visible_text: "none visible")).not_to exist
+      expect(browser.link(visible_text: /none visible/)).not_to exist
+
+      expect(browser.link(visible_text: "Link 2", class: "external")).to exist
+      expect(browser.link(visible_text: /Link 2/, class: "external")).to exist
+
+      expect(browser.element(visible_text: "all visible")).to exist
+      expect(browser.element(visible_text: /all visible/)).to exist
+      expect(browser.element(visible_text: "some visible")).to exist
+      expect(browser.element(visible_text: /some visible/)).to exist
+    end
+  end
+
   describe "finding with unknown tag name" do
     it "finds an element without arguments" do
       expect(browser.element).to exist
@@ -84,16 +105,6 @@ describe "Element" do
       expect(browser.element(title: "no title")).to exist
     end
 
-    it "raises MissingWayOfFindingObjectException if the attribute is invalid for the element type" do
-      expect {
-        browser.element(for: "no title").exists?
-      }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-
-      expect {
-        browser.element(value: //).exists?
-      }.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
-    end
-
     it "finds several elements by xpath" do
       expect(browser.elements(xpath: "//a").length).to eq 1
     end
@@ -191,10 +202,12 @@ describe "Element" do
       wd_element = browser.text_field(id: "new_user_email").wd
 
       # simulate element going stale during lookup
-      allow(browser.driver).to receive(:find_element).with(:id, 'new_user_email') { wd_element }
+      allow(browser.driver).to receive(:find_element).with(:css, '#new_user_email') { wd_element }
+      allow(browser.driver).to receive(:find_elements).with(:css, '#new_user_email') { [wd_element] }
+      allow(browser.driver).to receive(:find_elements).with(:tag_name, 'iframe') { [] }
       browser.refresh
 
-      expect { browser.text_field(id: 'new_user_email').visible? }.to raise_unknown_object_exception
+      expect { browser.text_field(css: '#new_user_email').visible? }.to raise_unknown_object_exception
     end
 
     it "returns true if the element has style='visibility: visible' even if parent has style='visibility: hidden'" do

data/spec/watirspec/elements/elements_spec.rb

@@ -33,4 +33,15 @@ describe "Elements" do
     end
   end
 
+  describe "visible text" do
+    it 'finds elements by visible text' do
+      browser.goto WatirSpec.url_for('non_control_elements.html')
+      expect(browser.links(visible_text: 'all visible').count).to eq(1)
+      expect(browser.links(visible_text: /all visible/).count).to eq(1)
+      expect(browser.links(visible_text: 'some visible').count).to eq(1)
+      expect(browser.links(visible_text: /some visible/).count).to eq(1)
+      expect(browser.links(visible_text: 'none visible').count).to eq(0)
+      expect(browser.links(visible_text: /none visible/).count).to eq(0)
+    end
+  end
 end