Merge pull request #191 from rubycdp/issue_58/pick_option_in_select

Feature: Node#select / Node#selected

Author: Mifrill

README.md

@@ -1048,6 +1048,8 @@ browser.playback_rate # => 2000
 #### property
 #### attribute
 #### evaluate
+#### selected : `Array`
+#### select
 
 
 ## Thread safety ##

lib/ferrum/node.rb

@@ -127,6 +127,42 @@ def attribute(name)
       evaluate("this.getAttribute('#{name}')")
     end
 
+    def selected
+      function = <<~JS
+        function(element) {
+          if (element.nodeName.toLowerCase() !== 'select') {
+            throw new Error('Element is not a <select> element.');
+          }
+          return Array.from(element).filter(option => option.selected).map((option) => option.text);
+        }
+      JS
+      page.evaluate_func(function, self)
+    end
+
+    def select(*values)
+      tap do
+        function = <<~JS
+          function(element, values) {
+            if (element.nodeName.toLowerCase() !== 'select') {
+              throw new Error('Element is not a <select> element.');
+            }
+            const options = Array.from(element.options);
+            element.value = undefined;
+            for (const option of options) {
+              option.selected = values.includes(option.value);
+              if (option.selected && !element.multiple) break;
+            }
+            element.dispatchEvent(new Event('input', { bubbles: true }));
+            element.dispatchEvent(new Event('change', { bubbles: true }));
+            return options
+              .filter((option) => option.selected)
+              .map((option) => option.value);
+          }
+        JS
+        page.evaluate_func(function, self, values.join(','))
+      end
+    end
+
     def evaluate(expression)
       page.evaluate_on(node: self, expression: expression)
     end

spec/node_spec.rb

@@ -83,6 +83,94 @@ module Ferrum
       expect(links.first.text).to eq("Open for match")
     end
 
+    describe "#selected" do
+      before do
+        browser.goto("/ferrum/form")
+      end
+
+      it "returns texts of selected options" do
+        expect(browser.at_xpath("//*[@id='form_region']").selected).to eq(["Norway"])
+      end
+
+      context "when options exists but no selected option" do
+        it "returns first option text as default value" do
+          expect(browser.at_xpath("//*[@id='form_title']").selected).to eq(["Mrs"])
+        end
+      end
+
+      context "when no selected options" do
+        it "returns empty array" do
+          expect(browser.at_xpath("//*[@id='form_tendency']").selected).to eq([])
+        end
+      end
+
+      context "when selector is not <select>" do
+        it "raises JavaScriptError with proper message" do
+          expect { browser.at_xpath("//*[@id='customer_name']").selected }.
+            to raise_exception(Ferrum::JavaScriptError, /Element is not a <select> element/)
+        end
+      end
+    end
+
+    describe "#select" do
+      before do
+        browser.goto("/ferrum/form")
+      end
+
+      it "picks option in select by match string argument" do
+        expect(browser.at_xpath("//*[@id='form_title']").select("Miss").selected).to eq(["Miss"])
+      end
+
+      shared_examples "clears selected options with no exception" do |options|
+        it "clears selected options with no exception" do
+          expect(browser.at_xpath("//*[@id='form_title']").selected).to eq(["Mrs"])
+          expect(browser.at_xpath("//*[@id='form_title']").select(options).selected).to eq([])
+        end
+      end
+
+      context "when option with provided text does not exist" do
+        include_examples "clears selected options with no exception", "Gotcha"
+      end
+
+      context "when provided empty array" do
+        include_examples "clears selected options with no exception", []
+      end
+
+      context "when provided empty string" do
+        include_examples "clears selected options with no exception", ""
+      end
+
+      context "when one of option with provided texts does not exist" do
+        it "picks only existed options with no exception" do
+          expect(browser.at_xpath("//*[@id='form_title']").selected).to eq(["Mrs"])
+          expect(browser.at_xpath("//*[@id='form_title']").select(%w[Mrs SQL]).selected).to eq(["Mrs"])
+        end
+      end
+
+      context "when select has multiple property" do
+        it "picks options in select by match arguments as array" do
+          expect(browser.at_xpath("//*[@id='form_languages']").select(%w[SQL Ruby]).selected).to eq(%w[Ruby SQL])
+        end
+
+        it "picks options in select by match arguments as string" do
+          expect(browser.at_xpath("//*[@id='form_languages']").select("SQL, Ruby").selected).to eq(%w[Ruby SQL])
+        end
+      end
+
+      context "when selector is not <select>" do
+        it "raises JavaScriptError with proper message" do
+          expect { browser.at_xpath("//*[@id='customer_name']").select(anything) }.
+            to raise_exception(Ferrum::JavaScriptError, /Element is not a <select> element/)
+        end
+      end
+
+      context "when provided texts of disabled option" do
+        it "picks disabled option with no exception" do
+          expect(browser.at_xpath("//*[@id='form_title']").select(["Other"]).selected).to eq(["Other"])
+        end
+      end
+    end
+
     context "when the element is not in the viewport" do
       before do
         browser.go_to("/ferrum/with_js")