From 973fc4f325ccbc509770774316ee28ba3c3ac999 Mon Sep 17 00:00:00 2001 From: Thomas Walpole Date: Mon, 30 Jun 2014 17:50:41 -0700 Subject: [PATCH] document expected behavior of Driver#accept_modal and #dismiss_modal --- lib/capybara/driver/base.rb | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/lib/capybara/driver/base.rb b/lib/capybara/driver/base.rb index b264c69a9..6fc3b4fe1 100644 --- a/lib/capybara/driver/base.rb +++ b/lib/capybara/driver/base.rb @@ -91,10 +91,30 @@ def no_such_window_error raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#no_such_window_error' end + + ## + # + # Execute the block, and then accept the modal opened. + # @param type [:alert, :confirm, :prompt] + # @option options [Numeric] :wait How long to wait for the modal to appear after executing the block. + # @option options [String, Regexp] :text Text to verify is in the message shown in the modal + # @option options [String] :with Text to fill in in the case of a prompt + # @return [String] the message shown in the modal + # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found + # def accept_modal(type, options={}, &blk) raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#accept_modal' end + ## + # + # Execute the block, and then dismiss the modal opened. + # @param type [:alert, :confirm, :prompt] + # @option options [Numeric] :wait How long to wait for the modal to appear after executing the block. + # @option options [String, Regexp] :text Text to verify is in the message shown in the modal + # @return [String] the message shown in the modal + # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found + # def dismiss_modal(type, &blk) raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#dismiss_modal' end