capybara 3.32.2

data/lib/capybara/config.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'capybara/session/config'
+
+module Capybara
+  class Config
+    extend Forwardable
+
+    OPTIONS = %i[app reuse_server threadsafe server default_driver javascript_driver allow_gumbo].freeze
+
+    attr_accessor :app
+    attr_reader :reuse_server, :threadsafe
+    attr_reader :session_options
+    attr_writer :default_driver, :javascript_driver
+    attr_accessor :allow_gumbo
+
+    SessionConfig::OPTIONS.each do |method|
+      def_delegators :session_options, method, "#{method}="
+    end
+
+    def initialize
+      @session_options = Capybara::SessionConfig.new
+      @javascript_driver = nil
+    end
+
+    attr_writer :reuse_server
+
+    def threadsafe=(bool)
+      if (bool != threadsafe) && Session.instance_created?
+        raise 'Threadsafe setting cannot be changed once a session is created'
+      end
+
+      @threadsafe = bool
+    end
+
+    ##
+    #
+    # Return the proc that Capybara will call to run the Rack application.
+    # The block returned receives a rack app, port, and host/ip and should run a Rack handler
+    # By default, Capybara will try to use puma.
+    #
+    attr_reader :server
+
+    ##
+    #
+    # Set the server to use.
+    #
+    #     Capybara.server = :webrick
+    #     Capybara.server = :puma, { Silent: true }
+    #
+    # @overload server=(name)
+    #   @param [Symbol] name     Name of the server type to use
+    # @overload server=([name, options])
+    #   @param [Symbol] name Name of the server type to use
+    #   @param [Hash] options Options to pass to the server block
+    # @see register_server
+    #
+    def server=(name)
+      name, options = *name if name.is_a? Array
+      @server = if name.respond_to? :call
+        name
+      elsif options
+        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }
+      else
+        Capybara.servers[name.to_sym]
+      end
+    end
+
+    ##
+    #
+    # @return [Symbol]    The name of the driver to use by default
+    #
+    def default_driver
+      @default_driver || :rack_test
+    end
+
+    ##
+    #
+    # @return [Symbol]    The name of the driver used when JavaScript is needed
+    #
+    def javascript_driver
+      @javascript_driver || :selenium
+    end
+
+    def deprecate(method, alternate_method, once = false)
+      @deprecation_notified ||= {}
+      unless once && @deprecation_notified[method]
+        warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
+      end
+      @deprecation_notified[method] = true
+    end
+  end
+end

data/lib/capybara/cucumber.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'capybara/dsl'
+require 'capybara/rspec/matchers'
+require 'capybara/rspec/matcher_proxies'
+
+World(Capybara::DSL)
+World(Capybara::RSpecMatchers)
+
+After do
+  Capybara.reset_sessions!
+end
+
+Before do
+  Capybara.use_default_driver
+end
+
+Before '@javascript' do
+  Capybara.current_driver = Capybara.javascript_driver
+end
+
+Before do |scenario|
+  scenario.source_tag_names.each do |tag|
+    driver_name = tag.sub(/^@/, '').to_sym
+    Capybara.current_driver = driver_name if Capybara.drivers.key?(driver_name)
+  end
+end

data/lib/capybara/driver/base.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+class Capybara::Driver::Base
+  attr_writer :session
+
+  def current_url
+    raise NotImplementedError
+  end
+
+  def visit(path)
+    raise NotImplementedError
+  end
+
+  def refresh
+    raise NotImplementedError
+  end
+
+  def find_xpath(query, **options)
+    raise NotImplementedError
+  end
+
+  def find_css(query, **options)
+    raise NotImplementedError
+  end
+
+  def html
+    raise NotImplementedError
+  end
+
+  def go_back
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#go_back'
+  end
+
+  def go_forward
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#go_forward'
+  end
+
+  def execute_script(script, *args)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#execute_script'
+  end
+
+  def evaluate_script(script, *args)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script'
+  end
+
+  def evaluate_async_script(script, *args)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script_asnyc'
+  end
+
+  def save_screenshot(path, **options)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#save_screenshot'
+  end
+
+  def response_headers
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#response_headers'
+  end
+
+  def status_code
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#status_code'
+  end
+
+  ##
+  #
+  # @param frame [Capybara::Node::Element, :parent, :top]  The iframe element to switch to
+  #
+  def switch_to_frame(frame)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#switch_to_frame'
+  end
+
+  def frame_title
+    find_xpath('/html/head/title').map(&:all_text).first.to_s
+  end
+
+  def frame_url
+    evaluate_script('document.location.href')
+  rescue Capybara::NotSupportedByDriverError
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#frame_title'
+  end
+
+  def current_window_handle
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#current_window_handle'
+  end
+
+  def window_size(handle)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#window_size'
+  end
+
+  def resize_window_to(handle, width, height)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#resize_window_to'
+  end
+
+  def maximize_window(handle)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#maximize_window'
+  end
+
+  def fullscreen_window(handle)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#fullscreen_window'
+  end
+
+  def close_window(handle)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#close_window'
+  end
+
+  def window_handles
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#window_handles'
+  end
+
+  def open_new_window
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#open_new_window'
+  end
+
+  def switch_to_window(handle)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#switch_to_window'
+  end
+
+  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, **options, &blk)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#dismiss_modal'
+  end
+
+  def invalid_element_errors
+    []
+  end
+
+  def wait?
+    false
+  end
+
+  def reset!; end
+
+  def needs_server?
+    false
+  end
+
+  def session_options
+    session&.config || Capybara.session_options
+  end
+
+private
+
+  def session
+    @session ||= nil
+  end
+end

data/lib/capybara/driver/node.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Driver
+    class Node
+      attr_reader :driver, :native, :initial_cache
+
+      def initialize(driver, native, initial_cache = {})
+        @driver = driver
+        @native = native
+        @initial_cache = initial_cache
+      end
+
+      def all_text
+        raise NotImplementedError
+      end
+
+      def visible_text
+        raise NotImplementedError
+      end
+
+      def [](name)
+        raise NotImplementedError
+      end
+
+      def value
+        raise NotImplementedError
+      end
+
+      def style(styles)
+        raise NotImplementedError
+      end
+
+      # @param value [String, Array] Array is only allowed if node has 'multiple' attribute
+      # @param options [Hash] Driver specific options for how to set a value on a node
+      def set(value, **options)
+        raise NotImplementedError
+      end
+
+      def select_option
+        raise NotImplementedError
+      end
+
+      def unselect_option
+        raise NotImplementedError
+      end
+
+      def click(keys = [], **options)
+        raise NotImplementedError
+      end
+
+      def right_click(keys = [], **options)
+        raise NotImplementedError
+      end
+
+      def double_click(keys = [], **options)
+        raise NotImplementedError
+      end
+
+      def send_keys(*args)
+        raise NotImplementedError
+      end
+
+      def hover
+        raise NotImplementedError
+      end
+
+      def drag_to(element, **options)
+        raise NotImplementedError
+      end
+
+      def drop(*args)
+        raise NotImplementedError
+      end
+
+      def scroll_by(x, y)
+        raise NotImplementedError
+      end
+
+      def scroll_to(element, alignment, position = nil)
+        raise NotImplementedError
+      end
+
+      def tag_name
+        raise NotImplementedError
+      end
+
+      def visible?
+        raise NotImplementedError
+      end
+
+      def obscured?
+        raise NotImplementedError
+      end
+
+      def checked?
+        raise NotImplementedError
+      end
+
+      def selected?
+        raise NotImplementedError
+      end
+
+      def disabled?
+        raise NotImplementedError
+      end
+
+      def readonly?
+        !!self[:readonly]
+      end
+
+      def multiple?
+        !!self[:multiple]
+      end
+
+      def rect
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#rect'
+      end
+
+      def path
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#path'
+      end
+
+      def trigger(event)
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#trigger'
+      end
+
+      def inspect
+        %(#<#{self.class} tag="#{tag_name}" path="#{path}">)
+      rescue NotSupportedByDriverError
+        %(#<#{self.class} tag="#{tag_name}">)
+      end
+
+      def ==(other)
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#=='
+      end
+    end
+  end
+end

data/lib/capybara/dsl.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'capybara'
+
+module Capybara
+  module DSL
+    def self.included(base)
+      warn 'including Capybara::DSL in the global scope is not recommended!' if base == Object
+      super
+    end
+
+    def self.extended(base)
+      warn 'extending the main object with Capybara::DSL is not recommended!' if base == TOPLEVEL_BINDING.eval('self')
+      super
+    end
+
+    ##
+    #
+    # Shortcut to working in a different session.
+    #
+    def using_session(name_or_session, &block)
+      Capybara.using_session(name_or_session, &block)
+    end
+
+    # Shortcut to using a different wait time.
+    #
+    def using_wait_time(seconds, &block)
+      page.using_wait_time(seconds, &block)
+    end
+
+    ##
+    #
+    # Shortcut to accessing the current session.
+    #
+    #     class MyClass
+    #       include Capybara::DSL
+    #
+    #       def has_header?
+    #         page.has_css?('h1')
+    #       end
+    #     end
+    #
+    # @return [Capybara::Session] The current session object
+    #
+    def page
+      Capybara.current_session
+    end
+
+    Session::DSL_METHODS.each do |method|
+      if RUBY_VERSION >= '2.7'
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            page.method("#{method}").call(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          page.send method, *args, &block
+        end
+      end
+    end
+  end
+
+  extend(Capybara::DSL)
+end