KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use synchronize_windows method of Capybara Package

Best Capybara code snippet using Capybara.synchronize_windows

session.rb

Source:session.rb

...523    #524    def window_opened_by(**options)525      old_handles = driver.window_handles526      yield527      synchronize_windows(options) do528        opened_handles = (driver.window_handles - old_handles)529        if opened_handles.size != 1530          raise Capybara::WindowError, 'block passed to #window_opened_by '\531                                       "opened #{opened_handles.size} windows instead of 1"532        end533        Window.new(self, opened_handles.first)534      end535    end536    ##537    #538    # Execute the given script, not returning a result. This is useful for scripts that return539    # complex objects, such as jQuery statements. {#execute_script} should be used over540    # {#evaluate_script} whenever possible.541    #542    # @param [String] script   A string of JavaScript to execute543    # @param args  Optional arguments that will be passed to the script. Driver support for this is optional and types of objects supported may differ between drivers544    #545    def execute_script(script, *args)546      @touched = true547      driver.execute_script(script, *driver_args(args))548    end549    ##550    #551    # Evaluate the given JavaScript and return the result. Be careful when using this with552    # scripts that return complex objects, such as jQuery statements. {#execute_script} might553    # be a better alternative.554    #555    # @param  [String] script   A string of JavaScript to evaluate556    # @param           args     Optional arguments that will be passed to the script557    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)558    #559    def evaluate_script(script, *args)560      @touched = true561      result = driver.evaluate_script(script.strip, *driver_args(args))562      element_script_result(result)563    end564    ##565    #566    # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.567    #568    # @param  [String] script   A string of JavaScript to evaluate569    # @param           args     Optional arguments that will be passed to the script570    # @return [Object]          The result of the evaluated JavaScript (may be driver specific)571    #572    def evaluate_async_script(script, *args)573      @touched = true574      result = driver.evaluate_async_script(script, *driver_args(args))575      element_script_result(result)576    end577    ##578    #579    # Execute the block, accepting a alert.580    #581    # @!macro modal_params582    #   Expects a block whose actions will trigger the display modal to appear.583    #   @example584    #     $0 do585    #       click_link('link that triggers appearance of system modal')586    #     end587    #   @overload $0(text, **options, &blk)588    #     @param text [String, Regexp]  Text or regex to match against the text in the modal. If not provided any modal is matched.589    #     @option options [Numeric] :wait  Maximum time to wait for the modal to appear after executing the block. Defaults to {Capybara.configure default_max_wait_time}.590    #     @yield Block whose actions will trigger the system modal591    #   @overload $0(**options, &blk)592    #     @option options [Numeric] :wait  Maximum time to wait for the modal to appear after executing the block. Defaults to {Capybara.configure default_max_wait_time}.593    #     @yield Block whose actions will trigger the system modal594    #   @return [String]  the message shown in the modal595    #   @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found596    #597    def accept_alert(text = nil, **options, &blk)598      accept_modal(:alert, text, options, &blk)599    end600    ##601    #602    # Execute the block, accepting a confirm.603    #604    # @macro modal_params605    #606    def accept_confirm(text = nil, **options, &blk)607      accept_modal(:confirm, text, options, &blk)608    end609    ##610    #611    # Execute the block, dismissing a confirm.612    #613    # @macro modal_params614    #615    def dismiss_confirm(text = nil, **options, &blk)616      dismiss_modal(:confirm, text, options, &blk)617    end618    ##619    #620    # Execute the block, accepting a prompt, optionally responding to the prompt.621    #622    # @macro modal_params623    # @option options [String] :with   Response to provide to the prompt624    #625    def accept_prompt(text = nil, **options, &blk)626      accept_modal(:prompt, text, options, &blk)627    end628    ##629    #630    # Execute the block, dismissing a prompt.631    #632    # @macro modal_params633    #634    def dismiss_prompt(text = nil, **options, &blk)635      dismiss_modal(:prompt, text, options, &blk)636    end637    ##638    #639    # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag640    # pointing to {Capybara.configure asset_host}.641    #642    # If invoked without arguments it will save file to {Capybara.configure save_path}643    # and file will be given randomly generated filename. If invoked with a relative path644    # the path will be relative to {Capybara.configure save_path}.645    #646    # @param [String] path  the path to where it should be saved647    # @return [String]      the path to which the file was saved648    #649    def save_page(path = nil)650      prepare_path(path, 'html').tap do |p_path|651        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')652      end653    end654    ##655    #656    # Save a snapshot of the page and open it in a browser for inspection.657    #658    # If invoked without arguments it will save file to {Capybara.configure save_path}659    # and file will be given randomly generated filename. If invoked with a relative path660    # the path will be relative to {Capybara.configure save_path}.661    #662    # @param [String] path  the path to where it should be saved663    #664    def save_and_open_page(path = nil)665      save_page(path).tap { |s_path| open_file(s_path) }666    end667    ##668    #669    # Save a screenshot of page.670    #671    # If invoked without arguments it will save file to {Capybara.configure save_path}672    # and file will be given randomly generated filename. If invoked with a relative path673    # the path will be relative to {Capybara.configure save_path}.674    #675    # @param [String] path    the path to where it should be saved676    # @param [Hash] options   a customizable set of options677    # @return [String]        the path to which the file was saved678    def save_screenshot(path = nil, **options)679      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }680    end681    ##682    #683    # Save a screenshot of the page and open it for inspection.684    #685    # If invoked without arguments it will save file to {Capybara.configure save_path}686    # and file will be given randomly generated filename. If invoked with a relative path687    # the path will be relative to {Capybara.configure save_path}.688    #689    # @param [String] path    the path to where it should be saved690    # @param [Hash] options   a customizable set of options691    #692    def save_and_open_screenshot(path = nil, **options)693      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }694    end695    def document696      @document ||= Capybara::Node::Document.new(self, driver)697    end698    NODE_METHODS.each do |method|699      if RUBY_VERSION >= '2.7'700        class_eval <<~METHOD, __FILE__, __LINE__ + 1701          def #{method}(...)702            @touched = true703            current_scope.#{method}(...)704          end705        METHOD706      else707        define_method method do |*args, &block|708          @touched = true709          current_scope.send(method, *args, &block)710        end711      end712    end713    DOCUMENT_METHODS.each do |method|714      if RUBY_VERSION >= '2.7'715        class_eval <<~METHOD, __FILE__, __LINE__ + 1716          def #{method}(...)717            document.#{method}(...)718          end719        METHOD720      else721        define_method method do |*args, &block|722          document.send(method, *args, &block)723        end724      end725    end726    def inspect727      %(#<Capybara::Session>)728    end729    def current_scope730      scope = scopes.last731      [nil, :frame].include?(scope) ? document : scope732    end733    ##734    #735    # Yield a block using a specific maximum wait time.736    #737    def using_wait_time(seconds, &block)738      if Capybara.threadsafe739        begin740          previous_wait_time = config.default_max_wait_time741          config.default_max_wait_time = seconds742          yield743        ensure744          config.default_max_wait_time = previous_wait_time745        end746      else747        Capybara.using_wait_time(seconds, &block)748      end749    end750    ##751    #752    # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect753    # if set at initialization time, so look at the configuration block that can be passed to the initializer too.754    #755    def configure756      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe757      yield config758    end759    def self.instance_created?760      @@instance_created761    end762    def config763      @config ||= if Capybara.threadsafe764        Capybara.session_options.dup765      else766        Capybara::ReadOnlySessionConfig.new(Capybara.session_options)767      end768    end769    def server_url770      @server&.base_url771    end772  private773    @@instance_created = false # rubocop:disable Style/ClassVars774    def driver_args(args)775      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }776    end777    def accept_modal(type, text_or_options, options, &blk)778      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)779    end780    def dismiss_modal(type, text_or_options, options, &blk)781      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)782    end783    def modal_options(text = nil, **options)784      options[:text] ||= text unless text.nil?785      options[:wait] ||= config.default_max_wait_time786      options787    end788    def open_file(path)789      require 'launchy'790      Launchy.open(path)791    rescue LoadError792      warn "File saved to #{path}.\nPlease install the launchy gem to open the file automatically."793    end794    def prepare_path(path, extension)795      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|796        FileUtils.mkdir_p(File.dirname(p_path))797      end798    end799    def default_fn(extension)800      timestamp = Time.new.strftime('%Y%m%d%H%M%S')801      "capybara-#{timestamp}#{rand(10**10)}.#{extension}"802    end803    def scopes804      @scopes ||= [nil]805    end806    def element_script_result(arg)807      case arg808      when Array809        arg.map { |subarg| element_script_result(subarg) }810      when Hash811        arg.transform_values! { |value| element_script_result(value) }812      when Capybara::Driver::Node813        Capybara::Node::Element.new(self, arg, nil, nil)814      else815        arg816      end817    end818    def adjust_server_port(uri)819      uri.port ||= @server.port if @server && config.always_include_port820    end821    def _find_frame(*args, **kw_args)822      case args[0]823      when Capybara::Node::Element824        args[0]825      when String, nil826        find(:frame, *args, **kw_args)827      when Symbol828        find(*args, **kw_args)829      when Integer830        idx = args[0]831        all(:frame, minimum: idx + 1)[idx]832      else833        raise TypeError834      end835    end836    def _switch_to_window(window = nil, **options, &window_locator)837      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)838      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?839      if window840        driver.switch_to_window(window.handle)841        window842      else843        synchronize_windows(options) do844          original_window_handle = driver.current_window_handle845          begin846            _switch_to_window_by_locator(&window_locator)847          rescue StandardError848            driver.switch_to_window(original_window_handle)849            raise850          end851        end852      end853    end854    def _switch_to_window_by_locator855      driver.window_handles.each do |handle|856        driver.switch_to_window handle857        return Window.new(self, handle) if yield858      end859      raise Capybara::WindowError, 'Could not find a window matching block/lambda'860    end861    def synchronize_windows(options, &block)862      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)863      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)864    end865  end866end...

synchronize_windows

Using AI Code Generation

1  Capybara::Selenium::Driver.new(app, :browser => :chrome)2Capybara::Screenshot.register_driver(:selenium) do |driver, path|3  driver.browser.save_screenshot(path)4Capybara::Screenshot.register_filename_prefix_formatter(:cucumber) do |scenario|

synchronize_windows

Using AI Code Generation

1  Capybara::Selenium::Driver.new(app, :browser => :chrome)2Capybara::Screenshot.register_driver(:selenium) do |driver, path|3  driver.browser.save_screenshot(path)4Capybara::Screenshot.register_filename_prefix_formatter(:cucumber) do |scenario|

synchronize_windows

Using AI Code Generation

1  config.allow_ul("http://www.google.com")2visit('/)3    page.driver.browser.switch_to.window(window)4  config.allow_url("http://www.google.com")5visit('/')6    page.driver.browser.switch_to.window(window)7  onfig.allow_rl("http://www.google.co")8visit('/')

synchronize_windows

Using AI Code Generation

1 config.allow_url("http://www.google.com")2visit('/')3 page.driver.browser.switch_to.window(window)

synchronize_windows

Using AI Code Generation

1  Capybara::Selenium::Driver.new(app, :browser => :chrome)2World(Capybara)3When(/^I search for "([^"]*)"$/) do |search_term|4  visit('/')5  fill_in('q', :with => search_term)6  click_button('Google Search')7Then(/^I should see "([^"]*)"$/) do |text|8  page.should have_content(text)9And(/^I should see "([^"]*)"$/) do |text|10  page.should have_content(text)11  Capybara::Selenium::Driver.new(app, :browser => :chrome)12World(Capybara)13When(/^I search for "([^"]*)"$/) do |search_term|14  visit('/')15  fill_in('q', :with => search_term)16  click_button('Google Search')17Then(/^I should see "([^"]*)"$/) do |text|18  page.should have_content(text)19And(/^I should see "([^"]*)"$/) do |text|20  page.should have_content(text)21  config.allow_url("http://www.google.com")22visit('/')23    page.driver.browser.switch_to.window(window)24  config.allow_url("http://www.google.com")25visit('/')

synchronize_windows

Using AI Code Generation

1  Capybara::Selenium::Driver.new(app, :browser => :chrome)2World(Capybara)3When(/^I search for "([^"]*)"$/) do |search_term|4  visit('/')5  fill_in('q', :with => search_term)6  click_button('Google Search')7Then(/^I should see "([^"]*)"$/) do |text|8  page.should have_content(text)9And(/^I should see "([^"]*)"$/) do |text|10  page.should have_content(text)11  Capybara::Selenium::Driver.new(app, :browser => :chrome)12World(Capybara)13When(/^I search for "([^"]*)"$/) do |search_term|14  visit('/')15  fill_in('q', :with => search_term)16  click_button('Google Search')17Then(/^I should see "([^"]*)"$/) do |text|18  page.should have_content(text)19And(/^I should see "([^"]*)"$/) do |text|20  page.should have_content(text)21Capybara::Session.new(:webkit).visit("/")22      page.driver.browser.switch_to.window(window)

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.