element_spec.rb

# encoding: utf-8
require File.expand_path("../spec_helper", __FILE__)

describe "Element" do

  before :each do
    browser.goto(WatirSpec.url_for("forms_with_input_elements.html"))
  end

  describe ".new" do
    it "finds elements matching the conditions when given a hash of :how => 'what' arguments" do
      expect(browser.checkbox(name: 'new_user_interests', title: 'Dancing is fun!').value).to eq 'dancing'
      expect(browser.text_field(class_name: 'name', index: 1).id).to eq 'new_user_last_name'
    end

    it "raises UnknownObjectException with a sane error message when given a hash of :how => 'what' arguments (non-existing object)" do
      expect { browser.text_field(index: 100, name: "foo").id }.to raise_error(Watir::Exception::UnknownObjectException)
    end

    it "raises ArgumentError if given the wrong number of arguments" do
      container = double("container").as_null_object
      expect { Element.new(container, 1, 2, 3, 4) }.to raise_error(ArgumentError)
      expect { Element.new(container, "foo") }.to raise_error(ArgumentError)
    end
  end

  describe "#eq and #eql?" do
    before { browser.goto WatirSpec.url_for("definition_lists.html") }

    it "returns true if the two elements point to the same DOM element" do
      a = browser.dl(id: "experience-list")
      b = browser.dl

      expect(a).to eq b
      expect(a).to eql(b)
    end

    it "returns false if the two elements are not the same" do
      a = browser.dls[0]
      b = browser.dls[1]

      expect(a).to_not eq b
      expect(a).to_not eql(b)
    end

    it "returns false if the other object is not an Element" do
      expect(browser.dl).to_not eq 1
    end
  end

  describe "data-* attributes" do
    before { browser.goto WatirSpec.url_for("data_attributes.html") }

    it "finds elements by a data-* attribute" do
      expect(browser.p(data_type: "ruby-library")).to exist
    end

    it "returns the value of a data-* attribute" do
      expect(browser.p.data_type).to eq "ruby-library"
    end
  end

  describe "aria-* attributes" do
    before { browser.goto WatirSpec.url_for("aria_attributes.html") }

    it "finds elements by a aria-* attribute" do
      expect(browser.p(aria_label: "ruby-library")).to exist
    end

    it "returns the value of a aria-* attribute" do
      expect(browser.p.aria_label).to eq "ruby-library"
    end
  end

  describe "finding with unknown tag name" do
    it "finds an element by xpath" do
      expect(browser.element(xpath: "//*[@for='new_user_first_name']")).to exist
    end

    it "finds an element by arbitrary attribute" 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

    it "finds finds several elements by arbitrary attribute" do
      expect(browser.elements(id: /^new_user/).length).to eq 32
    end

    it "finds an element from an element's subtree" do
      expect(browser.fieldset.element(id: "first_label")).to exist
      expect(browser.field_set.element(id: "first_label")).to exist
    end

    it "finds several elements from an element's subtree" do
      expect(browser.fieldset.elements(xpath: ".//label").length).to eq 20
    end
  end

  describe "#to_subtype" do
    it "returns a CheckBox instance" do
      e = browser.input(xpath: "//input[@type='checkbox']").to_subtype
      expect(e).to be_kind_of(Watir::CheckBox)
    end

    it "returns a Radio instance" do
      e = browser.input(xpath: "//input[@type='radio']").to_subtype
      expect(e).to be_kind_of(Watir::Radio)
    end

    it "returns a Button instance" do
      es = [
        browser.input(xpath: "//input[@type='button']").to_subtype,
        browser.input(xpath: "//input[@type='submit']").to_subtype,
        browser.input(xpath: "//input[@type='reset']").to_subtype,
        browser.input(xpath: "//input[@type='image']").to_subtype
      ]

      es.all? { |e| expect(e).to be_kind_of(Watir::Button) }
    end

    it "returns a TextField instance" do
      e = browser.input(xpath: "//input[@type='text']").to_subtype
      expect(e).to be_kind_of(Watir::TextField)
    end

    it "returns a FileField instance" do
      e = browser.input(xpath: "//input[@type='file']").to_subtype
      expect(e).to be_kind_of(Watir::FileField)
    end

    it "returns a Div instance" do
      el = browser.element(xpath: "//*[@id='messages']").to_subtype
      expect(el).to be_kind_of(Watir::Div)
    end
  end

  describe "#focus" do
    bug "http://code.google.com/p/selenium/issues/detail?id=157", :firefox do
      it "fires the onfocus event for the given element" do
        tf = browser.text_field(id: "new_user_occupation")
        expect(tf.value).to eq "Developer"
        tf.focus
        expect(browser.div(id: "onfocus_test").text).to eq "changed by onfocus event"
      end
    end
  end

  bug "https://github.com/SeleniumHQ/selenium/issues/2555", %i(remote firefox) do
    bug "https://github.com/SeleniumHQ/selenium/issues/1795", %i(remote edge) do
      describe "#focused?" do
        it "knows if the element is focused" do
          expect(browser.element(id: 'new_user_first_name')).to be_focused
          expect(browser.element(id: 'new_user_last_name')).to_not be_focused
        end
      end
    end
  end

  describe "#fire_event" do
    bug "https://bugzilla.mozilla.org/show_bug.cgi?id=1290966", :firefox do
      it "should fire the given event" do
        expect(browser.div(id: "onfocus_test").text).to be_empty
        browser.text_field(id: "new_user_occupation").fire_event('onfocus')
        expect(browser.div(id: "onfocus_test").text).to eq "changed by onfocus event"
      end
    end
  end

  describe "#parent" do
    it "gets the parent of this element" do
      expect(browser.text_field(id: "new_user_email").parent).to be_instance_of(FieldSet)
    end

    it "returns nil if the element has no parent" do
      expect(browser.body.parent.parent).to be_nil
    end
  end

  describe "#visible?" do
    it "returns true if the element is visible" do
      expect(browser.text_field(id: "new_user_email")).to be_visible
    end

    it "raises UnknownObjectException exception if the element does not exist" do
      expect {browser.text_field(id: "no_such_id").visible?}.to raise_error(Watir::Exception::UnknownObjectException)
    end

    it "raises UnknownObjectException exception if the element is stale" 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 }
      browser.refresh

      expect { browser.text_field(id: 'new_user_email').visible? }.to raise_error(Watir::Exception::UnknownObjectException)
    end

    it "returns true if the element has style='visibility: visible' even if parent has style='visibility: hidden'" do
      expect(browser.div(id: "visible_child")).to be_visible
    end

    it "returns false if the element is input element where type eq 'hidden'" do
      expect(browser.hidden(id: "new_user_interests_dolls")).to_not be_visible
    end

    it "returns false if the element has style='display: none;'" do
      expect(browser.div(id: 'changed_language')).to_not be_visible
    end

    it "returns false if the element has style='visibility: hidden;" do
      expect(browser.div(id: 'wants_newsletter')).to_not be_visible
    end

    it "returns false if one of the parent elements is hidden" do
      expect(browser.div(id: 'hidden_parent')).to_not be_visible
    end
  end

  describe "#exist?" do
    context ":class locator" do
      before do
        browser.goto(WatirSpec.url_for("class_locator.html"))
      end

      it "matches when the element has a single class" do
        e = browser.div(class: "a")
        expect(e).to exist
        expect(e.class_name).to eq "a"
      end

      it "matches when the element has several classes" do
        e = browser.div(class: "b")
        expect(e).to exist
        expect(e.class_name).to eq "a b"
      end

      it "does not match only part of the class name" do
        expect(browser.div(class: "c")).to_not exist
      end

      it "matches part of the class name when given a regexp" do
        expect(browser.div(class: /c/)).to exist
      end
    end

    it "doesn't raise when called on nested elements" do
      expect(browser.div(id: 'no_such_div').link(id: 'no_such_id')).to_not exist
    end

    it "raises if both :xpath and :css are given" do
      expect { browser.div(xpath: "//div", css: "div").exists? }.to raise_error(ArgumentError)
    end

    it "doesn't raise when selector has with :xpath has :index" do
      expect(browser.div(xpath: "//div", index: 1)).to exist
    end

    it "raises ArgumentError error if selector hash with :xpath has multiple entries" do
      expect { browser.div(xpath: "//div", class: "foo").exists? }.to raise_error(ArgumentError)
    end

    it "doesn't raise when selector has with :css has :index" do
      expect(browser.div(css: "div", index: 1)).to exist
    end

    it "raises ArgumentError error if selector hash with :css has multiple entries" do
      expect { browser.div(css: "div", class: "foo").exists? }.to raise_error(ArgumentError)
    end
  end

  bug "https://bugzilla.mozilla.org/show_bug.cgi?id=1255906", :firefox do
    describe '#send_keys' do
      before(:each) do
        phantom = browser.driver.capabilities.browser_name == 'phantomjs'
        @c = RUBY_PLATFORM =~ /darwin/ && !phantom ? :command : :control
        browser.goto(WatirSpec.url_for('keylogger.html'))
      end

      let(:receiver) { browser.text_field(id: 'receiver') }
      let(:events)   { browser.element(id: 'output').ps.size }

      it 'sends keystrokes to the element' do
        receiver.send_keys 'hello world'
        expect(receiver.value).to eq 'hello world'
        expect(events).to eq 11
      end

      it 'accepts arbitrary list of arguments' do
        receiver.send_keys 'hello', 'world'
        expect(receiver.value).to eq 'helloworld'
        expect(events).to eq 10
      end

      bug "http://code.google.com/p/chromium/issues/detail?id=93879", :chrome do
        not_compliant_on :safari do
          it 'performs key combinations' do
            receiver.send_keys 'foo'
            receiver.send_keys [@c, 'a']
            receiver.send_keys :backspace
            expect(receiver.value).to be_empty
            expect(events).to eq 6
          end

          it 'performs arbitrary list of key combinations' do
            receiver.send_keys 'foo'
            receiver.send_keys [@c, 'a'], [@c, 'x']
            expect(receiver.value).to be_empty
            expect(events).to eq 7
          end

          it 'supports combination of strings and arrays' do
            receiver.send_keys 'foo', [@c, 'a'], :backspace
            expect(receiver.value).to be_empty
            expect(events).to eq 6
          end
        end
      end
    end
  end

  describe "#flash" do

    let(:h2) { browser.h2(text: 'Add user') }

    it 'returns the element on which it was called' do
      expect(h2.flash).to eq h2
    end
  end

  describe '#inner_html' do
    it 'returns inner HTML code of element' do
      browser.goto WatirSpec.url_for('inner_outer.html')
      div = browser.div(id: 'foo')
      expect(div.inner_html).to eq('<a href="#">hello</a>')
    end
  end

  describe '#outer_html' do
    it 'returns outer (inner + element itself) HTML code of element' do
      browser.goto WatirSpec.url_for('inner_outer.html')
      div = browser.div(id: 'foo')
      expect(div.outer_html).to eq('<div id="foo"><a href="#">hello</a></div>')
    end
  end
end